sharp

Upgrade to libvips v8.14.4 for upstream bug fixes.

TypeScript: Add missing WebpPresetEnum to definitions. #3748 @pilotso11

Ensure compilation using musl v1.2.4. #3755 @kleisauke

Ensure resize with a fit of inside respects 90/270 degree rotation. #3756

TypeScript: Ensure minSize property of WebpOptions is boolean. #3758 @sho-xizz

Ensure withMetadata adds default sRGB profile. #3761

Upgrade to libvips v8.14.3 for upstream bug fixes.

Expose ability to (un)block low-level libvips operations by name.

Prebuilt binaries: restore support for tile-based output. #3581

Expose preset option for WebP output. #3639

Ensure decoding remains sequential for all operations (regression in 0.32.2). #3725

Limit HEIF output dimensions to 16384x16384, matches libvips.

Ensure exceptions are not thrown when terminating. #3569

Ensure the same access method is used for all inputs (regression in 0.32.0). #3669

Improve detection of jp2 filename extensions. #3674 @bianjunjie1981

Guard use of smartcrop premultiplied option to prevent warning (regression in 0.32.1). #3710

Prevent over-compute in affine-based rotate before resize. #3722

Allow sequential read for EXIF-based auto-orientation. #3725

Add experimental unflatten operation. #3461 @antonmarsden

Ensure use of flip operation forces random access read (regression in 0.32.0). #3600

Ensure linear operation works with 16-bit input (regression in 0.31.3). #3605

Install: ensure proxy URLs are logged correctly. #3615 @TomWis97

Ensure profile-less CMYK to CMYK roundtrip skips colourspace conversion. #3620

Add support for modulate operation when using non-sRGB pipeline colourspace. #3620

Ensure trim operation works with CMYK images (regression in 0.31.0). #3636

Install: coerce libc version to semver. #3641

Default to using sequential rather than random access read where possible.

Replace GIF output optimise / optimize option with reuse.

Add progressive option to GIF output for interlacing.

Add wrap option to text image creation.

Add formatMagick property to metadata of images loaded via *magick.

Prefer integer (un)premultiply for faster resizing of RGBA images.

Add ignoreIcc input option to ignore embedded ICC profile.

Allow use of GPS (IFD3) EXIF metadata. #2767

TypeScript definitions are now maintained and published directly, deprecating the @types/sharp package. #3369

Prebuilt binaries: ensure macOS 10.13+ support, as documented. #3438

Prebuilt binaries: prevent use of glib slice allocator, improves QEMU support. #3448

Add focus point coordinates to output when using attention based crop. #3470 @ejoebstl

Expose sharp version as sharp.versions.sharp. #3471

Respect fastShrinkOnLoad resize option for WebP input. #3516

Reduce sharpen sigma maximum from 10000 to 10. #3521

Add support for ArrayBuffer input. #3548 @kapouer

Add support to extend operation for extendWith to allow copy/mirror/repeat. #3556 @janaz

Ensure all async JS callbacks are wrapped to help avoid possible race condition. #3569

Prebuilt binaries: support for tile-based output temporarily removed due to licensing issue. #3581

Add support to normalise for lower and upper percentiles. #3583 @LachlanNewman

Add experimental support for JPEG-XL images. Requires libvips compiled with libjxl. #2731

Add runtime detection of V8 memory cage, ensures compatibility with Electron 21 onwards. #3384

Expose interFrameMaxError and interPaletteMaxError GIF optimisation properties. #3401

Allow installation on Linux with glibc patch versions e.g. Fedora 38. #3423

Expand range of existing sharpen parameters to match libvips. #3427

Prevent possible race condition awaiting metadata of Stream-based input. #3451

Improve extractChannel support for 16-bit output colourspaces. #3453

Ignore sequentialRead option when calculating image statistics. #3462

Small performance improvement for operations that introduce a non-opaque background. #3465

Ensure integral output of linear operation. #3468

Upgrade to libvips v8.13.3 for upstream bug fixes.

Ensure manual flip, rotate, resize operation ordering (regression in 0.31.1) #3391

Ensure auto-rotation works without resize (regression in 0.31.1) #3422

Upgrade to libvips v8.13.2 for upstream bug fixes.

Ensure close event occurs after end event for Stream-based output. #3313

