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

// Copyright (c) Six Labors.
// Licensed under the Six Labors Split License.

using SixLabors.ImageSharp.Formats.Jpeg;
using SixLabors.ImageSharp.Metadata;
using SixLabors.ImageSharp.Metadata.Profiles.Exif;
using SixLabors.ImageSharp.Metadata.Profiles.Icc;
using SixLabors.ImageSharp.Metadata.Profiles.Iptc;
using SixLabors.ImageSharp.PixelFormats;

namespace SixLabors.ImageSharp.Tests.Formats.Jpg;

[Trait("Format", "Jpg")]
public partial class JpegEncoderTests
{
    public static readonly TheoryData<string, int, int, PixelResolutionUnit> RatioFiles =
        new()
        {
            { TestImages.Jpeg.Baseline.Ratio1x1, 1, 1, PixelResolutionUnit.AspectRatio },
            { TestImages.Jpeg.Baseline.Snake, 300, 300, PixelResolutionUnit.PixelsPerInch },
            { TestImages.Jpeg.Baseline.GammaDalaiLamaGray, 72, 72, PixelResolutionUnit.PixelsPerInch }
        };

    public static readonly TheoryData<string, int> QualityFiles =
        new()
        {
            { TestImages.Jpeg.Baseline.Calliphora, 80 },
            { TestImages.Jpeg.Progressive.Fb, 75 }
        };

    [Fact]
    public void Encode_PreservesIptcProfile()
    {
        // arrange
        using Image<Rgba32> input = new(1, 1);
        IptcProfile expectedProfile = new();
        expectedProfile.SetValue(IptcTag.Country, "ESPAÑA");
        expectedProfile.SetValue(IptcTag.City, "unit-test-city");
        input.Metadata.IptcProfile = expectedProfile;

        // act
        using MemoryStream memStream = new();
        input.Save(memStream, JpegEncoder);

        // assert
        memStream.Position = 0;
        using Image<Rgba32> output = Image.Load<Rgba32>(memStream);
        IptcProfile actual = output.Metadata.IptcProfile;
        Assert.NotNull(actual);
        IEnumerable<IptcValue> values = expectedProfile.Values;
        Assert.Equal(values, actual.Values);
    }

    [Fact]
    public void Encode_PreservesExifProfile()
    {
        // arrange
        using Image<Rgba32> input = new(1, 1);
        input.Metadata.ExifProfile = new ExifProfile();
        input.Metadata.ExifProfile.SetValue(ExifTag.Software, "unit_test");

        // act
        using MemoryStream memStream = new();
        input.Save(memStream, JpegEncoder);

        // assert
        memStream.Position = 0;
        using Image<Rgba32> output = Image.Load<Rgba32>(memStream);
        ExifProfile actual = output.Metadata.ExifProfile;
        Assert.NotNull(actual);
        IReadOnlyList<IExifValue> values = input.Metadata.ExifProfile.Values;
        Assert.Equal(values, actual.Values);
    }

    [Fact]
    public void Encode_PreservesIccProfile()
    {
        // arrange
        using Image<Rgba32> input = new(1, 1);
        input.Metadata.IccProfile = new IccProfile(IccTestDataProfiles.Profile_Random_Array);

        // act
        using MemoryStream memStream = new();
        input.Save(memStream, JpegEncoder);

        // assert
        memStream.Position = 0;
        using Image<Rgba32> output = Image.Load<Rgba32>(memStream);
        IccProfile actual = output.Metadata.IccProfile;
        Assert.NotNull(actual);
        IccProfile values = input.Metadata.IccProfile;
        Assert.Equal(values.Entries, actual.Entries);
    }

    [Theory]
    [WithFile(TestImages.Jpeg.Issues.ValidExifArgumentNullExceptionOnEncode, PixelTypes.Rgba32)]
    public void Encode_WithValidExifProfile_DoesNotThrowException<TPixel>(TestImageProvider<TPixel> provider)
        where TPixel : unmanaged, IPixel<TPixel>
    {
        Exception ex = Record.Exception(() =>
        {
            JpegEncoder encoder = new();
            using MemoryStream stream = new();
            using Image<TPixel> image = provider.GetImage(JpegDecoder.Instance);
            image.Save(stream, encoder);
        });

        Assert.Null(ex);
    }

