add jpeg com marker support

Author: RobertMut

ImageSharp.sln

@@ -237,6 +237,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "issues", "issues", "{5C9B68
 		tests\Images\Input\Jpg\issues\issue750-exif-tranform.jpg = tests\Images\Input\Jpg\issues\issue750-exif-tranform.jpg
 		tests\Images\Input\Jpg\issues\Issue845-Incorrect-Quality99.jpg = tests\Images\Input\Jpg\issues\Issue845-Incorrect-Quality99.jpg
 		tests\Images\Input\Jpg\issues\issue855-incorrect-colorspace.jpg = tests\Images\Input\Jpg\issues\issue855-incorrect-colorspace.jpg
+		tests\Images\Input\Jpg\issues\issue-2067-comment.jpg = tests\Images\Input\Jpg\issues\issue-2067-comment.jpg
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "fuzz", "fuzz", "{516A3532-6AC2-417B-AD79-9BD5D0D378A0}"

src/ImageSharp/Formats/Jpeg/JpegDecoderCore.cs

@@ -6,6 +6,7 @@
 using System.Buffers.Binary;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
+using System.Text;
 using SixLabors.ImageSharp.Common.Helpers;
 using SixLabors.ImageSharp.Formats.Jpeg.Components;
 using SixLabors.ImageSharp.Formats.Jpeg.Components.Decoder;
@@ -481,7 +482,7 @@ internal void ParseStream(BufferedReadStream stream, SpectralConverter spectralC
 
                     case JpegConstants.Markers.APP15:
                     case JpegConstants.Markers.COM:
-                        stream.Skip(markerContentByteSize);
+                        this.ProcessComMarker(stream, markerContentByteSize);
                         break;
 
                     case JpegConstants.Markers.DAC:
@@ -515,6 +516,23 @@ public void Dispose()
         this.scanDecoder = null;
     }
 
+    /// <summary>
+    /// Assigns COM marker bytes to comment property
+    /// </summary>
+    /// <param name="stream">The input stream.</param>
+    /// <param name="markerContentByteSize">The remaining bytes in the segment block.</param>
+    private void ProcessComMarker(BufferedReadStream stream, int markerContentByteSize)
+    {
+        Span<byte> temp = stackalloc byte[markerContentByteSize];
+        char[] chars = new char[markerContentByteSize];
+        JpegMetadata metadata = this.Metadata.GetFormatMetadata(JpegFormat.Instance);
+
+        stream.Read(temp);
+        Encoding.ASCII.GetChars(temp, chars);
+
+        metadata.Comments.Add(chars);
+    }
+
     /// <summary>
     /// Returns encoded colorspace based on the adobe APP14 marker.
     /// </summary>

src/ImageSharp/Formats/Jpeg/JpegEncoderCore.cs

@@ -3,6 +3,7 @@
 #nullable disable
 
 using System.Buffers.Binary;
+using System.Text;
 using SixLabors.ImageSharp.Common.Helpers;
 using SixLabors.ImageSharp.Formats.Jpeg.Components;
 using SixLabors.ImageSharp.Formats.Jpeg.Components.Encoder;
@@ -89,6 +90,9 @@ public void Encode<TPixel>(Image<TPixel> image, Stream stream, CancellationToken
         // Write Exif, XMP, ICC and IPTC profiles
         this.WriteProfiles(metadata, buffer);
 
+        // Write comments
+        this.WriteComment(jpegMetadata);
+
         // Write the image dimensions.
         this.WriteStartOfFrame(image.Width, image.Height, frameConfig, buffer);
 
@@ -167,6 +171,47 @@ private void WriteJfifApplicationHeader(ImageMetadata meta, Span<byte> buffer)
         this.outputStream.Write(buffer, 0, 18);
     }
 
