Add support for miniswhite when using TIFF output

lovell · Nov 3, 2023 · 28aa176 · 28aa176
1 parent 0f24f0f
commit 28aa176
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 2 deletions.
diff --git a/docs/api-output.md b/docs/api-output.md
@@ -466,6 +466,7 @@ instead of providing `xres` and `yres` in pixels/mm.
 | [options.yres] | <code>number</code> | <code>1.0</code> | vertical resolution in pixels/mm |
 | [options.resolutionUnit] | <code>string</code> | <code>&quot;&#x27;inch&#x27;&quot;</code> | resolution unit options: inch, cm |
 | [options.bitdepth] | <code>number</code> | <code>8</code> | reduce bitdepth to 1, 2 or 4 bit |
+| [options.miniswhite] | <code>boolean</code> | <code>false</code> | write 1-bit images as miniswhite |
 
 **Example**  
 ```js

diff --git a/docs/search-index.json b/docs/search-index.json
diff --git a/lib/constructor.js b/lib/constructor.js
@@ -305,6 +305,7 @@ const Sharp = function (input, options) {
     tiffCompression: 'jpeg',
     tiffPredictor: 'horizontal',
     tiffPyramid: false,
+    tiffMiniswhite: false,
     tiffBitdepth: 8,
     tiffTile: false,
     tiffTileHeight: 256,

diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -1234,6 +1234,8 @@ declare namespace sharp {
         yres?: number | undefined;
         /** Reduce bitdepth to 1, 2 or 4 bit (optional, default 8) */
         bitdepth?: 1 | 2 | 4 | 8 | undefined;
+        /** Write 1-bit images as miniswhite (optional, default false) */
+        miniswhite?: boolean | undefined;
         /** Resolution unit options: inch, cm (optional, default 'inch') */
         resolutionUnit?: 'inch' | 'cm' | undefined;
     }

diff --git a/lib/output.js b/lib/output.js
@@ -782,6 +782,7 @@ function trySetAnimationOptions (source, target) {
  * @param {number} [options.yres=1.0] - vertical resolution in pixels/mm
  * @param {string} [options.resolutionUnit='inch'] - resolution unit options: inch, cm
  * @param {number} [options.bitdepth=8] - reduce bitdepth to 1, 2 or 4 bit
+ * @param {boolean} [options.miniswhite=false] - write 1-bit images as miniswhite
  * @returns {Sharp}
  * @throws {Error} Invalid options
  */
@@ -819,6 +820,10 @@ function tiff (options) {
         throw is.invalidParameterError('tileHeight', 'integer greater than zero', options.tileHeight);
       }
     }
+    // miniswhite
+    if (is.defined(options.miniswhite)) {
+      this._setBooleanOption('tiffMiniswhite', options.miniswhite);
+    }
     // pyramid
     if (is.defined(options.pyramid)) {
       this._setBooleanOption('tiffPyramid', options.pyramid);

diff --git a/package.json b/package.json
@@ -86,7 +86,8 @@
     "Ankur Parihar <[email protected]>",
     "Brahim Ait elhaj <[email protected]>",
     "Mart Jansink <[email protected]>",
-    "Lachlan Newman <[email protected]>"
+    "Lachlan Newman <[email protected]>",
+    "Dennis Beatty <[email protected]>"
   ],
   "scripts": {
     "install": "node install/check",

diff --git a/src/pipeline.cc b/src/pipeline.cc
@@ -940,6 +940,7 @@ class PipelineWorker : public Napi::AsyncWorker {
             ->set("Q", baton->tiffQuality)
             ->set("bitdepth", baton->tiffBitdepth)
             ->set("compression", baton->tiffCompression)
+            ->set("miniswhite", baton->tiffMiniswhite)
             ->set("predictor", baton->tiffPredictor)
             ->set("pyramid", baton->tiffPyramid)
             ->set("tile", baton->tiffTile)
@@ -1136,6 +1137,7 @@ class PipelineWorker : public Napi::AsyncWorker {
             ->set("Q", baton->tiffQuality)
             ->set("bitdepth", baton->tiffBitdepth)
             ->set("compression", baton->tiffCompression)
+            ->set("miniswhite", baton->tiffMiniswhite)
             ->set("predictor", baton->tiffPredictor)
             ->set("pyramid", baton->tiffPyramid)
             ->set("tile", baton->tiffTile)
@@ -1647,6 +1649,7 @@ Napi::Value pipeline(const Napi::CallbackInfo& info) {
   baton->gifProgressive = sharp::AttrAsBool(options, "gifProgressive");
   baton->tiffQuality = sharp::AttrAsUint32(options, "tiffQuality");
   baton->tiffPyramid = sharp::AttrAsBool(options, "tiffPyramid");
+  baton->tiffMiniswhite = sharp::AttrAsBool(options, "tiffMiniswhite");
   baton->tiffBitdepth = sharp::AttrAsUint32(options, "tiffBitdepth");
   baton->tiffTile = sharp::AttrAsBool(options, "tiffTile");
   baton->tiffTileWidth = sharp::AttrAsUint32(options, "tiffTileWidth");

diff --git a/src/pipeline.h b/src/pipeline.h
@@ -169,6 +169,7 @@ struct PipelineBaton {
   VipsForeignTiffPredictor tiffPredictor;
   bool tiffPyramid;
   int tiffBitdepth;
+  bool tiffMiniswhite;
   bool tiffTile;
   int tiffTileHeight;
   int tiffTileWidth;
@@ -335,6 +336,7 @@ struct PipelineBaton {
     tiffPredictor(VIPS_FOREIGN_TIFF_PREDICTOR_HORIZONTAL),
     tiffPyramid(false),
     tiffBitdepth(8),
+    tiffMiniswhite(false),
     tiffTile(false),
     tiffTileHeight(256),
     tiffTileWidth(256),

diff --git a/test/unit/tiff.js b/test/unit/tiff.js
@@ -462,6 +462,18 @@ describe('TIFF', function () {
     });
   });
 
+  it('TIFF miniswhite true value does not throw error', function () {
+    assert.doesNotThrow(function () {
+      sharp().tiff({ miniswhite: true });
+    });
+  });
+
+  it('Invalid TIFF miniswhite value throws error', function () {
+    assert.throws(function () {
+      sharp().tiff({ miniswhite: 'true' });
+    });
+  });
+
   it('Invalid TIFF tile value throws error', function () {
     assert.throws(function () {
       sharp().tiff({ tile: 'true' });