    [Theory]
    [MemberData(nameof(RatioFiles))]
    public void Encode_PreserveRatio(string imagePath, int xResolution, int yResolution, PixelResolutionUnit resolutionUnit)
    {
        TestFile testFile = TestFile.Create(imagePath);
        using Image<Rgba32> input = testFile.CreateRgba32Image();
        using MemoryStream memStream = new();
        input.Save(memStream, JpegEncoder);

        memStream.Position = 0;
        using Image<Rgba32> output = Image.Load<Rgba32>(memStream);
        ImageMetadata meta = output.Metadata;
        Assert.Equal(xResolution, meta.HorizontalResolution);
        Assert.Equal(yResolution, meta.VerticalResolution);
        Assert.Equal(resolutionUnit, meta.ResolutionUnits);
    }

    [Theory]
    [MemberData(nameof(QualityFiles))]
    public void Encode_PreservesQuality(string imagePath, int quality)
    {
        TestFile testFile = TestFile.Create(imagePath);
        using Image<Rgba32> input = testFile.CreateRgba32Image();
        using MemoryStream memStream = new();
        input.Save(memStream, JpegEncoder);

        memStream.Position = 0;
        using Image<Rgba32> output = Image.Load<Rgba32>(memStream);
        JpegMetadata meta = output.Metadata.GetJpegMetadata();
        Assert.Equal(quality, meta.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 Image<TPixel> input = provider.GetImage(JpegDecoder.Instance);
        using MemoryStream memStream = new();

        // act
        input.Save(memStream, JpegEncoder);

        // assert
        memStream.Position = 0;
        using Image<Rgba32> 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[0].ToString());
    }

    [Fact]
    public void Encode_SavesMultipleComments()
    {
        // arrange
        using Image<Rgba32> input = new(1, 1);
        JpegMetadata meta = input.Metadata.GetJpegMetadata();
        using MemoryStream memStream = new();

        // act
        meta.Comments.Add(JpegComData.FromString("First comment"));
        meta.Comments.Add(JpegComData.FromString("Second Comment"));
        input.Save(memStream, JpegEncoder);

        // assert
        memStream.Position = 0;
        using Image<Rgba32> output = Image.Load<Rgba32>(memStream);
        JpegMetadata actual = output.Metadata.GetJpegMetadata();
        Assert.NotEmpty(actual.Comments);
        Assert.Equal(2, actual.Comments.Count);
        Assert.Equal(meta.Comments[0].ToString(), actual.Comments[0].ToString());
        Assert.Equal(meta.Comments[1].ToString(), actual.Comments[1].ToString());
    }

    [Fact]
    public void Encode_SaveTooLongComment()
    {
        // arrange
        string longString = new('c', 65534);
        using Image<Rgba32> input = new(1, 1);
        JpegMetadata meta = input.Metadata.GetJpegMetadata();
        using MemoryStream memStream = new();

        // act
        meta.Comments.Add(JpegComData.FromString(longString));
        input.Save(memStream, JpegEncoder);

        // assert
        memStream.Position = 0;
        using Image<Rgba32> output = Image.Load<Rgba32>(memStream);
        JpegMetadata actual = output.Metadata.GetJpegMetadata();
        Assert.NotEmpty(actual.Comments);
        Assert.Equal(2, actual.Comments.Count);
        Assert.Equal(longString[..65533], actual.Comments[0].ToString());
        Assert.Equal("c", actual.Comments[1].ToString());
    }

    [Theory]
    [WithFile(TestImages.Jpeg.Baseline.Floorplan, PixelTypes.Rgb24, JpegColorType.Luminance)]
    [WithFile(TestImages.Jpeg.Baseline.Jpeg444, PixelTypes.Rgb24, JpegColorType.YCbCrRatio444)]
    [WithFile(TestImages.Jpeg.Baseline.Jpeg420Small, PixelTypes.Rgb24, JpegColorType.YCbCrRatio420)]
    [WithFile(TestImages.Jpeg.Baseline.JpegRgb, PixelTypes.Rgb24, JpegColorType.Rgb)]
    public void Encode_PreservesColorType<TPixel>(TestImageProvider<TPixel> provider, JpegColorType expectedColorType)
        where TPixel : unmanaged, IPixel<TPixel>
    {
        // arrange
        using Image<TPixel> input = provider.GetImage(JpegDecoder.Instance);
        using MemoryStream memoryStream = new();

        // act
        input.Save(memoryStream, JpegEncoder);

        // assert
        memoryStream.Position = 0;
        using Image<Rgba32> output = Image.Load<Rgba32>(memoryStream);
        JpegMetadata meta = output.Metadata.GetJpegMetadata();
        Assert.Equal(expectedColorType, meta.ColorType);
    }
}