1
0
mirror of https://github.com/imgproxy/imgproxy.git synced 2024-11-29 08:22:11 +02:00
imgproxy/docs/image_formats_support.md

55 lines
2.0 KiB
Markdown
Raw Normal View History

2018-11-08 12:34:21 +02:00
# Image formats support
2019-09-30 11:53:13 +02:00
At the moment, imgproxy supports only the most popular image formats:
2018-11-08 12:34:21 +02:00
* PNG;
* JPEG;
* WebP;
2018-12-02 15:02:19 +02:00
* GIF;
2018-12-11 12:02:23 +02:00
* ICO;
2019-10-11 15:33:34 +02:00
* SVG;
2019-10-11 15:20:28 +02:00
* MP4 _(result only)_ <img class="pro-badge" src="assets/pro.svg" alt="pro" />;
2019-09-30 11:53:13 +02:00
* HEIC;
* BMP;
2019-09-30 11:53:13 +02:00
* TIFF.
2018-11-08 12:34:21 +02:00
## GIF support
imgproxy supports GIF output only when using libvips 8.7.0+ compiled with ImageMagick support. Official imgproxy Docker image supports GIF out of the box.
2018-11-15 16:04:12 +02:00
2019-06-13 10:20:11 +02:00
## ICO support
2018-11-15 16:04:12 +02:00
2019-09-30 12:03:07 +02:00
imgproxy supports ICO only when using libvips 8.7.0+ compiled with ImageMagick support. Official imgproxy Docker image supports ICO out of the box.
2018-11-15 16:04:12 +02:00
2019-10-11 15:33:34 +02:00
## SVG support
imgproxy supports SVG sources without limitations, but SVG results are not supported when the source image is not SVG.
When the source image is SVG and the SVG result is requested, imgproxy returns source image without modifications.
2019-06-25 11:28:34 +02:00
## HEIC support
imgproxy supports HEIC only when using libvips 8.8.0+. Official imgproxy Docker image supports HEIC out of the box.
By default, imgproxy saves HEIC images as JPEG. You need to explicitly specify the `format` option to get HEIC output.
## BMP support
2019-09-30 13:36:38 +02:00
imgproxy supports BMP only when using libvips 8.7.0+ compiled with ImageMagick support. Official imgproxy Docker image supports ICO out of the box.
By default, imgproxy saves BMP images as JPEG. You need to explicitly specify the `format` option to get BMP output.
2019-06-13 10:20:11 +02:00
## Animated images support
2018-12-02 15:02:19 +02:00
2019-06-13 10:20:11 +02:00
Since processing of animated images is pretty heavy, only one frame is processed by default. You can increase the maximum of animation frames to process with the following variable:
2018-12-02 15:02:19 +02:00
2019-06-13 10:20:11 +02:00
* `IMGPROXY_MAX_ANIMATION_FRAMES`: the maximum of animated image frames to being processed. Default: `1`.
**Note:** imgproxy summarizes all frames resolutions while checking source image resolution.
2019-10-11 15:20:28 +02:00
## Converting animated images to MP4 <img class="pro-badge" src="assets/pro.svg" alt="pro" />
Animated images results can be converted to MP4 by specifying `mp4` extension.
Since MP4 requires usage of a `<video>` tag instead of `<img>`, automatic conversion to MP4 is not provided.