+    /// <summary>
+    /// Writes comment
+    /// </summary>
+    /// <param name="metadata">The image metadata.</param>
+    private void WriteComment(JpegMetadata metadata)
+    {
+        if (metadata.Comments is { Count: 0 })
+        {
+            return;
+        }
+
+        // Length (comment strings lengths) + (comments markers with payload sizes)
+        int commentsBytes = metadata.Comments.Sum(x => x.Length) + (metadata.Comments.Count * 4);
+        int commentStart = 0;
+        Span<byte> commentBuffer = stackalloc byte[commentsBytes];
+
+        foreach (Memory<char> comment in metadata.Comments)
+        {
+            int totalComLength = comment.Length + 4;
+
+            Span<byte> commentData = commentBuffer.Slice(commentStart, totalComLength);
+            Span<byte> markers = commentData.Slice(0, 2);
+            Span<byte> payloadSize = commentData.Slice(2, 2);
+            Span<byte> payload = commentData.Slice(4, comment.Length);
+
+            // Beginning of comment ff fe
+            markers[0] = JpegConstants.Markers.XFF;
+            markers[1] = JpegConstants.Markers.COM;
+
+            // Write payload size
+            BinaryPrimitives.WriteInt16BigEndian(payloadSize, (short)(commentData.Length - 2));
+
+            Encoding.ASCII.GetBytes(comment.Span, payload);
+
+            // Indicate begin of next comment in buffer
+            commentStart += totalComLength;
+        }
+
+        this.outputStream.Write(commentBuffer, 0, commentBuffer.Length);
+    }
+
     /// <summary>
     /// Writes the Define Huffman Table marker and tables.
     /// </summary>

src/ImageSharp/Formats/Jpeg/JpegMetadata.cs

@@ -15,6 +15,7 @@ public class JpegMetadata : IDeepCloneable
     /// </summary>
     public JpegMetadata()
     {
+        this.Comments = new List<Memory<char>>();
     }
 
     /// <summary>
@@ -25,6 +26,7 @@ private JpegMetadata(JpegMetadata other)
     {
         this.ColorType = other.ColorType;
 
+        this.Comments = other.Comments;
         this.LuminanceQuality = other.LuminanceQuality;
         this.ChrominanceQuality = other.ChrominanceQuality;
     }
@@ -101,6 +103,11 @@ public int Quality
     /// </remarks>
     public bool? Progressive { get; internal set; }
 
+    /// <summary>
+    /// Gets the comments.
+    /// </summary>
+    public ICollection<Memory<char>>? Comments { get; }
+
     /// <inheritdoc/>
     public IDeepCloneable DeepClone() => new JpegMetadata(this);
 }

src/ImageSharp/Formats/Jpeg/MetadataExtensions.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
+using System.Text;
 using SixLabors.ImageSharp.Formats.Jpeg;
 using SixLabors.ImageSharp.Metadata;
 
@@ -17,4 +18,24 @@ public static partial class MetadataExtensions
     /// <param name="metadata">The metadata this method extends.</param>
     /// <returns>The <see cref="JpegMetadata"/>.</returns>
     public static JpegMetadata GetJpegMetadata(this ImageMetadata metadata) => metadata.GetFormatMetadata(JpegFormat.Instance);
+
+    /// <summary>
+    /// Saves the comment into <see cref="JpegMetadata"/>
+    /// </summary>
+    /// <param name="metadata">The metadata this method extends.</param>
+    /// <param name="comment">The comment string.</param>
+    public static void SaveComment(this JpegMetadata metadata, string comment)
+    {
+        ASCIIEncoding encoding = new();
+
+        byte[] bytes = encoding.GetBytes(comment);
+        metadata.Comments?.Add(encoding.GetChars(bytes));
+    }
+
+    /// <summary>
+    /// Gets the comments from <see cref="JpegMetadata"/>
+    /// </summary>
+    /// <param name="metadata">The metadata this method extends.</param>
+    /// <returns>The IEnumerable string of comments.</returns>
+    public static IEnumerable<string>? GetComments(this JpegMetadata metadata) => metadata.Comments?.Select(x => x.ToString());
 }

tests/ImageSharp.Tests/Formats/Jpg/JpegDecoderTests.cs

@@ -364,4 +364,19 @@ public void Issue2517_DecodeWorks<TPixel>(TestImageProvider<TPixel> provider)
         image.DebugSave(provider);
         image.CompareToOriginal(provider);
     }
+
+    [Theory]
+    [WithFile(TestImages.Jpeg.Issues.Issue2067_CommentMarker, PixelTypes.Rgba32)]
+    public void JpegDecoder_DecodeMetadataComment<TPixel>(TestImageProvider<TPixel> provider)
+        where TPixel : unmanaged, IPixel<TPixel>
+    {
+        string expectedComment = "TEST COMMENT";
+        using Image<TPixel> image = provider.GetImage(JpegDecoder.Instance);
+        JpegMetadata metadata = image.Metadata.GetJpegMetadata();
+
+        Assert.Equal(1, metadata.Comments?.Count);
+        Assert.Equal(expectedComment, metadata.GetComments()?.FirstOrDefault());
+        image.DebugSave(provider);
+        image.CompareToOriginal(provider);
+    }
 }

