sharp-gif

Generate animated GIF for sharp base on gif-encoder.

+ + =

Install

npm install sharp-gif

Usage

const fs = require("fs");
const sharp = require("sharp");
const GIF = require("sharp-gif");

(async () => {
  // Simple use case
  const image = await GIF
    .createGif()
    .addFrame([
      sharp("./frames/0000.png"),
      sharp("./frames/0001.png"),
      sharp("./frames/0002.png"),
    ])
    .toSharp();
  image.toFile("./frames.gif");

  // Options
  const gif = GIF.createGif({
    // GifEncoder constructor options
    gifEncoderOptions: { highWaterMark: 64 },
    // Sharp constructor options
    sharpOptions: {},
    // Custom size
    width: 300,
    height: 200,
    // Amount of milliseconds to delay between frames
    delay: 200,
    // Amount of times to repeat GIF
    repeat: 0,
    // GIF quality
    quality: 10,
    // Define the color which represents transparency in the GIF.
    transparent: "#FFFFFF",
    // Resize all frame to `largest` or `smallest`
    resizeTo: "largest",
    // Resize by `zoom` or `crop`
    resizeType: "zoom",
    // Options for sharp.resize()
    resizeOptions: {},
    // Background option for sharp.extend()
    extendBackground: { r: 0, g: 0, b: 0, alpha: 0 },
  });
  gif.addFrame(sharp("./1.png"));
  gif.addFrame(sharp("./2.png"));
  const image = await gif.toSharp();
  image.toFile("./frames.gif");

  // Trace encoding progress
  const image = await GIF
    .createGif()
    .addFrame(
      fs.readdirSync("./frames")
        .map((file) => sharp(`./frames/${file}`))
    )
    .toSharp(({ total, encoded }) => {
      console.log(`${encoded}/${total}`);
    });
  image.toFile("./frames.gif");

  // You can even concat animated GIFs
  const image = await GIF
    .createGif({ transparent: "#FFFFFF", })
    .addFrame([
      sharp("./1.gif", { animated: true }),
      sharp("./2.gif", { animated: true }),
    ])
    .toSharp();
  image.toFile("./concat.gif");
})();

API

GIF.createGif(options?: Object): Gif

• options Object (optional)
  • gifEncoderOptions Object (optional) - GifEncoder constructor options.
    • highWaterMark Number - Number, in bytes, to store in internal buffer. Defaults to 64kB.
  • sharpOptions Object (optional) - Sharp constructor options.
  • width Number (optional) - Width, in pixels, of the GIF to output.
  • height Number (optional) - Height, in pixels, of the GIF to output.
  • delay Number (optional) - Amount of milliseconds to delay between frames.
  • repeat Number (optional) - Amount of times to repeat GIF. Default by 0, loop indefinitely.
  • quality Number (optional) - GIF quality. 1 is best colors and worst performance, 20 is suggested maximum but there is no limit. Default by 10.
  • transparent String (optional) - Define the color which represents transparency in the GIF.
  • resizeTo ("largest" | "smallest") (optional) - Resize all frame to the largest frame or smallest frame size. Default by largest.
  • resizeType ("zoom" | "crop") (optional) - zoom use sharp.resize(), crop use sharp.extend() and sharp.extract().
  • resizeOptions sharp.ResizeOptions (optional) - Options for sharp.resize().
  • extendBackground sharp.Color (optional) - Background option for sharp.extend().

Returns Gif - Return a instance of Gif Contains the following methods:

gif.addFrame(frame: Sharp | Sharp[]): Gif

• frame Object - An instance of Sharp, or an array of instance of Sharp.

gif.toSharp(progress?: Function, encoder?: GifEncoder): Promise<Sharp>

Encode all frames and resolve with an animated Sharp instance.

• progress (info: Object) => void (optional) - Frames encoding progress.
  • info Object - Note that the frames count contains GIF header end footer (as 2 frames).
    • total Number - Total frames count.
    • encoded Number - Encoded frames count.
• encoder GifEncoder (optional) - Custom GifEncoder.

Returns Promise<Sharp> - Resolve with an instance of Sharp.

gif.toBuffer(progress?: Function, encoder?: GifEncoder): Promise<Buffer>

Encode all frames and resolve with an animated GIF buffer.

gif.getEncoder(width: Number, height: Number, options?: Object): GIFEncoder

Create a instance of GIFEncoder. See new GifEncoder.