feat: support for animated WEBP & GIF #2012

deftomat · 2019-12-19T06:22:49Z

Requires libvips 8.9

New features:

load & save WEBP animations
load & save GIF animations

Please keep in mind that to create a GIF file, libvips must be compiled with imageMagick support (which could be a real pain 😞 )

OJezu · 2019-12-19T08:55:11Z

Re: imagemagick support

FROM node:12-slim

# Install libraries and programs
RUN true \
  && apt-get update \
  && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
      # needed for building
      automake build-essential \
      # libvips image libraries
      libjpeg-dev libtiff-dev libpng-dev libgif-dev librsvg2-dev libpoppler-glib-dev zlib1g-dev fftw3-dev liblcms2-dev \
      libmagickwand-dev libpango1.0-dev  libexif-dev liborc-0.4-dev libwebp-dev \
      # needed to rebuild sharp against global libvips
      python \
      # custom allocator to preserve rss memory
      libjemalloc1 \
  && apt-get autoremove -y \
  && apt-get autoclean \
  && apt-get clean \
  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* \
  && true

# get your own from https://github.com/libvips/libvips/releases
COPY ./lib/vips-8.7.3.tar.gz /tmp/

# Build libvips
RUN true\
  && cd /tmp \
  && tar zxvf vips-8.7.3.tar.gz \
  && cd /tmp/vips-8.7.3 \
  && ./configure --enable-debug=no $1 \
  && make -j4 \
  && make install \
  && ldconfig \
  && rm -rf /tmp/* /var/tmp/* \
  true

# Change memory allocator to avoid leaks
ENV LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.1

Use this as base for image of docker container with your application for imagemagic-enabled libvips.

lovell · 2019-12-20T11:08:49Z

Thanks for this PR Tomáš, much appreciated, I expect to have some time to take a proper look at this during the next week or so.

lovell · 2019-12-27T19:47:29Z

@deftomat There's now a pre-release 8.9.0-rc4 version of the prebuilt libvips binaries available to help with this PR.

You might also want to rebase against the wit branch as it has a couple of other changes required for libvips v8.9.x.

This should allow you to fix up the linting errors and test failures.

salipitchero · 2020-01-06T08:56:40Z

hi @deftomat & @lovell

just to jump in on this, this seems to rebase pretty easily with the wit branch. Linting and tests pass apart from three.

  1) GIF input
       Animated GIF first page to PNG:
     Error: VipsOperation: class "magicksave_buffer" not found

  2) GIF input
       Animated GIF all pages to PNG "toilet roll":
     Error: VipsOperation: class "magicksave_buffer" not found

  3) Input/output
       Output filename with unknown extension
         Autoconvert GIF input to PNG output:
     Uncaught Error: VipsOperation: class "magicksave" not found

not sure if the tests need amending, or if, in an environment without libvips + imagemagick, it needs a fallback.

christianbundy · 2020-01-08T01:32:12Z

This is super exciting! Would this change require ImageMagick for everyone using Sharp, or just people who want WebP / GIF?

lovell · 2020-01-08T12:23:42Z

@christianbundy Please see #1372 (comment)

"The prebuilt libvips binaries provided by sharp do not include *magick. To take advantage, you will need to compile your own libvips with support for *magick and install it globally before installing sharp."

elemarin · 2020-01-14T15:08:26Z

@lovell is there plans for creating a version of sharp that includes prebuild libvips with *magick support? maybe have a flag during installation or something like that? since we use Sharp in a production application running in windows, and using a globally installed version of libvips is not supported in windows, this means that we will never be able to use these features.

lovell · 2020-01-14T15:13:24Z

@elndro85 No, but all the tools to build your own are open source - see https://github.com/lovell/sharp-libvips

summera · 2020-01-15T00:40:57Z

@lovell in order to get this built and working with magick support for linux-x64, for example, would you simply need to add ImageMagick-devel as a package dependency in the Dockerfile from https://github.com/lovell/sharp-libvips/blob/master/linux-x64/Dockerfile and build with the build script?

I did that and also attempted a rebase of this branch on top of your wit branch for testing sharp with the libvips binaries I built, but it resulted in a lot of issues when installing sharp after the rebase. Anything I can help with to move this along?

kapouer · 2020-01-21T09:34:48Z

What about APNG ?

lovell · 2020-01-21T12:18:54Z

@kapouer libpng, as used by libvips, does not support APNG.

summera · 2020-01-28T20:13:51Z

@lovell looks like your wit branch was merged and there was a new release. Does this branch now need to be rebased on master before it's ready?

lovell · 2020-01-28T22:42:28Z

The latest version of sharp depends on (and provides a prebuilt) libvips v8.9.0 as required by the changes in this PR, so yes, it can now be rebased against the master branch.

deftomat · 2020-01-29T06:37:06Z

AWESOME! 🥳

Sorry to everyone which is waiting for this. I didn't have a much time lately but I will try to finish it this weekend.

Charuru · 2020-02-07T03:24:44Z

How about this weekend?

adityapatadia · 2020-02-26T10:36:50Z

How about next one?

lovell · 2020-03-14T22:28:16Z

@deftomat The internals of sharp have been migrated to N-API hence there are now a few conflicts in this PR. As always, I'm happy to keep PRs open for as long as necessary; please ignore any implied time pressure in comments.

I'd also be happy to accept an alternative PR that focuses on WebP. Avoiding the *magick dependency might make for a simpler method by which to introduce this feature initially.

adityapatadia · 2020-04-24T10:13:35Z

Jokes aside, I am really interested in getting this merged to master so it can be released. @deftomat @lovell can you let me know if I can help in any way. I have limited knowledge of C but I will try as much as I can.

adityapatadia · 2020-04-24T10:14:25Z

Even if we can get WebP ones without Magick support it will still be good.

deftomat · 2020-04-27T09:13:56Z

@adityapatadia

Ok, let's finish this PR. We need to upgrade our fork to the latest Sharp anyway.

adityapatadia · 2020-04-27T09:41:22Z

@adityapatadia

Ok, let's finish this PR. We need to upgrade our fork to the latest Sharp anyway.

Please let me know how can I help you in this. I am ready to offer my axe.

src/pipeline.cc

deftomat · 2020-04-27T13:39:16Z

@lovell

I got the following test failures:

1) GIF input
       Animated GIF first page to PNG:
     Error: VipsOperation: class "magicksave_buffer" not found

  

  2) GIF input
       Animated GIF all pages to PNG "toilet roll":
     Error: VipsOperation: class "magicksave_buffer" not found

  

  3) Input/output
       Output filename with unknown extension
         Autoconvert GIF input to PNG output:
     Uncaught Error: VipsOperation: class "magicksave" not found

  

  4) Utilities
       Counters
         Have zero value at rest:

      AssertionError [ERR_ASSERTION]: Expected values to be strictly equal:

I'm not sure how we want to test GIF features as ImageMagick support is not included by default.

Also, I'm not sure what the 4th failure means.

lovell

This is looking so much better, thank you very much - I've left a few comments inline.

lib/output.js

src/common.cc

test/unit/gif.js

lovell · 2020-06-30T21:52:31Z

I've created #2275 with some thoughts on possible future improvements to handling animated/multipage images beyond this PR.

lovell · 2020-08-14T16:42:10Z

@deftomat I'm preparing v0.26.0 for release. hopefully in the next few days. Are you able to take a look at the last couple of remaining comments? I might have a chance to address them myself, otherwise this can wait until a future v0.26.x release.

deftomat · 2020-08-14T17:26:15Z

@lovell I will try this weekend

deftomat · 2020-08-16T14:39:33Z

@lovell Comments resolved!

lovell · 2020-08-17T13:49:30Z

@deftomat Marvellous, thank you very much for persisting with this Tomáš.

lovell · 2020-08-18T19:32:44Z

Commit 4beae0d adds animated as a constructor property shortcut for pages=-1 to allow the following API:

// Convert an animated GIF to an animated WebP (available from v0.26.0)
sharp('in.gif', { animated: true }).toFile('out.webp');

deftomat · 2020-08-19T04:16:42Z

Sounds good!

lovell · 2020-08-25T19:31:22Z

v0.26.0 now available, enjoy!

nglazov · 2020-08-31T08:30:15Z

@lovell may it be used with resize somehow?
I'm getting large canvas with all frames instead of animated gif

My code

sharp(buffer, { animated: true })
    .resize({
        height: 100,
        width: 100,
    })
    .toBuffer();

JulianBerger · 2020-08-31T09:06:12Z

@lovell may it be used with resize somehow?
I'm getting large canvas with all frames instead of animated gif

Thats what #2275 is about

davekiss · 2020-09-19T16:21:47Z

I'm an idiot and don't know what I'm doing, but would like to use this feature on AWS Lambda – can anyone help with steps to compile libvips + *magick so it can be used there?

deftomat · 2020-09-21T09:12:06Z

@davekiss Hi, we have our custom sharp-libvips fork where we add IM support.

You need to add something like the following before libvips build:

mkdir ${DEPS}/libtool
curl -Ls http://ftpmirror.gnu.org/libtool/libtool-${VERSION_LIBTOOL}.tar.gz | tar xzC ${DEPS}/libtool --strip-components=1
cd ${DEPS}/libtool
./configure --host=${CHOST} --prefix=${TARGET} --enable-shared --disable-static --disable-dependency-tracking
make install-strip

mkdir ${DEPS}/imagemagick
cd ${DEPS}/imagemagick
curl -O https://imagemagick.org/download/ImageMagick.tar.gz
tar xzf ImageMagick.tar.gz
rm ImageMagick.tar.gz
cd */.
./configure \
  --host=${CHOST} \
  --prefix=${TARGET} \
  --enable-shared \
  --disable-static \
  --with-modules \
  --without-bzlib \
  --without-dps \
  --without-freetype \
  --without-jbig \
  --without-jpeg \
  --without-jp2 \
  --without-lcms \
  --without-lzma \
  --without-png \
  --without-tiff \
  --without-wmf \
  --without-xml \
  --without-zlib \
  --without-perl \
  --without-x \
  --without-magick-plus-plus \
  --enable-delegate-build \
  --disable-dependency-tracking \
  --disable-docs \
  --disable-openmp \
  --disable-installed
