sharp

The typical use case for this high speed Node.js module is to convert large images of many formats to smaller, web-friendly JPEG, PNG and WebP images of varying dimensions.

This module supports reading and writing JPEG, PNG and WebP images to and from Streams, Buffer objects and the filesystem. It also supports reading images of many other formats from the filesystem via libmagick, libgraphicsmagick or OpenSlide if present.

Deep Zoom image pyramids can be generated, suitable for use with "slippy map" tile viewers like OpenSeadragon and Leaflet.

Colour spaces, embedded ICC profiles and alpha transparency channels are all handled correctly.

Only small regions of uncompressed image data are held in memory and processed at a time, taking full advantage of multiple CPU cores and L1/L2/L3 cache. Resizing an image is typically 4x faster than using the quickest ImageMagick and GraphicsMagick settings.

Huffman tables are optimised when generating JPEG output images without having to use separate command line tools like jpegoptim and jpegtran. PNG filtering can be disabled, which for diagrams and line art often produces the same result as pngcrush.

Everything remains non-blocking thanks to libuv, no child processes are spawned and Promises/A+ are supported.

Anyone who has used the Node.js bindings for GraphicsMagick will find the API similarly fluent.

This module is powered by the blazingly fast libvips image processing library, originally created in 1989 at Birkbeck College and currently maintained by John Cupitt.

Installation

npm install sharp

Prerequisites

Node.js v0.10+ or io.js
libvips v7.40.0+ (7.42.0+ recommended)
C++11 compatible compiler such as gcc 4.6+, clang 3.0+ or MSVC 2013

To install the most suitable version of libvips on the following Operating Systems:

Mac OS
- Homebrew
- MacPorts
Debian Linux
- Debian 7, 8
- Ubuntu 12.04, 14.04, 14.10, 15.04
- Mint 13, 17
Red Hat Linux
- RHEL/Centos/Scientific 6, 7
- Fedora 21, 22
- Amazon Linux 2014.09
OpenSuse Linux
- OpenSuse 13.1, 13.2

run the following as a user with sudo access:

curl -s https://raw.githubusercontent.com/lovell/sharp/master/preinstall.sh | sudo bash -

or run the following as root:

curl -s https://raw.githubusercontent.com/lovell/sharp/master/preinstall.sh | bash -

The preinstall.sh script requires curl and pkg-config.

Add --with-openslide to enable OpenSlide support:

curl -s https://raw.githubusercontent.com/lovell/sharp/master/preinstall.sh | sudo bash -s -- --with-openslide

Mac OS tips

Manual install via homebrew:

brew install homebrew/science/vips --with-webp --with-graphicsmagick

A missing or incorrectly configured Xcode Command Line Tools installation can lead to a library not found for -ljpeg error. If so, please try:

xcode-select --install

The gettext dependency of libvips can lead to a library not found for -lintl error. If so, please try:

brew link gettext --force

Windows

Requires x86 32-bit Node.js or io.js (use iojs.exe rather than node.exe). The WebP format is currently unsupported.

Ensure the node-gyp prerequisites are met.
Download and unzip vips-dev.x.y.z.zip.
Set the VIPS_HOME environment variable to the full path of the vips-dev-x.y.z directory.
Add vips-dev-x.y.z\bin to PATH.

Versions of MSVC more recent than 2013 may require the use of npm install --arch=ia32 --msvs_version=2013.

Heroku

Alessandro Tagliapietra maintains an Heroku buildpack for libvips and its dependencies.

Docker

Marc Bachmann maintains a Dockerfile for libvips.

docker pull marcbachmann/libvips

Build tools

Usage examples

var sharp = require('sharp');

sharp('input.jpg').resize(300, 200).toFile('output.jpg', function(err) {
  if (err) {
    throw err;
  }
  // output.jpg is a 300 pixels wide and 200 pixels high image
  // containing a scaled and cropped version of input.jpg
});

var transformer = sharp()
  .resize(300, 200)
  .crop(sharp.gravity.north)
  .on('error', function(err) {
    console.log(err);
  });
