sharp - npm Package Compare versions

Comparing version 0.29.0 to 0.29.1

lib/constructor.js

@@ -202,2 +202,3 @@ 'use strict';
     hue: 0,
+    lightness: 0,
     booleanBufferIn: null,
@@ -236,4 +237,9 @@ booleanFileIn: '',
     pngQuality: 100,
-    pngColours: 256,
+    pngBitdepth: 8,
     pngDither: 1,
+    jp2Quality: 80,
+    jp2TileHeight: 512,
+    jp2TileWidth: 512,
+    jp2Lossless: false,
+    jp2ChromaSubsampling: '4:4:4',
     webpQuality: 80,
@@ -240,0 +246,0 @@ webpAlphaQuality: 100,

lib/operation.js

@@ -573,3 +573,5 @@ 'use strict';
 /**
- * Transforms the image using brightness, saturation and hue rotation.
+ * Transforms the image using brightness, saturation, hue rotation, and lightness.
+ * Brightness and lightness both operate on luminance, with the difference being that
+ * brightness is multiplicative whereas lightness is additive.
  *
@@ -581,3 +583,3 @@ * @since 0.22.1
  *   .modulate({
- *     brightness: 2 // increase lightness by a factor of 2
+ *     brightness: 2 // increase brightness by a factor of 2
  *   });
@@ -590,2 +592,7 @@ *
  *
+ * sharp(input)
+ *   .modulate({
+ *     lightness: 50 // increase lightness by +50
+ *   });
+ *
  * // decreate brightness and saturation while also hue-rotating by 90 degrees
@@ -603,2 +610,3 @@ * sharp(input)
  * @param {number} [options.hue] Degrees for hue rotation
+ * @param {number} [options.lightness] Lightness addend
  * @returns {Sharp}
@@ -631,2 +639,9 @@ */
   }
+  if ('lightness' in options) {
+    if (is.number(options.lightness)) {
+      this.options.lightness = options.lightness;
+    } else {
+      throw is.invalidParameterError('lightness', 'number', options.lightness);
+    }
+  }
   return this;
@@ -633,0 +648,0 @@ }

lib/output.js

 'use strict';
 
+const path = require('path');
 const is = require('./is');
@@ -16,6 +17,11 @@ const sharp = require('./sharp');
   ['webp', 'webp'],
-  ['gif', 'gif']
+  ['gif', 'gif'],
+  ['jp2', 'jp2'],
+  ['jpx', 'jp2'],
+  ['j2k', 'jp2'],
+  ['j2c', 'jp2']
 ]);
 
 const errMagickSave = new Error('GIF output requires libvips with support for ImageMagick');
+const errJp2Save = new Error('JP2 output requires libvips with support for OpenJPEG');
 
