Repository files navigation

Extracts frames from GIFs including inter-frame coalescing.

Some GIFs store delta information between frames instead of storing complete frames. Here's an example:

Original gif (source).

5 extracted frameswithout coalescing.

5 extracted frameswith coalescing.

This module requiresnode >= 8.

npm install --save gif-extract-frames

constextractFrames=require('gif-extract-frames')constresults=awaitextractFrames({input:'./media/bubbles.gif',output:'frame-%d.png'})console.log('number of frames',results.shape[0])

Returns:Promise<ndarray>

Returns a modified version of thendarray returned byget-pixels.

Type:StringRequired

Path to a GIF file.

Type:StringExample:'output/frame-%d.png'

Optional frame pattern if you want to write each frame to disk. Should contain a%d that will be replaced with the frame number (starting at 0).

The resultingndarray will be returned whether or not anoutput is given.

Type:BooleanDefault:true

Whether or not to perform inter-frame coalescing.

• gifsicle - GIF manipulation library capable ofexploding gifs, but AFAIK does not support frame coalescing when exporting frames.
• gif-explode - Alternative which usesgifsicle but does not support frame coalescing.
• omggif - JavaScript GIF encoder & decoder used under the hood.
• ffmpeg-extract-frames - Analogous module for extracting frames from video files.

MIT ©Travis Fischer

Support my OSS work byfollowing me on twitter