@revizly/sharp 0.34.0-revizly9 → 0.34.1-revizly2

package/README.md

@@ -1,6 +1,6 @@
 # sharp
 
-<img src="https://cdn.jsdelivr.net/gh/lovell/sharp@main/docs/image/sharp-logo.svg" width="160" height="160" alt="sharp logo" align="right">
+<img src="https://cdn.jsdelivr.net/gh/lovell/sharp@main/docs/public/sharp-logo.svg" width="160" height="160" alt="sharp logo" align="right">
 
 The typical use case for this high speed Node-API module
 is to convert large images in common formats to

package/lib/colour.js

@@ -134,6 +134,26 @@ function toColorspace (colorspace) {
   return this.toColourspace(colorspace);
 }
 
+/**
+ * Create a RGBA colour array from a given value.
+ * @private
+ * @param {string|Object} value
+ * @throws {Error} Invalid value
+ */
+function _getBackgroundColourOption (value) {
+  if (is.object(value) || is.string(value)) {
+    const colour = color(value);
+    return [
+      colour.red(),
+      colour.green(),
+      colour.blue(),
+      Math.round(colour.alpha() * 255)
+    ];
+  } else {
+    throw is.invalidParameterError('background', 'object or string', value);
+  }
+}
+
 /**
  * Update a colour attribute of the this.options Object.
  * @private
@@ -143,17 +163,7 @@ function toColorspace (colorspace) {
  */
 function _setBackgroundColourOption (key, value) {
   if (is.defined(value)) {
-    if (is.object(value) || is.string(value)) {
-      const colour = color(value);
-      this.options[key] = [
-        colour.red(),
-        colour.green(),
-        colour.blue(),
-        Math.round(colour.alpha() * 255)
-      ];
-    } else {
-      throw is.invalidParameterError('background', 'object or string', value);
-    }
+    this.options[key] = _getBackgroundColourOption(value);
   }
 }
 
@@ -173,6 +183,7 @@ module.exports = function (Sharp) {
     toColourspace,
     toColorspace,
     // Private
+    _getBackgroundColourOption,
     _setBackgroundColourOption
   });
   // Class attributes

package/lib/constructor.js