make install-strip

And then use --with-magick in libvips build script instead of --without-magick.

Not entirely sure if that is enough as we customised it a while ago but it should be enough.

Then, just follow https://sharp.pixelplumbing.com/install#custom-prebuilt-binaries to build it in AWS Lambda docker container, deploy sharp as layer and require it directly from /opt/sharp directory instead of node_modules.

OJezu · 2020-09-21T09:16:38Z

@davekiss It's the first comment. #2012 (comment)

cthorner · 2020-09-23T18:09:40Z

How would I stitch together images and output an animated gif? Do I need to create the buffer with some other tool? Or can I use sharp to incrementally add the images, maybe even as a stream?

To be more specific, can I do something like this:

sharp(
 [
  {input: firstPage}, 
  { input: secondPage}
 ], 
 { animated: true }]
).gif({ animated: true, delay: [100, 200], pageHeight: 200 }) })
.toFile('somefile.gif')

Or should I be using compose?

On a side note, compiling imagemagick with the above instructions didn't work for me. I'm getting a format not detected error from imagemagick for 'gif'. Do I need to add LDFLAGS or something like that?

xdays · 2020-11-03T15:06:06Z

Does anyone have a sample code for animated webp resizing？

I have a workable piece of code for gif:

sharp('tb.gif', {
  animated: true
})
  .resize(60).gif({
    pageHeight: 60
  })
  .toFile('resized.gif');