// Read image data from readableStream, resize and write image data to writableStream
readableStream.pipe(transformer).pipe(writableStream);

var image = sharp(inputJpg);
image.metadata(function(err, metadata) {
  image.resize(Math.floor(metadata.width / 2)).webp().toBuffer(function(err, outputBuffer, info) {
    // outputBuffer contains a WebP image half the width and height of the original JPEG
  });
});

var pipeline = sharp()
  .rotate()
  .resize(null, 200)
  .progressive()
  .toBuffer(function(err, outputBuffer, info) {
    if (err) {
      throw err;
    }
    // outputBuffer contains 200px high progressive JPEG image data,
    // auto-rotated using EXIF Orientation tag
    // info.width and info.height contain the dimensions of the resized image
  });
readableStream.pipe(pipeline);

sharp('input.png')
  .rotate(180)
  .resize(300)
  .flatten()
  .background('#ff6600')
  .sharpen()
  .withMetadata()
  .quality(90)
  .webp()
  .toBuffer()
  .then(function(outputBuffer) {
    // outputBuffer contains upside down, 300px wide, alpha channel flattened
    // onto orange background, sharpened, with metadata, 90% quality WebP image
    // data
  });

http.createServer(function(request, response) {
  response.writeHead(200, {'Content-Type': 'image/webp'});
  sharp('input.jpg').rotate().resize(200).webp().pipe(response);
}).listen(8000);
// Create HTTP server that always returns auto-rotated 'input.jpg',
// resized to 200 pixels wide, in WebP format

sharp(input)
  .extract(top, left, width, height)
  .toFile(output);
  // Extract a region of the input image, saving in the same format.

sharp(input)
  .extract(topOffsetPre, leftOffsetPre, widthPre, heightPre)
  .resize(width, height)
  .extract(topOffsetPost, leftOffsetPost, widthPost, heightPost)
  .toFile(output);
  // Extract a region, resize, then extract from the resized image

sharp(inputBuffer)
  .resize(200, 300)
  .interpolateWith(sharp.interpolator.nohalo)
  .background('white')
  .embed()
  .toFile('output.tiff')
  .then(function() {
    // output.tiff is a 200 pixels wide and 300 pixels high image
    // containing a nohalo scaled version, embedded on a white canvas,
    // of the image data in inputBuffer
  });

sharp('input.gif')
  .resize(200, 300)
  .background({r: 0, g: 0, b: 0, a: 0})
  .embed()
  .toFormat(sharp.format.webp)
  .toBuffer(function(err, outputBuffer) {
    if (err) {
      throw err;
    }
    // outputBuffer contains WebP image data of a 200 pixels wide and 300 pixels high
    // containing a scaled version, embedded on a transparent canvas, of input.gif
  });

sharp(inputBuffer)
  .resize(200, 200)
  .max()
  .toFormat('jpeg')
  .toBuffer().then(function(outputBuffer) {
    // outputBuffer contains JPEG image data no wider than 200 pixels and no higher
    // than 200 pixels regardless of the inputBuffer image dimensions
  });

sharp('input.tiff').tile(256).toFile('output.dzi', function(err, info) {
  // The output.dzi file is the XML format Deep Zoom definition
  // The output_files directory contains 256x256 pixel tiles grouped by zoom level
});

// Runtime discovery of available formats
console.dir(sharp.format);

API

Attributes

format

An Object containing nested boolean values representing the available input and output formats/methods, for example:

{ jpeg: { id: 'jpeg',
    input: { file: true, buffer: true, stream: true },
    output: { file: true, buffer: true, stream: true } },
  png: { id: 'png',
    input: { file: true, buffer: true, stream: true },
    output: { file: true, buffer: true, stream: true } },
  webp: { id: 'webp',
    input: { file: true, buffer: true, stream: true },
    output: { file: true, buffer: true, stream: true } },
  tiff: { id: 'tiff',
    input: { file: true, buffer: true, stream: true },
    output: { file: true, buffer: false, stream: false } },
  magick: { id: 'magick',
    input: { file: true, buffer: true, stream: true },
    output: { file: false, buffer: false, stream: false } },
  raw: { id: 'raw',
    input: { file: false, buffer: false, stream: false },
    output: { file: false, buffer: true, stream: true } } }

