changes on code review

SixLabors · Jan 19, 2018 · 61c9caf · 61c9caf
1 parent e88e138
commit 61c9caf
Show file tree

Hide file tree

Showing 22 changed files with 208 additions and 188 deletions.
diff --git a/src/ImageSharp/Formats/Bmp/BmpDecoder.cs b/src/ImageSharp/Formats/Bmp/BmpDecoder.cs
@@ -34,7 +34,7 @@ public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
         }
 
         /// <inheritdoc/>
-        public IImage Identify(Configuration configuration, Stream stream)
+        public IImageInfo Identify(Configuration configuration, Stream stream)
         {
             Guard.NotNull(stream, "stream");
 

diff --git a/src/ImageSharp/Formats/Bmp/BmpDecoderCore.cs b/src/ImageSharp/Formats/Bmp/BmpDecoderCore.cs
@@ -141,10 +141,10 @@ public Image<TPixel> Decode<TPixel>(Stream stream)
         }
 
         /// <summary>
-        /// Reads the image base information from the specified stream.
+        /// Reads the raw image information from the specified stream.
         /// </summary>
         /// <param name="stream">The <see cref="Stream"/> containing image data.</param>
-        public IImage Identify(Stream stream)
+        public IImageInfo Identify(Stream stream)
         {
             this.ReadImageHeaders(stream, out _, out _);
             return new ImageInfo(new PixelTypeInfo(this.infoHeader.BitsPerPixel), this.infoHeader.Width, this.infoHeader.Height, new ImageMetaData());

diff --git a/src/ImageSharp/Formats/Gif/GifDecoder.cs b/src/ImageSharp/Formats/Gif/GifDecoder.cs
@@ -36,7 +36,7 @@ public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
         }
 
         /// <inheritdoc/>
-        public IImage Identify(Configuration configuration, Stream stream)
+        public IImageInfo Identify(Configuration configuration, Stream stream)
         {
             Guard.NotNull(stream, "stream");
 

diff --git a/src/ImageSharp/Formats/Gif/GifDecoderCore.cs b/src/ImageSharp/Formats/Gif/GifDecoderCore.cs
@@ -165,10 +165,10 @@ public Image<TPixel> Decode<TPixel>(Stream stream)
         }
 
         /// <summary>
-        /// Reads the image base information from the specified stream.
+        /// Reads the raw image information from the specified stream.
         /// </summary>
         /// <param name="stream">The <see cref="Stream"/> containing image data.</param>