but webp doesn't work

sharp("tb.webp", {
  animated: true,
})
  .resize(160)
  .webp({
    pageHeight: 160,
  })
  .toFile("resized.webp", (err, info) => {
    console.log(err, info);
  });

gonber · 2021-02-09T21:20:10Z

~~Is this supposed to also allow resizing? I'm struggling to get sharp({ animated: true }).resize(...) to work with a GIF. Thanks!~~
Nevermind, saw issue #2296 #2275

feat: support for animated WEBP & GIF

1c5a3c3

deftomat referenced this pull request in deftomat/sharp Dec 19, 2019

IGIF support

f297c6b

deftomat mentioned this pull request Dec 19, 2019

Enhancement: expose libvips magicksave, requires v8.7.0 #1372

Closed

lovell mentioned this pull request Dec 30, 2019

How can i generate an animated webp image with multi images? #2011

Closed

davidmerfield mentioned this pull request Apr 23, 2020

Adds support for thumbnails generated from gifs davidmerfield/Blot#291

Merged

1 task

Merge remote-tracking branch 'upstream/master'

e629109

deftomat commented Apr 27, 2020

View reviewed changes

src/pipeline.cc Outdated Show resolved Hide resolved

fix lint issues

2e41dbd

lovell requested changes Jun 30, 2020