queue

An EventEmitter that emits a change event when a task is either:

queued, waiting for libuv to provide a worker thread
complete

sharp.queue.on('change', function(queueLength) {
  console.log('Queue contains ' + queueLength + ' task(s)');
});

Input methods

sharp([input])

Constructor to which further methods are chained. input, if present, can be one of:

Buffer containing JPEG, PNG, WebP, GIF* or TIFF image data, or
String containing the filename of an image, with most major formats supported.

The object returned implements the stream.Duplex class.

JPEG, PNG, WebP, GIF* or TIFF format image data can be streamed into the object when input is not provided.

JPEG, PNG or WebP format image data can be streamed out from this object.

* libvips 8.0.0+ is required for Buffer/Stream input of GIF and other magick formats.

metadata([callback])

Fast access to image metadata without decoding any compressed image data.

callback, if present, gets the arguments (err, metadata) where metadata has the attributes:

format: Name of decoder to be used to decompress image data e.g. jpeg, png, webp (for file-based input additionally tiff, magick and openslide)
width: Number of pixels wide
height: Number of pixels high
space: Name of colour space interpretation e.g. srgb, rgb, scrgb, cmyk, lab, xyz, b-w ...
channels: Number of bands e.g. 3 for sRGB, 4 for CMYK
hasProfile: Boolean indicating the presence of an embedded ICC profile
hasAlpha: Boolean indicating the presence of an alpha transparency channel
orientation: Number value of the EXIF Orientation header, if present

A Promises/A+ promise is returned when callback is not provided.

sequentialRead()

An advanced setting that switches the libvips access method to VIPS_ACCESS_SEQUENTIAL. This will reduce memory usage and can improve performance on some systems.

limitInputPixels(pixels)

Do not process input images where the number of pixels (width * height) exceeds this limit.

pixels is the integral Number of pixels, with a value between 1 and the default 268402689 (0x3FFF * 0x3FFF).

Image transformation options

resize(width, [height])

Scale output to width x height. By default, the resized image is cropped to the exact size specified.

width is the integral Number of pixels wide the resultant image should be, between 1 and 16383 (0x3FFF). Use null or undefined to auto-scale the width to match the height.

height is the integral Number of pixels high the resultant image should be, between 1 and 16383. Use null or undefined to auto-scale the height to match the width.

extract(top, left, width, height)

Extract a region of the image. Can be used with or without a resize operation.

top and left are the offset, in pixels, from the top-left corner.

width and height are the dimensions of the extracted image.

Use extract before resize for pre-resize extraction. Use extract after resize for post-resize extraction. Use extract before and after for both.

crop([gravity])

Crop the resized image to the exact size specified, the default behaviour.

gravity, if present, is an attribute of the sharp.gravity Object e.g. sharp.gravity.north.

Possible values are north, east, south, west, center and centre. The default gravity is center/centre.

max()

Preserving aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to the width and height specified.

Both width and height must be provided via resize otherwise the behaviour will default to crop.

min()

Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to the width and height specified.

Both width and height must be provided via resize otherwise the behaviour will default to crop.

ignoreAspectRatio()

Ignoring the aspect ratio of the input, stretch the image to the exact width and/or height provided via resize.

background(rgba)

Set the background for the embed and flatten operations.

rgba is parsed by the color module to extract values for red, green, blue and alpha.

The alpha value is a float between 0 (transparent) and 1 (opaque).

The default background is {r: 0, g: 0, b: 0, a: 1}, black without transparency.

embed()

Preserving aspect ratio, resize the image to the maximum width or height specified then embed on a background of the exact width and height specified.

If the background contains an alpha value then WebP and PNG format output images will contain an alpha channel, even when the input image does not.

flatten()

Merge alpha transparency channel, if any, with background.

rotate([angle])

Rotate the output image by either an explicit angle or auto-orient based on the EXIF Orientation tag.

