Merge pull request #1384 from SixLabors/dl/fix-bmp-files-size

Fixed setting the file size when the BMP encoder has a color palette

Author: JimBobSquarePants

src/ImageSharp/Formats/Bmp/BmpEncoderCore.cs

@@ -171,7 +171,7 @@ public void Encode<TPixel>(Image<TPixel> image, Stream stream, CancellationToken
 
             var fileHeader = new BmpFileHeader(
                 type: BmpConstants.TypeMarkers.Bitmap,
-                fileSize: BmpFileHeader.Size + infoHeaderSize + infoHeader.ImageSize,
+                fileSize: BmpFileHeader.Size + infoHeaderSize + colorPaletteSize + infoHeader.ImageSize,
                 reserved: 0,
                 offset: BmpFileHeader.Size + infoHeaderSize + colorPaletteSize);
 

tests/ImageSharp.Tests/Formats/Bmp/BmpDecoderTests.cs

@@ -348,7 +348,9 @@ public void BmpDecoder_CanDecodeBmpv2<TPixel>(TestImageProvider<TPixel> provider
             using (Image<TPixel> image = provider.GetImage(BmpDecoder))
             {
                 image.DebugSave(provider);
-                image.CompareToOriginal(provider);
+
+                // Do not validate. Reference files will fail validation.
+                image.CompareToOriginal(provider, new MagickReferenceDecoder(false));
             }
         }
 

tests/ImageSharp.Tests/Formats/Bmp/BmpEncoderTests.cs

@@ -10,7 +10,7 @@
 using SixLabors.ImageSharp.Processing;
 using SixLabors.ImageSharp.Processing.Processors.Quantization;
 using SixLabors.ImageSharp.Tests.TestUtilities.ImageComparison;
-
+using SixLabors.ImageSharp.Tests.TestUtilities.ReferenceCodecs;
 using Xunit;
 using Xunit.Abstractions;
 
@@ -200,10 +200,18 @@ public void Encode_8BitColor_WithWuQuantizer<TPixel>(TestImageProvider<TPixel> p
                     Quantizer = new WuQuantizer()
                 };
                 string actualOutputFile = provider.Utility.SaveTestOutputFile(image, "bmp", encoder, appendPixelTypeToFileName: false);
+
+                // Use the default decoder to test our encoded image. This verifies the content.
+                // We do not verify the reference image though as some are invalid.
                 IImageDecoder referenceDecoder = TestEnvironment.GetReferenceDecoder(actualOutputFile);
                 using (var referenceImage = Image.Load<TPixel>(actualOutputFile, referenceDecoder))
                 {
-                    referenceImage.CompareToReferenceOutput(ImageComparer.TolerantPercentage(0.01f), provider, extension: "bmp", appendPixelTypeToFileName: false);
+                    referenceImage.CompareToReferenceOutput(
+                        ImageComparer.TolerantPercentage(0.01f),
+                        provider,
+                        extension: "bmp",
+                        appendPixelTypeToFileName: false,
+                        decoder: new MagickReferenceDecoder(false));
                 }
             }
         }
@@ -226,10 +234,18 @@ public void Encode_8BitColor_WithOctreeQuantizer<TPixel>(TestImageProvider<TPixe
                     Quantizer = new OctreeQuantizer()
                 };
                 string actualOutputFile = provider.Utility.SaveTestOutputFile(image, "bmp", encoder, appendPixelTypeToFileName: false);
+
+                // Use the default decoder to test our encoded image. This verifies the content.
+                // We do not verify the reference image though as some are invalid.
                 IImageDecoder referenceDecoder = TestEnvironment.GetReferenceDecoder(actualOutputFile);
                 using (var referenceImage = Image.Load<TPixel>(actualOutputFile, referenceDecoder))
                 {
-                    referenceImage.CompareToReferenceOutput(ImageComparer.TolerantPercentage(0.01f), provider, extension: "bmp", appendPixelTypeToFileName: false);
+                    referenceImage.CompareToReferenceOutput(
+                        ImageComparer.TolerantPercentage(0.01f),
+                        provider,
+                        extension: "bmp",
+                        appendPixelTypeToFileName: false,
+                        decoder: new MagickReferenceDecoder(false));
                 }
             }
         }

tests/ImageSharp.Tests/TestUtilities/ReferenceCodecs/MagickReferenceDecoder.cs

@@ -16,6 +16,18 @@ namespace SixLabors.ImageSharp.Tests.TestUtilities.ReferenceCodecs
 {
     public class MagickReferenceDecoder : IImageDecoder
     {
+        private readonly bool validate;
+
+        public MagickReferenceDecoder()
+            : this(true)
+        {
+        }
+
+        public MagickReferenceDecoder(bool validate)
+        {
+            this.validate = validate;
+        }
+
         public static MagickReferenceDecoder Instance { get; } = new MagickReferenceDecoder();
 
         private static void FromRgba32Bytes<TPixel>(Configuration configuration, Span<byte> rgbaBytes, IMemoryGroup<TPixel> destinationGroup)
@@ -57,10 +69,7 @@ public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
         {
             var bmpReadDefines = new BmpReadDefines
             {
-                // See https://github.com/SixLabors/ImageSharp/issues/1380
-                // Validation fails on Ubuntu despite identical header generation
-                // on all platforms.
-                IgnoreFileSize = !TestEnvironment.IsWindows
+                IgnoreFileSize = !this.validate
             };
 
             var settings = new MagickReadSettings();