Add an equivalent for System.Drawing.Image.GetPixelFormatSize() (#258)

Author: Nikita Balabaev

src/ImageSharp/Formats/Bmp/BmpDecoder.cs

@@ -37,5 +37,16 @@ public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
 
             return new BmpDecoderCore(configuration, this).Decode<TPixel>(stream);
         }
+
+        /// <inheritdoc/>
+        public int DetectPixelSize(Configuration configuration, Stream stream)
+        {
+            Guard.NotNull(stream, "stream");
+
+            byte[] buffer = new byte[2];
+            stream.Skip(28);
+            stream.Read(buffer, 0, 2);
+            return BitConverter.ToInt16(buffer, 0);
+        }
     }
 }

src/ImageSharp/Formats/Gif/GifDecoder.cs

@@ -33,5 +33,16 @@ public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
             var decoder = new GifDecoderCore<TPixel>(configuration, this);
             return decoder.Decode(stream);
         }
+
+        /// <inheritdoc/>
+        public int DetectPixelSize(Configuration configuration, Stream stream)
+        {
+            Guard.NotNull(stream, "stream");
+
+            byte[] buffer = new byte[1];
+            stream.Skip(10); // Skip the identifier and size
+            stream.Read(buffer, 0, 1); // Skip the identifier and size
+            return (buffer[0] & 0x07) + 1;  // The lowest 3 bits represent the bit depth minus 1
+        }
     }
 }

src/ImageSharp/Formats/IImageDecoder.cs

@@ -25,5 +25,13 @@ public interface IImageDecoder
         /// <returns>The decoded image</returns>
         Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
             where TPixel : struct, IPixel<TPixel>;
+
+        /// <summary>
+        /// Detects the image pixel size from the specified stream.
+        /// </summary>
+        /// <param name="configuration">The configuration for the image.</param>
+        /// <param name="stream">The <see cref="Stream"/> containing image data.</param>
+        /// <returns>The color depth, in number of bits per pixel</returns>
+        int DetectPixelSize(Configuration configuration, Stream stream);
     }
 }

src/ImageSharp/Formats/Jpeg/JpegDecoder.cs

@@ -32,5 +32,16 @@ public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
                 return decoder.Decode<TPixel>(stream);
             }
         }
+
+        /// <inheritdoc/>
+        public int DetectPixelSize(Configuration configuration, Stream stream)
+        {
+            Guard.NotNull(stream, "stream");
+
+            using (JpegDecoderCore decoder = new JpegDecoderCore(configuration, this))
+            {
+                return decoder.DetectPixelSize(stream);
+            }
+        }
     }
 }

src/ImageSharp/Formats/Jpeg/JpegDecoderCore.cs

@@ -30,6 +30,11 @@ internal sealed unsafe class JpegDecoderCore : IDisposable
         /// </summary>
         public const int MaxTq = 3;
 
+        /// <summary>
+        /// The only supported precision
+        /// </summary>
+        public const int SupportedPrecision = 8;
+
         // Complex value type field + mutable + available to other classes = the field MUST NOT be private :P
 #pragma warning disable SA1401 // FieldsMustBePrivate
 
@@ -191,7 +196,7 @@ public JpegDecoderCore(Configuration configuration, IJpegDecoderOptions options)
         public bool IgnoreMetadata { get; private set; }
 
         /// <summary>
-        /// Decodes the image from the specified <see cref="Stream"/>  and sets
+        /// Decodes the image from the specified <see cref="Stream"/> and sets
         /// the data to image.
         /// </summary>
         /// <typeparam name="TPixel">The pixel format.</typeparam>
@@ -208,6 +213,17 @@ public Image<TPixel> Decode<TPixel>(Stream stream)
             return image;
         }
 
+        /// <summary>
+        /// Detects the image pixel size from the specified stream.
+        /// </summary>
+        /// <param name="stream">The <see cref="Stream"/> containing image data.</param>
+        /// <returns>The color depth, in number of bits per pixel</returns>
+        public int DetectPixelSize(Stream stream)
+        {
+            this.ProcessStream(new ImageMetaData(), stream, true);
+            return this.ComponentCount * SupportedPrecision;
+        }
+
         /// <summary>
         /// Dispose
         /// </summary>