angle, if present, is a Number with a value of 0, 90, 180 or 270.

Use this method without angle to determine the angle from EXIF data. Mirroring is supported and may infer the use of a flip operation.

Method order is important when both rotating and extracting regions, for example rotate(x).extract(y) will produce a different result to extract(y).rotate(x).

flip()

Flip the image about the vertical Y axis. This always occurs after rotation, if any.

flop()

Flop the image about the horizontal X axis. This always occurs after rotation, if any.

withoutEnlargement()

Do not enlarge the output image if the input image width or height are already less than the required dimensions.

This is equivalent to GraphicsMagick's > geometry option: "change the dimensions of the image only if its width or height exceeds the geometry specification".

blur([sigma])

When used without parameters, performs a fast, mild blur of the output image. This typically reduces performance by 10%.

When a sigma is provided, performs a slower, more accurate Gaussian blur. This typically reduces performance by 25%.

sigma, if present, is a Number between 0.3 and 1000 representing the approximate blur radius in pixels.

sharpen([radius], [flat], [jagged])

When used without parameters, performs a fast, mild sharpen of the output image. This typically reduces performance by 10%.

When a radius is provided, performs a slower, more accurate sharpen of the L channel in the LAB colour space. Separate control over the level of sharpening in "flat" and "jagged" areas is available. This typically reduces performance by 50%.

radius, if present, is an integral Number representing the sharpen mask radius in pixels.
flat, if present, is a Number representing the level of sharpening to apply to "flat" areas, defaulting to a value of 1.0.
jagged, if present, is a Number representing the level of sharpening to apply to "jagged" areas, defaulting to a value of 2.0.

interpolateWith(interpolator)

Use the given interpolator for image resizing, where interpolator is an attribute of the sharp.interpolator Object e.g. sharp.interpolator.bicubic.

Possible interpolators, in order of performance, are:

nearest: Use nearest neighbour interpolation, suitable for image enlargement only.
bilinear: Use bilinear interpolation, the default and fastest image reduction interpolation.
bicubic: Use bicubic interpolation, which typically reduces performance by 5%.
vertexSplitQuadraticBasisSpline: Use VSQBS interpolation, which prevents "staircasing" and typically reduces performance by 5%.
locallyBoundedBicubic: Use LBB interpolation, which prevents some "acutance" and typically reduces performance by a factor of 2.
nohalo: Use Nohalo interpolation, which prevents acutance and typically reduces performance by a factor of 3.

gamma([gamma])

Apply a gamma correction by reducing the encoding (darken) pre-resize at a factor of 1/gamma then increasing the encoding (brighten) post-resize at a factor of gamma.

gamma, if present, is a Number betweem 1 and 3. The default value is 2.2, a suitable approximation for sRGB images.

This can improve the perceived brightness of a resized image in non-linear colour spaces.

JPEG input images will not take advantage of the shrink-on-load performance optimisation when applying a gamma correction.

grayscale() / greyscale()

Convert to 8-bit greyscale; 256 shades of grey.

This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use gamma() with greyscale() for the best results.

The output image will still be web-friendly sRGB and contain three (identical) channels.

normalize() / normalise()

Enhance output image contrast by stretching its luminance to cover the full dynamic range. This typically reduces performance by 30%.

Output options

jpeg()

Use JPEG format for the output image.

png()

Use PNG format for the output image.

webp()

Use WebP format for the output image.

raw()

Requires libvips 7.42.0+

Provide raw, uncompressed uint8 (unsigned char) image data for Buffer and Stream based output.

The number of channels depends on the input image and selected options.

1 channel for images converted to greyscale(), with each byte representing one pixel.
3 channels for colour images without alpha transparency, with bytes ordered [red, green, blue, red, green, blue, etc.]).
4 channels for colour images with alpha transparency, with bytes ordered [red, green, blue, alpha, red, green, blue, alpha, etc.].

toFormat(format)

Convenience method for the above output format methods, where format is either:

an attribute of the sharp.format Object e.g. sharp.format.jpeg, or
a String containing jpeg, png, webp or raw.

quality(quality)

