sharp 0.20.5 → 0.21.0

package/README.md

@@ -21,8 +21,8 @@ Lanczos resampling ensures quality is not sacrificed for speed.
 As well as image resizing, operations such as
 rotation, extraction, compositing and gamma correction are available.
 
-Most modern 64-bit OS X, Windows and Linux (glibc) systems running
-Node versions 4, 6, 8 and 10
+Most modern 64-bit OS X, Windows and Linux systems running
+Node versions 6, 8 and 10
 do not require any additional install or runtime dependencies.
 
 ## Examples
@@ -78,7 +78,7 @@ Visit [sharp.pixelplumbing.com](http://sharp.pixelplumbing.com/) for complete
 A [guide for contributors](https://github.com/lovell/sharp/blob/master/CONTRIBUTING.md)
 covers reporting bugs, requesting features and submitting code changes.
 
-### Licence
+### Licensing
 
 Copyright 2013, 2014, 2015, 2016, 2017, 2018 Lovell Fuller and contributors.
 

package/binding.gyp

@@ -128,9 +128,11 @@
               '../vendor/lib/libcairo.so',
               '../vendor/lib/libcroco-0.6.so',
               '../vendor/lib/libexif.so',
+              '../vendor/lib/libexpat.so',
               '../vendor/lib/libffi.so',
               '../vendor/lib/libfontconfig.so',
               '../vendor/lib/libfreetype.so',
+              '../vendor/lib/libfribidi.so',
               '../vendor/lib/libgdk_pixbuf-2.0.so',
               '../vendor/lib/libgif.so',
               '../vendor/lib/libgio-2.0.so',
@@ -138,6 +140,7 @@
               '../vendor/lib/libgsf-1.so',
               '../vendor/lib/libgthread-2.0.so',
               '../vendor/lib/libharfbuzz.so',
+              '../vendor/lib/libharfbuzz-subset.so.0',
               '../vendor/lib/libjpeg.so',
               '../vendor/lib/liblcms2.so',
               '../vendor/lib/liborc-0.4.so',
@@ -149,6 +152,8 @@
               '../vendor/lib/librsvg-2.so',
               '../vendor/lib/libtiff.so',
               '../vendor/lib/libwebp.so',
+              '../vendor/lib/libwebpdemux.so',
+              '../vendor/lib/libwebpmux.so',
               '../vendor/lib/libxml2.so',
               '../vendor/lib/libz.so',
               # Ensure runtime linking is relative to sharp.node

package/docs/api-channel.md

@@ -1,5 +1,21 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
+## removeAlpha
+
+Remove alpha channel, if any. This is a no-op if the image does not have an alpha channel.
+
+### Examples
+
+```javascript
+sharp('rgba.png')
+  .removeAlpha()
+  .toFile('rgb.png', function(err, info) {
+    // rgb.png is a 3 channel image without an alpha channel
+  });
+```
+
+Returns **Sharp** 
+
 ## extractChannel
 
 Extract a single channel from a multi-channel image.

package/docs/api-colour.md

@@ -1,23 +1,5 @@
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-## background
-
-Set the background for the `embed`, `flatten` and `extend` operations.
-The default background is `{r: 0, g: 0, b: 0, alpha: 1}`, black without transparency.
-
-Delegates to the _color_ module, which can throw an Error
-but is liberal in what it accepts, clipping values to sensible min/max.
-The alpha value is a float between `0` (transparent) and `1` (opaque).
-
-### Parameters
-
--   `rgba` **([String][1] \| [Object][2])** parsed by the [color][3] module to extract values for red, green, blue and alpha.
-
-
--   Throws **[Error][4]** Invalid parameter
-
-Returns **Sharp** 
-
 ## tint
 
 Tint the image using the provided chroma while preserving the image luminance.
@@ -94,4 +76,4 @@ Returns **Sharp**
 
 [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[6]: https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568
+[6]: https://github.com/libvips/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568

package/docs/api-composite.md

@@ -18,7 +18,7 @@ If the overlay image contains an alpha channel then composition with premultipli
     -   `options.left` **[Number][4]?** the pixel offset from the left edge.
     -   `options.tile` **[Boolean][5]** set to true to repeat the overlay image across the entire image with the given `gravity`. (optional, default `false`)
     -   `options.cutout` **[Boolean][5]** set to true to apply only the alpha channel of the overlay image to the input image, giving the appearance of one image being cut out of another. (optional, default `false`)
-    -   `options.density` **[Number][4]** integral number representing the DPI for vector overlay image. (optional, default `72`)
+    -   `options.density` **[Number][4]** number representing the DPI for vector overlay image. (optional, default `72`)
     -   `options.raw` **[Object][3]?** describes overlay when using raw pixel data.
         -   `options.raw.width` **[Number][4]?** 
         -   `options.raw.height` **[Number][4]?** 
@@ -40,8 +40,7 @@ sharp('input.png')
   .overlayWith('overlay.png', { gravity: sharp.gravity.southeast } )
   .sharpen()
   .withMetadata()
-  .quality(90)
-  .webp()
+  .webp( { quality: 90 } )
   .toBuffer()
   .then(function(outputBuffer) {
     // outputBuffer contains upside down, 300px wide, alpha channel flattened

package/docs/api-constructor.md

@@ -12,7 +12,7 @@
     -   `options.failOnError` **[Boolean][4]** by default apply a "best effort"
          to decode images, even if the data is corrupt or invalid. Set this flag to true
          if you'd rather halt processing and raise an error when loading invalid images. (optional, default `false`)
-    -   `options.density` **[Number][5]** integral number representing the DPI for vector images. (optional, default `72`)
+    -   `options.density` **[Number][5]** number representing the DPI for vector images. (optional, default `72`)
     -   `options.page` **[Number][5]** page number to extract for multi-page input (GIF, TIFF) (optional, default `0`)
     -   `options.raw` **[Object][3]?** describes raw pixel input image data. See `raw()` for pixel ordering.
         -   `options.raw.width` **[Number][5]?** 
@@ -55,7 +55,7 @@ sharp({
     width: 300,
     height: 200,
     channels: 4,
-    background: { r: 255, g: 0, b: 0, alpha: 128 }
+    background: { r: 255, g: 0, b: 0, alpha: 0.5 }
   }
 })
 .png()

package/docs/api-input.md

@@ -25,12 +25,15 @@ Fast access to (uncached) image metadata without decoding any compressed image d
 A Promises/A+ promise is returned when `callback` is not provided.
 
 -   `format`: Name of decoder used to decompress image data e.g. `jpeg`, `png`, `webp`, `gif`, `svg`
+-   `size`: Total size of image in bytes, for Stream and Buffer input only
 -   `width`: Number of pixels wide (EXIF orientation is not taken into consideration)
 -   `height`: Number of pixels high (EXIF orientation is not taken into consideration)
 -   `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...][1]
 -   `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
 -   `depth`: Name of pixel depth format e.g. `uchar`, `char`, `ushort`, `float` [...][2]
 -   `density`: Number of pixels per inch (DPI), if present
+-   `chromaSubsampling`: String containing JPEG chroma subsampling, `4:2:0` or `4:4:4` for RGB, `4:2:0:4` or `4:4:4:4` for CMYK
+-   `isProgressive`: Boolean indicating whether the image is interlaced using a progressive scan
 -   `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
@@ -79,6 +82,7 @@ A Promise is returned when `callback` is not provided.
     -   `maxX` (x-coordinate of one of the pixel where the maximum lies)
     -   `maxY` (y-coordinate of one of the pixel where the maximum lies)
 -   `isOpaque`: Value to identify if the image is opaque or transparent, based on the presence and use of alpha channel
+-   `entropy`: Histogram-based estimation of greyscale entropy, discarding alpha channel if any (experimental)
 
 ### Parameters
 
@@ -125,9 +129,9 @@ The default behaviour _before_ function call is `false`, meaning the libvips acc
 
 Returns **Sharp** 
 
-[1]: https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L636
+[1]: https://github.com/libvips/libvips/blob/master/libvips/iofuncs/enumtypes.c#L636
 
-[2]: https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L672
+[2]: https://github.com/libvips/libvips/blob/master/libvips/iofuncs/enumtypes.c#L672
 
 [3]: https://www.npmjs.com/package/icc
 

package/docs/api-operation.md

@@ -5,9 +5,12 @@
 Rotate the output image by either an explicit angle
 or auto-orient based on the EXIF `Orientation` tag.
 
-If an angle is provided, it is converted to a valid 90/180/270deg rotation.
+If an angle is provided, it is converted to a valid positive degree rotation.
 For example, `-450` will produce a 270deg rotation.
 
+When rotating by an angle other than a multiple of 90,
+the background colour can be provided with the `background` option.
+
 If no angle is provided, it is determined from the EXIF data.
 Mirroring is supported and may infer the use of a flip operation.
 
@@ -18,7 +21,9 @@ for example `rotate(x).extract(y)` will produce a different result to `extract(y
 
 ### Parameters
 
--   `angle` **[Number][1]** angle of rotation, must be a multiple of 90. (optional, default `auto`)
+-   `angle` **[Number][1]** angle of rotation. (optional, default `auto`)
+-   `options` **[Object][2]?** if present, is an Object with optional attributes.
+    -   `options.background` **([String][3] \| [Object][2])** parsed by the [color][4] module to extract values for red, green, blue and alpha. (optional, default `"#000000"`)
 
 ### Examples
 
@@ -34,47 +39,7 @@ const pipeline = sharp()
 readableStream.pipe(pipeline);
 ```
 
--   Throws **[Error][2]** Invalid parameters
-
-Returns **Sharp** 
-
-## extract
-
-Extract a region of the image.
-
--   Use `extract` before `resize` for pre-resize extraction.
--   Use `extract` after `resize` for post-resize extraction.
--   Use `extract` before and after for both.
-
-### Parameters
-
--   `options` **[Object][3]** 
-    -   `options.left` **[Number][1]** zero-indexed offset from left edge
-    -   `options.top` **[Number][1]** zero-indexed offset from top edge
-    -   `options.width` **[Number][1]** dimension of extracted image
-    -   `options.height` **[Number][1]** dimension of extracted image
-
-### Examples
-
-```javascript
-sharp(input)
-  .extract({ left: left, top: top, width: width, height: height })
-  .toFile(output, function(err) {
-    // Extract a region of the input image, saving in the same format.
-  });
-```
-
-```javascript
-sharp(input)
-  .extract({ left: leftOffsetPre, top: topOffsetPre, width: widthPre, height: heightPre })
-  .resize(width, height)
-  .extract({ left: leftOffsetPost, top: topOffsetPost, width: widthPost, height: heightPost })
-  .toFile(output, function(err) {
-    // Extract a region, resize, then extract from the resized image
-  });
-```
-
--   Throws **[Error][2]** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -85,7 +50,7 @@ The use of `flip` implies the removal of the EXIF `Orientation` tag, if any.
 
 ### Parameters
 
--   `flip` **[Boolean][4]**  (optional, default `true`)
+-   `flip` **[Boolean][6]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -96,7 +61,7 @@ The use of `flop` implies the removal of the EXIF `Orientation` tag, if any.
 
 ### Parameters
 
--   `flop` **[Boolean][4]**  (optional, default `true`)
+-   `flop` **[Boolean][6]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -114,7 +79,7 @@ Separate control over the level of sharpening in "flat" and "jagged" areas is av
 -   `jagged` **[Number][1]** the level of sharpening to apply to "jagged" areas. (optional, default `2.0`)
 
 
--   Throws **[Error][2]** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -128,7 +93,7 @@ When used without parameters the default window is 3x3.
 -   `size` **[Number][1]** square mask size: size x size (optional, default `3`)
 
 
--   Throws **[Error][2]** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -143,59 +108,17 @@ When a `sigma` is provided, performs a slower, more accurate Gaussian blur.
 -   `sigma` **[Number][1]?** a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
 
 
--   Throws **[Error][2]** Invalid parameters
-
-Returns **Sharp** 
-
-## extend
-
-Extends/pads the edges of the image with the colour provided to the `background` method.
-This operation will always occur after resizing and extraction, if any.
-
-### Parameters
-
--   `extend` **([Number][1] \| [Object][3])** single pixel count to add to all edges or an Object with per-edge counts
-    -   `extend.top` **[Number][1]?** 
-    -   `extend.left` **[Number][1]?** 
-    -   `extend.bottom` **[Number][1]?** 
-    -   `extend.right` **[Number][1]?** 
-
-### Examples
-
-```javascript
-// Resize to 140 pixels wide, then add 10 transparent pixels
-// to the top, left and right edges and 20 to the bottom edge
-sharp(input)
-  .resize(140)
-  .background({r: 0, g: 0, b: 0, alpha: 0})
-  .extend({top: 10, bottom: 20, left: 10, right: 10})
-  ...
-```
-
--   Throws **[Error][2]** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
 ## flatten
 
-Merge alpha transparency channel, if any, with `background`.
+Merge alpha transparency channel, if any, with a background.
 
 ### Parameters
 
--   `flatten` **[Boolean][4]**  (optional, default `true`)
-
-Returns **Sharp** 
-
-## trim
-
-Trim "boring" pixels from all edges that contain values within a percentage similarity of the top-left pixel.
-
-### Parameters
-
--   `tolerance` **[Number][1]** value between 1 and 99 representing the percentage similarity. (optional, default `10`)
-
-
--   Throws **[Error][2]** Invalid parameters
+-   `options`  
 
 Returns **Sharp** 
 
@@ -212,7 +135,7 @@ when applying a gamma correction.
 -   `gamma` **[Number][1]** value between 1.0 and 3.0. (optional, default `2.2`)
 
 
--   Throws **[Error][2]** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -222,7 +145,7 @@ Produce the "negative" of the image.
 
 ### Parameters
 
--   `negate` **[Boolean][4]**  (optional, default `true`)
+-   `negate` **[Boolean][6]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -232,7 +155,7 @@ Enhance output image contrast by stretching its luminance to cover the full dyna
 
 ### Parameters
 
--   `normalise` **[Boolean][4]**  (optional, default `true`)
+-   `normalise` **[Boolean][6]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -242,7 +165,7 @@ Alternative spelling of normalise.
 
 ### Parameters
 
--   `normalize` **[Boolean][4]**  (optional, default `true`)
+-   `normalize` **[Boolean][6]**  (optional, default `true`)
 
 Returns **Sharp** 
 
@@ -252,10 +175,10 @@ Convolve the image with the specified kernel.
 
 ### Parameters
 
--   `kernel` **[Object][3]** 
+-   `kernel` **[Object][2]** 
     -   `kernel.width` **[Number][1]** width of the kernel in pixels.
     -   `kernel.height` **[Number][1]** width of the kernel in pixels.
-    -   `kernel.kernel` **[Array][5]<[Number][1]>** Array of length `width*height` containing the kernel values.
+    -   `kernel.kernel` **[Array][7]<[Number][1]>** Array of length `width*height` containing the kernel values.
     -   `kernel.scale` **[Number][1]** the scale of the kernel in pixels. (optional, default `sum`)
     -   `kernel.offset` **[Number][1]** the offset of the kernel in pixels. (optional, default `0`)
 
@@ -275,7 +198,7 @@ sharp(input)
   });
 ```
 
--   Throws **[Error][2]** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -286,12 +209,12 @@ Any pixel value greather than or equal to the threshold value will be set to 255
 ### Parameters
 
 -   `threshold` **[Number][1]** a value in the range 0-255 representing the level at which the threshold will be applied. (optional, default `128`)
--   `options` **[Object][3]?** 
-    -   `options.greyscale` **[Boolean][4]** convert to single channel greyscale. (optional, default `true`)
-    -   `options.grayscale` **[Boolean][4]** alternative spelling for greyscale. (optional, default `true`)
+-   `options` **[Object][2]?** 
+    -   `options.greyscale` **[Boolean][6]** convert to single channel greyscale. (optional, default `true`)
+    -   `options.grayscale` **[Boolean][6]** alternative spelling for greyscale. (optional, default `true`)
 
 
--   Throws **[Error][2]** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -304,16 +227,16 @@ the selected bitwise boolean `operation` between the corresponding pixels of the
 
 ### Parameters
 
--   `operand` **([Buffer][6] \| [String][7])** Buffer containing image data or String containing the path to an image file.
--   `operator` **[String][7]** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
--   `options` **[Object][3]?** 
-    -   `options.raw` **[Object][3]?** describes operand when using raw pixel data.
+-   `operand` **([Buffer][8] \| [String][3])** Buffer containing image data or String containing the path to an image file.
+-   `operator` **[String][3]** one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
+-   `options` **[Object][2]?** 
+    -   `options.raw` **[Object][2]?** describes operand when using raw pixel data.
         -   `options.raw.width` **[Number][1]?** 
         -   `options.raw.height` **[Number][1]?** 
         -   `options.raw.channels` **[Number][1]?** 
 
 
--   Throws **[Error][2]** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
@@ -327,20 +250,22 @@ Apply the linear formula a \* input + b to the image (levels adjustment)
 -   `b` **[Number][1]** offset (optional, default `0.0`)
 
 
--   Throws **[Error][2]** Invalid parameters
+-   Throws **[Error][5]** Invalid parameters
 
 Returns **Sharp** 
 
 [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[4]: https://www.npmjs.org/package/color
 
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
 
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[6]: https://nodejs.org/api/buffer.html
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[8]: https://nodejs.org/api/buffer.html

package/docs/api-output.md

@@ -121,6 +121,8 @@ Use these JPEG options for output image.
     -   `options.optimizeScans` **[Boolean][6]** alternative spelling of optimiseScans (optional, default `false`)
     -   `options.optimiseCoding` **[Boolean][6]** optimise Huffman coding tables (optional, default `true`)
     -   `options.optimizeCoding` **[Boolean][6]** alternative spelling of optimiseCoding (optional, default `true`)
+    -   `options.quantisationTable` **[Number][8]** quantization table to use, integer 0-8, requires mozjpeg (optional, default `0`)
+    -   `options.quantizationTable` **[Number][8]** alternative spelling of quantisationTable (optional, default `0`)
     -   `options.force` **[Boolean][6]** force JPEG output, otherwise attempt to use input format (optional, default `true`)
 
 ### Examples
@@ -276,6 +278,7 @@ Warning: multiple sharp instances concurrently producing tile output can expose
     -   `tile.size` **[Number][8]** tile size in pixels, a value between 1 and 8192. (optional, default `256`)
     -   `tile.overlap` **[Number][8]** tile overlap in pixels, a value between 0 and 8192. (optional, default `0`)
     -   `tile.angle` **[Number][8]** tile angle of rotation, must be a multiple of 90. (optional, default `0`)
+    -   `tile.depth` **[String][1]?** how deep to make the pyramid, possible values are `onepixel`, `onetile` or `one`, default based on layout.
     -   `tile.container` **[String][1]** tile container, with value `fs` (filesystem) or `zip` (compressed file). (optional, default `'fs'`)
     -   `tile.layout` **[String][1]** filesystem layout, possible values are `dz`, `zoomify` or `google`. (optional, default `'dz'`)