Ensure limitInputPixels constructor option uses uint64. #3349 @marcosc90

Ensure auto-rotation works with shrink-on-load and extract (regression in 0.31.0). #3352

Ensure AVIF output is always 8-bit. #3358

Ensure greyscale images can be trimmed (regression in 0.31.0). #3386

Drop support for Node.js 12, now requires Node.js >= 14.15.0.

GIF output now re-uses input palette if possible. Use reoptimise option to generate a new palette.

Add WebP minSize and mixed options for greater control over animation frames.

Remove previously-deprecated WebP reductionEffort and HEIF speed options. Use effort to control these.

The flip and flop operations will now occur before the rotate operation.

Improve normalise operation with use of histogram. #200

Use combined bounding box of alpha and non-alpha channels for trim operation. #2166

Add Buffer and Stream support to tile-based output. #2238

Add input fileSuffix and output alias to format information. #2642

Re-introduce support for greyscale ICC profiles (temporarily removed in 0.30.2). #3114

Add support for WebP and PackBits compression options with TIFF output. #3198

Ensure OpenSlide and FITS input works with custom libvips. #3226

Ensure trim operation is a no-op when it would reduce an image to nothing. #3223

Expose vips_text to create an image containing rendered text. #3252 @brahima

Ensure only properties owned by the withMetadata EXIF Object are parsed. #3292

Expand linear operation to allow use of per-channel arrays. #3303 @antonmarsden

Ensure the order of rotate, resize and extend operations is respected where possible. Emit warnings when previous calls in the same pipeline will be ignored. #3319

Ensure PNG bitdepth can be set for non-palette output. #3322

Add trim option to provide a specific background colour. #3332 @mart-jansink

Ensure resized image is unpremultiplied before composite. #3334

Ensure tiled composition always works with outside resizing. #3227

Allow WebP encoding effort of 0. #3261 @AlexanderTheGrey

Prevent upsampling via libwebp. #3267 @blacha

Allow values for limitInputPixels larger than 32-bit. #3238

Ensure brew-installed vips can be detected (regression in 0.30.5). #3239

Install: pass PKG_CONFIG_PATH via env rather than substitution. @dwisiswant0

Add support for --libc flag to improve cross-platform installation. #3160 @joonamo

Allow installation of prebuilt libvips binaries from filesystem. #3196 @ankurparihar

Fix rotate-then-extract for EXIF orientation 2. #3218 @jakob0fischl

Increase control over sensitivity to invalid images via failOn, deprecate failOnError (equivalent to failOn: 'warning').

Ensure create input image has correct bit depth and colour space. #3139

Add support for TypedArray input with byteOffset and length. #3146 @codepage949

Improve error message when attempting to render SVG input greater than 32767x32767. #3167

Add missing file name to 'Input file is missing' error message. #3178 @Brodan

Allow sharpen options to be provided more consistently as an Object. #2561

Expose x1, y2 and y3 parameters of sharpen operation. #2935

Prevent double unpremultiply with some composite blend modes (regression in 0.30.2). #3118

Improve performance and accuracy when compositing multiple images. #2286

Expand pkgconfig search path for wider BSD support. #3106

Ensure Windows C++ runtime is linked statically (regression in 0.30.0). #3110 @kleisauke

Temporarily ignore greyscale ICC profiles to workaround lcms bug. #3112

Allow use of toBuffer and toFile on the same instance. #3044

Skip shrink-on-load for known libjpeg rounding errors. #3066 @kleisauke

Ensure withoutReduction does not interfere with contain/crop/embed. #3081 @kleisauke

Ensure affine interpolator is correctly finalised. #3083 @kleisauke

Add support for GIF output to prebuilt binaries.

Reduce minimum Linux ARM64v8 glibc requirement to 2.17.

Verify prebuilt binaries with a Subresource Integrity check.

Standardise WebP effort option name, deprecate reductionEffort.

Standardise HEIF effort option name, deprecate speed.

Add support for IIIF v3 tile-based output.

Expose control over CPU effort for palette-based PNG output. #2541

Improve animated (multi-page) image resize and extract. #2789 @kleisauke

Expose platform and architecture of vendored binaries as sharp.vendor. #2928

Ensure 16-bit PNG output uses correct bitdepth. #2958 @gforge

Properly emit close events for duplex streams. #2976 @driannaude

