Fix alpha blending and add tests

SixLabors · Oct 30, 2023 · 66f444d · 66f444d
1 parent 56588d3
commit 66f444d
Show file tree

Hide file tree

Showing 58 changed files with 302 additions and 104 deletions.
diff --git a/src/ImageSharp/Formats/Png/PngDecoderCore.cs b/src/ImageSharp/Formats/Png/PngDecoderCore.cs
diff --git a/src/ImageSharp/ImageFrameCollection{TPixel}.cs b/src/ImageSharp/ImageFrameCollection{TPixel}.cs
@@ -2,7 +2,6 @@
 // Licensed under the Six Labors Split License.
 
 using System.Collections;
-using SixLabors.ImageSharp.Advanced;
 using SixLabors.ImageSharp.Memory;
 using SixLabors.ImageSharp.PixelFormats;
 

diff --git a/tests/ImageSharp.Tests/Formats/Png/PngDecoderTests.cs b/tests/ImageSharp.Tests/Formats/Png/PngDecoderTests.cs
@@ -78,6 +78,18 @@ public partial class PngDecoderTests
         { TestImages.Png.Rgba64Bpp, typeof(Image<Rgba64>) },
     };
 
+    public static readonly string[] MultiFrameTestFiles =
+    {
+        //TestImages.Png.APng,
+        //TestImages.Png.SplitIDatZeroLength,
+        //TestImages.Png.DisposeNone,
+        //TestImages.Png.DisposeBackground,
+        //TestImages.Png.DisposeBackgroundRegion,
+        //TestImages.Png.DisposePreviousFirst,
+        //TestImages.Png.DisposeBackgroundBeforeRegion,
+        TestImages.Png.BlendOverMultiple
+    };
+
     [Theory]
     [MemberData(nameof(PixelFormatRange))]
     public void Decode_NonGeneric_CreatesCorrectImageType(string path, Type type)
@@ -107,16 +119,16 @@ public void Decode<TPixel>(TestImageProvider<TPixel> provider)
     }
 
     [Theory]
-    [WithFile(TestImages.Png.APng, PixelTypes.Rgba32)]
-    public void Decode_APng<TPixel>(TestImageProvider<TPixel> provider)
-        where TPixel : unmanaged, IPixel<TPixel>
+    [WithFileCollection(nameof(MultiFrameTestFiles), PixelTypes.Rgba32)]
+    public void Decode_VerifyAllFrames<TPixel>(TestImageProvider<TPixel> provider)
+    where TPixel : unmanaged, IPixel<TPixel>
     {
         using Image<TPixel> image = provider.GetImage(PngDecoder.Instance);
 
-        Assert.Equal(5, image.Frames.Count);
-
-        // TODO: Assertations.
-        // MagickReferenceDecoder cannot decode APNGs (Though ImageMagick can, we likely need to update our mapping implementation)
+        // Some images have many frames, only compare a selection of them.
+        static bool Predicate(int i, int _) => i <= 8 || i % 8 == 0;
+        image.DebugSaveMultiFrame(provider, predicate: Predicate);
+        image.CompareToReferenceOutputMultiFrame(provider, ImageComparer.Exact, predicate: Predicate);
     }
 
     [Theory]

diff --git a/tests/ImageSharp.Tests/TestImages.cs b/tests/ImageSharp.Tests/TestImages.cs
@@ -61,7 +61,17 @@ public static class Png
         public const string TestPattern31x31 = "Png/testpattern31x31.png";
         public const string TestPattern31x31HalfTransparent = "Png/testpattern31x31-halftransparent.png";
         public const string XmpColorPalette = "Png/xmp-colorpalette.png";
