sharp 0.17.2 → 0.18.2

package/lib/input.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const util = require('util');
+const color = require('color');
 const is = require('./is');
 const sharp = require('../build/Release/sharp.node');
 
@@ -8,7 +8,7 @@ const sharp = require('../build/Release/sharp.node');
  * Create Object containing input and input-related options.
  * @private
  */
-const _createInputDescriptor = function _createInputDescriptor (input, inputOptions, containerOptions) {
+function _createInputDescriptor (input, inputOptions, containerOptions) {
   const inputDescriptor = {};
   if (is.string(input)) {
     // filesystem
@@ -16,6 +16,9 @@ const _createInputDescriptor = function _createInputDescriptor (input, inputOpti
   } else if (is.buffer(input)) {
     // Buffer
     inputDescriptor.buffer = input;
+  } else if (is.plainObject(input) && !is.defined(inputOptions)) {
+    // Plain Object descriptor, e.g. create
+    inputOptions = input;
   } else if (!is.defined(input) && is.object(containerOptions) && containerOptions.allowStream) {
     // Stream
     inputDescriptor.buffer = [];
@@ -35,8 +38,8 @@ const _createInputDescriptor = function _createInputDescriptor (input, inputOpti
     if (is.defined(inputOptions.raw)) {
       if (
         is.object(inputOptions.raw) &&
-        is.integer(inputOptions.raw.width) && is.inRange(inputOptions.raw.width, 1, this.constructor.maximum.width) &&
-        is.integer(inputOptions.raw.height) && is.inRange(inputOptions.raw.height, 1, this.constructor.maximum.height) &&
+        is.integer(inputOptions.raw.width) && inputOptions.raw.width > 0 &&
+        is.integer(inputOptions.raw.height) && inputOptions.raw.height > 0 &&
         is.integer(inputOptions.raw.channels) && is.inRange(inputOptions.raw.channels, 1, 4)
       ) {
         inputDescriptor.rawWidth = inputOptions.raw.width;
@@ -46,11 +49,35 @@ const _createInputDescriptor = function _createInputDescriptor (input, inputOpti
         throw new Error('Expected width, height and channels for raw pixel input');
       }
     }
+    // Create new image
+    if (is.defined(inputOptions.create)) {
+      if (
+        is.object(inputOptions.create) &&
+        is.integer(inputOptions.create.width) && inputOptions.create.width > 0 &&
+        is.integer(inputOptions.create.height) && inputOptions.create.height > 0 &&
+        is.integer(inputOptions.create.channels) && is.inRange(inputOptions.create.channels, 3, 4) &&
+        is.defined(inputOptions.create.background)
+      ) {
+        inputDescriptor.createWidth = inputOptions.create.width;
+        inputDescriptor.createHeight = inputOptions.create.height;
+        inputDescriptor.createChannels = inputOptions.create.channels;
+        const background = color(inputOptions.create.background);
+        inputDescriptor.createBackground = [
+          background.red(),
+          background.green(),
+          background.blue(),
+          Math.round(background.alpha() * 255)
+        ];
+        delete inputDescriptor.buffer;
+      } else {
+        throw new Error('Expected width, height, channels and background to create a new input image');
+      }
+    }
   } else if (is.defined(inputOptions)) {
     throw new Error('Invalid input options ' + inputOptions);
   }
   return inputDescriptor;
-};
+}
 
 /**
  * Handle incoming Buffer chunk on Writable Stream.
@@ -59,7 +86,7 @@ const _createInputDescriptor = function _createInputDescriptor (input, inputOpti
  * @param {String} encoding - unused
  * @param {Function} callback
  */
-const _write = function _write (chunk, encoding, callback) {
+function _write (chunk, encoding, callback) {
   /* istanbul ignore else */
   if (Array.isArray(this.options.input.buffer)) {
     /* istanbul ignore else */
@@ -78,26 +105,26 @@ const _write = function _write (chunk, encoding, callback) {
   } else {
     callback(new Error('Unexpected data on Writable Stream'));
   }
-};
+}
 
 /**
  * Flattens the array of chunks accumulated in input.buffer.
  * @private
  */
-const _flattenBufferIn = function _flattenBufferIn () {
+function _flattenBufferIn () {
   if (this._isStreamInput()) {
     this.options.input.buffer = Buffer.concat(this.options.input.buffer);
   }
-};
+}
 
 /**
  * Are we expecting Stream-based input?
  * @private
  * @returns {Boolean}
  */
-const _isStreamInput = function _isStreamInput () {
+function _isStreamInput () {
   return Array.isArray(this.options.input.buffer);
-};
+}
 
 /**
  * Take a "snapshot" of the Sharp instance, returning a new instance.
@@ -114,11 +141,11 @@ const _isStreamInput = function _isStreamInput () {
  *
  * @returns {Sharp}
  */
-const clone = function clone () {
+function clone () {
   const that = this;
   // Clone existing options
   const clone = this.constructor.call();
-  util._extend(clone.options, this.options);
+  clone.options = Object.assign({}, this.options);
   // Pass 'finish' event to clone for Stream-based input
   this.on('finish', function () {
     // Clone inherits input data
@@ -127,17 +154,18 @@ const clone = function clone () {
     clone.emit('finish');
   });
   return clone;
-};
+}
 
 /**
- * Fast access to image metadata without decoding any compressed image data.
+ * Fast access to (uncached) image metadata without decoding any compressed image data.
  * 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`
  * - `width`: Number of pixels wide
  * - `height`: Number of pixels high
- * - `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L568)
+ * - `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L636)
  * - `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
+ * - `depth`: Name of pixel depth format e.g. `uchar`, `char`, `ushort`, `float` [...](https://github.com/jcupitt/libvips/blob/master/libvips/iofuncs/enumtypes.c#L672)
  * - `density`: Number of pixels per inch (DPI), if present
  * - `hasProfile`: Boolean indicating the presence of an embedded ICC profile
  * - `hasAlpha`: Boolean indicating the presence of an alpha transparency channel
@@ -162,7 +190,7 @@ const clone = function clone () {
  * @param {Function} [callback] - called with the arguments `(err, metadata)`
  * @returns {Promise<Object>|Sharp}
  */
-const metadata = function metadata (callback) {
+function metadata (callback) {
   const that = this;
   if (is.fn(callback)) {
     if (this._isStreamInput()) {
@@ -200,7 +228,7 @@ const metadata = function metadata (callback) {
       });
     }
   }
-};
+}
 
 /**
  * Do not process input images where the number of pixels (width * height) exceeds this limit.
@@ -210,20 +238,20 @@ const metadata = function metadata (callback) {
  * @returns {Sharp}
  * @throws {Error} Invalid limit
 */
-const limitInputPixels = function limitInputPixels (limit) {
+function limitInputPixels (limit) {
   // if we pass in false we represent the integer as 0 to disable
   if (limit === false) {
     limit = 0;
   } else if (limit === true) {
-    limit = this.constructor.maximum.pixels;
+    limit = Math.pow(0x3FFF, 2);
   }
   if (is.integer(limit) && limit >= 0) {
     this.options.limitInputPixels = limit;
   } else {
-    throw new Error('Invalid pixel limit (0 to ' + this.constructor.maximum.pixels + ') ' + limit);
+    throw is.invalidParameterError('limitInputPixels', 'integer', limit);
   }
   return this;
-};
+}
 
 /**
  * An advanced setting that switches the libvips access method to `VIPS_ACCESS_SEQUENTIAL`.
@@ -231,10 +259,10 @@ const limitInputPixels = function limitInputPixels (limit) {
  * @param {Boolean} [sequentialRead=true]
  * @returns {Sharp}
  */
-const sequentialRead = function sequentialRead (sequentialRead) {
+function sequentialRead (sequentialRead) {
   this.options.sequentialRead = is.bool(sequentialRead) ? sequentialRead : true;
   return this;
-};
+}
 
 /**
  * Decorate the Sharp prototype with input-related functions.

package/lib/is.js

@@ -16,6 +16,14 @@ const object = function (val) {
   return typeof val === 'object';
 };
 
+/**
+ * Is this value a plain object?
+ * @private
+ */
+const plainObject = function (val) {
+  return object(val) && Object.prototype.toString.call(val) === '[object Object]';
+};
+
 /**
  * Is this value a function?
  * @private
@@ -98,6 +106,7 @@ const invalidParameterError = function (name, expected, actual) {
 module.exports = {
   defined: defined,
   object: object,
+  plainObject: plainObject,
   fn: fn,
   bool: bool,
   buffer: buffer,

package/lib/operation.js

@@ -6,7 +6,10 @@ const is = require('./is');
  * Rotate the output image by either an explicit angle
  * or auto-orient based on the EXIF `Orientation` tag.
  *
- * Use this method without angle to determine the angle from EXIF data.
+ * If an angle is provided, it is converted to a valid 90/180/270deg rotation.
+ * For example, `-450` will produce a 270deg rotation.
+ *
+ * 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` implies the removal of the EXIF `Orientation` tag, if any.
@@ -25,20 +28,20 @@ const is = require('./is');
  *   });
  * readableStream.pipe(pipeline);
  *
- * @param {Number} [angle=auto] 0, 90, 180 or 270.
+ * @param {Number} [angle=auto] angle of rotation, must be a multiple of 90.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const rotate = function rotate (angle) {
+function rotate (angle) {
   if (!is.defined(angle)) {
-    this.options.angle = -1;
-  } else if (is.integer(angle) && is.inArray(angle, [0, 90, 180, 270])) {
+    this.options.useExifOrientation = true;
+  } else if (is.integer(angle) && !(angle % 90)) {
     this.options.angle = angle;
   } else {
-    throw new Error('Unsupported angle (0, 90, 180, 270) ' + angle);
+    throw new Error('Unsupported angle: angle must be a positive/negative multiple of 90 ' + angle);
   }
   return this;
-};
+}
 
 /**
  * Extract a region of the image.
@@ -70,7 +73,7 @@ const rotate = function rotate (angle) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const extract = function extract (options) {
+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];
@@ -81,11 +84,11 @@ const extract = function extract (options) {
     }
   }, this);
   // Ensure existing rotation occurs before pre-resize extraction
-  if (suffix === 'Pre' && this.options.angle !== 0) {
+  if (suffix === 'Pre' && ((this.options.angle % 360) !== 0 || this.options.useExifOrientation === true)) {
     this.options.rotateBeforePreExtract = true;
   }
   return this;
-};
+}
 
 /**
  * Flip the image about the vertical Y axis. This always occurs after rotation, if any.
@@ -93,10 +96,10 @@ const extract = function extract (options) {
  * @param {Boolean} [flip=true]
  * @returns {Sharp}
  */
-const flip = function flip (flip) {
+function flip (flip) {
   this.options.flip = is.bool(flip) ? flip : true;
   return this;
-};
+}
 
 /**
  * Flop the image about the horizontal X axis. This always occurs after rotation, if any.
@@ -104,10 +107,10 @@ const flip = function flip (flip) {
  * @param {Boolean} [flop=true]
  * @returns {Sharp}
  */
-const flop = function flop (flop) {
+function flop (flop) {
   this.options.flop = is.bool(flop) ? flop : true;
   return this;
-};
+}
 
 /**
  * Sharpen the image.
@@ -121,7 +124,7 @@ const flop = function flop (flop) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const sharpen = function sharpen (sigma, flat, jagged) {
+function sharpen (sigma, flat, jagged) {
   if (!is.defined(sigma)) {
     // No arguments: default to mild sharpen
     this.options.sharpenSigma = -1;
@@ -151,7 +154,7 @@ const sharpen = function sharpen (sigma, flat, jagged) {
     throw new Error('Invalid sharpen sigma (0.01 - 10000) ' + sigma);
   }
   return this;
-};
+}
 
 /**
  * Blur the image.
@@ -161,7 +164,7 @@ const sharpen = function sharpen (sigma, flat, jagged) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const blur = function blur (sigma) {
+function blur (sigma) {
   if (!is.defined(sigma)) {
     // No arguments: default to mild blur
     this.options.blurSigma = -1;
@@ -175,7 +178,7 @@ const blur = function blur (sigma) {
     throw new Error('Invalid blur sigma (0.3 - 1000.0) ' + sigma);
   }
   return this;
-};
+}
 
 /**
  * Extends/pads the edges of the image with the colour provided to the `background` method.
@@ -198,7 +201,7 @@ const blur = function blur (sigma) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
 */
-const extend = function extend (extend) {
+function extend (extend) {
   if (is.integer(extend) && extend > 0) {
     this.options.extendTop = extend;
     this.options.extendBottom = extend;
@@ -219,17 +222,17 @@ const extend = function extend (extend) {
     throw new Error('Invalid edge extension ' + extend);
   }
   return this;
-};
+}
 
 /**
  * Merge alpha transparency channel, if any, with `background`.
  * @param {Boolean} [flatten=true]
  * @returns {Sharp}
  */
-const flatten = function flatten (flatten) {
+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.
@@ -237,7 +240,7 @@ const flatten = function flatten (flatten) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const trim = function trim (tolerance) {
+function trim (tolerance) {
   if (!is.defined(tolerance)) {
     this.options.trimTolerance = 10;
   } else if (is.integer(tolerance) && is.inRange(tolerance, 1, 99)) {
@@ -246,7 +249,7 @@ const trim = function trim (tolerance) {
     throw new Error('Invalid trim tolerance (1 to 99) ' + tolerance);
   }
   return this;
-};
+}
 
 /**
  * Apply a gamma correction by reducing the encoding (darken) pre-resize at a factor of `1/gamma`
@@ -258,7 +261,7 @@ const trim = function trim (tolerance) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const gamma = function gamma (gamma) {
+function gamma (gamma) {
   if (!is.defined(gamma)) {
     // Default gamma correction of 2.2 (sRGB)
     this.options.gamma = 2.2;
@@ -268,36 +271,36 @@ const gamma = function gamma (gamma) {
     throw new Error('Invalid gamma correction (1.0 to 3.0) ' + gamma);
   }
   return this;
-};
+}
 
 /**
  * Produce the "negative" of the image.
  * @param {Boolean} [negate=true]
  * @returns {Sharp}
  */
-const negate = function negate (negate) {
+function negate (negate) {
   this.options.negate = is.bool(negate) ? negate : true;
   return this;
-};
+}
 
 /**
  * Enhance output image contrast by stretching its luminance to cover the full dynamic range.
  * @param {Boolean} [normalise=true]
  * @returns {Sharp}
  */
-const normalise = function normalise (normalise) {
+function normalise (normalise) {
   this.options.normalise = is.bool(normalise) ? normalise : true;
   return this;
-};
+}
 
 /**
  * Alternative spelling of normalise.
  * @param {Boolean} [normalize=true]
  * @returns {Sharp}
  */
-const normalize = function normalize (normalize) {
+function normalize (normalize) {
   return this.normalise(normalize);
-};
+}
 
 /**
  * Convolve the image with the specified kernel.
@@ -324,7 +327,7 @@ const normalize = function normalize (normalize) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const convolve = function convolve (kernel) {
+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) ||
@@ -348,7 +351,7 @@ const convolve = function convolve (kernel) {
   }
   this.options.convKernel = kernel;
   return this;
-};
+}
 
 /**
  * Any pixel value greather than or equal to the threshold value will be set to 255, otherwise it will be set to 0.
@@ -359,7 +362,7 @@ const convolve = function convolve (kernel) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const threshold = function threshold (threshold, options) {
+function threshold (threshold, options) {
   if (!is.defined(threshold)) {
     this.options.threshold = 128;
   } else if (is.bool(threshold)) {
@@ -375,7 +378,7 @@ const threshold = function threshold (threshold, options) {
     this.options.thresholdGrayscale = false;
   }
   return this;
-};
+}
 
 /**
  * Perform a bitwise boolean operation with operand image.
@@ -393,7 +396,7 @@ const threshold = function threshold (threshold, options) {
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-const boolean = function boolean (operand, operator, options) {
+function boolean (operand, operator, options) {
   this.options.boolean = this._createInputDescriptor(operand, options);
   if (is.string(operator) && is.inArray(operator, ['and', 'or', 'eor'])) {
     this.options.booleanOp = operator;
@@ -401,7 +404,7 @@ const boolean = function boolean (operand, operator, options) {
     throw new Error('Invalid boolean operator ' + operator);
   }
   return this;
-};
+}
 
 /**
  * Decorate the Sharp prototype with operation-related functions.