Expose unlimited option for SVG and PNG input, switches off safety features. #2984

Add withoutReduction option to resize operation. #3006 @christopherbradleybanks

Add resolutionUnit as tiff option and expose in metadata. #3023 @ompal-sisodiya

Ensure rotate-then-extract works with EXIF mirroring. #3024

Ensure correct dimensions when containing image resized to 1px. #2951

Impute TIFF xres/yres from density provided to withMetadata. #2952 @mbklein

Add timeout function to limit processing time.

Ensure sharp.versions is populated from vendored libvips.

Remove animation properties from single page images. #2890

Allow use of 'tif' to select TIFF output. #2893 @erf

Improve error message on Windows for version conflict. #2918 @dkrnl

Throw error rather than exit when invalid binaries detected. #2931

Add lightness option to modulate operation. #2846

Ensure correct PNG bitdepth is set based on number of colours. #2855

Ensure background is always premultiplied when compositing. #2858

Ensure images with P3 profiles retain full gamut. #2862

Add support for libvips compiled with OpenJPEG. #2868

Remove unsupported animation properties from AVIF output. #2870

Resolve paths before comparing input/output filenames. #2878 @rexxars

Allow use of speed 9 (fastest) for HEIF encoding. #2879 @rexxars

Drop support for Node.js 10, now requires Node.js >= 12.13.0.

Add background property to PNG and GIF image metadata.

Add compression property to HEIF image metadata. #2504

AVIF encoding now defaults to 4:4:4 chroma subsampling. #2562

Allow multiple platform-arch binaries in same node_modules installation tree. #2575

Default to single-channel b-w space when extractChannel is used. #2658

Allow installation directory to contain spaces (regression in v0.26.0). #2777

Add pipelineColourspace operator to set the processing space. #2704 @Daiz

Allow bit depth to be set when using raw input and output. #2762 @mart-jansink

Allow negate to act only on non-alpha channels. #2808 @rexxars

Ensure presence of libvips, vendored or global, before invoking node-gyp.

Skip shrink-on-load for multi-page WebP. #2714

Add contrast limiting adaptive histogram equalization (CLAHE) operator. #2726 @baparham

Allow withMetadata to set density. #967

Skip shrink-on-load where one dimension <4px. #2653

Allow escaped proxy credentials. #2664 @msalettes

Add premultiplied flag for raw pixel data input. #2685 @mnutt

Detect empty input and throw a helpful error. #2687 @JakobJingleheimer

Add install-time flag to skip version compatibility checks. #2692 @xemle

Ensure all installation errors are logged with a more obvious prefix.

Allow withMetadata to set and update EXIF metadata. #650

Add support for OME-TIFF Sub Image File Directories (subIFD). #2557

Allow ensureAlpha to set the alpha transparency level. #2634

Prebuilt binaries now include mozjpeg and libimagequant (BSD 2-Clause).

Prebuilt binaries limit AVIF support to the most common 8-bit depth.

Add mozjpeg option to jpeg method, sets mozjpeg defaults.

Reduce the default PNG compressionLevel to the more commonly used 6.

Reduce concurrency on glibc-based Linux when using the default memory allocator to help prevent fragmentation.

Default missing edge properties of extend operation to zero. #2578

Ensure composite does not clip top and left offsets. #2594 @SHG42

Improve error handling of network failure at install time. #2608 @abradley

Ensure @id attribute can be set for IIIF tile-based output. #2612 @edsilv

Ensure composite replicates the correct number of tiles for centred gravities. #2626

macOS: Prevent use of globally-installed ARM64 libvips with Rosetta x64 emulation. #2460

Linux (musl): Prevent use of prebuilt linuxmusl-x64 binaries with musl >= 1.2.0. #2570

Improve 16-bit grey+alpha support by using libvips' has_alpha detection. #2569

Allow the use of non lower case extensions with toFormat. #2581 @florian-busch

Allow use of recomb operation with single channel input. #2584

Ensure TIFF is cast when using float predictor. #2502 @randyridge

Add support for Uint8Array and Uint8ClampedArray input. #2511 @leon

Revert: ensure all platforms use fontconfig for font rendering. #2515

Expose libvips gaussnoise operation to allow creation of Gaussian noise. #2527 @alza54

Add support for AVIF to prebuilt binaries.