@@ -1196,7 +1212,7 @@ private void ProcessStartOfFrameMarker(int remaining)
             this.InputProcessor.ReadFull(this.Temp, 0, remaining);
 
             // We only support 8-bit precision.
-            if (this.Temp[0] != 8)
+            if (this.Temp[0] != SupportedPrecision)
             {
                 throw new ImageFormatException("Only 8-Bit precision supported.");
             }
@@ -1238,7 +1254,7 @@ private void ProcessStartOfFrameMarker(int remaining)
 
                 if (h == 3 || v == 3)
                 {
-                    throw new ImageFormatException("Lnsupported subsampling ratio");
+                    throw new ImageFormatException("Unsupported subsampling ratio");
                 }
 
                 switch (this.ComponentCount)

src/ImageSharp/Formats/Png/PngDecoder.cs

@@ -56,5 +56,17 @@ public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
             var decoder = new PngDecoderCore(configuration, this);
             return decoder.Decode<TPixel>(stream);
         }
+
+        /// <summary>
+        /// Detects the image pixel size from the specified stream.
+        /// </summary>
+        /// <param name="configuration">The configuration for the image.</param>
+        /// <param name="stream">The <see cref="Stream"/> containing image data.</param>
+        /// <returns>The color depth, in number of bits per pixel</returns>
+        public int DetectPixelSize(Configuration configuration, Stream stream)
+        {
+            var decoder = new PngDecoderCore(configuration, this);
+            return decoder.DetectPixelSize(stream);
+        }
     }
 }

src/ImageSharp/Formats/Png/PngDecoderCore.cs

@@ -261,6 +261,58 @@ public Image<TPixel> Decode<TPixel>(Stream stream)
             }
         }
 
+        /// <summary>
+        /// Detects the image pixel size from the specified stream.
+        /// </summary>
+        /// <param name="stream">The <see cref="Stream"/> containing image data.</param>
+        /// <returns>The color depth, in number of bits per pixel</returns>
+        public int DetectPixelSize(Stream stream)
+        {
+            this.currentStream = stream;
+            this.currentStream.Skip(8);
+            try
+            {
+                    PngChunk currentChunk;
+                    while (!this.isEndChunkReached && (currentChunk = this.ReadChunk()) != null)
+                    {
+                        try
+                        {
+                            switch (currentChunk.Type)
+                            {
+                                case PngChunkTypes.Header:
+                                    this.ReadHeaderChunk(currentChunk.Data);
+                                    this.ValidateHeader();
+                                    this.isEndChunkReached = true;
+                                    break;
+                                case PngChunkTypes.End:
+                                    this.isEndChunkReached = true;
+                                    break;
+                            }
+                        }
+                        finally
+                        {
+                            // Data is rented in ReadChunkData()
+                            if (currentChunk.Data != null)
+                            {
+                                ArrayPool<byte>.Shared.Return(currentChunk.Data);
+                            }
+                        }
+                    }
+            }
+            finally
+            {
+                this.scanline?.Dispose();
+                this.previousScanline?.Dispose();
+            }
+
+            if (this.header == null)
+            {
+                throw new ImageFormatException("PNG Image hasn't header chunk");
+            }
+
+            return this.CalculateBitsPerPixel();
+        }
+
         /// <summary>
         /// Converts a byte array to a new array where each value in the original array is represented by the specified number of bits.
         /// </summary>
@@ -343,6 +395,28 @@ private void InitializeImage<TPixel>(ImageMetaData metadata, out Image<TPixel> i
             this.scanline = Buffer<byte>.CreateClean(this.bytesPerScanline);
         }
 