The output quality to use for lossy JPEG, WebP and TIFF output formats. The default quality is 80.

quality is a Number between 1 and 100.

progressive()

Use progressive (interlace) scan for JPEG and PNG output. This typically reduces compression performance by 30% but results in an image that can be rendered sooner when decompressed.

withMetadata()

Include all metadata (EXIF, XMP, IPTC) from the input image in the output image. This will also convert to and add the latest web-friendly v2 sRGB ICC profile.

The default behaviour is to strip all metadata and convert to the device-independent sRGB colour space.

tile([size], [overlap])

The size and overlap, in pixels, of square Deep Zoom image pyramid tiles.

size is an integral Number between 1 and 8192. The default value is 256 pixels.
overlap is an integral Number between 0 and 8192. The default value is 0 pixels.

withoutChromaSubsampling()

Disable the use of chroma subsampling with JPEG output (4:4:4).

This can improve colour representation at higher quality settings (90+), but usually increases output file size and typically reduces performance by 25%.

The default behaviour is to use chroma subsampling (4:2:0).

trellisQuantisation() / trellisQuantization()

Requires libvips 8.0.0+ compiled against mozjpeg 3.0+

An advanced setting to apply the use of trellis quantisation with JPEG output. Reduces file size and slightly increases relative quality at the cost of increased compression time.

overshootDeringing()

Requires libvips 8.0.0+ compiled against mozjpeg 3.0+

An advanced setting to reduce the effects of ringing in JPEG output, in particular where black text appears on a white background (or vice versa).

optimiseScans() / optimizeScans()

Requires libvips 8.0.0+ compiled against mozjpeg 3.0+

An advanced setting for progressive (interlace) JPEG output. Calculates which spectrum of DCT coefficients uses the fewest bits. Usually reduces file size at the cost of increased compression time.

compressionLevel(compressionLevel)

An advanced setting for the zlib compression level of the lossless PNG output format. The default level is 6.

compressionLevel is a Number between 0 and 9.

withoutAdaptiveFiltering()

Requires libvips 7.42.0+

An advanced setting to disable adaptive row filtering for the lossless PNG output format.

Output methods

toFile(filename, [callback])

filename is a String containing the filename to write the image data to. The format is inferred from the extension, with JPEG, PNG, WebP, TIFF and DZI supported.

callback, if present, is called with two arguments (err, info) where:

err contains an error message, if any.
info contains the output image format, size (bytes), width and height.

A Promises/A+ promise is returned when callback is not provided.

toBuffer([callback])

Write image data to a Buffer, the format of which will match the input image by default. JPEG, PNG and WebP are supported.

callback, if present, gets three arguments (err, buffer, info) where:

err is an error message, if any.
buffer is the output image data.
info contains the output image format, size (bytes), width and height.

A Promises/A+ promise is returned when callback is not provided.

Utility methods

sharp.cache([memory], [items])

If memory or items are provided, set the limits of libvips' operation cache.

memory is the maximum memory in MB to use for this cache, with a default value of 100
items is the maximum number of operations to cache, with a default value of 500

This method always returns cache statistics, useful for determining how much working memory is required for a particular task.

var stats = sharp.cache(); // { current: 75, high: 99, memory: 100, items: 500 }
sharp.cache(200); // { current: 75, high: 99, memory: 200, items: 500 }
sharp.cache(50, 200); // { current: 49, high: 99, memory: 50, items: 200}

sharp.concurrency([threads])

threads, if provided, is the Number of threads libvips' should create for processing each image. The default value is the number of CPU cores. A value of 0 will reset to this default.

This method always returns the current concurrency.

var threads = sharp.concurrency(); // 4
sharp.concurrency(2); // 2
sharp.concurrency(0); // 4

The maximum number of images that can be processed in parallel is limited by libuv's UV_THREADPOOL_SIZE environment variable.

sharp.counters()

Provides access to internal task counters.

queue is the number of tasks this module has queued waiting for libuv to provide a worker thread from its pool.
process is the number of resize tasks currently being processed.

var counters = sharp.counters(); // { queue: 2, process: 4 }