Remove experimental status from heif output, defaults are now AVIF-centric.

Allow negative top/left offsets for composite operation. #2391 @CurosMJ

Ensure all platforms use fontconfig for font rendering. #2399

Expose libvips' affine operation. #2336 @guillevc

Fallback to tar.gz for prebuilt libvips when Brotli not available. #2412 @ascorbic

Add support for EXR input. Requires libvips compiled with OpenEXR. #698

Ensure support for yarn v2. #2379 @jalovatt

Add centre/center option to tile-based output. #2397 @beig

Ensure correct pageHeight when verifying multi-page image dimensions. #2343 @derom

Allow input density range up to 100000 DPI. #2348 @stefanprobst

Ensure animation-related properties can be set for Stream-based input. #2369 @AcrylicShrimp

Ensure stats can be calculated for 1x1 input. #2372

Ensure animated GIF output is optimised. #2376

Prebuilt libvips binaries are now statically-linked and Brotli-compressed, requiring Node.js 10.16.0+.

TIFF output squash is replaced by bitdepth to reduce to 1, 2 or 4 bit.

JPEG output quality >= 90 no longer automatically sets chromaSubsampling to 4:4:4.

Add most dominant colour to image stats. #640

Add support for animated GIF (requires *magick) and WebP output. #2012 @deftomat

Add support for libvips ImageMagick v7 loaders. #2258 @vouillon

Allow multi-page input via *magick. #2259 @vouillon

Add support to withMetadata for custom ICC profile. #2271 @roborourke

Ensure prebuilt binaries for ARM default to v7 when using Electron. #2292 @diegodev3

Allow libvips binary location override where version is appended. #2217 @malice00

Enable PNG palette when setting quality, colours, colors or dither. #2226 @romaleev

Add level constructor option to use a specific level of a multi-level image. Expose levels metadata for multi-level images. #2222

Add support for named alpha channel to extractChannel operation. #2138

Add experimental sharpness calculation to stats() response. #2251

Emit warning event for non-critical processing problems. #2032

Ensure libvips is initialised only once, improves worker thread safety. #2143

Ensure npm platform flag is respected when copying DLLs. #2188 @dimadeveatii

Allow SVG input with large inline images to be parsed. #2195

Provide prebuilt binaries for Linux ARM64v8.

Add IIIF layout support to tile-based output. #2098 @edsilv

Ensure input options are consistently and correctly detected. #2118

Ensure N-API prebuilt binaries work on RHEL7 and its derivatives. #2119

Ensure AsyncWorker options are persisted. #2130

Remove limitInputPixels and sequentialRead previously deprecated in v0.24.0.

Migrate internals to N-API. #1282

Add support for 32-bit Windows. #2088

Ensure correct ordering of rotate-then-trim operations. #2087

Ensure composite accepts limitInputPixels and sequentialRead input options. #2099

Prevent use of sequentialRead for EXIF-based rotate operation. #2042

Ensure RGBA LZW TIFF returns correct channel count. #2064

Drop support for Node.js 8. #1910

Drop support for undefined input where options also provided. #1768

Move limitInputPixels and sequentialRead to input options, deprecating functions of the same name.

Expose delay and loop metadata for animated images. #1905

Ensure correct colour output for 16-bit, 2-channel PNG input with ICC profile. #2013

Prevent use of sequentialRead for rotate operations. #2016

Correctly bind max width and height values when using withoutEnlargement. #2024 @BrychanOdlum

Add support for input with 16-bit RGB profile. #2037

Handle zero-length Buffer objects when using Node.js v13.2.0+.

Expose raw TIFFTAG_PHOTOSHOP metadata. #1600

Improve thread safety by using copy-on-write when updating metadata. #1986

Ensure trim operation supports images contained in the alpha channel. #1597

Ensure tile overlap option works as expected. #1921 @rustyguts

Allow compilation on FreeBSD and variants (broken since v0.23.0) #1952 @pouya-eghbali

Ensure modulate and other colour-based operations can co-exist. #1958

Add background option to tile output operation. #1924 @neave

Add support for Node.js 13. #1932 @MayhemYDG

Ensure sharp.format.vips is present and correct (filesystem only). #1813

Ensure invalid width and height provided as options to resize throw. #1817

Allow use of 'heic' and 'heif' identifiers with toFormat. #1834 @jaubourg

