Ensure withMetadata skips default profile for RGB16 #3773

lovell · Aug 24, 2023 · 9563568 · 9563568
1 parent 44a0ee3
commit 9563568
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 11 deletions.
diff --git a/docs/api-output.md b/docs/api-output.md
@@ -109,8 +109,8 @@ await sharp(pixelArray, { raw: { width, height, channels } })
 
 ## withMetadata
 Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
-This will also convert to and add a web-friendly sRGB ICC profile unless a custom
-output profile is provided.
+This will also convert to and add a web-friendly sRGB ICC profile if appropriate,
+unless a custom output profile is provided.
 
 The default behaviour, when `withMetadata` is not used, is to convert to the device-independent
 sRGB colour space and strip all metadata, including the removal of any ICC profile.

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -4,6 +4,11 @@
 
 Requires libvips v8.14.4
 
+### v0.32.6 - TBD
+
+* Ensure `withMetadata` does not add default sRGB profile to RGB16 (regression in 0.32.5).
+  [#3773](https://github.com/lovell/sharp/issues/3773)
+
 ### v0.32.5 - 15th August 2023
 
 * Upgrade to libvips v8.14.4 for upstream bug fixes.

diff --git a/docs/search-index.json b/docs/search-index.json
diff --git a/lib/output.js b/lib/output.js
@@ -162,8 +162,8 @@ function toBuffer (options, callback) {
 
 /**
  * Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
- * This will also convert to and add a web-friendly sRGB ICC profile unless a custom
- * output profile is provided.
+ * This will also convert to and add a web-friendly sRGB ICC profile if appropriate,
+ * unless a custom output profile is provided.
  *
  * The default behaviour, when `withMetadata` is not used, is to convert to the device-independent
  * sRGB colour space and strip all metadata, including the removal of any ICC profile.

diff --git a/src/pipeline.cc b/src/pipeline.cc
@@ -789,12 +789,14 @@ class PipelineWorker : public Napi::AsyncWorker {
 
       // Apply output ICC profile
       if (baton->withMetadata) {
-        image = image.icc_transform(
-          baton->withMetadataIcc.empty() ? "srgb" : const_cast<char*>(baton->withMetadataIcc.data()),
-          VImage::option()
-            ->set("input_profile", processingProfile)
-            ->set("embedded", TRUE)
-            ->set("intent", VIPS_INTENT_PERCEPTUAL));
+        if (image.interpretation() == VIPS_INTERPRETATION_sRGB || !baton->withMetadataIcc.empty()) {
+          image = image.icc_transform(
+            baton->withMetadataIcc.empty() ? "srgb" : const_cast<char*>(baton->withMetadataIcc.data()),
+            VImage::option()
+              ->set("input_profile", processingProfile)
+              ->set("embedded", TRUE)
+              ->set("intent", VIPS_INTENT_PERCEPTUAL));
+        }
       }
       // Override EXIF Orientation tag
       if (baton->withMetadata && baton->withMetadataOrientation != -1) {

diff --git a/test/unit/metadata.js b/test/unit/metadata.js
@@ -794,6 +794,17 @@ describe('Image metadata', function () {
     assert.strictEqual(intent, 'Perceptual');
   });
 
+  it('withMetadata does not add default sRGB profile to RGB16', async () => {
+    const data = await sharp(fixtures.inputJpg)
+      .resize(32, 24)
+      .toColorspace('rgb16')
+      .withMetadata()
+      .toBuffer();
+
+    const metadata = await sharp(data).metadata();
+    assert.strictEqual(undefined, metadata.icc);
+  });
+
   it('File input with corrupt header fails gracefully', function (done) {
     sharp(fixtures.inputJpgWithCorruptHeader)
       .metadata(function (err) {