@revizly/sharp 0.33.4-revizly6 → 0.33.5-revizly1

package/install/check.js

@@ -18,7 +18,7 @@ try {
     }
     try {
       const gyp = require('node-gyp');
-      log(`Found node-gyp version ${gyp().version}`);
+      log(`Found node-gyp ${gyp().version}`);
     } catch (err) {
       log('Please add node-gyp to your dependencies');
       return;

package/lib/constructor.js

@@ -226,6 +226,8 @@ const Sharp = function (input, options) {
     negateAlpha: true,
     medianSize: 0,
     blurSigma: 0,
+    precision: 'integer',
+    minAmpl: 0.2,
     sharpenSigma: 0,
     sharpenM1: 1,
     sharpenM2: 2,

package/lib/index.d.ts

@@ -464,7 +464,7 @@ declare namespace sharp {
          * @throws {Error} Invalid parameters
          * @returns A sharp instance that can be used to chain operations
          */
-        blur(sigma?: number | boolean): Sharp;
+        blur(sigma?: number | boolean | BlurOptions): Sharp;
 
         /**
          * Merge alpha transparency channel, if any, with background.
@@ -1069,7 +1069,7 @@ declare namespace sharp {
         /** Number of pixels per inch (DPI), if present */
         density?: number | undefined;
         /** String containing JPEG chroma subsampling, 4:2:0 or 4:4:4 for RGB, 4:2:0:4 or 4:4:4:4 for CMYK */
-        chromaSubsampling: string;
+        chromaSubsampling?: string | undefined;
         /** Boolean indicating whether the image is interlaced using a progressive scan */
         isProgressive?: boolean | undefined;
         /** Number of pages/frames contained within the image, with support for TIFF, HEIF, PDF, animated GIF and animated WebP */
@@ -1108,6 +1108,8 @@ declare namespace sharp {
         resolutionUnit?: 'inch' | 'cm' | undefined;
         /** String containing format for images loaded via *magick */
         formatMagick?: string | undefined;
+        /** Array of keyword/text pairs representing PNG text blocks, if present. */
+        comments?: CommentsMetadata[] | undefined;
     }
 
     interface LevelMetadata {
@@ -1115,6 +1117,11 @@ declare namespace sharp {
         height: number;
     }
 
+    interface CommentsMetadata {
+        keyword: string;
+        text: string;
+    }
+
     interface Stats {
         /** Array of channel statistics for each channel in the image. */
         channels: ChannelStats[];
@@ -1335,6 +1342,17 @@ declare namespace sharp {
         background?: Color | undefined;
     }
 
+    type Precision = 'integer' | 'float' | 'approximate';
+
+    interface BlurOptions {
+        /** A value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2` */
+        sigma: number;
+        /** A value between 0.001 and 1. A smaller value will generate a larger, more accurate mask. */
+        minAmplitude?: number;
+        /** How accurate the operation should be, one of: integer, float, approximate. (optional, default "integer") */
+        precision?: Precision | undefined;
+    }
+
     interface FlattenOptions {
         /** background colour, parsed by the color module, defaults to black. (optional, default {r:0,g:0,b:0}) */
         background?: Color | undefined;

package/lib/input.js

@@ -450,6 +450,7 @@ function _isStreamInput () {
  * - `xmp`: Buffer containing raw XMP data, if present
  * - `tifftagPhotoshop`: Buffer containing raw TIFFTAG_PHOTOSHOP data, if present
  * - `formatMagick`: String containing format for images loaded via *magick
+ * - `comments`: Array of keyword/text pairs representing PNG text blocks, if present.
  *
  * @example
  * const metadata = await sharp(input).metadata();

package/lib/libvips.js

@@ -10,10 +10,10 @@ const semverGreaterThanOrEqualTo = require('semver/functions/gte');
 const semverSatisfies = require('semver/functions/satisfies');
 const detectLibc = require('detect-libc');
 
-const { engines, optionalDependencies } = require('../package.json');
+const { config, engines, optionalDependencies } = require('../package.json');
 
 const minimumLibvipsVersionLabelled = process.env.npm_package_config_libvips || /* istanbul ignore next */
-  engines.libvips;
+  config.libvips;
 const minimumLibvipsVersion = semverCoerce(minimumLibvipsVersionLabelled).version;
 
 const prebuiltPlatforms = [

package/lib/operation.js

@@ -6,6 +6,17 @@
 const color = require('color');
 const is = require('./is');
 
+/**
+ * How accurate an operation should be.
+ * @member
+ * @private
+ */
+const vipsPrecision = {
+  integer: 'integer',
+  float: 'float',
+  approximate: 'approximate'
+};
+
 /**
  * Rotate the output image by either an explicit angle
  * or auto-orient based on the EXIF `Orientation` tag.
@@ -367,23 +378,51 @@ function median (size) {
  *   .blur(5)
  *   .toBuffer();
  *
- * @param {number} [sigma] a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
+ * @param {Object|number|Boolean} [options]
+ * @param {number} [options.sigma] a value between 0.3 and 1000 representing the sigma of the Gaussian mask, where `sigma = 1 + radius / 2`.
+ * @param {string} [options.precision='integer'] How accurate the operation should be, one of: integer, float, approximate.
+ * @param {number} [options.minAmplitude=0.2] A value between 0.001 and 1. A smaller value will generate a larger, more accurate mask.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function blur (sigma) {
-  if (!is.defined(sigma)) {
+function blur (options) {
+  let sigma;
+  if (is.number(options)) {
+    sigma = options;
+  } else if (is.plainObject(options)) {
+    if (!is.number(options.sigma)) {
+      throw is.invalidParameterError('options.sigma', 'number between 0.3 and 1000', sigma);
+    }
+    sigma = options.sigma;
+    if ('precision' in options) {
+      if (is.string(vipsPrecision[options.precision])) {
+        this.options.precision = vipsPrecision[options.precision];
+      } else {
+        throw is.invalidParameterError('precision', 'one of: integer, float, approximate', options.precision);
+      }
+    }
+    if ('minAmplitude' in options) {
+      if (is.number(options.minAmplitude) && is.inRange(options.minAmplitude, 0.001, 1)) {
+        this.options.minAmpl = options.minAmplitude;
+      } else {
+        throw is.invalidParameterError('minAmplitude', 'number between 0.001 and 1', options.minAmplitude);
+      }
+    }
+  }
+
+  if (!is.defined(options)) {
     // No arguments: default to mild blur
     this.options.blurSigma = -1;
-  } else if (is.bool(sigma)) {
+  } else if (is.bool(options)) {
     // Boolean argument: apply mild blur?
-    this.options.blurSigma = sigma ? -1 : 0;
+    this.options.blurSigma = options ? -1 : 0;
   } else if (is.number(sigma) && is.inRange(sigma, 0.3, 1000)) {
     // Numeric argument: specific sigma
     this.options.blurSigma = sigma;
   } else {
     throw is.invalidParameterError('sigma', 'number between 0.3 and 1000', sigma);
   }
+
   return this;
 }
 

package/lib/sharp.js

@@ -57,7 +57,6 @@ if (sharp) {
     help.push(
       '- Ensure optional dependencies can be installed:',
       '    npm install --include=optional sharp',
-      '    yarn add sharp --ignore-engines',
       '- Ensure your package manager supports multi-platform installation:',
       '    See https://sharp.pixelplumbing.com/install#cross-platform',
       '- Add platform-specific dependencies:',
@@ -73,10 +72,9 @@ if (sharp) {
   }
   if (isLinux && /(symbol not found|CXXABI_)/i.test(messages)) {
     try {
-      const { engines } = require(`@revizly/sharp-libvips-${runtimePlatform}/package`);
-
+      const { config } = require(`@revizly/sharp-libvips-${runtimePlatform}/package`);
       const libcFound = `${familySync()} ${versionSync()}`;
-      const libcRequires = `${engines.musl ? 'musl' : 'glibc'} ${engines.musl || engines.glibc}`;
+      const libcRequires = `${config.musl ? 'musl' : 'glibc'} ${config.musl || config.glibc}`;
       help.push(
         '- Update your OS:',
         `    Found ${libcFound}`,

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.33.4-revizly6",
+  "version": "0.33.5-revizly1",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",
   "contributors": [
@@ -139,17 +139,17 @@
   "dependencies": {
     "color": "^4.2.3",
     "detect-libc": "^2.0.3",
-    "semver": "^7.6.0"
+    "semver": "^7.6.3"
   },
   "optionalDependencies": {
-    "@revizly/sharp-libvips-linux-arm64": "1.0.7",
-    "@revizly/sharp-libvips-linux-x64": "1.0.7",
-    "@revizly/sharp-linux-arm64": "0.33.4-revizly3",
-    "@revizly/sharp-linux-x64": "0.33.4-revizly3"
+    "@revizly/sharp-libvips-linux-arm64": "1.0.8",
+    "@revizly/sharp-libvips-linux-x64": "1.0.8",
+    "@revizly/sharp-linux-arm64": "0.33.4-revizly6",
+    "@revizly/sharp-linux-x64": "0.33.4-revizly6"
   },
   "devDependencies": {
     "@emnapi/runtime": "^1.2.0",
-    "@revizly/sharp-libvips-dev": "1.0.7",
+    "@revizly/sharp-libvips-dev": "1.0.8",
     "@types/node": "*",
     "async": "^3.2.5",
     "cc": "^3.0.1",
@@ -157,10 +157,10 @@
     "exif-reader": "^2.0.1",
     "extract-zip": "^2.0.1",
     "icc": "^3.0.0",
-    "jsdoc-to-markdown": "^8.0.1",
+    "jsdoc-to-markdown": "^8.0.3",
     "license-checker": "^25.0.1",
-    "mocha": "^10.5.2",
-    "node-addon-api": "^8.0.0",
+    "mocha": "^10.7.3",
+    "node-addon-api": "^8.1.0",
     "nyc": "^17.0.0",
     "prebuild": "^13.0.1",
     "semistandard": "^17.0.0",
@@ -169,8 +169,10 @@
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "libvips": ">=8.15.2"
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
+    "libvips": ">=8.15.3"
   },
   "funding": {
     "url": "https://opencollective.com/libvips"

package/src/binding.gyp

@@ -192,7 +192,7 @@
                 '-Oz',
                 '-sALLOW_MEMORY_GROWTH',
                 '-sENVIRONMENT=node',
-                '-sEXPORTED_FUNCTIONS=["_vips_shutdown", "_uv_library_shutdown"]',
+                '-sEXPORTED_FUNCTIONS=["emnapiInit", "_vips_shutdown", "_uv_library_shutdown"]',
                 '-sNODERAWFS',
                 '-sTEXTDECODER=0',
                 '-sWASM_ASYNC_COMPILATION=0',

package/src/common.h

@@ -16,8 +16,8 @@
 
 #if (VIPS_MAJOR_VERSION < 8) || \
   (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION < 15) || \
-  (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION == 15 && VIPS_MICRO_VERSION < 2)
-#error "libvips version 8.15.2+ is required - please see https://sharp.pixelplumbing.com/install"
+  (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION == 15 && VIPS_MICRO_VERSION < 3)
+#error "libvips version 8.15.3+ is required - please see https://sharp.pixelplumbing.com/install"
 #endif
 
 #if ((!defined(__clang__)) && defined(__GNUC__) && (__GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 6)))

package/src/metadata.cc

@@ -10,6 +10,8 @@
 #include "common.h"
 #include "metadata.h"
 
+static void* readPNGComment(VipsImage *image, const char *field, GValue *value, void *p);
+
 class MetadataWorker : public Napi::AsyncWorker {
  public:
   MetadataWorker(Napi::Function callback, MetadataBaton *baton, Napi::Function debuglog) :
@@ -131,6 +133,8 @@ class MetadataWorker : public Napi::AsyncWorker {
         memcpy(baton->tifftagPhotoshop, tifftagPhotoshop, tifftagPhotoshopLength);
         baton->tifftagPhotoshopLength = tifftagPhotoshopLength;
       }
+      // PNG comments
+      vips_image_map(image.get_image(), readPNGComment, &baton->comments);
     }
 
     // Clean up
@@ -246,6 +250,17 @@ class MetadataWorker : public Napi::AsyncWorker {
           Napi::Buffer<char>::NewOrCopy(env, baton->tifftagPhotoshop,
             baton->tifftagPhotoshopLength, sharp::FreeCallback));
       }
+      if (baton->comments.size() > 0) {
+        int i = 0;
+        Napi::Array comments = Napi::Array::New(env, baton->comments.size());
+        for (auto &c : baton->comments) {
+          Napi::Object comment = Napi::Object::New(env);
+          comment.Set("keyword", c.first);
+          comment.Set("text", c.second);
+          comments.Set(i++, comment);
+        }
+        info.Set("comments", comments);
+      }
       Callback().Call(Receiver().Value(), { env.Null(), info });
     } else {
       Callback().Call(Receiver().Value(), { Napi::Error::New(env, sharp::TrimEnd(baton->err)).Value() });
@@ -285,3 +300,21 @@ Napi::Value metadata(const Napi::CallbackInfo& info) {
 
   return info.Env().Undefined();
 }
+
+const char *PNG_COMMENT_START = "png-comment-";
+const int PNG_COMMENT_START_LEN = strlen(PNG_COMMENT_START);
+
+static void* readPNGComment(VipsImage *image, const char *field, GValue *value, void *p) {
+  MetadataComments *comments = static_cast<MetadataComments *>(p);
+
+  if (vips_isprefix(PNG_COMMENT_START, field)) {
+    const char *keyword = strchr(field + PNG_COMMENT_START_LEN, '-');
+    const char *str;
+    if (keyword != NULL && !vips_image_get_string(image, field, &str)) {
+      keyword++;  // Skip the hyphen
+      comments->push_back(std::make_pair(keyword, str));
+    }
+  }
+
+  return NULL;
+}

package/src/metadata.h

@@ -9,6 +9,8 @@
 
 #include "./common.h"
 
+typedef std::vector<std::pair<std::string, std::string>> MetadataComments;
+
 struct MetadataBaton {
   // Input
   sharp::InputDescriptor *input;
@@ -47,6 +49,7 @@ struct MetadataBaton {
   size_t xmpLength;
   char *tifftagPhotoshop;
   size_t tifftagPhotoshopLength;
+  MetadataComments comments;
   std::string err;
 
   MetadataBaton():

package/src/operations.cc

@@ -144,7 +144,7 @@ namespace sharp {
   /*
    * Gaussian blur. Use sigma of -1.0 for fast blur.
    */
-  VImage Blur(VImage image, double const sigma) {
+  VImage Blur(VImage image, double const sigma, VipsPrecision precision, double const minAmpl) {
     if (sigma == -1.0) {
       // Fast, mild blur - averages neighbouring pixels
       VImage blur = VImage::new_matrixv(3, 3,
@@ -155,7 +155,9 @@ namespace sharp {
       return image.conv(blur);
     } else {
       // Slower, accurate Gaussian blur
-      return StaySequential(image).gaussblur(sigma);
+      return StaySequential(image).gaussblur(sigma, VImage::option()
+        ->set("precision", precision)
+        ->set("min_ampl", minAmpl));
     }
   }
 

package/src/operations.h

@@ -47,7 +47,7 @@ namespace sharp {
   /*
    * Gaussian blur. Use sigma of -1.0 for fast blur.
    */
-  VImage Blur(VImage image, double const sigma);
+  VImage Blur(VImage image, double const sigma, VipsPrecision precision, double const minAmpl);
 
   /*
    * Convolution with a kernel.

package/src/pipeline.cc

@@ -325,6 +325,7 @@ class PipelineWorker : public Napi::AsyncWorker {
       if ((baton->keepMetadata & VIPS_FOREIGN_KEEP_ICC) && baton->withIccProfile.empty()) {
         // Cache input profile for use with output
         inputProfile = sharp::GetProfile(image);
+        baton->input->ignoreIcc = true;
       }
       char const *processingProfile = image.interpretation() == VIPS_INTERPRETATION_RGB16 ? "p3" : "srgb";
       if (
@@ -592,7 +593,7 @@ class PipelineWorker : public Napi::AsyncWorker {
 
       // Blur
       if (shouldBlur) {
-        image = sharp::Blur(image, baton->blurSigma);
+        image = sharp::Blur(image, baton->blurSigma, baton->precision, baton->minAmpl);
       }
 
       // Unflatten the image
@@ -1541,6 +1542,8 @@ Napi::Value pipeline(const Napi::CallbackInfo& info) {
   baton->negate = sharp::AttrAsBool(options, "negate");
   baton->negateAlpha = sharp::AttrAsBool(options, "negateAlpha");
   baton->blurSigma = sharp::AttrAsDouble(options, "blurSigma");
+  baton->precision = sharp::AttrAsEnum<VipsPrecision>(options, "precision", VIPS_TYPE_PRECISION);
+  baton->minAmpl = sharp::AttrAsDouble(options, "minAmpl");
   baton->brightness = sharp::AttrAsDouble(options, "brightness");
   baton->saturation = sharp::AttrAsDouble(options, "saturation");
   baton->hue = sharp::AttrAsInt32(options, "hue");

package/src/pipeline.h

@@ -78,6 +78,8 @@ struct PipelineBaton {
   bool negate;
   bool negateAlpha;
   double blurSigma;
+  VipsPrecision precision;
+  double minAmpl;
   double brightness;
   double saturation;
   int hue;