Merge pull request #3028 from Socolin/png-icc

Apply ICC Profile / Color Conversion when decoding PNG

src/ImageSharp/ColorProfiles/ColorProfileConverterExtensionsIcc.cs

@@ -39,6 +39,24 @@ internal static class ColorProfileConverterExtensionsIcc
          0.0033717495F, 0.0034852044F, 0.0028800198F, 0F,
          0.0033717495F, 0.0034852044F, 0.0028800198F, 0F];
 
+    /// <summary>
+    /// Converts a color value from one ICC color profile to another using the specified color profile converter.
+    /// </summary>
+    /// <remarks>
+    /// This method performs color conversion using ICC profiles, ensuring accurate color mapping
+    /// between different color spaces. Both the source and target ICC profiles must be provided in the converter's
+    /// options. The method supports perceptual adjustments when required by the profiles.
+    /// </remarks>
+    /// <typeparam name="TFrom">The type representing the source color profile. Must implement <see cref="IColorProfile{TFrom}"/>.</typeparam>
+    /// <typeparam name="TTo">The type representing the destination color profile. Must implement <see cref="IColorProfile{TTo}"/>.</typeparam>
+    /// <param name="converter">The color profile converter configured with source and target ICC profiles.</param>
+    /// <param name="source">The color value to convert, defined in the source color profile.</param>
+    /// <returns>
+    /// A color value in the target color profile, resulting from the ICC profile-based conversion of the source value.
+    /// </returns>
+    /// <exception cref="InvalidOperationException">
+    /// Thrown if either the source or target ICC profile is missing from the converter options.
+    /// </exception>
     internal static TTo ConvertUsingIccProfile<TFrom, TTo>(this ColorProfileConverter converter, in TFrom source)
         where TFrom : struct, IColorProfile<TFrom>
         where TTo : struct, IColorProfile<TTo>
@@ -81,6 +99,29 @@ internal static class ColorProfileConverterExtensionsIcc
         return TTo.FromScaledVector4(targetParams.Converter.Calculate(targetPcs));
     }
 
+    /// <summary>
+    /// Converts a span of color values from a source color profile to a destination color profile using ICC profiles.
+    /// </summary>
+    /// <remarks>
+    /// This method performs color conversion by transforming the input values through the Profile
+    /// Connection Space (PCS) as defined by the provided ICC profiles. Perceptual adjustments are applied as required
+    /// by the profiles. The method does not support absolute colorimetric intent and will not perform such
+    /// conversions.
+    /// </remarks>
+    /// <typeparam name="TFrom">The type representing the source color profile. Must implement <see cref="IColorProfile{TFrom}"/>.</typeparam>
+    /// <typeparam name="TTo">The type representing the destination color profile. Must implement <see cref="IColorProfile{TTo}"/>.</typeparam>
+    /// <param name="converter">The color profile converter that provides conversion options and ICC profiles.</param>
+    /// <param name="source">
+    /// A read-only span containing the source color values to convert. The values must conform to the source color
+    /// profile.
+    /// </param>
+    /// <param name="destination">
+    /// A span to receive the converted color values in the destination color profile. Must be at least as large as the
+    /// source span.
+    /// </param>
+    /// <exception cref="InvalidOperationException">
+    /// Thrown if the source or target ICC profile is missing from the converter options.
+    /// </exception>
     internal static void ConvertUsingIccProfile<TFrom, TTo>(this ColorProfileConverter converter, ReadOnlySpan<TFrom> source, Span<TTo> destination)
         where TFrom : struct, IColorProfile<TFrom>
         where TTo : struct, IColorProfile<TTo>

src/ImageSharp/ColorProfiles/ColorProfileConverterExtensionsPixelCompatible.cs