+        /// <summary>
+        /// Calculates the correct number of bits per pixel for the given color type.
+        /// </summary>
+        /// <returns>The <see cref="int"/></returns>
+        private int CalculateBitsPerPixel()
+        {
+            switch (this.pngColorType)
+            {
+                case PngColorType.Grayscale:
+                case PngColorType.Palette:
+                    return this.header.BitDepth;
+                case PngColorType.GrayscaleWithAlpha:
+                    return this.header.BitDepth * 2;
+                case PngColorType.Rgb:
+                    return this.header.BitDepth * 3;
+                case PngColorType.RgbWithAlpha:
+                    return this.header.BitDepth * 4;
+                default:
+                    throw new NotSupportedException("Unsupported PNG color type");
+            }
+        }
+
         /// <summary>
         /// Calculates the correct number of bytes per pixel for the given color type.
         /// </summary>

src/ImageSharp/Image/Image.Decode.cs

@@ -81,5 +81,19 @@ private static (Image<TPixel> img, IImageFormat format) Decode<TPixel>(Stream st
             Image<TPixel> img = decoder.Decode<TPixel>(config, stream);
             return (img, format);
         }
+
+        /// <summary>
+        /// Detects the image pixel size.
+        /// </summary>
+        /// <param name="stream">The stream.</param>
+        /// <param name="config">the configuration.</param>
+        /// <returns>
+        /// The color depth, in number of bits per pixel or null if suitable decoder not found.
+        /// </returns>
+        private static int? InternalDetectPixelSize(Stream stream, Configuration config)
+        {
+            IImageDecoder decoder = DiscoverDecoder(stream, config, out IImageFormat _);
+            return decoder?.DetectPixelSize(config, stream);
+        }
     }
 }

src/ImageSharp/Image/Image.FromStream.cs

@@ -39,6 +39,33 @@ public static IImageFormat DetectFormat(Configuration config, Stream stream)
             return WithSeekableStream(stream, s => InternalDetectFormat(s, config ?? Configuration.Default));
         }
 
+        /// <summary>
+        /// By reading the header on the provided stream this calculates the images color depth.
+        /// </summary>
+        /// <param name="stream">The image stream to read the header from.</param>
+        /// <exception cref="NotSupportedException">
+        /// Thrown if the stream is not readable nor seekable.
+        /// </exception>
+        /// <returns>The color depth, in number of bits per pixel or null if suitable decoder not found</returns>
+        public static int? DetectPixelSize(Stream stream)
+        {
+            return DetectPixelSize(null, stream);
+        }
+
+        /// <summary>
+        /// By reading the header on the provided stream this calculates the images color depth.
+        /// </summary>
+        /// <param name="config">The configuration.</param>
+        /// <param name="stream">The image stream to read the header from.</param>
+        /// <exception cref="NotSupportedException">
+        /// Thrown if the stream is not readable nor seekable.
+        /// </exception>
+        /// <returns>The color depth, in number of bits per pixel or null if suitable decoder not found</returns>
+        public static int? DetectPixelSize(Configuration config, Stream stream)
+        {
+            return WithSeekableStream(stream, s => InternalDetectPixelSize(s, config ?? Configuration.Default));
+        }
+
         /// <summary>
         /// Create a new instance of the <see cref="Image{Rgba32}"/> class from the given stream.
         /// </summary>

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

@@ -0,0 +1,29 @@
+// <copyright file="GifDecoderTests.cs" company="James Jackson-South">
+// Copyright (c) James Jackson-South and contributors.
+// Licensed under the Apache License, Version 2.0.
+// </copyright>
+
+// ReSharper disable InconsistentNaming
+namespace ImageSharp.Tests
+{
+    using System.IO;
+
+    using Xunit;
+
+    public class BmpDecoderTests
+    {
+        [Theory]
+        [InlineData(TestImages.Bmp.Car, 24)]
+        [InlineData(TestImages.Bmp.F, 24)]
+        [InlineData(TestImages.Bmp.NegHeight, 24)]
+        [InlineData(TestImages.Bmp.Bpp8, 8)]
+        public void DetectPixelSize(string imagePath, int expectedPixelSize)
+        {
+            TestFile testFile = TestFile.Create(imagePath);
+            using (var stream = new MemoryStream(testFile.Bytes, false))
+            {
+                Assert.Equal(expectedPixelSize, Image.DetectPixelSize(stream));
+            }
+        }
+    }
+}