Contributing

A guide for contributors covers reporting bugs, requesting features and submitting code changes.

Testing

Functional tests

Coverage

Ubuntu 12.04

Centos 6.5

Windows Server 2012

Benchmark tests

cd sharp/test/bench
npm install
npm test

Requires both ImageMagick and GraphicsMagick:

brew install imagemagick
brew install graphicsmagick

sudo apt-get install -qq imagemagick graphicsmagick libmagickcore-dev

sudo yum install ImageMagick
sudo yum install -y http://download.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
sudo yum install -y --enablerepo=epel GraphicsMagick

Performance

Test environment

AWS EC2 c3.xlarge
Ubuntu 14.04
libvips 7.40.8
liborc 0.4.22

The contenders

imagemagick-native v1.2.2 - Supports Buffers only
imagemagick v0.1.3 - Supports filesystem only and "has been unmaintained for a long time".
gm v1.16.0 - Fully featured wrapper around GraphicsMagick.
sharp v0.6.2 - Caching within libvips disabled to ensure a fair comparison.

The task

Decompress a 2725x2225 JPEG image, resize and crop to 720x480, then compress to JPEG.

Results

Module	Input	Output	Ops/sec	Speed-up
imagemagick-native	buffer	buffer	1.58	1
imagemagick	file	file	6.23	3.9
gm	buffer	file	5.32	3.4
gm	buffer	buffer	5.32	3.4
gm	file	file	5.36	3.4
gm	file	buffer	5.36	3.4
sharp	buffer	file	22.05	14.0
sharp	buffer	buffer	22.14	14.0
sharp	file	file	21.79	13.8
sharp	file	buffer	21.90	13.9
sharp	stream	stream	20.87	13.2
sharp +promise	file	buffer	21.89	13.9
sharp +sharpen	file	buffer	19.69	12.5
sharp +progressive	file	buffer	16.93	10.7
sharp +sequentialRead	file	buffer	21.60	13.7

You can expect greater performance with caching enabled (default) and using 8+ core machines.

Thanks

This module would never have been possible without the help and code contributions of the following people:

Thank you!

Licence

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Name		Name	Last commit message	Last commit date
Latest commit History 333 Commits
icc		icc
src		src
test		test
.gitignore		.gitignore
.jshintignore		.jshintignore
.jshintrc		.jshintrc
.npmignore		.npmignore
.travis.yml		.travis.yml
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
appveyor.yml		appveyor.yml
binding.gyp		binding.gyp
index.js		index.js
package.json		package.json
preinstall.sh		preinstall.sh

License

gasi/sharp

Folders and files

Latest commit

History

Repository files navigation

sharp

Installation

Prerequisites

Mac OS tips

Windows

Heroku

Docker

Build tools

Usage examples

API

Attributes

format

queue

Input methods

sharp([input])

metadata([callback])

sequentialRead()

limitInputPixels(pixels)

Image transformation options

resize(width, [height])

extract(top, left, width, height)

crop([gravity])

max()

min()

ignoreAspectRatio()

background(rgba)

embed()

flatten()

rotate([angle])

flip()

flop()

withoutEnlargement()

blur([sigma])

sharpen([radius], [flat], [jagged])

interpolateWith(interpolator)

gamma([gamma])

grayscale() / greyscale()

normalize() / normalise()

Output options

jpeg()

png()

webp()

raw()

toFormat(format)

quality(quality)

progressive()

withMetadata()

tile([size], [overlap])

withoutChromaSubsampling()

trellisQuantisation() / trellisQuantization()

overshootDeringing()

optimiseScans() / optimizeScans()

compressionLevel(compressionLevel)

withoutAdaptiveFiltering()

Output methods

toFile(filename, [callback])

toBuffer([callback])

Utility methods

sharp.cache([memory], [items])

sharp.concurrency([threads])

sharp.counters()

Contributing

Testing

Functional tests

Coverage

Ubuntu 12.04

Centos 6.5

Windows Server 2012

Benchmark tests

Performance

Test environment

The contenders

The task

Results

Packages