-        public const string APng = "Png/apng.png";
+
+        // Animated
+        // https://philip.html5.org/tests/apng/tests.html
+        public const string APng = "Png/animated/apng.png";
+        public const string SplitIDatZeroLength = "Png/animated/4-split-idat-zero-length.png";
+        public const string DisposeNone = "Png/animated/7-dispose-none.png";
+        public const string DisposeBackground = "Png/animated/8-dispose-background.png";
+        public const string DisposeBackgroundBeforeRegion = "Png/animated/14-dispose-background-before-region.png";
+        public const string DisposeBackgroundRegion = "Png/animated/15-dispose-background-region.png";
+        public const string DisposePreviousFirst = "Png/animated/12-dispose-prev-first.png";
+        public const string BlendOverMultiple = "Png/animated/21-blend-over-multiple.png";
 
         // Filtered test images from http://www.schaik.com/pngsuite/pngsuite_fil_png.html
         public const string Filter0 = "Png/filter0.png";

diff --git a/tests/ImageSharp.Tests/TestUtilities/ImagingTestCaseUtility.cs b/tests/ImageSharp.Tests/TestUtilities/ImagingTestCaseUtility.cs
@@ -179,7 +179,7 @@ public class ImagingTestCaseUtility
         return path;
     }
 
-    public IEnumerable<string> GetTestOutputFileNamesMultiFrame(
+    public IEnumerable<(int Index, string FileName)> GetTestOutputFileNamesMultiFrame(
         int frameCount,
         string extension = null,
         object testOutputDetails = null,
@@ -201,11 +201,11 @@ public class ImagingTestCaseUtility
                 continue;
             }
 
-            yield return $"{baseDir}/{i:D2}.{extension}";
+            yield return (i, $"{baseDir}/{i:D2}.{extension}");
         }
     }
 