@@ -0,0 +1,72 @@
+// Copyright (c) Six Labors.
+// Licensed under the Six Labors Split License.
+
+using System.Buffers;
+using System.Numerics;
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
+using SixLabors.ImageSharp.PixelFormats;
+using SixLabors.ImageSharp.Processing;
+
+namespace SixLabors.ImageSharp.ColorProfiles;
+
+internal static class ColorProfileConverterExtensionsPixelCompatible
+{
+    /// <summary>
+    /// Converts the pixel data of the specified image from the source color profile to the target color profile using
+    /// the provided color profile converter.
+    /// </summary>
+    /// <remarks>
+    /// This method modifies the source image in place by converting its pixel data according to the
+    /// color profiles specified in the converter. The method does not verify whether the profiles are RGB compatible;
+    /// if they are not, the conversion may produce incorrect results. Ensure that both the source and target ICC
+    /// profiles are set on the converter before calling this method.
+    /// </remarks>
+    /// <typeparam name="TPixel">The pixel format.</typeparam>
+    /// <param name="converter">The color profile converter configured with source and target ICC profiles.</param>
+    /// <param name="source">
+    /// The image whose pixel data will be converted. The conversion is performed in place, modifying the original
+    /// image.
+    /// </param>
+    /// <exception cref="InvalidOperationException">
+    /// Thrown if the converter's source or target ICC profile is not specified.
+    /// </exception>
+    public static void Convert<TPixel>(this ColorProfileConverter converter, Image<TPixel> source)
+        where TPixel : unmanaged, IPixel<TPixel>
+    {
+        // These checks actually take place within the converter, but we want to fail fast here.
+        // Note. we do not check to see whether the profiles themselves are RGB compatible,
+        // if they are not, then the converter will simply produce incorrect results.
+        if (converter.Options.SourceIccProfile is null)
+        {
+            throw new InvalidOperationException("Source ICC profile is missing.");
+        }
+
+        if (converter.Options.TargetIccProfile is null)
+        {
+            throw new InvalidOperationException("Target ICC profile is missing.");
+        }
+
+        // Process the rows in parallel chunks, the converter itself is thread safe.
+        source.Mutate(o => o.ProcessPixelRowsAsVector4(
+            row =>
+            {
+                // Gather and convert the pixels in the row to Rgb.
+                using IMemoryOwner<Rgb> rgbBuffer = converter.Options.MemoryAllocator.Allocate<Rgb>(row.Length);
+                Span<Rgb> rgbSpan = rgbBuffer.Memory.Span;
+                Rgb.FromScaledVector4(row, rgbSpan);
+
+                // Perform the actual color conversion.
+                converter.ConvertUsingIccProfile<Rgb, Rgb>(rgbSpan, rgbSpan);
+
+                // Copy the converted Rgb pixels back to the row as TPixel.
+                ref Vector4 rowRef = ref MemoryMarshal.GetReference(row);
+                for (int i = 0; i < rgbSpan.Length; i++)
+                {
+                    Vector3 rgb = rgbSpan[i].AsVector3Unsafe();
+                    Unsafe.As<Vector4, Vector3>(ref Unsafe.Add(ref rowRef, (uint)i)) = rgb;
+                }
+            },
+            PixelConversionModifiers.Scale));
+    }
+}

src/ImageSharp/Formats/ImageDecoderCore.cs

@@ -1,8 +1,11 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
+using SixLabors.ImageSharp.ColorProfiles;
+using SixLabors.ImageSharp.ColorProfiles.Icc;
 using SixLabors.ImageSharp.IO;
 using SixLabors.ImageSharp.Memory;
+using SixLabors.ImageSharp.Metadata.Profiles.Icc;
 using SixLabors.ImageSharp.PixelFormats;
 
 namespace SixLabors.ImageSharp.Formats;
@@ -124,4 +127,41 @@ internal abstract class ImageDecoderCore
     /// </remarks>
     protected abstract Image<TPixel> Decode<TPixel>(BufferedReadStream stream, CancellationToken cancellationToken)
         where TPixel : unmanaged, IPixel<TPixel>;
+
+    /// <summary>
+    /// Converts the ICC color profile of the specified image to the compact sRGB v4 profile if a source profile is
+    /// available.
+    /// </summary>
+    /// <remarks>
+    /// This method should only be used by decoders that gurantee that the encoded image data is in a color space
+    /// compatible with sRGB (e.g. standard RGB, Adobe RGB, ProPhoto RGB).
+    /// <br/>
+    /// If the image does not have a valid ICC profile for color conversion, no changes are made.
+    /// This operation may affect the color appearance of the image to ensure consistency with the sRGB color
+    /// space.
+    /// </remarks>
+    /// <typeparam name="TPixel">The pixel format.</typeparam>
+    /// <param name="image">The image whose ICC profile will be converted to the compact sRGB v4 profile.</param>
+    /// <returns>
+    /// <see langword="true"/> if the conversion was performed; otherwise, <see langword="false"/>.
+    /// </returns>
+    protected bool TryConvertIccProfile<TPixel>(Image<TPixel> image)
+        where TPixel : unmanaged, IPixel<TPixel>
+    {
+        if (!this.Options.TryGetIccProfileForColorConversion(image.Metadata.IccProfile, out IccProfile? profile))
+        {
+            return false;
+        }
+
+        ColorConversionOptions options = new()
+        {
+            SourceIccProfile = profile,
+            TargetIccProfile = CompactSrgbV4Profile.Profile,
+            MemoryAllocator = image.Configuration.MemoryAllocator,
+        };
+
+        ColorProfileConverter converter = new(options);
+        converter.Convert(image);
+        return true;
+    }
 }

