Merge pull request #1020 from brianpopow/feature/Issue1014

WIP: Png decoder fix for Issue #1014

src/ImageSharp/Formats/Png/Zlib/ZlibInflateStream.cs

@@ -13,7 +13,7 @@ namespace SixLabors.ImageSharp.Formats.Png.Zlib
     internal sealed class ZlibInflateStream : Stream
     {
         /// <summary>
-        /// Used to read the Adler-32 and Crc-32 checksums
+        /// Used to read the Adler-32 and Crc-32 checksums.
         /// We don't actually use this for anything so it doesn't
         /// have to be threadsafe.
         /// </summary>
@@ -25,7 +25,7 @@ namespace SixLabors.ImageSharp.Formats.Png.Zlib
         private static readonly Func<int> GetDataNoOp = () => 0;
 
         /// <summary>
-        /// The inner raw memory stream
+        /// The inner raw memory stream.
         /// </summary>
         private readonly Stream innerStream;
 
@@ -43,12 +43,12 @@ namespace SixLabors.ImageSharp.Formats.Png.Zlib
         private bool isDisposed;
 
         /// <summary>
-        /// The current data remaining to be read
+        /// The current data remaining to be read.
         /// </summary>
         private int currentDataRemaining;
 
         /// <summary>
-        /// Delegate to get more data once we've exhausted the current data remaining
+        /// Delegate to get more data once we've exhausted the current data remaining.
         /// </summary>
         private readonly Func<int> getData;
 
@@ -88,14 +88,14 @@ namespace SixLabors.ImageSharp.Formats.Png.Zlib
         public override long Position { get => throw new NotSupportedException(); set => throw new NotSupportedException(); }
 
         /// <summary>
-        /// Gets the compressed stream over the deframed inner stream
+        /// Gets the compressed stream over the deframed inner stream.
         /// </summary>
         public DeflateStream CompressedStream { get; private set; }
 
         /// <summary>
-        /// Adds new bytes from a frame found in the original stream
+        /// Adds new bytes from a frame found in the original stream.
         /// </summary>
-        /// <param name="bytes">blabla</param>
+        /// <param name="bytes">The current remaining data according to the chunk length.</param>
         /// <param name="isCriticalChunk">Whether the chunk to be inflated is a critical chunk.</param>
         /// <returns>The <see cref="bool"/>.</returns>
         public bool AllocateNewBytes(int bytes, bool isCriticalChunk)
@@ -124,7 +124,7 @@ namespace SixLabors.ImageSharp.Formats.Png.Zlib
         {
             if (this.currentDataRemaining == 0)
             {
-                // last buffer was read in its entirety, let's make sure we don't actually have more
+                // Last buffer was read in its entirety, let's make sure we don't actually have more in additional IDAT chunks.
                 this.currentDataRemaining = this.getData();
 
                 if (this.currentDataRemaining == 0)
@@ -135,32 +135,35 @@ namespace SixLabors.ImageSharp.Formats.Png.Zlib
 
             int bytesToRead = Math.Min(count, this.currentDataRemaining);
             this.currentDataRemaining -= bytesToRead;
-            int bytesRead = this.innerStream.Read(buffer, offset, bytesToRead);
-            long length = this.innerStream.Length;
+            int totalBytesRead = this.innerStream.Read(buffer, offset, bytesToRead);
+            long innerStreamLength = this.innerStream.Length;
 
-            // Keep reading data until we've reached the end of the stream or filled the buffer
-            while (this.currentDataRemaining == 0 && bytesRead < count)
+            // Keep reading data until we've reached the end of the stream or filled the buffer.
+            int bytesRead = 0;
+            offset += totalBytesRead;
+            while (this.currentDataRemaining == 0 && totalBytesRead < count)
             {
                 this.currentDataRemaining = this.getData();
 
                 if (this.currentDataRemaining == 0)
                 {
-                    return bytesRead;
+                    return totalBytesRead;
                 }
 
                 offset += bytesRead;
 
-                if (offset >= length || offset >= count)
+                if (offset >= innerStreamLength || offset >= count)
                 {
-                    return bytesRead;
+                    return totalBytesRead;
                 }
 
-                bytesToRead = Math.Min(count - bytesRead, this.currentDataRemaining);
+                bytesToRead = Math.Min(count - totalBytesRead, this.currentDataRemaining);
                 this.currentDataRemaining -= bytesToRead;
-                bytesRead += this.innerStream.Read(buffer, offset, bytesToRead);
+                bytesRead = this.innerStream.Read(buffer, offset, bytesToRead);
+                totalBytesRead += bytesRead;
             }
 
-            return bytesRead;
+            return totalBytesRead;
         }
 
         /// <inheritdoc/>
@@ -191,7 +194,7 @@ namespace SixLabors.ImageSharp.Formats.Png.Zlib
 
             if (disposing)
             {
-                // dispose managed resources
+                // Dispose managed resources.
                 if (this.CompressedStream != null)
                 {
                     this.CompressedStream.Dispose();

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

@@ -75,6 +75,13 @@ namespace SixLabors.ImageSharp.Tests.Formats.Png
                 TestImages.Png.GrayAlpha8BitInterlaced
             };
 
+        public static readonly string[] TestImagesIssue1014 =
+        {
+            TestImages.Png.Issue1014_1, TestImages.Png.Issue1014_2,
+            TestImages.Png.Issue1014_3, TestImages.Png.Issue1014_4,
+            TestImages.Png.Issue1014_5, TestImages.Png.Issue1014_6
+        };
+
         [Theory]
         [WithFileCollection(nameof(CommonTestImages), PixelTypes.Rgba32)]
         public void Decode<TPixel>(TestImageProvider<TPixel> provider)
@@ -199,5 +206,22 @@ namespace SixLabors.ImageSharp.Tests.Formats.Png
                 Assert.Equal(expectedPixelSize, Image.Identify(stream)?.PixelType?.BitsPerPixel);
             }
         }
+
+        [Theory]
+        [WithFileCollection(nameof(TestImagesIssue1014), PixelTypes.Rgba32)]
+        public void Issue1014<TPixel>(TestImageProvider<TPixel> provider)
+            where TPixel : struct, IPixel<TPixel>
+        {
+            System.Exception ex = Record.Exception(
+                () =>
+                {
+                    using (Image<TPixel> image = provider.GetImage(new PngDecoder()))
+                    {
+                        image.DebugSave(provider);
+                        // TODO: compare to expected output
+                    }
+                });
+            Assert.Null(ex);
+        }
     }
 }