-    public string[] SaveTestOutputFileMultiFrame<TPixel>(
+    public (int Index, string FileName)[] SaveTestOutputFileMultiFrame<TPixel>(
         Image<TPixel> image,
         string extension = "png",
         IImageEncoder encoder = null,
@@ -216,27 +216,17 @@ public class ImagingTestCaseUtility
     {
         encoder ??= TestEnvironment.GetReferenceEncoder($"foo.{extension}");
 
-        string[] files = this.GetTestOutputFileNamesMultiFrame(
+        (int Index, string FileName)[] files = this.GetTestOutputFileNamesMultiFrame(
             image.Frames.Count,
             extension,
             testOutputDetails,
             appendPixelTypeToFileName,
             predicate: predicate).ToArray();
 
-        for (int i = 0; i < image.Frames.Count; i++)
+        foreach ((int Index, string FileName) file in files)
         {
-            if (predicate != null && !predicate(i, image.Frames.Count))
-            {
-                continue;
-            }
-
-            if (i >= files.Length)
-            {
-                break;
-            }
-
-            using Image<TPixel> frameImage = image.Frames.CloneFrame(i);
-            string filePath = files[i];
+            using Image<TPixel> frameImage = image.Frames.CloneFrame(file.Index);
+            string filePath = file.FileName;
             using FileStream stream = File.OpenWrite(filePath);
             frameImage.Save(stream, encoder);
         }
@@ -252,14 +242,14 @@ public class ImagingTestCaseUtility
         => TestEnvironment.GetReferenceOutputFileName(
             this.GetTestOutputFileName(extension, testOutputDetails, appendPixelTypeToFileName, appendSourceFileOrDescription));
 
-    public string[] GetReferenceOutputFileNamesMultiFrame(
+    public (int Index, string FileName)[] GetReferenceOutputFileNamesMultiFrame(
         int frameCount,
         string extension,
         object testOutputDetails,
         bool appendPixelTypeToFileName = true,
         Func<int, int, bool> predicate = null)
         => this.GetTestOutputFileNamesMultiFrame(frameCount, extension, testOutputDetails, appendPixelTypeToFileName, predicate: predicate)
-        .Select(TestEnvironment.GetReferenceOutputFileName).ToArray();
+        .Select(x => (x.Index, TestEnvironment.GetReferenceOutputFileName(x.FileName))).ToArray();
 
     internal void Init(string typeName, string methodName, string outputSubfolderName)
     {

diff --git a/tests/ImageSharp.Tests/TestUtilities/TestImageExtensions.cs b/tests/ImageSharp.Tests/TestUtilities/TestImageExtensions.cs
@@ -336,7 +336,7 @@ public static class TestImageExtensions
         Func<int, int, bool> predicate = null)
         where TPixel : unmanaged, IPixel<TPixel>
     {
-        string[] frameFiles = provider.Utility.GetReferenceOutputFileNamesMultiFrame(
+        (int Index, string FileName)[] frameFiles = provider.Utility.GetReferenceOutputFileNamesMultiFrame(
             frameCount,
             extension,
             testOutputDetails,
@@ -345,10 +345,11 @@ public static class TestImageExtensions
 
         List<Image<TPixel>> temporaryFrameImages = new();
 
-        IImageDecoder decoder = TestEnvironment.GetReferenceDecoder(frameFiles[0]);
+        IImageDecoder decoder = TestEnvironment.GetReferenceDecoder(frameFiles[0].FileName);
 
-        foreach (string path in frameFiles)
+        for (int i = 0; i < frameFiles.Length; i++)
         {
+            string path = frameFiles[i].FileName;
             if (!File.Exists(path))
             {
                 throw new FileNotFoundException("Reference output file missing: " + path);

diff --git a/tests/ImageSharp.Tests/TestUtilities/Tests/TestImageProviderTests.cs b/tests/ImageSharp.Tests/TestUtilities/Tests/TestImageProviderTests.cs
@@ -200,13 +200,13 @@ public void SaveTestOutputFileMultiFrame<TPixel>(TestImageProvider<TPixel> provi
         where TPixel : unmanaged, IPixel<TPixel>
     {
         using Image<TPixel> image = provider.GetImage();
-        string[] files = provider.Utility.SaveTestOutputFileMultiFrame(image);
+        (int Index, string FileName)[] files = provider.Utility.SaveTestOutputFileMultiFrame(image);
 
         Assert.True(files.Length > 2);
-        foreach (string path in files)
+        foreach ((int Index, string FileName) file in files)
         {
-            this.Output.WriteLine(path);
-            Assert.True(File.Exists(path));
+            this.Output.WriteLine(file.FileName);
+            Assert.True(File.Exists(file.FileName));
         }
     }
 

diff --git a/.../PngDecoderTests/Decode_VerifyAllFrames_Rgba32_12-dispose-prev-first.png/00.png b/.../PngDecoderTests/Decode_VerifyAllFrames_Rgba32_12-dispose-prev-first.png/00.png
diff --git a/.../PngDecoderTests/Decode_VerifyAllFrames_Rgba32_12-dispose-prev-first.png/01.png b/.../PngDecoderTests/Decode_VerifyAllFrames_Rgba32_12-dispose-prev-first.png/01.png
diff --git a/...ts/Decode_VerifyAllFrames_Rgba32_14-dispose-background-before-region.png/00.png b/...ts/Decode_VerifyAllFrames_Rgba32_14-dispose-background-before-region.png/00.png
diff --git a/...ts/Decode_VerifyAllFrames_Rgba32_14-dispose-background-before-region.png/01.png b/...ts/Decode_VerifyAllFrames_Rgba32_14-dispose-background-before-region.png/01.png
diff --git a/...oderTests/Decode_VerifyAllFrames_Rgba32_15-dispose-background-region.png/00.png b/...oderTests/Decode_VerifyAllFrames_Rgba32_15-dispose-background-region.png/00.png
diff --git a/...oderTests/Decode_VerifyAllFrames_Rgba32_15-dispose-background-region.png/01.png b/...oderTests/Decode_VerifyAllFrames_Rgba32_15-dispose-background-region.png/01.png
diff --git a/...oderTests/Decode_VerifyAllFrames_Rgba32_15-dispose-background-region.png/02.png b/...oderTests/Decode_VerifyAllFrames_Rgba32_15-dispose-background-region.png/02.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/00.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/00.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/01.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/01.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/02.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/02.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/03.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/03.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/04.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/04.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/05.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/05.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/06.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/06.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/07.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/07.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/08.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/08.png
diff --git a/...ngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/104.png b/...ngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/104.png
diff --git a/...ngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/112.png b/...ngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/112.png
diff --git a/...ngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/120.png b/...ngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/120.png
diff --git a/...ngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/128.png b/...ngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/128.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/16.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/16.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/24.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/24.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/32.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/32.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/40.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/40.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/48.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/48.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/56.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/56.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/64.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/64.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/72.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/72.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/80.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/80.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/88.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/88.png
diff --git a/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/96.png b/...PngDecoderTests/Decode_VerifyAllFrames_Rgba32_21-blend-over-multiple.png/96.png
diff --git a/...gDecoderTests/Decode_VerifyAllFrames_Rgba32_4-split-idat-zero-length.png/00.png b/...gDecoderTests/Decode_VerifyAllFrames_Rgba32_4-split-idat-zero-length.png/00.png
diff --git a/...eOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_7-dispose-none.png/00.png b/...eOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_7-dispose-none.png/00.png
diff --git a/...eOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_7-dispose-none.png/01.png b/...eOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_7-dispose-none.png/01.png
diff --git a/...eOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_7-dispose-none.png/02.png b/...eOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_7-dispose-none.png/02.png
diff --git a/...t/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_8-dispose-background.png/00.png b/...t/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_8-dispose-background.png/00.png
diff --git a/...t/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_8-dispose-background.png/01.png b/...t/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_8-dispose-background.png/01.png
diff --git a/...t/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_8-dispose-background.png/02.png b/...t/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_8-dispose-background.png/02.png
diff --git a/...l/ReferenceOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_apng.png/00.png b/...l/ReferenceOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_apng.png/00.png
diff --git a/...l/ReferenceOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_apng.png/01.png b/...l/ReferenceOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_apng.png/01.png
diff --git a/...l/ReferenceOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_apng.png/02.png b/...l/ReferenceOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_apng.png/02.png
diff --git a/...l/ReferenceOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_apng.png/03.png b/...l/ReferenceOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_apng.png/03.png
diff --git a/...l/ReferenceOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_apng.png/04.png b/...l/ReferenceOutput/PngDecoderTests/Decode_VerifyAllFrames_Rgba32_apng.png/04.png
diff --git a/tests/Images/Input/Png/animated/12-dispose-prev-first.png b/tests/Images/Input/Png/animated/12-dispose-prev-first.png
diff --git a/tests/Images/Input/Png/animated/14-dispose-background-before-region.png b/tests/Images/Input/Png/animated/14-dispose-background-before-region.png
diff --git a/tests/Images/Input/Png/animated/15-dispose-background-region.png b/tests/Images/Input/Png/animated/15-dispose-background-region.png
diff --git a/tests/Images/Input/Png/animated/21-blend-over-multiple.png b/tests/Images/Input/Png/animated/21-blend-over-multiple.png
diff --git a/tests/Images/Input/Png/animated/4-split-idat-zero-length.png b/tests/Images/Input/Png/animated/4-split-idat-zero-length.png
diff --git a/tests/Images/Input/Png/animated/7-dispose-none.png b/tests/Images/Input/Png/animated/7-dispose-none.png
diff --git a/tests/Images/Input/Png/animated/8-dispose-background.png b/tests/Images/Input/Png/animated/8-dispose-background.png
diff --git a/tests/Images/Input/Png/apng.png → tests/Images/Input/Png/animated/apng.png b/tests/Images/Input/Png/apng.png → tests/Images/Input/Png/animated/apng.png