src/ImageSharp/Formats/Png/PngDecoderCore.cs

@@ -212,6 +212,7 @@ internal sealed class PngDecoderCore : ImageDecoderCore
                             currentFrameControl = this.ReadFrameControlChunk(chunk.Data.GetSpan());
                             break;
                         case PngChunkType.FrameData:
+                        {
                             if (frameCount >= this.maxFrames)
                             {
                                 goto EOF;
@@ -246,7 +247,10 @@ internal sealed class PngDecoderCore : ImageDecoderCore
                             }
 
                             break;
+                        }
+
                         case PngChunkType.Data:
+                        {
                             pngMetadata.AnimateRootFrame = currentFrameControl != null;
                             currentFrameControl ??= new FrameControl((uint)this.header.Width, (uint)this.header.Height);
                             if (image is null)
@@ -276,6 +280,8 @@ internal sealed class PngDecoderCore : ImageDecoderCore
                             }
 
                             break;
+                        }
+
                         case PngChunkType.Palette:
                             this.palette = chunk.Data.GetSpan().ToArray();
                             break;
@@ -323,6 +329,7 @@ internal sealed class PngDecoderCore : ImageDecoderCore
                 PngThrowHelper.ThrowNoData();
             }
 
+            _ = this.TryConvertIccProfile(image);
             return image;
         }
         catch

tests/ImageSharp.Tests/Formats/Png/PngDecoderTests.cs

@@ -206,6 +206,22 @@ public partial class PngDecoderTests
         image.CompareToOriginal(provider, ImageComparer.Exact);
     }
 
+    [Theory]
+    [WithFile(TestImages.Png.Icc.Perceptual, PixelTypes.Rgba32)]
+    [WithFile(TestImages.Png.Icc.PerceptualcLUTOnly, PixelTypes.Rgba32)]
+    [WithFile(TestImages.Png.Icc.SRgbGray, PixelTypes.Rgba32)]
+    [WithFile(TestImages.Png.Icc.SRgbGrayInterlacedRgba32, PixelTypes.Rgba32)]
+    [WithFile(TestImages.Png.Icc.SRgbGrayInterlacedRgba64, PixelTypes.Rgba32)]
+    public void Decode_WhenColorProfileHandlingIsConvert_ApplyIccProfile<TPixel>(TestImageProvider<TPixel> provider)
+        where TPixel : unmanaged, IPixel<TPixel>
+    {
+        using Image<TPixel> image = provider.GetImage(PngDecoder.Instance, new DecoderOptions { ColorProfileHandling = ColorProfileHandling.Convert });
+
+        image.DebugSave(provider);
+        image.CompareToReferenceOutput(provider);
+        Assert.Null(image.Metadata.IccProfile);
+    }
+
     [Theory]
     [WithFile(TestImages.Png.SubFilter3BytesPerPixel, PixelTypes.Rgba32)]
     [WithFile(TestImages.Png.SubFilter4BytesPerPixel, PixelTypes.Rgba32)]

tests/ImageSharp.Tests/MemoryAllocatorValidator.cs

@@ -20,20 +20,13 @@ public static class MemoryAllocatorValidator
     private static void MemoryDiagnostics_MemoryReleased()
     {
         TestMemoryDiagnostics backing = LocalInstance.Value;
-        if (backing != null)
-        {
-            backing.TotalRemainingAllocated--;
-        }
+        backing?.OnReleased();
     }
 
     private static void MemoryDiagnostics_MemoryAllocated()
     {
         TestMemoryDiagnostics backing = LocalInstance.Value;
-        if (backing != null)
-        {
-            backing.TotalAllocated++;
-            backing.TotalRemainingAllocated++;
-        }
+        backing?.OnAllocated();
     }
 
     public static TestMemoryDiagnostics MonitorAllocations()
@@ -48,11 +41,23 @@ public static class MemoryAllocatorValidator
     public static void ValidateAllocations(int expectedAllocationCount = 0)
         => LocalInstance.Value?.Validate(expectedAllocationCount);
 
