sharp 0.33.5 → 0.35.3

package/{lib/operation.js → dist/operation.mjs}

@@ -1,10 +1,9 @@
-// Copyright 2013 Lovell Fuller and others.
-// SPDX-License-Identifier: Apache-2.0
+/*!
+  Copyright 2013 Lovell Fuller and others.
+  SPDX-License-Identifier: Apache-2.0
+*/
 
-'use strict';
-
-const color = require('color');
-const is = require('./is');
+import is from './is.mjs';
 
 /**
  * How accurate an operation should be.
@@ -18,22 +17,19 @@ const vipsPrecision = {
 };
 
 /**
- * Rotate the output image by either an explicit angle
- * or auto-orient based on the EXIF `Orientation` tag.
+ * Rotate the output image.
  *
- * If an angle is provided, it is converted to a valid positive degree rotation.
+ * The provided angle is converted to a valid positive degree rotation.
  * For example, `-450` will produce a 270 degree 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.
- *
- * The use of `rotate` without an angle will remove the EXIF `Orientation` tag, if any.
+ * For backwards compatibility, if no angle is provided, `.autoOrient()` will be called.
  *
- * Only one rotation can occur per pipeline.
- * Previous calls to `rotate` in the same pipeline will be ignored.
+ * Only one rotation can occur per pipeline (aside from an initial call without
+ * arguments to orient via EXIF data). Previous calls to `rotate` in the same
+ * pipeline will be ignored.
  *
  * Multi-page images can only be rotated by 180 degrees.
  *
@@ -41,17 +37,6 @@ const vipsPrecision = {
  * for example `.rotate(x).extract(y)` will produce a different result to `.extract(y).rotate(x)`.
  *
  * @example
- * const pipeline = sharp()
- *   .rotate()
- *   .resize(null, 200)
- *   .toBuffer(function (err, outputBuffer, info) {
- *     // outputBuffer contains 200px high JPEG image data,
- *     // auto-rotated using EXIF Orientation tag
- *     // info.width and info.height contain the dimensions of the resized image
- *   });
- * readableStream.pipe(pipeline);
- *
- * @example
  * const rotateThenResize = await sharp(input)
  *   .rotate(90)
  *   .resize({ width: 16, height: 8, fit: 'fill' })
@@ -68,23 +53,20 @@ const vipsPrecision = {
  * @throws {Error} Invalid parameters
  */
 function rotate (angle, options) {
-  if (this.options.useExifOrientation || this.options.angle || this.options.rotationAngle) {
+  if (!is.defined(angle)) {
+    return this.autoOrient();
+  }
+  if (this.options.angle || this.options.rotationAngle) {
     this.options.debuglog('ignoring previous rotate options');
+    this.options.angle = 0;
+    this.options.rotationAngle = 0;
   }
-  if (!is.defined(angle)) {
-    this.options.useExifOrientation = true;
-  } else if (is.integer(angle) && !(angle % 90)) {
+  if (is.integer(angle) && !(angle % 90)) {
     this.options.angle = angle;
   } 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._setBackgroundColourOption('rotationBackground', options.background);
     }
   } else {
     throw is.invalidParameterError('angle', 'numeric', angle);
@@ -92,6 +74,34 @@ function rotate (angle, options) {
   return this;
 }
 
+/**
+ * Auto-orient based on the EXIF `Orientation` tag, then remove the tag.
+ * Mirroring is supported and may infer the use of a flip operation.
+ *
+ * Previous or subsequent use of `rotate(angle)` and either `flip()` or `flop()`
+ * will logically occur after auto-orientation, regardless of call order.
+ *
+ * @example
+ * const output = await sharp(input).autoOrient().toBuffer();
+ *
+ * @example
+ * const pipeline = sharp()
+ *   .autoOrient()
+ *   .resize(null, 200)
+ *   .toBuffer(function (err, outputBuffer, info) {
+ *     // outputBuffer contains 200px high JPEG image data,
+ *     // auto-oriented using EXIF Orientation tag
+ *     // info.width and info.height contain the dimensions of the resized image
+ *   });
+ * readableStream.pipe(pipeline);
+ *
+ * @returns {Sharp}
+ */
+function autoOrient () {
+  this.options.input.autoOrient = true;
+  return this;
+}
+
 /**
  * Mirror the image vertically (up-down) about the x-axis.
  * This always occurs before rotation, if any.
@@ -128,7 +138,7 @@ function flop (flop) {
  * Perform an affine transform on an image. This operation will always occur after resizing, extraction and rotation, if any.
  *
  * You must provide an array of length 4 or a 2x2 affine transformation matrix.
- * By default, new pixels are filled with a black background. You can provide a background color with the `background` option.
+ * By default, new pixels are filled with a black background. You can provide a background colour with the `background` option.
  * A particular interpolator may also be specified. Set the `interpolator` option to an attribute of the `sharp.interpolators` Object e.g. `sharp.interpolators.nohalo`.
  *
  * In the case of a 2x2 matrix, the transform is:
@@ -168,7 +178,13 @@ function flop (flop) {
  * @throws {Error} Invalid parameters
  */
 function affine (matrix, options) {
-  const flatMatrix = [].concat(...matrix);
+  const isValidShape = Array.isArray(matrix) && (
+    // 1x4 array of numbers
+    (matrix.length === 4 && matrix.every(is.number)) ||
+    // 2x2 array of arrays of numbers
+    (matrix.length === 2 && matrix.every((row) => Array.isArray(row) && row.length === 2))
+  );
+  const flatMatrix = isValidShape ? matrix.flat() : [];
   if (flatMatrix.length === 4 && flatMatrix.every(is.number)) {
     this.options.affineMatrix = flatMatrix;
   } else {
@@ -229,7 +245,7 @@ function affine (matrix, options) {
  * When a `sigma` is provided, performs a slower, more accurate sharpen of the L channel in the LAB colour space.
  * Fine-grained control over the level of sharpening in "flat" (m1) and "jagged" (m2) areas is available.
  *
- * See {@link https://www.libvips.org/API/current/libvips-convolution.html#vips-sharpen|libvips sharpen} operation.
+ * See {@link https://www.libvips.org/API/current/method.Image.sharpen.html libvips sharpen} operation.
  *
  * @example
  * const data = await sharp(input).sharpen().toBuffer();
@@ -249,45 +265,18 @@ function affine (matrix, options) {
  *   })
  *   .toBuffer();
  *
- * @param {Object|number} [options] - if present, is an Object with attributes
+ * @param {Object} [options] - if present, is an Object with attributes
  * @param {number} [options.sigma] - the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`, between 0.000001 and 10
  * @param {number} [options.m1=1.0] - the level of sharpening to apply to "flat" areas, between 0 and 1000000
  * @param {number} [options.m2=2.0] - the level of sharpening to apply to "jagged" areas, between 0 and 1000000
  * @param {number} [options.x1=2.0] - threshold between "flat" and "jagged", between 0 and 1000000
  * @param {number} [options.y2=10.0] - maximum amount of brightening, between 0 and 1000000
  * @param {number} [options.y3=20.0] - maximum amount of darkening, between 0 and 1000000
- * @param {number} [flat] - (deprecated) see `options.m1`.
- * @param {number} [jagged] - (deprecated) see `options.m2`.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function sharpen (options, flat, jagged) {
-  if (!is.defined(options)) {
-    // No arguments: default to mild sharpen
-    this.options.sharpenSigma = -1;
-  } else if (is.bool(options)) {
-    // Deprecated boolean argument: apply mild sharpen?
-    this.options.sharpenSigma = options ? -1 : 0;
-  } else if (is.number(options) && is.inRange(options, 0.01, 10000)) {
-    // Deprecated numeric argument: specific sigma
-    this.options.sharpenSigma = options;
-    // Deprecated control over flat areas
-    if (is.defined(flat)) {
-      if (is.number(flat) && is.inRange(flat, 0, 10000)) {
-        this.options.sharpenM1 = flat;
-      } else {
-        throw is.invalidParameterError('flat', 'number between 0 and 10000', flat);
-      }
-    }
-    // Deprecated control over jagged areas
-    if (is.defined(jagged)) {
-      if (is.number(jagged) && is.inRange(jagged, 0, 10000)) {
-        this.options.sharpenM2 = jagged;
-      } else {
-        throw is.invalidParameterError('jagged', 'number between 0 and 10000', jagged);
-      }
-    }
-  } else if (is.plainObject(options)) {
+function sharpen (options) {
+  if (is.plainObject(options)) {
     if (is.number(options.sigma) && is.inRange(options.sigma, 0.000001, 10)) {
       this.options.sharpenSigma = options.sigma;
     } else {
@@ -329,7 +318,7 @@ function sharpen (options, flat, jagged) {
       }
     }
   } else {
-    throw is.invalidParameterError('sigma', 'number between 0.01 and 10000', options);
+    this.options.sharpenSigma = -1;
   }
   return this;
 }
@@ -426,10 +415,56 @@ function blur (options) {
   return this;
 }
 
+/**
+ * Expand foreground objects using the dilate morphological operator.
+ *
+ * @example
+ * const output = await sharp(input)
+ *   .dilate()
+ *   .toBuffer();
+ *
+ * @param {Number} [width=1] dilation width in pixels.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function dilate (width) {
+  if (!is.defined(width)) {
+    this.options.dilateWidth = 1;
+  } else if (is.integer(width) && is.inRange(width, 1, 65536)) {
+    this.options.dilateWidth = width;
+  } else {
+    throw is.invalidParameterError('width', 'integer between 1 and 65536', width);
+  }
+  return this;
+}
+
+/**
+ * Shrink foreground objects using the erode morphological operator.
+ *
+ * @example
+ * const output = await sharp(input)
+ *   .erode()
+ *   .toBuffer();
+ *
+ * @param {Number} [width=1] erosion width in pixels.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function erode (width) {
+  if (!is.defined(width)) {
+    this.options.erodeWidth = 1;
+  } else if (is.integer(width) && is.inRange(width, 1, 65536)) {
+    this.options.erodeWidth = width;
+  } else {
+    throw is.invalidParameterError('width', 'integer between 1 and 65536', width);
+  }
+  return this;
+}
+
 /**
  * Merge alpha transparency channel, if any, with a background, then remove the alpha channel.
  *
- * See also {@link /api-channel#removealpha|removeAlpha}.
+ * See also {@link /api-channel#removealpha removeAlpha}.
  *
  * @example
  * await sharp(rgbaInput)
@@ -454,8 +489,6 @@ function flatten (options) {
  *
  * Existing alpha channel values for non-white pixels remain unchanged.
  *
- * This feature is experimental and the API may change.
- *
  * @since 0.32.1
  *
  * @example
@@ -604,7 +637,7 @@ function normalize (options) {
 
 /**
  * Perform contrast limiting adaptive histogram equalization
- * {@link https://en.wikipedia.org/wiki/Adaptive_histogram_equalization#Contrast_Limited_AHE|CLAHE}.
+ * {@link https://en.wikipedia.org/wiki/Adaptive_histogram_equalization#Contrast_Limited_AHE CLAHE}.
  *
  * This will, in general, enhance the clarity of the image by bringing out darker details.
  *
@@ -619,23 +652,23 @@ function normalize (options) {
  *   .toBuffer();
  *
  * @param {Object} options
- * @param {number} options.width - Integral width of the search window, in pixels.
- * @param {number} options.height - Integral height of the search window, in pixels.
+ * @param {number} options.width - Integral width of the search window, in pixels, between 1 and 65536.
+ * @param {number} options.height - Integral height of the search window, in pixels, between 1 and 65536.
  * @param {number} [options.maxSlope=3] - Integral level of brightening, between 0 and 100, where 0 disables contrast limiting.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
 function clahe (options) {
   if (is.plainObject(options)) {
-    if (is.integer(options.width) && options.width > 0) {
+    if (is.integer(options.width) && is.inRange(options.width, 1, 65536)) {
       this.options.claheWidth = options.width;
     } else {
-      throw is.invalidParameterError('width', 'integer greater than zero', options.width);
+      throw is.invalidParameterError('width', 'integer between 1 and 65536', options.width);
     }
-    if (is.integer(options.height) && options.height > 0) {
+    if (is.integer(options.height) && is.inRange(options.height, 1, 65536)) {
       this.options.claheHeight = options.height;
     } else {
-      throw is.invalidParameterError('height', 'integer greater than zero', options.height);
+      throw is.invalidParameterError('height', 'integer between 1 and 65536', options.height);
     }
     if (is.defined(options.maxSlope)) {
       if (is.integer(options.maxSlope) && is.inRange(options.maxSlope, 0, 100)) {
@@ -679,16 +712,15 @@ function convolve (kernel) {
   if (!is.object(kernel) || !Array.isArray(kernel.kernel) ||
       !is.integer(kernel.width) || !is.integer(kernel.height) ||
       !is.inRange(kernel.width, 3, 1001) || !is.inRange(kernel.height, 3, 1001) ||
-      kernel.height * kernel.width !== kernel.kernel.length
+      kernel.height * kernel.width !== kernel.kernel.length ||
+      !kernel.kernel.every(is.number)
   ) {
     // must pass in a kernel
     throw new Error('Invalid convolution kernel');
   }
   // Default scale is sum of kernel values
   if (!is.integer(kernel.scale)) {
-    kernel.scale = kernel.kernel.reduce(function (a, b) {
-      return a + b;
-    }, 0);
+    kernel.scale = kernel.kernel.reduce((a, b) => a + b, 0);
   }
   // Clip scale to a minimum value of 1
   if (kernel.scale < 1) {
@@ -834,12 +866,16 @@ function recomb (inputMatrix) {
   if (!Array.isArray(inputMatrix)) {
     throw is.invalidParameterError('inputMatrix', 'array', inputMatrix);
   }
-  if (inputMatrix.length !== 3 && inputMatrix.length !== 4) {
-    throw is.invalidParameterError('inputMatrix', '3x3 or 4x4 array', inputMatrix.length);
+  const dimensions = inputMatrix.length;
+  if (dimensions !== 3 && dimensions !== 4) {
+    throw is.invalidParameterError('inputMatrix', '3x3 or 4x4 array', dimensions);
+  }
+  if (!inputMatrix.every((row) => Array.isArray(row) && row.length === dimensions)) {
+    throw is.invalidParameterError('inputMatrix', `array of ${dimensions} arrays of length ${dimensions}`, inputMatrix);
   }
-  const recombMatrix = inputMatrix.flat().map(Number);
-  if (recombMatrix.length !== 9 && recombMatrix.length !== 16) {
-    throw is.invalidParameterError('inputMatrix', 'cardinality of 9 or 16', recombMatrix.length);
+  const recombMatrix = inputMatrix.flat();
+  if (!recombMatrix.every(is.number)) {
+    throw is.invalidParameterError('inputMatrix', 'array of numbers', recombMatrix);
   }
   this.options.recombMatrix = recombMatrix;
   return this;
@@ -930,15 +966,19 @@ function modulate (options) {
 
 /**
  * Decorate the Sharp prototype with operation-related functions.
+ * @module Sharp
  * @private
  */
-module.exports = function (Sharp) {
+export default (Sharp) => {
   Object.assign(Sharp.prototype, {
+    autoOrient,
     rotate,
     flip,
     flop,
     affine,
     sharpen,
+    erode,
+    dilate,
     median,
     blur,
     flatten,