Add premultiplied option to composite operation. #1835 @Andargor

Allow instance reuse with differing toBuffer options. #1860 @RaboliotTheGrey

Ensure image is at least 3x3 pixels before attempting trim operation.

Remove overlayWith previously deprecated in v0.22.0.

Add experimental support for HEIF images. Requires libvips compiled with libheif. #1105

Expose libwebp smartSubsample and reductionEffort options. #1545

Add experimental support for Worker Threads. #1558

Use libvips' built-in CMYK and sRGB profiles when required. #1619

Drop support for Node.js versions 6 and 11. #1674

Expose skipBlanks option for tile-based output. #1687 @RaboliotTheGrey

Allow use of failOnError option with Stream-based input. #1691

Fix rotate/extract ordering for non-90 angles. #1755 @iovdin

Add modulate operation for brightness, saturation and hue. #1601 @Goues

Improve help messaging should require("sharp") fail. #1638 @sidharthachatterjee

Add support for Node 12. #1668

Remove functions previously deprecated in v0.21.0: background, crop, embed, ignoreAspectRatio, max, min and withoutEnlargement.

Add composite operation supporting multiple images and blend modes; deprecate overlayWith. #728

Add support for pages input option for multi-page input. #1566

Allow Stream-based input of raw pixel data. #1579

Add support for page input option to GIF and PDF. #1595 @ramiel

Input image decoding now fails fast, set failOnError to change this behaviour.

Failed filesystem-based input now separates missing file and invalid format errors. #1542

Ensure all metadata is removed from PNG output unless withMetadata used.

Ensure shortest edge is at least one pixel after resizing. #1003

Add ensureAlpha operation to add an alpha channel, if missing. #1153

Expose pages and pageHeight metadata for multi-page input images. #1205

Expose PNG output options requiring libimagequant. #1484

Expose underlying error message for invalid input. #1505

Prevent mutatation of options passed to jpeg. #1516

Ensure forced output format applied correctly when output chaining. #1528

Install: support sharp_dist_base_url npm config, like existing SHARP_DIST_BASE_URL. #1422 @SethWen

Ensure channel metadata is correct for raw, greyscale output. #1425

Add support for the "mitchell" kernel for image reductions. #1438 @Daiz

Allow separate parameters for gamma encoding and decoding. #1439 @Daiz

Build prototype with Object.assign to allow minification. #1475 @jaubourg

Expose libvips' recombination matrix operation. #1477 @fromkeith

Expose libvips' pyramid/tile options for TIFF output. #1483 @mbklein

Deprecate the following resize-related functions: crop, embed, ignoreAspectRatio, max, min and withoutEnlargement. Access to these is now via options passed to the resize function. For example: embed('north') is now resize(width, height, { fit: 'contain', position: 'north' }), crop('attention') is now resize(width, height, { fit: 'cover', position: 'attention' }), max().withoutEnlargement() is now resize(width, height, { fit: 'inside', withoutEnlargement: true }). #1135

Deprecate the background function. Per-operation background options added to resize, extend and flatten operations. #1392

Add size to metadata response (Stream and Buffer input only). #695

Switch from custom trim operation to vips_find_trim. #914

Add chromaSubsampling and isProgressive properties to metadata response. #1186

Drop Node 4 support. #1212

Enable SIMD convolution by default. #1213

Add experimental prebuilt binaries for musl-based Linux. #1379

Add support for arbitrary rotation angle via vips_rotate. #1385 @freezy

Avoid race conditions when creating directories during installation. #1358 @ajhool

Accept floating point values for input density parameter. #1362 @aeirola

Add removeAlpha operation to remove alpha channel, if any. #1248

Expose mozjpeg quant_table flag. #1285 @rexxars

Allow full WebP alphaQuality range of 0-100. #1290 @sylvaindumont

Cache libvips binaries to reduce re-install time. #1301

Ensure vendor platform mismatch throws error at install time. #1303

Improve install time error messages for FreeBSD users. #1310

Ensure extractChannel works with 16-bit images. #1330

Expose depth option for tile-based output. #1342 @alundavies

Add experimental entropy field to stats response.

Prevent possible rounding error when using shrink-on-load and 90/270 degree rotation. #1241 @anahit42

Ensure extractChannel sets correct single-channel colour space interpretation. #1257 @jeremychone