sharp 0.20.8 → 0.21.3

package/lib/libvips.js

@@ -44,10 +44,16 @@ const globalLibvipsVersion = function () {
 
 const hasVendoredLibvips = function () {
   const currentPlatformId = platform();
+  const vendorPath = path.join(__dirname, '..', 'vendor');
+  let vendorVersionId;
   let vendorPlatformId;
   try {
-    vendorPlatformId = require(path.join(__dirname, '..', 'vendor', 'platform.json'));
+    vendorVersionId = require(path.join(vendorPath, 'versions.json')).vips;
+    vendorPlatformId = require(path.join(vendorPath, 'platform.json'));
   } catch (err) {}
+  if (vendorVersionId && vendorVersionId !== minimumLibvipsVersion) {
+    throw new Error(`Found vendored libvips v${vendorVersionId} but require v${minimumLibvipsVersion}. Please remove the 'node_modules/sharp/vendor' directory and run 'npm install'.`);
+  }
   if (vendorPlatformId) {
     if (currentPlatformId === vendorPlatformId) {
       return true;

package/lib/operation.js

@@ -1,14 +1,18 @@
 'use strict';
 
+const color = require('color');
 const is = require('./is');
 
 /**
  * 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.
  *
@@ -28,64 +32,30 @@ const is = require('./is');
  *   });
  * readableStream.pipe(pipeline);
  *
- * @param {Number} [angle=auto] angle of rotation, must be a multiple of 90.
+ * @param {Number} [angle=auto] angle of rotation.
+ * @param {Object} [options] - if present, is an Object with optional attributes.
+ * @param {String|Object} [options.background="#000000"] 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
  */
-function rotate (angle) {
+function rotate (angle, options) {
   if (!is.defined(angle)) {
     this.options.useExifOrientation = true;
   } else if (is.integer(angle) && !(angle % 90)) {
     this.options.angle = angle;
-  } else {
-    throw new Error('Unsupported angle: angle must be a positive/negative multiple of 90 ' + angle);
-  }
-  return this;
-}
-
-/**
- * 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.
- *
- * @example
- * 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.
- *   });
- * @example
- * 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
- *   });
- *
- * @param {Object} options
- * @param {Number} options.left - zero-indexed offset from left edge
- * @param {Number} options.top - zero-indexed offset from top edge
- * @param {Number} options.width - dimension of extracted image
- * @param {Number} options.height - dimension of extracted image
- * @returns {Sharp}
- * @throws {Error} Invalid parameters
- */
-function extract (options) {
-  const suffix = this.options.width === -1 && this.options.height === -1 ? 'Pre' : 'Post';
-  ['left', 'top', 'width', 'height'].forEach(function (name) {
-    const value = options[name];
-    if (is.integer(value) && value >= 0) {
-      this.options[name + (name === 'left' || name === 'top' ? 'Offset' : '') + suffix] = value;
-    } else {
-      throw new Error('Non-integer value for ' + name + ' of ' + value);
+  } else if (is.number(angle)) {
+    this.options.rotationAngle = angle;
+    if (is.object(options) && options.background) {
+      const backgroundColour = color(options.background);
+      this.options.rotationBackground = [
+        backgroundColour.red(),
+        backgroundColour.green(),
+        backgroundColour.blue(),
+        Math.round(backgroundColour.alpha() * 255)
+      ];
     }
-  }, this);
-  // Ensure existing rotation occurs before pre-resize extraction
-  if (suffix === 'Pre' && ((this.options.angle % 360) !== 0 || this.options.useExifOrientation === true)) {
-    this.options.rotateBeforePreExtract = true;
+  } else {
+    throw new Error('Unsupported angle: must be a number.');
   }
   return this;
 }
@@ -201,72 +171,15 @@ function blur (sigma) {
 }
 
 /**
- * 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.
- *
- * @example
- * // 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})
- *   ...
- *
- * @param {(Number|Object)} extend - single pixel count to add to all edges or an Object with per-edge counts
- * @param {Number} [extend.top]
- * @param {Number} [extend.left]
- * @param {Number} [extend.bottom]
- * @param {Number} [extend.right]
- * @returns {Sharp}
- * @throws {Error} Invalid parameters
-*/
-function extend (extend) {
-  if (is.integer(extend) && extend > 0) {
-    this.options.extendTop = extend;
-    this.options.extendBottom = extend;
-    this.options.extendLeft = extend;
-    this.options.extendRight = extend;
-  } else if (
-    is.object(extend) &&
-    is.integer(extend.top) && extend.top >= 0 &&
-    is.integer(extend.bottom) && extend.bottom >= 0 &&
-    is.integer(extend.left) && extend.left >= 0 &&
-    is.integer(extend.right) && extend.right >= 0
-  ) {
-    this.options.extendTop = extend.top;
-    this.options.extendBottom = extend.bottom;
-    this.options.extendLeft = extend.left;
-    this.options.extendRight = extend.right;
-  } else {
-    throw new Error('Invalid edge extension ' + extend);
-  }
-  return this;
-}
-
-/**
- * Merge alpha transparency channel, if any, with `background`.
- * @param {Boolean} [flatten=true]
- * @returns {Sharp}
- */
-function flatten (flatten) {
-  this.options.flatten = is.bool(flatten) ? flatten : true;
-  return this;
-}
-
-/**
- * Trim "boring" pixels from all edges that contain values within a percentage similarity of the top-left pixel.
- * @param {Number} [tolerance=10] value between 1 and 99 representing the percentage similarity.
+ * Merge alpha transparency channel, if any, with a background.
+ * @param {Object} [options]
+ * @param {String|Object} [options.background={r: 0, g: 0, b: 0}] - background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black.
  * @returns {Sharp}
- * @throws {Error} Invalid parameters
  */
-function trim (tolerance) {
-  if (!is.defined(tolerance)) {
-    this.options.trimTolerance = 10;
-  } else if (is.integer(tolerance) && is.inRange(tolerance, 1, 99)) {
-    this.options.trimTolerance = tolerance;
-  } else {
-    throw new Error('Invalid trim tolerance (1 to 99) ' + tolerance);
+function flatten (options) {
+  this.options.flatten = is.bool(options) ? options : true;
+  if (is.object(options)) {
+    this._setColourOption('flattenBackground', options.background);
   }
   return this;
 }
@@ -277,11 +190,15 @@ function trim (tolerance) {
  * This can improve the perceived brightness of a resized image in non-linear colour spaces.
  * JPEG and WebP input images will not take advantage of the shrink-on-load performance optimisation
  * when applying a gamma correction.
+ *
+ * Supply a second argument to use a different output gamma value, otherwise the first value is used in both cases.
+ *
  * @param {Number} [gamma=2.2] value between 1.0 and 3.0.
+ * @param {Number} [gammaOut] value between 1.0 and 3.0. (optional, defaults to same as `gamma`)
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function gamma (gamma) {
+function gamma (gamma, gammaOut) {
   if (!is.defined(gamma)) {
     // Default gamma correction of 2.2 (sRGB)
     this.options.gamma = 2.2;
@@ -290,6 +207,14 @@ function gamma (gamma) {
   } else {
     throw new Error('Invalid gamma correction (1.0 to 3.0) ' + gamma);
   }
+  if (!is.defined(gammaOut)) {
+    // Default gamma correction for output is same as input
+    this.options.gammaOut = this.options.gamma;
+  } else if (is.number(gammaOut) && is.inRange(gammaOut, 1, 3)) {
+    this.options.gammaOut = gammaOut;
+  } else {
+    throw new Error('Invalid output gamma correction (1.0 to 3.0) ' + gammaOut);
+  }
   return this;
 }
 
@@ -453,22 +378,56 @@ function linear (a, b) {
   return this;
 }
 
+/**
+ * Recomb the image with the specified matrix.
+ *
+ * @example
+ * sharp(input)
+ *   .recomb([
+ *    [0.3588, 0.7044, 0.1368],
+ *    [0.2990, 0.5870, 0.1140],
+ *    [0.2392, 0.4696, 0.0912],
+ *   ])
+ *   .raw()
+ *   .toBuffer(function(err, data, info) {
+ *     // data contains the raw pixel data after applying the recomb
+ *     // With this example input, a sepia filter has been applied
+ *   });
+ *
+ * @param {Array<Array<Number>>} 3x3 Recombination matrix
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function recomb (inputMatrix) {
+  if (!Array.isArray(inputMatrix) || inputMatrix.length !== 3 ||
+      inputMatrix[0].length !== 3 ||
+      inputMatrix[1].length !== 3 ||
+      inputMatrix[2].length !== 3
+  ) {
+    // must pass in a kernel
+    throw new Error('Invalid Recomb Matrix');
+  }
+  this.options.recombMatrix = [
+    inputMatrix[0][0], inputMatrix[0][1], inputMatrix[0][2],
+    inputMatrix[1][0], inputMatrix[1][1], inputMatrix[1][2],
+    inputMatrix[2][0], inputMatrix[2][1], inputMatrix[2][2]
+  ].map(Number);
+  return this;
+}
+
 /**
  * Decorate the Sharp prototype with operation-related functions.
  * @private
  */
 module.exports = function (Sharp) {
-  [
+  Object.assign(Sharp.prototype, {
     rotate,
-    extract,
     flip,
     flop,
     sharpen,
     median,
     blur,
-    extend,
     flatten,
-    trim,
     gamma,
     negate,
     normalise,
@@ -476,8 +435,7 @@ module.exports = function (Sharp) {
     convolve,
     threshold,
     boolean,
-    linear
-  ].forEach(function (f) {
-    Sharp.prototype[f.name] = f;
+    linear,
+    recomb
   });
 };

package/lib/output.js

@@ -32,7 +32,7 @@ const sharp = require('../build/Release/sharp.node');
  */
 function toFile (fileOut, callback) {
   if (!fileOut || fileOut.length === 0) {
-    const errOutputInvalid = new Error('Invalid output');
+    const errOutputInvalid = new Error('Missing output file path');
     if (is.fn(callback)) {
       callback(errOutputInvalid);
     } else {
@@ -175,30 +175,30 @@ function jpeg (options) {
         throw new Error('Invalid chromaSubsampling (4:2:0, 4:4:4) ' + options.chromaSubsampling);
       }
     }
-    options.trellisQuantisation = is.bool(options.trellisQuantization) ? options.trellisQuantization : options.trellisQuantisation;
-    if (is.defined(options.trellisQuantisation)) {
-      this._setBooleanOption('jpegTrellisQuantisation', options.trellisQuantisation);
+    const trellisQuantisation = is.bool(options.trellisQuantization) ? options.trellisQuantization : options.trellisQuantisation;
+    if (is.defined(trellisQuantisation)) {
+      this._setBooleanOption('jpegTrellisQuantisation', trellisQuantisation);
     }
     if (is.defined(options.overshootDeringing)) {
       this._setBooleanOption('jpegOvershootDeringing', options.overshootDeringing);
     }
-    options.optimiseScans = is.bool(options.optimizeScans) ? options.optimizeScans : options.optimiseScans;
-    if (is.defined(options.optimiseScans)) {
-      this._setBooleanOption('jpegOptimiseScans', options.optimiseScans);
-      if (options.optimiseScans) {
+    const optimiseScans = is.bool(options.optimizeScans) ? options.optimizeScans : options.optimiseScans;
+    if (is.defined(optimiseScans)) {
+      this._setBooleanOption('jpegOptimiseScans', optimiseScans);
+      if (optimiseScans) {
         this.options.jpegProgressive = true;
       }
     }
-    options.optimiseCoding = is.bool(options.optimizeCoding) ? options.optimizeCoding : options.optimiseCoding;
-    if (is.defined(options.optimiseCoding)) {
-      this._setBooleanOption('jpegOptimiseCoding', options.optimiseCoding);
+    const optimiseCoding = is.bool(options.optimizeCoding) ? options.optimizeCoding : options.optimiseCoding;
+    if (is.defined(optimiseCoding)) {
+      this._setBooleanOption('jpegOptimiseCoding', optimiseCoding);
     }
-    options.quantisationTable = is.number(options.quantizationTable) ? options.quantizationTable : options.quantisationTable;
-    if (is.defined(options.quantisationTable)) {
-      if (is.integer(options.quantisationTable) && is.inRange(options.quantisationTable, 0, 8)) {
-        this.options.jpegQuantisationTable = options.quantisationTable;
+    const quantisationTable = is.number(options.quantizationTable) ? options.quantizationTable : options.quantisationTable;
+    if (is.defined(quantisationTable)) {
+      if (is.integer(quantisationTable) && is.inRange(quantisationTable, 0, 8)) {
+        this.options.jpegQuantisationTable = quantisationTable;
       } else {
-        throw new Error('Invalid quantisation table (integer, 0-8) ' + options.quantisationTable);
+        throw new Error('Invalid quantisation table (integer, 0-8) ' + quantisationTable);
       }
     }
   }
@@ -221,6 +221,11 @@ function jpeg (options) {
  * @param {Boolean} [options.progressive=false] - use progressive (interlace) scan
  * @param {Number} [options.compressionLevel=9] - zlib compression level, 0-9
  * @param {Boolean} [options.adaptiveFiltering=false] - use adaptive row filtering
+ * @param {Boolean} [options.palette=false] - quantise to a palette-based image with alpha transparency support, requires libimagequant
+ * @param {Number} [options.quality=100] - use the lowest number of colours needed to achieve given quality, requires libimagequant
+ * @param {Number} [options.colours=256] - maximum number of palette entries, requires libimagequant
+ * @param {Number} [options.colors=256] - alternative spelling of `options.colours`, requires libimagequant
+ * @param {Number} [options.dither=1.0] - level of Floyd-Steinberg error diffusion, requires libimagequant
  * @param {Boolean} [options.force=true] - force PNG output, otherwise attempt to use input format
  * @returns {Sharp}
  * @throws {Error} Invalid options
@@ -240,6 +245,33 @@ function png (options) {
     if (is.defined(options.adaptiveFiltering)) {
       this._setBooleanOption('pngAdaptiveFiltering', options.adaptiveFiltering);
     }
+    if (is.defined(options.palette)) {
+      this._setBooleanOption('pngPalette', options.palette);
+      if (this.options.pngPalette) {
+        if (is.defined(options.quality)) {
+          if (is.integer(options.quality) && is.inRange(options.quality, 0, 100)) {
+            this.options.pngQuality = options.quality;
+          } else {
+            throw is.invalidParameterError('quality', 'integer between 0 and 100', options.quality);
+          }
+        }
+        const colours = options.colours || options.colors;
+        if (is.defined(colours)) {
+          if (is.integer(colours) && is.inRange(colours, 2, 256)) {
+            this.options.pngColours = colours;
+          } else {
+            throw is.invalidParameterError('colours', 'integer between 2 and 256', colours);
+          }
+        }
+        if (is.defined(options.dither)) {
+          if (is.number(options.dither) && is.inRange(options.dither, 0, 1)) {
+            this.options.pngDither = options.dither;
+          } else {
+            throw is.invalidParameterError('dither', 'number between 0.0 and 1.0', options.dither);
+          }
+        }
+      }
+    }
   }
   return this._updateFormatOut('png', options);
 }
@@ -304,6 +336,10 @@ function webp (options) {
  * @param {Boolean} [options.force=true] - force TIFF output, otherwise attempt to use input format
  * @param {Boolean} [options.compression='jpeg'] - compression options: lzw, deflate, jpeg, ccittfax4
  * @param {Boolean} [options.predictor='horizontal'] - compression predictor options: none, horizontal, float
+ * @param {Boolean} [options.pyramid=false] - write an image pyramid
+ * @param {Boolean} [options.tile=false] - write a tiled tiff
+ * @param {Boolean} [options.tileWidth=256] - horizontal tile size
+ * @param {Boolean} [options.tileHeight=256] - vertical tile size
  * @param {Number} [options.xres=1.0] - horizontal resolution in pixels/mm
  * @param {Number} [options.yres=1.0] - vertical resolution in pixels/mm
  * @param {Boolean} [options.squash=false] - squash 8-bit images down to 1 bit
@@ -311,51 +347,83 @@ function webp (options) {
  * @throws {Error} Invalid options
  */
 function tiff (options) {
-  if (is.object(options) && is.defined(options.quality)) {
-    if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
-      this.options.tiffQuality = options.quality;
-    } else {
-      throw new Error('Invalid quality (integer, 1-100) ' + options.quality);
+  if (is.object(options)) {
+    if (is.defined(options.quality)) {
+      if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
+        this.options.tiffQuality = options.quality;
+      } else {
+        throw new Error('Invalid quality (integer, 1-100) ' + options.quality);
+      }
     }
-  }
-  if (is.object(options) && is.defined(options.squash)) {
-    if (is.bool(options.squash)) {
-      this.options.tiffSquash = options.squash;
-    } else {
-      throw new Error('Invalid Value for squash ' + options.squash + ' Only Boolean Values allowed for options.squash.');
+    if (is.defined(options.squash)) {
+      if (is.bool(options.squash)) {
+        this.options.tiffSquash = options.squash;
+      } else {
+        throw new Error('Invalid Value for squash ' + options.squash + ' Only Boolean Values allowed for options.squash.');
+      }
     }
-  }
-  // resolution
-  if (is.object(options) && is.defined(options.xres)) {
-    if (is.number(options.xres)) {
-      this.options.tiffXres = options.xres;
-    } else {
-      throw new Error('Invalid Value for xres ' + options.xres + ' Only numeric values allowed for options.xres');
+    // tiling
+    if (is.defined(options.tile)) {
+      if (is.bool(options.tile)) {
+        this.options.tiffTile = options.tile;
+      } else {
+        throw new Error('Invalid Value for tile ' + options.tile + ' Only Boolean values allowed for options.tile');
+      }
     }
-  }
-  if (is.object(options) && is.defined(options.yres)) {
-    if (is.number(options.yres)) {
-      this.options.tiffYres = options.yres;
-    } else {
-      throw new Error('Invalid Value for yres ' + options.yres + ' Only numeric values allowed for options.yres');
+    if (is.defined(options.tileWidth)) {
+      if (is.number(options.tileWidth) && options.tileWidth > 0) {
+        this.options.tiffTileWidth = options.tileWidth;
+      } else {
+        throw new Error('Invalid Value for tileWidth ' + options.tileWidth + ' Only positive numeric values allowed for options.tileWidth');
+      }
     }
-  }
-  // compression
-  if (is.defined(options) && is.defined(options.compression)) {
-    if (is.string(options.compression) && is.inArray(options.compression, ['lzw', 'deflate', 'jpeg', 'ccittfax4', 'none'])) {
-      this.options.tiffCompression = options.compression;
-    } else {
-      const message = `Invalid compression option "${options.compression}". Should be one of: lzw, deflate, jpeg, ccittfax4, none`;
-      throw new Error(message);
+    if (is.defined(options.tileHeight)) {
+      if (is.number(options.tileHeight) && options.tileHeight > 0) {
+        this.options.tiffTileHeight = options.tileHeight;
+      } else {
+        throw new Error('Invalid Value for tileHeight ' + options.tileHeight + ' Only positive numeric values allowed for options.tileHeight');
+      }
     }
-  }
-  // predictor
-  if (is.defined(options) && is.defined(options.predictor)) {
-    if (is.string(options.predictor) && is.inArray(options.predictor, ['none', 'horizontal', 'float'])) {
-      this.options.tiffPredictor = options.predictor;
-    } else {
-      const message = `Invalid predictor option "${options.predictor}". Should be one of: none, horizontal, float`;
-      throw new Error(message);
+    // pyramid
+    if (is.defined(options.pyramid)) {
+      if (is.bool(options.pyramid)) {
+        this.options.tiffPyramid = options.pyramid;
+      } else {
+        throw new Error('Invalid Value for pyramid ' + options.pyramid + ' Only Boolean values allowed for options.pyramid');
+      }
+    }
+    // resolution
+    if (is.defined(options.xres)) {
+      if (is.number(options.xres)) {
+        this.options.tiffXres = options.xres;
+      } else {
+        throw new Error('Invalid Value for xres ' + options.xres + ' Only numeric values allowed for options.xres');
+      }
+    }
+    if (is.defined(options.yres)) {
+      if (is.number(options.yres)) {
+        this.options.tiffYres = options.yres;
+      } else {
+        throw new Error('Invalid Value for yres ' + options.yres + ' Only numeric values allowed for options.yres');
+      }
+    }
+    // compression
+    if (is.defined(options.compression)) {
+      if (is.string(options.compression) && is.inArray(options.compression, ['lzw', 'deflate', 'jpeg', 'ccittfax4', 'none'])) {
+        this.options.tiffCompression = options.compression;
+      } else {
+        const message = `Invalid compression option "${options.compression}". Should be one of: lzw, deflate, jpeg, ccittfax4, none`;
+        throw new Error(message);
+      }
+    }
+    // predictor
+    if (is.defined(options.predictor)) {
+      if (is.string(options.predictor) && is.inArray(options.predictor, ['none', 'horizontal', 'float'])) {
+        this.options.tiffPredictor = options.predictor;
+      } else {
+        const message = `Invalid predictor option "${options.predictor}". Should be one of: none, horizontal, float`;
+        throw new Error(message);
+      }
     }
   }
   return this._updateFormatOut('tiff', options);
@@ -505,7 +573,9 @@ function tile (tile) {
  * @returns {Sharp}
  */
 function _updateFormatOut (formatOut, options) {
-  this.options.formatOut = (is.object(options) && options.force === false) ? 'input' : formatOut;
+  if (!(is.object(options) && options.force === false)) {
+    this.options.formatOut = formatOut;
+  }
   return this;
 }
 
@@ -641,7 +711,7 @@ function _pipeline (callback) {
  * @private
  */
 module.exports = function (Sharp) {
-  [
+  Object.assign(Sharp.prototype, {
     // Public
     toFile,
     toBuffer,
@@ -658,7 +728,5 @@ module.exports = function (Sharp) {
     _setBooleanOption,
     _read,
     _pipeline
-  ].forEach(function (f) {
-    Sharp.prototype[f.name] = f;
   });
 };

package/lib/platform.js

@@ -1,10 +1,13 @@
 'use strict';
 
+const detectLibc = require('detect-libc');
+
 module.exports = function () {
   const arch = process.env.npm_config_arch || process.arch;
   const platform = process.env.npm_config_platform || process.platform;
+  const libc = (platform === 'linux' && detectLibc.isNonGlibcLinux) ? detectLibc.family : '';
 
-  const platformId = [platform];
+  const platformId = [`${platform}${libc}`];
   if (arch === 'arm' || arch === 'armhf' || arch === 'arm64') {
     const armVersion = (arch === 'arm64') ? '8' : process.env.npm_config_armv || process.config.variables.arm_version || '6';
     platformId.push(`armv${armVersion}`);