tests/ImageSharp.Tests/TestImages.cs

@@ -82,6 +82,14 @@ namespace SixLabors.ImageSharp.Tests
             public const string Ducky = "Png/ducky.png";
             public const string Rainbow = "Png/rainbow.png";
 
+            // Issue 1014: https://github.com/SixLabors/ImageSharp/issues/1014
+            public const string Issue1014_1 = "Png/issues/Issue_1014_1.png";
+            public const string Issue1014_2 = "Png/issues/Issue_1014_2.png";
+            public const string Issue1014_3 = "Png/issues/Issue_1014_3.png";
+            public const string Issue1014_4 = "Png/issues/Issue_1014_4.png";
+            public const string Issue1014_5 = "Png/issues/Issue_1014_5.png";
+            public const string Issue1014_6 = "Png/issues/Issue_1014_6.png";
+
             public static class Bad
             {
                 // Odd chunk lengths

tests/Images/Input/Png/issues/Issue_1014_1.png

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

tests/Images/Input/Png/issues/Issue_1014_2.png

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

tests/Images/Input/Png/issues/Issue_1014_3.png

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

tests/Images/Input/Png/issues/Issue_1014_4.png

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

tests/Images/Input/Png/issues/Issue_1014_5.png

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

tests/Images/Input/Png/issues/Issue_1014_6.png

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