tests/ImageSharp.Tests/Formats/Jpg/JpegEncoderTests.Metadata.cs

@@ -154,6 +154,50 @@ public void Encode_PreservesQuality(string imagePath, int quality)
         }
     }
 
+    [Theory]
+    [WithFile(TestImages.Jpeg.Issues.Issue2067_CommentMarker, PixelTypes.Rgba32)]
+    public void Encode_PreservesComments<TPixel>(TestImageProvider<TPixel> provider)
+        where TPixel : unmanaged, IPixel<TPixel>
+    {
+        // arrange
+        using var input = provider.GetImage(JpegDecoder.Instance);
+        using var memStream = new MemoryStream();
+
+        // act
+        input.Save(memStream, JpegEncoder);
+
+        // assert
+        memStream.Position = 0;
+        using var output = Image.Load<Rgba32>(memStream);
+        JpegMetadata actual = output.Metadata.GetJpegMetadata();
+        Assert.NotEmpty(actual.Comments);
+        Assert.Equal(1, actual.Comments.Count);
+        Assert.Equal("TEST COMMENT", actual.Comments.ElementAt(0).ToString());
+    }
+
+    [Fact]
+    public void Encode_SavesMultipleComments()
+    {
+        // arrange
+        using var input = new Image<Rgba32>(1, 1);
+        JpegMetadata meta = input.Metadata.GetJpegMetadata();
+        using var memStream = new MemoryStream();
+
+        // act
+        meta.SaveComment("First comment");
+        meta.SaveComment("Second Comment");
+        input.Save(memStream, JpegEncoder);
+
+        // assert
+        memStream.Position = 0;
+        using var output = Image.Load<Rgba32>(memStream);
+        JpegMetadata actual = output.Metadata.GetJpegMetadata();
+        Assert.NotEmpty(actual.Comments);
+        Assert.Equal(2, actual.Comments.Count);
+        Assert.Equal(meta.Comments.ElementAt(0).ToString(), actual.Comments.ElementAt(0).ToString());
+        Assert.Equal(meta.Comments.ElementAt(1).ToString(), actual.Comments.ElementAt(1).ToString());
+    }
+
     [Theory]
     [WithFile(TestImages.Jpeg.Baseline.Floorplan, PixelTypes.Rgb24, JpegEncodingColor.Luminance)]
     [WithFile(TestImages.Jpeg.Baseline.Jpeg444, PixelTypes.Rgb24, JpegEncodingColor.YCbCrRatio444)]

tests/ImageSharp.Tests/Formats/Jpg/JpegMetadataTests.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
+using System.Collections.ObjectModel;
 using SixLabors.ImageSharp.Formats.Jpeg;
 
 namespace SixLabors.ImageSharp.Tests.Formats.Jpg;
@@ -55,6 +56,27 @@ public void Quality_ReturnsMaxQuality()
 
         var meta = new JpegMetadata { LuminanceQuality = qualityLuma, ChrominanceQuality = qualityChroma };
 
-        Assert.Equal(meta.Quality, qualityLuma);
+    Assert.Equal(meta.Quality, qualityLuma);
+    }
+
+    [Fact]
+    public void Comment_EmptyComment()
+    {
+        var meta = new JpegMetadata();
+
+        Assert.True(Array.Empty<Memory<char>>().SequenceEqual(meta.Comments));
+    }
+
+    [Fact]
+    public void Comment_OnlyComment()
+    {
+        string comment = "test comment";
+        var expectedCollection = new Collection<Memory<char>> { new(comment.ToCharArray()) };
+
+        var meta = new JpegMetadata();
+        meta.Comments?.Add(comment.ToCharArray());
+
+        Assert.Equal(1, meta.Comments?.Count);
+        Assert.True(expectedCollection.FirstOrDefault().ToString() == meta.Comments?.FirstOrDefault().ToString());
     }
 }

tests/ImageSharp.Tests/TestImages.cs

@@ -309,6 +309,7 @@ public static class Issues
             public const string Issue2564 = "Jpg/issues/issue-2564.jpg";
             public const string HangBadScan = "Jpg/issues/Hang_C438A851.jpg";
             public const string Issue2517 = "Jpg/issues/issue2517-bad-d7.jpg";
+            public const string Issue2067_CommentMarker = "Jpg/issues/issue-2067-comment.jpg";
 
             public static class Fuzz
             {