@@ -32,2 +38,4 @@ /**
  *
+ * The caller is responsible for ensuring directory structures and permissions exist.
+ *
  * A `Promise` is returned when `callback` is not provided.
@@ -57,3 +65,3 @@ *
     err = new Error('Missing output file path');
-  } else if (this.options.input.file === fileOut) {
+  } else if (is.string(this.options.input.file) && path.resolve(this.options.input.file) === path.resolve(fileOut)) {
     err = new Error('Cannot use same file for input and output');
@@ -409,3 +417,3 @@ } else if (this.options.formatOut === 'input' && fileOut.toLowerCase().endsWith('.gif') && !this.constructor.format.magick.output.file) {
         if (is.integer(colours) && is.inRange(colours, 2, 256)) {
-          this.options.pngColours = colours;
+          this.options.pngBitdepth = 1 << 31 - Math.clz32(Math.ceil(Math.log2(colours)));
         } else {
@@ -517,2 +525,80 @@ throw is.invalidParameterError('colours', 'integer between 2 and 256', colours);
 /**
+ * Use these JP2 options for output image.
+ *
+ * Requires libvips compiled with support for OpenJPEG.
+ * The prebuilt binaries do not include this - see
+ * {@link https://sharp.pixelplumbing.com/install#custom-libvips installing a custom libvips}.
+ *
+ * @example
+ * // Convert any input to lossless JP2 output
+ * const data = await sharp(input)
+ *   .jp2({ lossless: true })
+ *   .toBuffer();
+ *
+ * @example
+ * // Convert any input to very high quality JP2 output
+ * const data = await sharp(input)
+ *   .jp2({
+ *     quality: 100,
+ *     chromaSubsampling: '4:4:4'
+ *   })
+ *   .toBuffer();
+ *
+ * @since 0.29.1
+ *
+ * @param {Object} [options] - output options
+ * @param {number} [options.quality=80] - quality, integer 1-100
+ * @param {boolean} [options.lossless=false] - use lossless compression mode
+ * @param {number} [options.tileWidth=512] - horizontal tile size
+ * @param {number} [options.tileHeight=512] - vertical tile size
+ * @param {string} [options.chromaSubsampling='4:4:4'] - set to '4:2:0' to use chroma subsampling
+ * @returns {Sharp}
+ * @throws {Error} Invalid options
+ */
+/* istanbul ignore next */
+function jp2 (options) {
+  if (!this.constructor.format.jp2k.output.buffer) {
+    throw errJp2Save;
+  }
+  if (is.object(options)) {
+    if (is.defined(options.quality)) {
+      if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
+        this.options.jp2Quality = options.quality;
+      } else {
+        throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
+      }
+    }
+    if (is.defined(options.lossless)) {
+      if (is.bool(options.lossless)) {
+        this.options.jp2Lossless = options.lossless;
+      } else {
+        throw is.invalidParameterError('lossless', 'boolean', options.lossless);
+      }
+    }
+    if (is.defined(options.tileWidth)) {
+      if (is.integer(options.tileWidth) && is.inRange(options.tileWidth, 1, 32768)) {
+        this.options.jp2TileWidth = options.tileWidth;
+      } else {
+        throw is.invalidParameterError('tileWidth', 'integer between 1 and 32768', options.tileWidth);
+      }
+    }
+    if (is.defined(options.tileHeight)) {
+      if (is.integer(options.tileHeight) && is.inRange(options.tileHeight, 1, 32768)) {
+        this.options.jp2TileHeight = options.tileHeight;
+      } else {
+        throw is.invalidParameterError('tileHeight', 'integer between 1 and 32768', options.tileHeight);
+      }
+    }
+    if (is.defined(options.chromaSubsampling)) {
+      if (is.string(options.chromaSubsampling) && is.inArray(options.chromaSubsampling, ['4:2:0', '4:4:4'])) {
+        this.options.heifChromaSubsampling = options.chromaSubsampling;
+      } else {
+        throw is.invalidParameterError('chromaSubsampling', 'one of: 4:2:0, 4:4:4', options.chromaSubsampling);
+      }
+    }
+  }
+  return this._updateFormatOut('jp2', options);
+}
+
+/**
  * Set animation options if available.
@@ -662,2 +748,4 @@ * @private
  *
+ * AVIF image sequences are not supported.
+ *
  * @since 0.27.0
@@ -668,3 +756,3 @@ *
  * @param {boolean} [options.lossless=false] - use lossless compression
- * @param {number} [options.speed=5] - CPU effort vs file size, 0 (slowest/smallest) to 8 (fastest/largest)
+ * @param {number} [options.speed=5] - CPU effort vs file size, 0 (slowest/smallest) to 9 (fastest/largest)
  * @param {string} [options.chromaSubsampling='4:4:4'] - set to '4:2:0' to use chroma subsampling
@@ -690,3 +778,3 @@ * @returns {Sharp}
  * @param {boolean} [options.lossless=false] - use lossless compression
- * @param {number} [options.speed=5] - CPU effort vs file size, 0 (slowest/smallest) to 8 (fastest/largest)
+ * @param {number} [options.speed=5] - CPU effort vs file size, 0 (slowest/smallest) to 9 (fastest/largest)
  * @param {string} [options.chromaSubsampling='4:4:4'] - set to '4:2:0' to use chroma subsampling
@@ -720,6 +808,6 @@ * @returns {Sharp}
     if (is.defined(options.speed)) {
-      if (is.integer(options.speed) && is.inRange(options.speed, 0, 8)) {
+      if (is.integer(options.speed) && is.inRange(options.speed, 0, 9)) {
         this.options.heifSpeed = options.speed;
       } else {
-        throw is.invalidParameterError('speed', 'integer between 0 and 8', options.speed);
+        throw is.invalidParameterError('speed', 'integer between 0 and 9', options.speed);
       }
@@ -1043,2 +1131,3 @@ }
     jpeg,
+    jp2,
     png,
@@ -1045,0 +1134,0 @@ webp,

package.json

 {
   "name": "sharp",
   "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP, AVIF and TIFF images",
-  "version": "0.29.0",
+  "version": "0.29.1",
   "author": "Lovell Fuller <[e-mail]>",
@@ -81,3 +81,4 @@ "homepage": "https://github.com/lovell/sharp",
     "Brad Parham <[e-mail]>",
-    "Taneli Vatanen <[e-mail]>"
+    "Taneli Vatanen <[e-mail]>",
+    "Joris Dugué <[e-mail]>"
   ],
@@ -116,2 +117,3 @@ "scripts": {
     "svg",
+    "jp2",
     "dzi",
@@ -129,3 +131,3 @@ "image",
     "detect-libc": "^1.0.3",
-    "node-addon-api": "^4.0.0",
+    "node-addon-api": "^4.1.0",
     "prebuild-install": "^6.1.4",
@@ -145,3 +147,3 @@ "semver": "^7.3.5",
     "license-checker": "^25.0.1",
-    "mocha": "^9.0.3",
+    "mocha": "^9.1.1",
     "mock-fs": "^5.0.0",
@@ -148,0 +150,0 @@ "nyc": "^15.1.0",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

464337

increased by1.77%

Lines of code

4211

increased by2.66%

Dependency changes

• Updatednode-addon-api@^4.1.0