sharp 0.17.2 → 0.18.2

package/docs/changelog.md

@@ -1,9 +1,112 @@
 # Changelog
 
+### v0.18 - "*ridge*"
+
+Requires libvips v8.5.5.
+
+#### v0.18.2 - 1<sup>st</sup> July 2017
+
+* Expose libvips' xres and yres properties for TIFF output.
+  [#828](https://github.com/lovell/sharp/pull/828)
+  [@YvesBos](https://github.com/YvesBos)
+
+* Ensure flip and flop operations work with auto-rotate.
+  [#837](https://github.com/lovell/sharp/issues/837)
+  [@rexxars](https://github.com/rexxars)
+
+* Allow binary download URL override via SHARP_DIST_BASE_URL env variable.
+  [#841](https://github.com/lovell/sharp/issues/841)
+
+* Add support for Solus Linux.
+  [#857](https://github.com/lovell/sharp/pull/857)
+  [@ekremkaraca](https://github.com/ekremkaraca)
+
+#### v0.18.1 - 30<sup>th</sup> May 2017
+
+* Remove regression from #781 that could cause incorrect shrink calculation.
+  [#831](https://github.com/lovell/sharp/issues/831)
+  [@suprMax](https://github.com/suprMax)
+
+#### v0.18.0 - 30<sup>th</sup> May 2017
+
+* Remove the previously-deprecated output format "option" functions:
+    quality, progressive, compressionLevel, withoutAdaptiveFiltering,
+    withoutChromaSubsampling, trellisQuantisation, trellisQuantization,
+    overshootDeringing, optimiseScans and optimizeScans.
+
+* Ensure maximum output dimensions are based on the format to be used.
+  [#176](https://github.com/lovell/sharp/issues/176)
+  [@stephanebachelier](https://github.com/stephanebachelier)
+
+* Avoid costly (un)premultiply when using overlayWith without alpha channel.
+  [#573](https://github.com/lovell/sharp/issues/573)
+  [@strarsis](https://github.com/strarsis)
+
+* Include pixel depth (e.g. "uchar") when reading metadata.
+  [#577](https://github.com/lovell/sharp/issues/577)
+  [@moedusa](https://github.com/moedusa)
+
+* Add support for Buffer and Stream-based TIFF output.
+  [#587](https://github.com/lovell/sharp/issues/587)
+  [@strarsis](https://github.com/strarsis)
+
+* Expose warnings from libvips via NODE_DEBUG=sharp environment variable.
+  [#607](https://github.com/lovell/sharp/issues/607)
+  [@puzrin](https://github.com/puzrin)
+
+* Switch to the libvips implementation of "attention" and "entropy" crop strategies.
+  [#727](https://github.com/lovell/sharp/issues/727)
+
+* Improve performance and accuracy of nearest neighbour integral upsampling.
+  [#752](https://github.com/lovell/sharp/issues/752)
+  [@MrIbby](https://github.com/MrIbby)
+
+* Constructor single argument API: allow plain object, reject null/undefined.
+  [#768](https://github.com/lovell/sharp/issues/768)
+  [@kub1x](https://github.com/kub1x)
+
+* Ensure ARM64 pre-built binaries use correct C++11 ABI version.
+  [#772](https://github.com/lovell/sharp/issues/772)
+  [@ajiratech2](https://github.com/ajiratech2)
+
+* Prevent aliasing by using dynamic values for shrink(-on-load).
+  [#781](https://github.com/lovell/sharp/issues/781)
+  [@kleisauke](https://github.com/kleisauke)
+
+* Expose libvips' "squash" parameter to enable 1-bit TIFF output.
+  [#783](https://github.com/lovell/sharp/pull/783)
+  [@YvesBos](https://github.com/YvesBos)
+
+* Add support for rotation using any multiple of +/-90 degrees.
+  [#791](https://github.com/lovell/sharp/pull/791)
+  [@ncoden](https://github.com/ncoden)
+
+* Add "jpg" alias to toFormat as shortened form of "jpeg".
+  [#814](https://github.com/lovell/sharp/pull/814)
+  [@jingsam](https://github.com/jingsam)
+
 ### v0.17 - "*quill*"
 
 Requires libvips v8.4.2.
 
+#### v0.17.3 - 1<sup>st</sup> April 2017
+
+* Allow toBuffer to optionally resolve a Promise with both info and data.
+  [#143](https://github.com/lovell/sharp/issues/143)
+  [@salzhrani](https://github.com/salzhrani)
+
+* Create blank image of given width, height, channels and background.
+  [#470](https://github.com/lovell/sharp/issues/470)
+  [@pjarts](https://github.com/pjarts)
+
+* Add support for the "nearest" kernel for image reductions.
+  [#732](https://github.com/lovell/sharp/pull/732)
+  [@alice0meta](https://github.com/alice0meta)
+
+* Add support for TIFF compression and predictor options.
+  [#738](https://github.com/lovell/sharp/pull/738)
+  [@kristojorg](https://github.com/kristojorg)
+
 #### v0.17.2 - 11<sup>th</sup> February 2017
 
 * Ensure Readable side of Stream can start flowing after Writable side has finished.

package/docs/index.md

@@ -22,7 +22,7 @@ the installation of any external runtime dependencies.
 
 This module supports reading JPEG, PNG, WebP, TIFF, GIF and SVG images.
 
-Output images can be in JPEG, PNG and WebP formats as well as uncompressed raw pixel data.
+Output images can be in JPEG, PNG, WebP and TIFF formats as well as uncompressed raw pixel data.
 
 Streams, Buffer objects and the filesystem can be used for input and output.
 
@@ -97,6 +97,9 @@ the help and code contributions of the following people:
 * [Matthias Thoemmes](https://github.com/cmtt)
 * [Patrick Paskaris](https://github.com/ppaskaris)
 * [Jérémy Lal](https://github.com/kapouer)
+* [Alice Monday](https://github.com/alice0meta)
+* [Kristo Jorgenson](https://github.com/kristojorg)
+* [Yves Bos](https://github.com/YvesBos)
 
 Thank you!
 

package/docs/install.md

@@ -10,9 +10,9 @@ yarn add sharp
 
 ### Prerequisites
 
-* Node v4+
+* Node v4.5.0+
 * C++11 compatible compiler such as gcc 4.8+, clang 3.0+ or MSVC 2013+
-* [node-gyp](https://github.com/TooTallNate/node-gyp#installation) and its dependencies
+* [node-gyp](https://github.com/TooTallNate/node-gyp#installation) and its dependencies (includes Python)
 
 ### Linux
 
@@ -20,18 +20,19 @@ yarn add sharp
 [![Linux Build Status](https://circleci.com/gh/lovell/sharp.svg?style=svg&circle-token=6cb6d1d287a51af83722b19ed8885377fbc85e5c)](https://circleci.com/gh/lovell/sharp)
 
 libvips and its dependencies are fetched and stored within `node_modules/sharp/vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 6.5MB.
+This involves an automated HTTPS download of approximately 7MB.
 
 Most recent Linux-based operating systems with glibc running on x64 and ARMv6+ CPUs should "just work", e.g.:
 
 * Debian 7, 8
 * Ubuntu 12.04, 14.04, 16.04
 * Centos 7
-* Fedora 23, 24
+* Fedora
 * openSUSE 13.2
 * Archlinux
 * Raspbian Jessie
 * Amazon Linux 2016.03, 2016.09
+* Solus
 
 To use a globally-installed version of libvips instead of the provided binaries,
 make sure it is at least the version listed under `config.libvips` in the `package.json` file
@@ -48,8 +49,17 @@ it is recommended to install a system-wide installation of libvips from source:
 
 https://github.com/jcupitt/libvips#building-libvips-from-a-source-tarball
 
-For Linux-based operating systems such as Alpine that use musl libc,
-the smaller stack size means libvips' cache should be disabled
+#### Alpine Linux
+
+libvips is available in the
+[testing repository](https://pkgs.alpinelinux.org/packages?name=vips-dev):
+
+```sh
+apk add vips-dev --update-cache --repository https://dl-3.alpinelinux.org/alpine/edge/testing/
+```
+
+The smaller stack size of musl libc means
+libvips may need to be used without a cache
 via `sharp.cache(false)` to avoid a stack overflow.
 
 ### Mac OS
@@ -57,7 +67,7 @@ via `sharp.cache(false)` to avoid a stack overflow.
 [![OS X 10.9.5 Build Status](https://travis-ci.org/lovell/sharp.png?branch=master)](https://travis-ci.org/lovell/sharp)
 
 libvips and its dependencies are fetched and stored within `node_modules/sharp/vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 6.3MB.
+This involves an automated HTTPS download of approximately 7MB.
 
 To use your own version of libvips instead of the provided binaries, make sure it is
 at least the version listed under `config.libvips` in the `package.json` file and
@@ -68,7 +78,7 @@ that it can be located using `pkg-config --modversion vips-cpp`.
 [![Windows x64 Build Status](https://ci.appveyor.com/api/projects/status/pgtul704nkhhg6sg)](https://ci.appveyor.com/project/lovell/sharp)
 
 libvips and its dependencies are fetched and stored within `node_modules\sharp\vendor` during `npm install`.
-This involves an automated HTTPS download of approximately 9MB.
+This involves an automated HTTPS download of approximately 11MB.
 
 Only 64-bit (x64) `node.exe` is supported.
 
@@ -83,9 +93,11 @@ cd /usr/ports/graphics/vips/ && make install clean
 
 ### Heroku
 
-[Alessandro Tagliapietra](https://github.com/alex88) maintains an
-[Heroku buildpack for libvips](https://github.com/alex88/heroku-buildpack-vips)
-and its dependencies.
+libvips and its dependencies are fetched and stored within `node_modules\sharp\vendor` during `npm install`.
+This involves an automated HTTPS download of approximately 7MB.
+
+Set [NODE_MODULES_CACHE](https://devcenter.heroku.com/articles/nodejs-support#cache-behavior)
+to `false` when using the `yarn` package manager.
 
 ### Docker
 
@@ -103,6 +115,13 @@ docker pull marcbachmann/libvips
 docker pull wjordan/libvips
 ```
 
+[Tailor Brands](https://github.com/TailorBrands) maintain
+[Debian-based Dockerfiles for libvips and nodejs](https://github.com/TailorBrands/docker-libvips).
+
+```sh
+docker pull tailor/docker-libvips
+```
+
 ### AWS Lambda
 
 In order to use sharp on AWS Lambda, you need to [create a deployment package](http://docs.aws.amazon.com/lambda/latest/dg/nodejs-create-deployment-pkg.html). Because sharp
@@ -135,7 +154,6 @@ You can now download your deployment ZIP using `scp` and upload it to Lambda. Be
 * [gulp-responsive](https://www.npmjs.com/package/gulp-responsive)
 * [grunt-sharp](https://www.npmjs.com/package/grunt-sharp)
 
-
 ### CLI tools
 
 * [sharp-cli](https://www.npmjs.com/package/sharp-cli)
@@ -175,16 +193,27 @@ configuration file to prevent the use of coders known to be vulnerable.
 Set the `MAGICK_CONFIGURE_PATH` environment variable
 to the directory containing the `policy.xml` file.
 
-### Licences
+### Pre-compiled libvips binaries
 
 If a global installation of libvips that meets the
 minimum version requirement cannot be found,
-this module will download a pre-compiled bundle of libvips
+this module will attempt to download a pre-compiled bundle of libvips
 and its dependencies on Linux and Windows machines.
 
 Should you need to manually download and inspect these files,
 you can do so via https://dl.bintray.com/lovell/sharp/
 
+Should you wish to install these from your own location,
+set the `SHARP_DIST_BASE_URL` environment variable, e.g.
+
+```sh
+SHARP_DIST_BASE_URL="https://hostname/path/" npm install sharp
+```
+
+to use `https://hostname/path/libvips-x.y.z-platform.tar.gz`.
+
+### Licences
+
 This module is licensed under the terms of the
 [Apache 2.0 Licence](https://github.com/lovell/sharp/blob/master/LICENSE).
 
@@ -198,6 +227,7 @@ Use of libraries under the terms of the LGPLv3 is via the
 | Library       | Used under the terms of                                                                                  |
 |---------------|----------------------------------------------------------------------------------------------------------|
 | cairo         | Mozilla Public License 2.0                                                                               |
+| expat         | MIT Licence                                                                                              |
 | fontconfig    | [fontconfig Licence](https://cgit.freedesktop.org/fontconfig/tree/COPYING) (BSD-like)                    |
 | freetype      | [freetype Licence](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/tree/docs/FTL.TXT) (BSD-like) |
 | giflib        | MIT Licence                                                                                              |

package/lib/channel.js

@@ -27,7 +27,7 @@ const bool = {
  * @returns {Sharp}
  * @throws {Error} Invalid channel
  */
-const extractChannel = function extractChannel (channel) {
+function extractChannel (channel) {
   if (channel === 'red') {
     channel = 0;
   } else if (channel === 'green') {
@@ -41,7 +41,7 @@ const extractChannel = function extractChannel (channel) {
     throw new Error('Cannot extract invalid channel ' + channel);
   }
   return this;
-};
+}
 
 /**
  * Join one or more channels to the image.
@@ -59,7 +59,7 @@ const extractChannel = function extractChannel (channel) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const joinChannel = function joinChannel (images, options) {
+function joinChannel (images, options) {
   if (Array.isArray(images)) {
     images.forEach(function (image) {
       this.options.joinChannelIn.push(this._createInputDescriptor(image, options));
@@ -68,7 +68,7 @@ const joinChannel = function joinChannel (images, options) {
     this.options.joinChannelIn.push(this._createInputDescriptor(images, options));
   }
   return this;
-};
+}
 
 /**
  * Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image.
@@ -86,14 +86,14 @@ const joinChannel = function joinChannel (images, options) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const bandbool = function bandbool (boolOp) {
+function bandbool (boolOp) {
   if (is.string(boolOp) && is.inArray(boolOp, ['and', 'or', 'eor'])) {
     this.options.bandBoolOp = boolOp;
   } else {
     throw new Error('Invalid bandbool operation ' + boolOp);
   }
   return this;
-};
+}
 
 /**
  * Decorate the Sharp prototype with channel-related functions.

package/lib/colour.js

@@ -27,7 +27,7 @@ const colourspace = {
  * @returns {Sharp}
  * @throws {Error} Invalid parameter
  */
-const background = function background (rgba) {
+function background (rgba) {
   const colour = color(rgba);
   this.options.background = [
     colour.red(),
@@ -36,7 +36,7 @@ const background = function background (rgba) {
     Math.round(colour.alpha() * 255)
   ];
   return this;
-};
+}
 
 /**
  * Convert to 8-bit greyscale; 256 shades of grey.
@@ -48,19 +48,19 @@ const background = function background (rgba) {
  * @param {Boolean} [greyscale=true]
  * @returns {Sharp}
  */
-const greyscale = function greyscale (greyscale) {
+function greyscale (greyscale) {
   this.options.greyscale = is.bool(greyscale) ? greyscale : true;
   return this;
-};
+}
 
 /**
  * Alternative spelling of `greyscale`.
  * @param {Boolean} [grayscale=true]
  * @returns {Sharp}
  */
-const grayscale = function grayscale (grayscale) {
+function grayscale (grayscale) {
   return this.greyscale(grayscale);
-};
+}
 
 /**
  * Set the output colourspace.
@@ -69,13 +69,13 @@ const grayscale = function grayscale (grayscale) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const toColourspace = function toColourspace (colourspace) {
+function toColourspace (colourspace) {
   if (!is.string(colourspace)) {
     throw new Error('Invalid output colourspace ' + colourspace);
   }
   this.options.colourspace = colourspace;
   return this;
-};
+}
 
 /**
  * Alternative spelling of `toColourspace`.
@@ -83,9 +83,9 @@ const toColourspace = function toColourspace (colourspace) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const toColorspace = function toColorspace (colorspace) {
+function toColorspace (colorspace) {
   return this.toColourspace(colorspace);
-};
+}
 
 /**
  * Decorate the Sharp prototype with colour-related functions.

package/lib/composite.js

@@ -8,6 +8,8 @@ const is = require('./is');
  * The overlay image must be the same size or smaller than the processed image.
  * If both `top` and `left` options are provided, they take precedence over `gravity`.
  *
+ * If the overlay image contains an alpha channel then composition with premultiplication will occur.
+ *
  * @example
  * sharp('input.png')
  *   .rotate(180)
@@ -33,14 +35,20 @@ const is = require('./is');
  * @param {Number} [options.left] - the pixel offset from the left edge.
  * @param {Boolean} [options.tile=false] - set to true to repeat the overlay image across the entire image with the given `gravity`.
  * @param {Boolean} [options.cutout=false] - 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.
+ * @param {Number} [options.density=72] - integral number representing the DPI for vector overlay image.
  * @param {Object} [options.raw] - describes overlay when using raw pixel data.
  * @param {Number} [options.raw.width]
  * @param {Number} [options.raw.height]
  * @param {Number} [options.raw.channels]
+ * @param {Object} [options.create] - describes a blank overlay to be created.
+ * @param {Number} [options.create.width]
+ * @param {Number} [options.create.height]
+ * @param {Number} [options.create.channels] - 3-4
+ * @param {String|Object} [options.create.background] - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const overlayWith = function overlayWith (overlay, options) {
+function overlayWith (overlay, options) {
   this.options.overlay = this._createInputDescriptor(overlay, options, {
     allowStream: false
   });
@@ -60,10 +68,7 @@ const overlayWith = function overlayWith (overlay, options) {
       }
     }
     if (is.defined(options.left) || is.defined(options.top)) {
-      if (
-        is.integer(options.left) && is.inRange(options.left, 0, this.constructor.maximum.width) &&
-        is.integer(options.top) && is.inRange(options.top, 0, this.constructor.maximum.height)
-      ) {
+      if (is.integer(options.left) && options.left >= 0 && is.integer(options.top) && options.top >= 0) {
         this.options.overlayXOffset = options.left;
         this.options.overlayYOffset = options.top;
       } else {
@@ -81,7 +86,7 @@ const overlayWith = function overlayWith (overlay, options) {
     }
   }
   return this;
-};
+}
 
 /**
  * Decorate the Sharp prototype with composite-related functions.

package/lib/constructor.js

@@ -5,6 +5,7 @@ const util = require('util');
 const stream = require('stream');
 const events = require('events');
 const semver = require('semver');
+const is = require('./is');
 const sharp = require('../build/Release/sharp.node');
 
 // Versioning
@@ -24,12 +25,15 @@ let versions = {
   } catch (err) {}
 })();
 
+// Use NODE_DEBUG=sharp to enable libvips warnings
+const debuglog = util.debuglog('sharp');
+
 /**
  * @class Sharp
  *
  * Constructor factory to create an instance of `sharp`, to which further methods are chained.
  *
- * JPEG, PNG or WebP format image data can be streamed out from this object.
+ * JPEG, PNG, WebP or TIFF format image data can be streamed out from this object.
  * When using Stream based output, derived attributes are available from the `info` event.
  *
  * Implements the [stream.Duplex](http://nodejs.org/api/stream.html#stream_class_stream_duplex) class.
@@ -54,20 +58,42 @@ let versions = {
  *   });
  * readableStream.pipe(transformer).pipe(writableStream);
  *
+ * @example
+ * // Create a blank 300x200 PNG image of semi-transluent red pixels
+ * sharp({
+ *   create: {
+ *     width: 300,
+ *     height: 200,
+ *     channels: 4,
+ *     background: { r: 255, g: 0, b: 0, alpha: 128 }
+ *   }
+ * })
+ * .png()
+ * .toBuffer()
+ * .then( ... );
+ *
  * @param {(Buffer|String)} [input] - if present, can be
  *  a Buffer containing JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data, or
  *  a String containing the path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file.
- *  JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when null or undefined.
+ *  JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when not present.
  * @param {Object} [options] - if present, is an Object with optional attributes.
  * @param {Number} [options.density=72] - integral number representing the DPI for vector images.
- * @param {Object} [options.raw] - describes raw pixel image data. See `raw()` for pixel ordering.
+ * @param {Object} [options.raw] - describes raw pixel input image data. See `raw()` for pixel ordering.
  * @param {Number} [options.raw.width]
  * @param {Number} [options.raw.height]
- * @param {Number} [options.raw.channels]
+ * @param {Number} [options.raw.channels] - 1-4
+ * @param {Object} [options.create] - describes a new image to be created.
+ * @param {Number} [options.create.width]
+ * @param {Number} [options.create.height]
+ * @param {Number} [options.create.channels] - 3-4
+ * @param {String|Object} [options.create.background] - parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
 const Sharp = function (input, options) {
+  if (arguments.length === 1 && !is.defined(input)) {
+    throw new Error('Invalid input');
+  }
   if (!(this instanceof Sharp)) {
     return new Sharp(input, options);
   }
@@ -75,7 +101,7 @@ const Sharp = function (input, options) {
   this.options = {
     // input options
     sequentialRead: false,
-    limitInputPixels: maximum.pixels,
+    limitInputPixels: Math.pow(0x3FFF, 2),
     // ICC profiles
     iccProfilePath: path.join(__dirname, 'icc') + path.sep,
     // resize options
@@ -91,6 +117,7 @@ const Sharp = function (input, options) {
     height: -1,
     canvas: 'crop',
     crop: 0,
+    useExifOrientation: false,
     angle: 0,
     rotateBeforePreExtract: false,
     flip: false,
@@ -134,6 +161,7 @@ const Sharp = function (input, options) {
     streamOut: false,
     withMetadata: false,
     withMetadataOrientation: -1,
+    resolveWithObject: false,
     // output format
     jpegQuality: 80,
     jpegProgressive: false,
@@ -149,8 +177,15 @@ const Sharp = function (input, options) {
     webpLossless: false,
     webpNearLossless: false,
     tiffQuality: 80,
+    tiffCompression: 'jpeg',
+    tiffPredictor: 'none',
+    tiffSquash: false,
+    tiffXres: 1.0,
+    tiffYres: 1.0,
     tileSize: 256,
     tileOverlap: 0,
+    // Function to notify of libvips warnings
+    debuglog: debuglog,
     // Function to notify of queue length changes
     queueListener: function (queueLength) {
       queue.emit('change', queueLength);
@@ -161,18 +196,6 @@ const Sharp = function (input, options) {
 };
 util.inherits(Sharp, stream.Duplex);
 
-/**
- * Pixel limits.
- * @member
- * @private
- */
-const maximum = {
-  width: 0x3FFF,
-  height: 0x3FFF,
-  pixels: Math.pow(0x3FFF, 2)
-};
-Sharp.maximum = maximum;
-
 /**
  * An EventEmitter that emits a `change` event when a task is either:
  * - queued, waiting for _libuv_ to provide a worker thread
@@ -189,7 +212,7 @@ Sharp.queue = queue;
 /**
  * An Object containing nested boolean values representing the available input and output formats/methods.
  * @example
- * console.log(sharp.format());
+ * console.log(sharp.format);
  * @returns {Object}
  */
 Sharp.format = sharp.format();