-        public IImage Identify(Stream stream)
+        public IImageInfo Identify(Stream stream)
         {
             try
             {
@@ -425,7 +425,7 @@ private void ReadFrameColors<TPixel>(ref Image<TPixel> image, ref ImageFrame<TPi
             if (previousFrame == null)
             {
                 // This initializes the image to become fully transparent because the alpha channel is zero.
-                image = new Image<TPixel>(this.configuration, new PixelTypeInfo(this.logicalScreenDescriptor.BitsPerPixel),  imageWidth, imageHeight, this.metaData);
+                image = new Image<TPixel>(this.configuration, imageWidth, imageHeight, this.metaData);
 
                 this.SetFrameMetaData(image.Frames.RootFrame.MetaData);
 

diff --git a/src/ImageSharp/Formats/IImageInfoDetector.cs b/src/ImageSharp/Formats/IImageInfoDetector.cs
@@ -6,16 +6,16 @@
 namespace SixLabors.ImageSharp.Formats
 {
     /// <summary>
-    /// Used for detecting the image base information without decoding it.
+    /// Used for detecting the raw image information without decoding it.
     /// </summary>
     public interface IImageInfoDetector
     {
         /// <summary>
-        /// Reads the image base information from the specified stream.
+        /// Reads the raw image information 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 <see cref="PixelTypeInfo"/> object</returns>
-        IImage Identify(Configuration configuration, Stream stream);
+        IImageInfo Identify(Configuration configuration, Stream stream);
     }
 }
diff --git a/src/ImageSharp/Formats/Jpeg/GolangPort/OrigJpegDecoder.cs b/src/ImageSharp/Formats/Jpeg/GolangPort/OrigJpegDecoder.cs
@@ -29,7 +29,7 @@ public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
         }
 
         /// <inheritdoc/>
-        public IImage Identify(Configuration configuration, Stream stream)
+        public IImageInfo Identify(Configuration configuration, Stream stream)
         {
             Guard.NotNull(stream, "stream");
 

diff --git a/src/ImageSharp/Formats/Jpeg/GolangPort/OrigJpegDecoderCore.cs b/src/ImageSharp/Formats/Jpeg/GolangPort/OrigJpegDecoderCore.cs
@@ -198,10 +198,10 @@ public Image<TPixel> Decode<TPixel>(Stream stream)
         }
 
         /// <summary>
-        /// Reads the image base information from the specified stream.
+        /// Reads the raw image information from the specified stream.
         /// </summary>
         /// <param name="stream">The <see cref="Stream"/> containing image data.</param>
-        public IImage Identify(Stream stream)
+        public IImageInfo Identify(Stream stream)
         {
             this.ParseStream(stream, true);
             return new ImageInfo(new PixelTypeInfo(this.BitsPerPixel), this.ImageWidth, this.ImageHeight, this.MetaData);
@@ -789,7 +789,7 @@ private Image<TPixel> PostProcessIntoImage<TPixel>()
         {
             using (var postProcessor = new JpegImagePostProcessor(this))
             {
-                var image = new Image<TPixel>(this.configuration, new PixelTypeInfo(this.BitsPerPixel),  this.ImageWidth, this.ImageHeight, this.MetaData);
+                var image = new Image<TPixel>(this.configuration, this.ImageWidth, this.ImageHeight, this.MetaData);
                 postProcessor.PostProcess(image.Frames.RootFrame);
                 return image;
             }

diff --git a/src/ImageSharp/Formats/Jpeg/JpegDecoder.cs b/src/ImageSharp/Formats/Jpeg/JpegDecoder.cs
@@ -31,7 +31,7 @@ public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
         }
 
         /// <inheritdoc/>
-        public IImage Identify(Configuration configuration, Stream stream)
+        public IImageInfo Identify(Configuration configuration, Stream stream)
         {
             Guard.NotNull(stream, "stream");
 

diff --git a/src/ImageSharp/Formats/Jpeg/PdfJsPort/PdfJsJpegDecoderCore.cs b/src/ImageSharp/Formats/Jpeg/PdfJsPort/PdfJsJpegDecoderCore.cs
@@ -159,7 +159,7 @@ public Image<TPixel> Decode<TPixel>(Stream stream)
 
             this.QuantizeAndInverseAllComponents();
 
-            var image = new Image<TPixel>(this.configuration, null, this.ImageWidth, this.ImageHeight, metadata);
+            var image = new Image<TPixel>(this.configuration, this.ImageWidth, this.ImageHeight, metadata);
             this.FillPixelData(image.Frames.RootFrame);
             this.AssignResolution(image);
             return image;

diff --git a/src/ImageSharp/Formats/PixelTypeInfo.cs b/src/ImageSharp/Formats/PixelTypeInfo.cs
@@ -1,7 +1,7 @@
 namespace SixLabors.ImageSharp.Formats
 {
     /// <summary>
-    /// Stores information about pixel.
+    /// Stores the raw image pixel type information.
     /// </summary>
     public class PixelTypeInfo
     {

diff --git a/src/ImageSharp/Formats/Png/PngDecoder.cs b/src/ImageSharp/Formats/Png/PngDecoder.cs
@@ -54,7 +54,7 @@ public Image<TPixel> Decode<TPixel>(Configuration configuration, Stream stream)
         }
 
         /// <inheritdoc/>
-        public IImage Identify(Configuration configuration, Stream stream)
+        public IImageInfo Identify(Configuration configuration, Stream stream)
         {
             var decoder = new PngDecoderCore(configuration, this);
             return decoder.Identify(stream);

diff --git a/src/ImageSharp/Formats/Png/PngDecoderCore.cs b/src/ImageSharp/Formats/Png/PngDecoderCore.cs
@@ -279,10 +279,10 @@ public Image<TPixel> Decode<TPixel>(Stream stream)
         }
 
         /// <summary>
-        /// Reads the image base information from the specified stream.
+        /// Reads the raw image information from the specified stream.
         /// </summary>
         /// <param name="stream">The <see cref="Stream"/> containing image data.</param>
-        public IImage Identify(Stream stream)
+        public IImageInfo Identify(Stream stream)
         {
             var metadata = new ImageMetaData();
             this.currentStream = stream;
@@ -426,7 +426,7 @@ private void ReadPhysicalChunk(ImageMetaData metadata, byte[] data)
         private void InitializeImage<TPixel>(ImageMetaData metadata, out Image<TPixel> image)
             where TPixel : struct, IPixel<TPixel>
         {
-            image = new Image<TPixel>(this.configuration, new PixelTypeInfo(this.CalculateBitsPerPixel()),  this.header.Width, this.header.Height, metadata);
+            image = new Image<TPixel>(this.configuration, this.header.Width, this.header.Height, metadata);
             this.bytesPerPixel = this.CalculateBytesPerPixel();
             this.bytesPerScanline = this.CalculateScanlineLength(this.header.Width) + 1;
             this.bytesPerSample = 1;

diff --git a/src/ImageSharp/Image/IImage.cs b/src/ImageSharp/Image/IImage.cs
@@ -1,31 +1,9 @@
-using SixLabors.ImageSharp.Formats;
-using SixLabors.ImageSharp.MetaData;
-
-namespace SixLabors.ImageSharp
+namespace SixLabors.ImageSharp
 {
     /// <summary>
     /// Represents the base image abstraction.
     /// </summary>
-    public interface IImage
+    public interface IImage : IImageInfo
     {
-        /// <summary>
-        /// Gets information about pixel.
-        /// </summary>
-        PixelTypeInfo PixelType { get; }
-
-        /// <summary>
-        /// Gets the width.
-        /// </summary>
-        int Width { get; }
-
-        /// <summary>
-        /// Gets the height.
-        /// </summary>
-        int Height { get; }
-
-        /// <summary>
-        /// Gets the meta data of the image.
-        /// </summary>
-        ImageMetaData MetaData { get; }
     }
 }
diff --git a/src/ImageSharp/Image/IImageInfo.cs b/src/ImageSharp/Image/IImageInfo.cs
@@ -0,0 +1,31 @@
+using SixLabors.ImageSharp.Formats;
+using SixLabors.ImageSharp.MetaData;
+
+namespace SixLabors.ImageSharp
+{
+    /// <summary>
+    /// Represents raw image information.
+    /// </summary>
+    public interface IImageInfo
+    {
+        /// <summary>
+        /// Gets the raw image pixel type information.
+        /// </summary>
+        PixelTypeInfo PixelType { get; }
+
+        /// <summary>
+        /// Gets the width.
+        /// </summary>
+        int Width { get; }
+
+        /// <summary>
+        /// Gets the height.
+        /// </summary>
+        int Height { get; }
+
+        /// <summary>
+        /// Gets the meta data of the image.
+        /// </summary>
+        ImageMetaData MetaData { get; }
+    }
+}
diff --git a/src/ImageSharp/Image/Image.Decode.cs b/src/ImageSharp/Image/Image.Decode.cs
@@ -86,9 +86,9 @@ private static (Image<TPixel> img, IImageFormat format) Decode<TPixel>(Stream st
         /// <param name="stream">The stream.</param>
         /// <param name="config">the configuration.</param>
         /// <returns>
-        /// The <see cref="IImage"/> or null if suitable info detector not found.
+        /// The <see cref="IImageInfo"/> or null if suitable info detector not found.
         /// </returns>
-        private static IImage InternalIdentity(Stream stream, Configuration config)
+        private static IImageInfo InternalIdentity(Stream stream, Configuration config)
         {
             var detector = DiscoverDecoder(stream, config, out IImageFormat _) as IImageInfoDetector;
             return detector?.Identify(config, stream);

diff --git a/src/ImageSharp/Image/Image.FromStream.cs b/src/ImageSharp/Image/Image.FromStream.cs
@@ -37,32 +37,32 @@ public static IImageFormat DetectFormat(Configuration config, Stream stream)
         }
 
         /// <summary>
-        /// By reading the header on the provided stream this reads the image base information.
+        /// By reading the header on the provided stream this reads the raw image information.
         /// </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 <see cref="IImage"/> or null if suitable info detector not found.
+        /// The <see cref="IImageInfo"/> or null if suitable info detector not found.
         /// </returns>
-        public static IImage Identify(Stream stream)
+        public static IImageInfo Identify(Stream stream)
         {
             return Identify(null, stream);
         }
 
         /// <summary>
-        /// By reading the header on the provided stream this reads the image base information.
+        /// By reading the header on the provided stream this reads the raw image information.
         /// </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 <see cref="IImage"/> or null if suitable info detector not found.
+        /// The <see cref="IImageInfo"/> or null if suitable info detector not found.
         /// </returns>
-        public static IImage Identify(Configuration config, Stream stream)
+        public static IImageInfo Identify(Configuration config, Stream stream)
         {
             return WithSeekableStream(stream, s => InternalIdentity(s, config ?? Configuration.Default));
         }

diff --git a/src/ImageSharp/Image/ImageFrameCollection.cs b/src/ImageSharp/Image/ImageFrameCollection.cs
@@ -129,15 +129,15 @@ public Image<TPixel> ExportFrame(int index)
 
             this.frames.Remove(frame);
 
-            return new Image<TPixel>(this.parent.GetConfiguration(), this.parent.PixelType, this.parent.MetaData.Clone(), new[] { frame });
+            return new Image<TPixel>(this.parent.GetConfiguration(), this.parent.MetaData.Clone(), new[] { frame });
         }
 
         /// <inheritdoc/>
         public Image<TPixel> CloneFrame(int index)
         {
             ImageFrame<TPixel> frame = this[index];
             ImageFrame<TPixel> clonedFrame = frame.Clone();
-            return new Image<TPixel>(this.parent.GetConfiguration(), this.parent.PixelType, this.parent.MetaData.Clone(), new[] { clonedFrame });
+            return new Image<TPixel>(this.parent.GetConfiguration(), this.parent.MetaData.Clone(), new[] { clonedFrame });
         }
 
         /// <inheritdoc/>

diff --git a/src/ImageSharp/Image/ImageInfo.cs b/src/ImageSharp/Image/ImageInfo.cs
@@ -3,8 +3,18 @@
 
 namespace SixLabors.ImageSharp
 {
-    internal sealed class ImageInfo : IImage
+    /// <summary>
+    /// Stores the raw image information.
+    /// </summary>
+    internal sealed class ImageInfo : IImageInfo
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ImageInfo"/> class.
+        /// </summary>
+        /// <param name="pixelType">The raw image pixel type information.</param>
+        /// <param name="width">The width of the image in pixels.</param>
+        /// <param name="height">The height of the image in pixels.</param>
+        /// <param name="metaData">The images metadata.</param>
         public ImageInfo(PixelTypeInfo pixelType, int width, int height, ImageMetaData metaData)
         {
             this.PixelType = pixelType;
@@ -13,12 +23,16 @@ public ImageInfo(PixelTypeInfo pixelType, int width, int height, ImageMetaData m
             this.MetaData = metaData;
         }
 
+        /// <inheritdoc />
         public PixelTypeInfo PixelType { get; }
 
+        /// <inheritdoc />
         public int Width { get; }
 
+        /// <inheritdoc />
         public int Height { get; }
 
+        /// <inheritdoc />
         public ImageMetaData MetaData { get; }
     }
 }