View reviewed changes

lib/output.js Outdated Show resolved Hide resolved

src/common.cc Show resolved Hide resolved

src/common.cc Outdated Show resolved Hide resolved

test/unit/gif.js Outdated Show resolved Hide resolved

lovell mentioned this pull request Jun 30, 2020

Enhancement: improve animated/multipage image resizing #2275

Closed

pkantsedalov mentioned this pull request Jul 15, 2020

Resize animated WebP #2296

Closed

tareiking mentioned this pull request Jul 16, 2020

Support for animated gifs humanmade/tachyon#3

Open

resolve PR conversation

d63ad9e

lovell added the enhancement label Aug 17, 2020

lovell merged commit cb1baed into lovell:master Aug 17, 2020

lovell added a commit that referenced this pull request Aug 17, 2020

Doc refresh and changelog entry for #2012

341ea3e

cthorner mentioned this pull request Oct 7, 2020

Error: magicksave: libMagick error: NoEncodeDelegateForThisImageFormat `gif' #2402

Closed

This was referenced Oct 15, 2020

gif support Umkus/lambda-layer-sharp#4

Closed

Add lambda layers to releases #1772

Closed

lovell mentioned this pull request Nov 11, 2020

The gif operation requires libvips to have been installed with support for ImageMagick #2437

Closed

slorber mentioned this pull request Jan 28, 2021

Support gifs in ideal image plugin facebook/docusaurus#4115

Open

Repository owner locked and limited conversation to collaborators Feb 10, 2021

feat: support for animated WEBP & GIF #2012

feat: support for animated WEBP & GIF #2012

Conversation

deftomat commented Dec 19, 2019 • edited Loading

OJezu commented Dec 19, 2019

lovell commented Dec 20, 2019

lovell commented Dec 27, 2019 • edited Loading

salipitchero commented Jan 6, 2020 • edited Loading

christianbundy commented Jan 8, 2020

lovell commented Jan 8, 2020

elemarin commented Jan 14, 2020

lovell commented Jan 14, 2020

summera commented Jan 15, 2020

kapouer commented Jan 21, 2020

lovell commented Jan 21, 2020

summera commented Jan 28, 2020

lovell commented Jan 28, 2020

deftomat commented Jan 29, 2020 • edited Loading

Charuru commented Feb 7, 2020

adityapatadia commented Feb 26, 2020

lovell commented Mar 14, 2020

adityapatadia commented Apr 24, 2020

adityapatadia commented Apr 24, 2020

deftomat commented Apr 27, 2020

adityapatadia commented Apr 27, 2020

deftomat commented Apr 27, 2020 • edited Loading

lovell left a comment

Choose a reason for hiding this comment

lovell commented Jun 30, 2020

lovell commented Aug 14, 2020

deftomat commented Aug 14, 2020

deftomat commented Aug 16, 2020

lovell commented Aug 17, 2020

lovell commented Aug 18, 2020

deftomat commented Aug 19, 2020

lovell commented Aug 25, 2020

nglazov commented Aug 31, 2020

JulianBerger commented Aug 31, 2020

davekiss commented Sep 19, 2020

deftomat commented Sep 21, 2020 • edited Loading

OJezu commented Sep 21, 2020

cthorner commented Sep 23, 2020 • edited Loading

xdays commented Nov 3, 2020

gonber commented Feb 9, 2021 • edited Loading

deftomat commented Dec 19, 2019 •

edited

Loading

lovell commented Dec 27, 2019 •

edited

Loading

salipitchero commented Jan 6, 2020 •

edited

Loading

deftomat commented Jan 29, 2020 •

edited

Loading

deftomat commented Apr 27, 2020 •

edited

Loading

deftomat commented Sep 21, 2020 •

edited

Loading

cthorner commented Sep 23, 2020 •

edited

Loading

gonber commented Feb 9, 2021 •

edited

Loading