-    public class TestMemoryDiagnostics : IDisposable
+    public sealed class TestMemoryDiagnostics : IDisposable
     {
-        public int TotalAllocated { get; set; }
+        private int totalAllocated;
+        private int totalRemainingAllocated;
+
+        public int TotalAllocated => Volatile.Read(ref this.totalAllocated);
+
+        public int TotalRemainingAllocated => Volatile.Read(ref this.totalRemainingAllocated);
+
+        internal void OnAllocated()
+        {
+            Interlocked.Increment(ref this.totalAllocated);
+            Interlocked.Increment(ref this.totalRemainingAllocated);
+        }
 
-        public int TotalRemainingAllocated { get; set; }
+        internal void OnReleased()
+            => Interlocked.Decrement(ref this.totalRemainingAllocated);
 
         public void Validate(int expectedAllocationCount)
         {

tests/ImageSharp.Tests/TestImages.cs

@@ -166,6 +166,15 @@ public static class TestImages
         // Issue 3000: https://github.com/SixLabors/ImageSharp/issues/3000
         public const string Issue3000 = "Png/issues/issue_3000.png";
 
+        public static class Icc
+        {
+            public const string SRgbGray = "Png/icc-profiles/sRGB_Gray.png";
+            public const string SRgbGrayInterlacedRgba32 = "Png/icc-profiles/sRGB_Gray_Interlaced_Rgba32.png";
+            public const string SRgbGrayInterlacedRgba64 = "Png/icc-profiles/sRGB_Gray_Interlaced_Rgba64.png";
+            public const string Perceptual = "Png/icc-profiles/Perceptual.png";
+            public const string PerceptualcLUTOnly = "Png/icc-profiles/Perceptual-cLUT-only.png";
+        }
+
         public static class Bad
         {
             public const string MissingDataChunk = "Png/xdtn0g01.png";

tests/Images/External/ReferenceOutput/PngDecoderTests/Decode_WhenColorProfileHandlingIsConvert_ApplyIccProfile_Rgba32_Perceptual-cLUT-only.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b72c885278a066e63c013885c42b772275f25a5f0b2290aa38c87f3dbeac984b
+size 81432

tests/Images/External/ReferenceOutput/PngDecoderTests/Decode_WhenColorProfileHandlingIsConvert_ApplyIccProfile_Rgba32_Perceptual.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:936261278b1a9f5bf9a2bb4f8da09f2a82e1b5c693790e137c5f98fa4d885735
+size 81785

tests/Images/External/ReferenceOutput/PngDecoderTests/Decode_WhenColorProfileHandlingIsConvert_ApplyIccProfile_Rgba32_sRGB_Gray.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bf856e49e4ece7e59eea684f6fa533ba313a36955be4703894f16b100283cb4a
+size 2687

tests/Images/External/ReferenceOutput/PngDecoderTests/Decode_WhenColorProfileHandlingIsConvert_ApplyIccProfile_Rgba32_sRGB_Gray_Interlaced_Rgba32.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:337e84b78fb07359a42e7eee0eed32e6728497c64aa30c6bd5ea8a3a5ec67ebc
+size 5151

tests/Images/External/ReferenceOutput/PngDecoderTests/Decode_WhenColorProfileHandlingIsConvert_ApplyIccProfile_Rgba32_sRGB_Gray_Interlaced_Rgba64.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:456ae30184b13aa2dc3d922db433017e076ff969862fe506436ed96c2d9be0a1
+size 6143

tests/Images/Input/Png/icc-profiles/Perceptual-cLUT-only.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0c734cacc2c6e761bab088cac80ef09da7b56a545ce71c6cced4cac31e661795
+size 119811

tests/Images/Input/Png/icc-profiles/Perceptual.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:208a325dedea4453b7accce1ec540452af2e9be0f8c1f636f1d61a463eb3a9ae
+size 123151

tests/Images/Input/Png/icc-profiles/sRGB_Gray.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c64e0f6cc38750c83e6ff0cf1911e210c342900bb2cd6c88d3daed30c854e863
+size 4531

tests/Images/Input/Png/icc-profiles/sRGB_Gray_Interlaced_Rgba32.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4fc63cea5de188e76503bde2fce3ff84518af5064bb46d506420cd6d7e58285b
+size 7237

tests/Images/Input/Png/icc-profiles/sRGB_Gray_Interlaced_Rgba64.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:64343871be4ad61451ef968fa9f07c6a11dee65d0f8fd718ae8c4941586aa60c
+size 8227