Add support for libvips JPEG 2000 one-shot load option

Author: mbklein

docs/src/content/docs/api-constructor.md

@@ -47,6 +47,7 @@ where the overall height is the `pageHeight` multiplied by the number of `pages`
 | [options.subifd] | <code>number</code> | <code>-1</code> | subIFD (Sub Image File Directory) to extract for OME-TIFF, defaults to main image. |
 | [options.level] | <code>number</code> | <code>0</code> | level to extract from a multi-level input (OpenSlide), zero based. |
 | [options.pdfBackground] | <code>string</code> \| <code>Object</code> |  | Background colour to use when PDF is partially transparent. Parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. Requires the use of a globally-installed libvips compiled with support for PDFium, Poppler, ImageMagick or GraphicsMagick. |
+| [options.jp2Oneshot] | <code>boolean</code> | <code>false</code> | Set to `true` to load JPEG 2000 images using [oneshot mode](https://github.com/libvips/libvips/issues/4205)|
 | [options.animated] | <code>boolean</code> | <code>false</code> | Set to `true` to read all frames/pages of an animated image (GIF, WebP, TIFF), equivalent of setting `pages` to `-1`. |
 | [options.raw] | <code>Object</code> |  | describes raw pixel input image data. See `raw()` for pixel ordering. |
 | [options.raw.width] | <code>number</code> |  | integral number of pixels wide. |

lib/constructor.js

@@ -156,6 +156,7 @@ const debuglog = util.debuglog('sharp');
  * @param {number} [options.subifd=-1] - subIFD (Sub Image File Directory) to extract for OME-TIFF, defaults to main image.
  * @param {number} [options.level=0] - level to extract from a multi-level input (OpenSlide), zero based.
  * @param {string|Object} [options.pdfBackground] - Background colour to use when PDF is partially transparent. Parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. Requires the use of a globally-installed libvips compiled with support for PDFium, Poppler, ImageMagick or GraphicsMagick.
+ * @param {boolean} [options.jp2Oneshot=false] - Set to `true` to load JPEG 2000 images using [oneshot mode](https://github.com/libvips/libvips/issues/4205)
  * @param {boolean} [options.animated=false] - Set to `true` to read all frames/pages of an animated image (GIF, WebP, TIFF), equivalent of setting `pages` to `-1`.
  * @param {Object} [options.raw] - describes raw pixel input image data. See `raw()` for pixel ordering.
  * @param {number} [options.raw.width] - integral number of pixels wide.
@@ -320,6 +321,7 @@ const Sharp = function (input, options) {
     jp2TileWidth: 512,
     jp2Lossless: false,
     jp2ChromaSubsampling: '4:4:4',
+    jp2Oneshot: false,
     webpQuality: 80,
     webpAlphaQuality: 100,
     webpLossless: false,

lib/index.d.ts

@@ -994,6 +994,8 @@ declare namespace sharp {
         /** Background colour to use when PDF is partially transparent. Requires the use of a globally-installed libvips compiled with support for PDFium, Poppler, ImageMagick or GraphicsMagick. */
         pdfBackground?: Colour | Color | undefined;
         /** Set to `true` to read all frames/pages of an animated image (equivalent of setting `pages` to `-1`). (optional, default false) */
+        jp2Oneshot?: boolean | undefined;
+        /** Set to `true` to load JPEG 2000 images using [oneshot mode(https://github.com/libvips/libvips/issues/4205) **/
         animated?: boolean | undefined;
         /** Describes raw pixel input image data. See raw() for pixel ordering. */
         raw?: CreateRaw | undefined;

lib/input.js

@@ -28,9 +28,9 @@ const align = {
  * @private
  */
 function _inputOptionsFromObject (obj) {
-  const { raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground, autoOrient } = obj;
-  return [raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground, autoOrient].some(is.defined)
-    ? { raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground, autoOrient }
+  const { raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground, autoOrient, jp2Oneshot } = obj;
+  return [raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground, autoOrient, jp2Oneshot].some(is.defined)
+    ? { raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground, autoOrient, jp2Oneshot }
     : undefined;
 }
 
@@ -45,7 +45,8 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
     limitInputPixels: Math.pow(0x3FFF, 2),
     ignoreIcc: false,
     unlimited: false,
-    sequentialRead: true
+    sequentialRead: true,
+    jp2Oneshot: false
   };
   if (is.string(input)) {
     // filesystem
@@ -251,6 +252,15 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
     if (is.defined(inputOptions.pdfBackground)) {
       this._setBackgroundColourOption('pdfBackground', inputOptions.pdfBackground);
     }
+
+    if (is.defined(inputOptions.jp2Oneshot)) {
+      if (is.bool(inputOptions.jp2Oneshot)) {
+        inputDescriptor.jp2Oneshot = inputOptions.jp2Oneshot;
+      } else {
+        throw is.invalidParameterError('jp2Oneshot', 'boolean', inputOptions.jp2Oneshot);
+      }
+    }
+    
     // Create new image
     if (is.defined(inputOptions.create)) {
       if (

src/common.cc

@@ -113,6 +113,11 @@ namespace sharp {
     if (HasAttr(input, "pdfBackground")) {
       descriptor->pdfBackground = AttrAsVectorOfDouble(input, "pdfBackground");
     }
+    // Use JPEG 2000 oneshot mode?
+    if (HasAttr(input, "jp2Oneshot")) {
+      descriptor->jp2Oneshot = AttrAsBool(input, "jp2Oneshot");
+    }
+
     // Create new image
     if (HasAttr(input, "createChannels")) {
       descriptor->createChannels = AttrAsUint32(input, "createChannels");
@@ -434,6 +439,9 @@ namespace sharp {
             if (imageType == ImageType::PDF) {
               option->set("background", descriptor->pdfBackground);
             }
+            if (imageType == ImageType::JP2 && descriptor->jp2Oneshot) {
+              option->set("oneshot", 1);
+            }
             image = VImage::new_from_buffer(descriptor->buffer, descriptor->bufferLength, nullptr, option);
             if (imageType == ImageType::SVG || imageType == ImageType::PDF || imageType == ImageType::MAGICK) {
               image = SetDensity(image, descriptor->density);
@@ -541,6 +549,9 @@ namespace sharp {
             if (imageType == ImageType::PDF) {
               option->set("background", descriptor->pdfBackground);
             }
+            if (imageType == ImageType::JP2 && descriptor->jp2Oneshot) {
+              option->set("oneshot", 1);
+            }
             image = VImage::new_from_file(descriptor->file.data(), option);
             if (imageType == ImageType::SVG || imageType == ImageType::PDF || imageType == ImageType::MAGICK) {
               image = SetDensity(image, descriptor->density);

src/common.h

@@ -78,6 +78,7 @@ namespace sharp {
     VipsAlign joinHalign;
     VipsAlign joinValign;
     std::vector<double> pdfBackground;
+    bool jp2Oneshot;
 
     InputDescriptor():
       autoOrient(false),
@@ -120,7 +121,8 @@ namespace sharp {
       joinBackground{ 0.0, 0.0, 0.0, 255.0 },
       joinHalign(VIPS_ALIGN_LOW),
       joinValign(VIPS_ALIGN_LOW),
-      pdfBackground{ 255.0, 255.0, 255.0, 255.0 } {}
+      pdfBackground{ 255.0, 255.0, 255.0, 255.0 },
+      jp2Oneshot(false) {}
   };
 
   // Convenience methods to access the attributes of a Napi::Object