@@ -263,6 +263,8 @@ const Sharp = function (input, options) {
     trimBackground: [],
     trimThreshold: -1,
     trimLineArt: false,
+    dilateWidth: 0,
+    erodeWidth: 0,
     gamma: 0,
     gammaOut: 0,
     greyscale: false,
@@ -296,6 +298,8 @@ const Sharp = function (input, options) {
     withExif: {},
     withExifMerge: true,
     resolveWithObject: false,
+    loop: 1,
+    delay: [],
     // output format
     jpegQuality: 80,
     jpegProgressive: false,

package/lib/index.d.ts

@@ -504,6 +504,22 @@ declare namespace sharp {
          */
         blur(sigma?: number | boolean | BlurOptions): Sharp;
 
+        /**
+         * Expand foreground objects using the dilate morphological operator.
+         * @param {Number} [width=1] dilation width in pixels.
+         * @throws {Error} Invalid parameters
+         * @returns A sharp instance that can be used to chain operations
+         */
+        dilate(width?: number): Sharp;
+
+        /**
+         * Shrink foreground objects using the erode morphological operator.
+         * @param {Number} [width=1] erosion width in pixels.
+         * @throws {Error} Invalid parameters
+         * @returns A sharp instance that can be used to chain operations
+         */
+        erode(width?: number): Sharp;
+
         /**
          * Merge alpha transparency channel, if any, with background.
          * @param flatten true to enable and false to disable (defaults to true)
@@ -955,7 +971,7 @@ declare namespace sharp {
          *
          * Using this option will remove the EXIF `Orientation` tag, if any.
          */
-        autoOrient?: boolean;
+        autoOrient?: boolean | undefined;
         /**
          *  When to abort processing of invalid pixel data, one of (in order of sensitivity):
          *  'none' (least), 'truncated', 'error' or 'warning' (most), highers level imply lower levels, invalid metadata will always abort. (optional, default 'warning')
@@ -1683,6 +1699,10 @@ declare namespace sharp {
         /** When using the attention crop strategy, the focal point of the cropped region */
         attentionX?: number | undefined;
         attentionY?: number | undefined;
+        /** Number of pages/frames contained within the image, with support for TIFF, HEIF, PDF, animated GIF and animated WebP */
+        pages?: number | undefined;
+        /** Number of pixels high each page in a multi-page image will be. */
+        pageHeight?: number | undefined;
     }
 
     interface AvailableFormatInfo {

package/lib/input.js

@@ -3,7 +3,6 @@
 
 'use strict';
 
-const color = require('color');
 const is = require('./is');
 const sharp = require('./sharp');
 
@@ -249,7 +248,7 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
     }
     // PDF background colour
     if (is.defined(inputOptions.pdfBackground)) {
-      this._setBackgroundColourOption('pdfBackground', inputOptions.pdfBackground);
+      inputDescriptor.pdfBackground = this._getBackgroundColourOption(inputOptions.pdfBackground);
     }
     // Create new image
     if (is.defined(inputOptions.create)) {
@@ -288,13 +287,7 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
           if (!is.inRange(inputOptions.create.channels, 3, 4)) {
             throw is.invalidParameterError('create.channels', 'number between 3 and 4', inputOptions.create.channels);
           }
-          const background = color(inputOptions.create.background);
-          inputDescriptor.createBackground = [
-            background.red(),
-            background.green(),
-            background.blue(),
-            Math.round(background.alpha() * 255)
-          ];
+          inputDescriptor.createBackground = this._getBackgroundColourOption(inputOptions.create.background);
         } else {
           throw new Error('Expected valid noise or background to create a new input image');
         }
@@ -410,13 +403,7 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
           }
         }
         if (is.defined(inputOptions.join.background)) {
-          const background = color(inputOptions.join.background);
-          inputDescriptor.joinBackground = [
-            background.red(),
-            background.green(),
-            background.blue(),
-            Math.round(background.alpha() * 255)
-          ];
+          inputDescriptor.joinBackground = this._getBackgroundColourOption(inputOptions.join.background);
         }
         if (is.defined(inputOptions.join.halign)) {
           if (is.string(inputOptions.join.halign) && is.string(this.constructor.align[inputOptions.join.halign])) {

package/lib/operation.js

@@ -3,7 +3,6 @@
 
 'use strict';
 
-const color = require('color');
 const is = require('./is');
 
 /**
@@ -67,13 +66,7 @@ function rotate (angle, options) {
   } 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);
@@ -443,6 +436,52 @@ 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) && width > 0) {
+    this.options.dilateWidth = width;
+  } else {
+    throw is.invalidParameterError('dilate', 'positive integer', dilate);
+  }
+  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) && width > 0) {
+    this.options.erodeWidth = width;
+  } else {
+    throw is.invalidParameterError('erode', 'positive integer', erode);
+  }
+  return this;
+}
+
 /**
  * Merge alpha transparency channel, if any, with a background, then remove the alpha channel.
  *
@@ -958,6 +997,8 @@ module.exports = function (Sharp) {
     flop,
     affine,
     sharpen,
+    erode,
+    dilate,
     median,
     blur,
     flatten,

package/lib/resize.js

@@ -129,7 +129,7 @@ function isResizeExpected (options) {
  *
  * Some of these values are based on the [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) CSS property.
  *
- * <img alt="Examples of various values for the fit property when resizing" width="100%" style="aspect-ratio: 998/243" src="https://cdn.jsdelivr.net/gh/lovell/sharp@main/docs/image/api-resize-fit.svg">
+ * <img alt="Examples of various values for the fit property when resizing" width="100%" style="aspect-ratio: 998/243" src="https://cdn.jsdelivr.net/gh/lovell/sharp@main/docs/public/api-resize-fit.svg">
  *
  * When using a **fit** of `cover` or `contain`, the default **position** is `centre`. Other options are:
  * - `sharp.position`: `top`, `right top`, `right`, `right bottom`, `bottom`, `left bottom`, `left`, `left top`.

package/lib/sharp.js

@@ -17,9 +17,9 @@ const paths = [
   '@revizly/sharp-wasm32/sharp.node'
 ];
 
-let sharp;
+let path, sharp;
 const errors = [];
-for (const path of paths) {
+for (path of paths) {
   try {
     sharp = require(path);
     break;
@@ -29,6 +29,14 @@ for (const path of paths) {
   }
 }
 
+/* istanbul ignore next */
+if (sharp && path.startsWith('@img/sharp-linux-x64') && !sharp._isUsingX64V2()) {
+  const err = new Error('Prebuilt binaries for linux-x64 require v2 microarchitecture');
+  err.code = 'Unsupported CPU';
+  errors.push(err);
+  sharp = null;
+}
+
 /* istanbul ignore next */
 if (sharp) {
   module.exports = sharp;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@revizly/sharp",
   "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP, GIF, AVIF and TIFF images",
-  "version": "0.34.0-revizly9",
+  "version": "0.34.1-revizly2",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",
   "contributors": [
@@ -142,17 +142,17 @@
     "semver": "^7.7.1"
   },
   "optionalDependencies": {
-    "@revizly/sharp-libvips-linux-arm64": "1.0.11",
-    "@revizly/sharp-libvips-linux-x64": "1.0.11",
-    "@revizly/sharp-linux-arm64": "0.34.0-revizly8",
-    "@revizly/sharp-linux-x64": "0.34.0-revizly8"
+    "@revizly/sharp-libvips-linux-arm64": "1.0.12",
+    "@revizly/sharp-libvips-linux-x64": "1.0.12",
+    "@revizly/sharp-linux-arm64": "0.34.1-revizly1",
+    "@revizly/sharp-linux-x64": "0.34.1-revizly1"
   },
   "devDependencies": {
-    "@emnapi/runtime": "^1.3.1",
+    "@emnapi/runtime": "^1.4.0",
     "@revizly/sharp-libvips-dev": "1.0.11",
     "@types/node": "*",
     "cc": "^3.0.1",
-    "emnapi": "^1.3.1",
+    "emnapi": "^1.4.0",
     "exif-reader": "^2.0.2",
     "extract-zip": "^2.0.1",
     "icc": "^3.0.0",

package/src/binding.gyp

@@ -19,7 +19,10 @@
         'type': 'shared_library',
         'defines': [
           '_VIPS_PUBLIC=__declspec(dllexport)',
-          '_ALLOW_KEYWORD_MACROS'
+          '_ALLOW_KEYWORD_MACROS',
+          'G_DISABLE_ASSERT',
+          'G_DISABLE_CAST_CHECKS',
+          'G_DISABLE_CHECKS'
         ],
         'sources': [
           '<(sharp_libvips_cplusplus_dir)/VConnection.cpp',
@@ -80,6 +83,9 @@
   }, {
     'target_name': 'sharp-<(platform_and_arch)',
     'defines': [
+      'G_DISABLE_ASSERT',
+      'G_DISABLE_CAST_CHECKS',
+      'G_DISABLE_CHECKS',
       'NAPI_VERSION=9',
       'NODE_ADDON_API_DISABLE_DEPRECATED',
       'NODE_API_SWALLOW_UNTHROWABLE_EXCEPTIONS'
@@ -179,6 +185,7 @@
                 '-Wl,-s',
                 '-Wl,--disable-new-dtags',
                 '-Wl,-z,nodelete',
+                '-Wl,-Bsymbolic-functions',
                 '-Wl,-rpath=\'$$ORIGIN/../../sharp-libvips-<(platform_and_arch)/lib\'',
                 '-Wl,-rpath=\'$$ORIGIN/../../../sharp-libvips-<(platform_and_arch)/<(sharp_libvips_version)/lib\'',
                 '-Wl,-rpath=\'$$ORIGIN/../../node_modules/@revizly/sharp-libvips-<(platform_and_arch)/lib\'',

package/src/operations.cc

@@ -472,4 +472,26 @@ namespace sharp {
     }
   }
 
+  /*
+   * Dilate an image
+   */
+  VImage Dilate(VImage image, int const width) {
+    int const maskWidth = 2 * width + 1;
+    VImage mask = VImage::new_matrix(maskWidth, maskWidth);
+    return image.morph(
+      mask,
+      VIPS_OPERATION_MORPHOLOGY_DILATE).invert();
+  }
+
+  /*
+   * Erode an image
+   */
+  VImage Erode(VImage image, int const width) {
+    int const maskWidth = 2 * width + 1;
+    VImage mask = VImage::new_matrix(maskWidth, maskWidth);
+    return image.morph(
+      mask,
+      VIPS_OPERATION_MORPHOLOGY_ERODE).invert();
+  }
+
 }  // namespace sharp

package/src/operations.h

@@ -120,6 +120,15 @@ namespace sharp {
   VImage EmbedMultiPage(VImage image, int left, int top, int width, int height,
                         VipsExtend extendWith, std::vector<double> background, int nPages, int *pageHeight);
 
+  /*
+   * Dilate an image
+   */
+  VImage Dilate(VImage image, int const maskWidth);
+
+  /*
+   * Erode an image
+   */
+  VImage Erode(VImage image, int const maskWidth);
 }  // namespace sharp
 
 #endif  // SRC_OPERATIONS_H_

package/src/pipeline.cc

@@ -609,6 +609,16 @@ class PipelineWorker : public Napi::AsyncWorker {
         image = sharp::Threshold(image, baton->threshold, baton->thresholdGrayscale);
       }
 
+      // Dilate - must happen before blurring, due to the utility of dilating after thresholding
+      if (baton->dilateWidth != 0) {
+        image = sharp::Dilate(image, baton->dilateWidth);
+      }
+
+      // Erode - must happen before blurring, due to the utility of eroding after thresholding
+      if (baton->erodeWidth != 0) {
+        image = sharp::Erode(image, baton->erodeWidth);
+      }
+
       // Blur
       if (shouldBlur) {
         image = sharp::Blur(image, baton->blurSigma, baton->precision, baton->minAmpl);
@@ -1032,7 +1042,7 @@ class PipelineWorker : public Napi::AsyncWorker {
           (baton->formatOut == "input" && inputImageType == sharp::ImageType::HEIF)) {
           // Write HEIF to buffer
           sharp::AssertImageTypeDimensions(image, sharp::ImageType::HEIF);
-          image = sharp::RemoveAnimationProperties(image).cast(VIPS_FORMAT_UCHAR);
+          image = sharp::RemoveAnimationProperties(image);
           VipsArea *area = reinterpret_cast<VipsArea*>(image.heifsave_buffer(VImage::option()
             ->set("keep", baton->keepMetadata)
             ->set("Q", baton->heifQuality)
@@ -1227,7 +1237,7 @@ class PipelineWorker : public Napi::AsyncWorker {
           (willMatchInput && inputImageType == sharp::ImageType::HEIF)) {
           // Write HEIF to file
           sharp::AssertImageTypeDimensions(image, sharp::ImageType::HEIF);
-          image = sharp::RemoveAnimationProperties(image).cast(VIPS_FORMAT_UCHAR);
+          image = sharp::RemoveAnimationProperties(image);
           image.heifsave(const_cast<char*>(baton->fileOut.data()), VImage::option()
             ->set("keep", baton->keepMetadata)
             ->set("Q", baton->heifQuality)
@@ -1621,6 +1631,8 @@ Napi::Value pipeline(const Napi::CallbackInfo& info) {
   baton->gammaOut = sharp::AttrAsDouble(options, "gammaOut");
   baton->linearA = sharp::AttrAsVectorOfDouble(options, "linearA");
   baton->linearB = sharp::AttrAsVectorOfDouble(options, "linearB");
+  baton->dilateWidth = sharp::AttrAsUint32(options, "dilateWidth");
+  baton->erodeWidth = sharp::AttrAsUint32(options, "erodeWidth");
   baton->greyscale = sharp::AttrAsBool(options, "greyscale");
   baton->normalise = sharp::AttrAsBool(options, "normalise");
   baton->normaliseLower = sharp::AttrAsUint32(options, "normaliseLower");
@@ -1705,6 +1717,8 @@ Napi::Value pipeline(const Napi::CallbackInfo& info) {
   }
   baton->withExifMerge = sharp::AttrAsBool(options, "withExifMerge");
   baton->timeoutSeconds = sharp::AttrAsUint32(options, "timeoutSeconds");
+  baton->loop = sharp::AttrAsUint32(options, "loop");
+  baton->delay = sharp::AttrAsInt32Vector(options, "delay");
   // Format-specific
   baton->jpegQuality = sharp::AttrAsUint32(options, "jpegQuality");
   baton->jpegProgressive = sharp::AttrAsBool(options, "jpegProgressive");
@@ -1774,13 +1788,6 @@ Napi::Value pipeline(const Napi::CallbackInfo& info) {
   baton->jxlEffort = sharp::AttrAsUint32(options, "jxlEffort");
   baton->jxlLossless = sharp::AttrAsBool(options, "jxlLossless");
   baton->rawDepth = sharp::AttrAsEnum<VipsBandFormat>(options, "rawDepth", VIPS_TYPE_BAND_FORMAT);
-  // Animated output properties
-  if (sharp::HasAttr(options, "loop")) {
-    baton->loop = sharp::AttrAsUint32(options, "loop");
-  }
-  if (sharp::HasAttr(options, "delay")) {
-    baton->delay = sharp::AttrAsInt32Vector(options, "delay");
-  }
   baton->tileSize = sharp::AttrAsUint32(options, "tileSize");
   baton->tileOverlap = sharp::AttrAsUint32(options, "tileOverlap");
   baton->tileAngle = sharp::AttrAsInt32(options, "tileAngle");

package/src/pipeline.h

@@ -101,6 +101,8 @@ struct PipelineBaton {
   int trimOffsetTop;
   std::vector<double> linearA;
   std::vector<double> linearB;
+  int dilateWidth;
+  int erodeWidth;
   double gamma;
   double gammaOut;
   bool greyscale;
@@ -274,6 +276,8 @@ struct PipelineBaton {
     trimOffsetTop(0),
     linearA{},
     linearB{},
+    dilateWidth(0),
+    erodeWidth(0),
     gamma(0.0),
     greyscale(false),
     normalise(false),
@@ -380,7 +384,7 @@ struct PipelineBaton {
     ensureAlpha(-1.0),
     colourspacePipeline(VIPS_INTERPRETATION_LAST),
     colourspace(VIPS_INTERPRETATION_LAST),
-    loop(-1),
+    loop(1),
     tileSize(256),
     tileOverlap(0),
     tileContainer(VIPS_FOREIGN_DZ_CONTAINER_FS),

package/src/sharp.cc

@@ -33,6 +33,7 @@ Napi::Object init(Napi::Env env, Napi::Object exports) {
   exports.Set("block", Napi::Function::New(env, block));
   exports.Set("_maxColourDistance", Napi::Function::New(env, _maxColourDistance));
   exports.Set("_isUsingJemalloc", Napi::Function::New(env, _isUsingJemalloc));
+  exports.Set("_isUsingX64V2", Napi::Function::New(env, _isUsingX64V2));
   exports.Set("stats", Napi::Function::New(env, stats));
   return exports;
 }

package/src/utilities.cc

@@ -267,3 +267,20 @@ Napi::Value _isUsingJemalloc(const Napi::CallbackInfo& info) {
   return Napi::Boolean::New(env, false);
 }
 #endif
+
+#if defined(__GNUC__) && defined(__x86_64__)
+// Are SSE 4.2 intrinsics available at runtime?
+Napi::Value _isUsingX64V2(const Napi::CallbackInfo& info) {
+  Napi::Env env = info.Env();
+  unsigned int eax, ebx, ecx, edx;
+  __asm__ __volatile__("cpuid"
+    : "=a"(eax), "=b"(ebx), "=c"(ecx), "=d"(edx)
+    : "a"(1));
+  return Napi::Boolean::New(env, (ecx & 1U << 20) != 0);
+}
+#else
+Napi::Value _isUsingX64V2(const Napi::CallbackInfo& info) {
+  Napi::Env env = info.Env();
+  return Napi::Boolean::New(env, false);
+}
+#endif

package/src/utilities.h

@@ -15,5 +15,6 @@ Napi::Value format(const Napi::CallbackInfo& info);
 void block(const Napi::CallbackInfo& info);
 Napi::Value _maxColourDistance(const Napi::CallbackInfo& info);
 Napi::Value _isUsingJemalloc(const Napi::CallbackInfo& info);
+Napi::Value _isUsingX64V2(const Napi::CallbackInfo& info);
 
 #endif  // SRC_UTILITIES_H_