Merge pull request #1095 from SixLabors/js/expose-pixel-operations

Expose Pixel Operations and Configuration

Author: JimBobSquarePants

README.md

@@ -9,6 +9,7 @@ SixLabors.ImageSharp
 <div align="center">
 
 [![Build Status](https://img.shields.io/github/workflow/status/SixLabors/ImageSharp/Build/master)](https://github.com/SixLabors/ImageSharp/actions)
+[![Code coverage](https://codecov.io/gh/SixLabors/ImageSharp/branch/master/graph/badge.svg)](https://codecov.io/gh/SixLabors/ImageSharp)
 [![GitHub license](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/SixLabors/ImageSharp/master/LICENSE)
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ImageSharp/General?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=flat&logo=twitter)](https://twitter.com/intent/tweet?hashtags=imagesharp,dotnet,oss&text=ImageSharp.+A+new+cross-platform+2D+graphics+API+in+C%23&url=https%3a%2f%2fgithub.com%2fSixLabors%2fImageSharp&via=sixlabors)
@@ -46,13 +47,6 @@ The **ImageSharp** library is made up of multiple packages:
   - Transform methods like Resize, Crop, Skew, Rotate - anything that alters the dimensions of the image
   - Non-transform methods like Gaussian Blur, Pixelate, Edge Detection - anything that maintains the original image dimensions
 
-<!--
-### Build Status
-
-|Build Status|Code Coverage|
-|:----------:|:-----------:|
-|[![Build Status](https://img.shields.io/github/workflow/status/SixLabors/ImageSharp/Build/master)](https://github.com/SixLabors/ImageSharp/actions)|[![Code coverage](https://codecov.io/gh/SixLabors/ImageSharp/branch/master/graph/badge.svg)](https://codecov.io/gh/SixLabors/ImageSharp)|
--->
 ### Questions?
 
 - Do you have questions? We are happy to help! Please [join our gitter channel](https://gitter.im/ImageSharp/General), or ask them on [stackoverflow](https://stackoverflow.com) using the `ImageSharp` tag. **Do not** open issues for questions!

src/ImageSharp/Advanced/AdvancedImageExtensions.cs

@@ -29,7 +29,23 @@ public static void AcceptVisitor(this Image source, IImageVisitor visitor)
         /// <param name="source">The source image.</param>
         /// <returns>Returns the configuration.</returns>
         public static Configuration GetConfiguration(this Image source)
-            => GetConfiguration((IConfigurable)source);
+            => GetConfiguration((IConfigurationProvider)source);
+
+        /// <summary>
+        /// Gets the configuration for the image frame.
+        /// </summary>
+        /// <param name="source">The source image.</param>
+        /// <returns>Returns the configuration.</returns>
+        public static Configuration GetConfiguration(this ImageFrame source)
+            => GetConfiguration((IConfigurationProvider)source);
+
+        /// <summary>
+        /// Gets the configuration .
+        /// </summary>
+        /// <param name="source">The source image</param>
+        /// <returns>Returns the bounds of the image</returns>
+        private static Configuration GetConfiguration(IConfigurationProvider source)
+            => source?.Configuration ?? Configuration.Default;
 
         /// <summary>
         /// Gets the representation of the pixels as a <see cref="Span{T}"/> of contiguous memory in the source image's pixel format
@@ -158,17 +174,9 @@ internal static Memory<TPixel> GetPixelRowMemory<TPixel>(this Image<TPixel> sour
         /// </summary>
         /// <param name="source">The source image.</param>
         /// <returns>Returns the configuration.</returns>
-        internal static MemoryAllocator GetMemoryAllocator(this IConfigurable source)
+        internal static MemoryAllocator GetMemoryAllocator(this IConfigurationProvider source)
             => GetConfiguration(source).MemoryAllocator;
 
-        /// <summary>
-        /// Gets the configuration.
-        /// </summary>
-        /// <param name="source">The source image</param>
-        /// <returns>Returns the bounds of the image</returns>
-        private static Configuration GetConfiguration(IConfigurable source)
-            => source?.Configuration ?? Configuration.Default;
-
         /// <summary>
         /// Returns a reference to the 0th element of the Pixel buffer.
         /// Such a reference can be used for pinning but must never be dereferenced.

src/ImageSharp/Advanced/AotCompilerTools.cs

@@ -109,7 +109,7 @@ private static void Seed<TPixel>()
         private static void AotCompileOctreeQuantizer<TPixel>()
             where TPixel : struct, IPixel<TPixel>
         {
-            using (var test = new OctreeFrameQuantizer<TPixel>(new OctreeQuantizer(false)))
+            using (var test = new OctreeFrameQuantizer<TPixel>(Configuration.Default, new OctreeQuantizer(false)))
             {
                 test.AotGetPalette();
             }
@@ -122,7 +122,7 @@ private static void AotCompileOctreeQuantizer<TPixel>()
         private static void AotCompileWuQuantizer<TPixel>()
             where TPixel : struct, IPixel<TPixel>
         {
-            using (var test = new WuFrameQuantizer<TPixel>(Configuration.Default.MemoryAllocator, new WuQuantizer(false)))
+            using (var test = new WuFrameQuantizer<TPixel>(Configuration.Default, new WuQuantizer(false)))
             {
                 test.QuantizeFrame(new ImageFrame<TPixel>(Configuration.Default, 1, 1));
                 test.AotGetPalette();

src/ImageSharp/Advanced/IConfigurable.cs

@@ -0,0 +1,16 @@
+// Copyright (c) Six Labors and contributors.
+// Licensed under the Apache License, Version 2.0.
+
+namespace SixLabors.ImageSharp.Advanced
+{
+    /// <summary>
+    /// Defines the contract for objects that can provide access to configuration.
+    /// </summary>
+    internal interface IConfigurationProvider
+    {
+        /// <summary>
+        /// Gets the configuration which allows altering default behaviour or extending the library.
+        /// </summary>
+        Configuration Configuration { get; }
+    }
+}

src/ImageSharp/Advanced/IConfigurationProvider.cs

@@ -16,7 +16,7 @@
 namespace SixLabors.ImageSharp
 {
     /// <summary>
-    /// Provides configuration code which allows altering default behaviour or extending the library.
+    /// Provides configuration which allows altering default behaviour or extending the library.
     /// </summary>
     public sealed class Configuration
     {

src/ImageSharp/Configuration.cs

@@ -28,7 +28,7 @@ public sealed class GifEncoder : IImageEncoder, IGifEncoderOptions
         public void Encode<TPixel>(Image<TPixel> image, Stream stream)
             where TPixel : struct, IPixel<TPixel>
         {
-            var encoder = new GifEncoderCore(image.GetConfiguration().MemoryAllocator, this);
+            var encoder = new GifEncoderCore(image.GetConfiguration(), this);
             encoder.Encode(image, stream);
         }
     }

src/ImageSharp/Formats/Gif/GifEncoder.cs

@@ -53,11 +53,12 @@ internal sealed class GifEncoderCore
         /// <summary>
         /// Initializes a new instance of the <see cref="GifEncoderCore"/> class.
         /// </summary>
-        /// <param name="memoryAllocator">The <see cref="MemoryAllocator"/> to use for buffer allocations.</param>
+        /// <param name="configuration">The configuration which allows altering default behaviour or extending the library.</param>
         /// <param name="options">The options for the encoder.</param>
-        public GifEncoderCore(MemoryAllocator memoryAllocator, IGifEncoderOptions options)
+        public GifEncoderCore(Configuration configuration, IGifEncoderOptions options)
         {
-            this.memoryAllocator = memoryAllocator;
+            this.configuration = configuration;
+            this.memoryAllocator = configuration.MemoryAllocator;
             this.quantizer = options.Quantizer;
             this.colorTableMode = options.ColorTableMode;
         }
@@ -74,16 +75,14 @@ public void Encode<TPixel>(Image<TPixel> image, Stream stream)
             Guard.NotNull(image, nameof(image));
             Guard.NotNull(stream, nameof(stream));
 
-            this.configuration = image.GetConfiguration();
-
             ImageMetadata metadata = image.Metadata;
             GifMetadata gifMetadata = metadata.GetGifMetadata();
-            this.colorTableMode = this.colorTableMode ?? gifMetadata.ColorTableMode;
+            this.colorTableMode ??= gifMetadata.ColorTableMode;
             bool useGlobalTable = this.colorTableMode == GifColorTableMode.Global;
 
             // Quantize the image returning a palette.
             IQuantizedFrame<TPixel> quantized;
-            using (IFrameQuantizer<TPixel> frameQuantizer = this.quantizer.CreateFrameQuantizer<TPixel>(image.GetConfiguration()))
+            using (IFrameQuantizer<TPixel> frameQuantizer = this.quantizer.CreateFrameQuantizer<TPixel>(this.configuration))
             {
                 quantized = frameQuantizer.QuantizeFrame(image.Frames.RootFrame);
             }
@@ -146,7 +145,7 @@ private void EncodeGlobal<TPixel>(Image<TPixel> image, IQuantizedFrame<TPixel> q
                 else
                 {
                     using (IFrameQuantizer<TPixel> paletteFrameQuantizer =
-                        new PaletteFrameQuantizer<TPixel>(this.quantizer.Diffuser, quantized.Palette))
+                        new PaletteFrameQuantizer<TPixel>(this.configuration, this.quantizer.Diffuser, quantized.Palette))
                     {
                         using (IQuantizedFrame<TPixel> paletteQuantized = paletteFrameQuantizer.QuantizeFrame(frame))
                         {
@@ -172,14 +171,14 @@ private void EncodeLocal<TPixel>(Image<TPixel> image, IQuantizedFrame<TPixel> qu
                     if (previousFrame != null && previousMeta.ColorTableLength != frameMetadata.ColorTableLength
                                               && frameMetadata.ColorTableLength > 0)
                     {
-                        using (IFrameQuantizer<TPixel> frameQuantizer = this.quantizer.CreateFrameQuantizer<TPixel>(image.GetConfiguration(), frameMetadata.ColorTableLength))
+                        using (IFrameQuantizer<TPixel> frameQuantizer = this.quantizer.CreateFrameQuantizer<TPixel>(this.configuration, frameMetadata.ColorTableLength))
                         {
                             quantized = frameQuantizer.QuantizeFrame(frame);
                         }
                     }
                     else
                     {
-                        using (IFrameQuantizer<TPixel> frameQuantizer = this.quantizer.CreateFrameQuantizer<TPixel>(image.GetConfiguration()))
+                        using (IFrameQuantizer<TPixel> frameQuantizer = this.quantizer.CreateFrameQuantizer<TPixel>(this.configuration))
                         {
                             quantized = frameQuantizer.QuantizeFrame(frame);
                         }
@@ -202,9 +201,7 @@ private void EncodeLocal<TPixel>(Image<TPixel> image, IQuantizedFrame<TPixel> qu
         /// <summary>
         /// Returns the index of the most transparent color in the palette.
         /// </summary>
-        /// <param name="quantized">
-        /// The quantized.
-        /// </param>
+        /// <param name="quantized">The quantized frame.</param>
         /// <typeparam name="TPixel">The pixel format.</typeparam>
         /// <returns>
         /// The <see cref="int"/>.

src/ImageSharp/Formats/Gif/GifEncoderCore.cs

@@ -1,9 +1,9 @@
-// Copyright (c) Six Labors and contributors.
+// Copyright (c) Six Labors and contributors.
 // Licensed under the Apache License, Version 2.0.
 
 using System;
 using System.Runtime.CompilerServices;
-
+using SixLabors.ImageSharp.Advanced;
 using SixLabors.ImageSharp.PixelFormats;
 
 namespace SixLabors.ImageSharp.Formats.Jpeg.Components.Encoder
@@ -60,7 +60,7 @@ public void Convert(ImageFrame<TPixel> frame, int x, int y)
             this.pixelBlock.LoadAndStretchEdges(frame, x, y);
 
             Span<Rgb24> rgbSpan = this.rgbBlock.AsSpanUnsafe();
-            PixelOperations<TPixel>.Instance.ToRgb24(frame.Configuration, this.pixelBlock.AsSpanUnsafe(), rgbSpan);
+            PixelOperations<TPixel>.Instance.ToRgb24(frame.GetConfiguration(), this.pixelBlock.AsSpanUnsafe(), rgbSpan);
 
             ref float yBlockStart = ref Unsafe.As<Block8x8F, float>(ref this.Y);
             ref float cbBlockStart = ref Unsafe.As<Block8x8F, float>(ref this.Cb);
@@ -81,4 +81,4 @@ ref Unsafe.Add(ref cbBlockStart, i),
             }
         }
     }
-}
+}

src/ImageSharp/Formats/Jpeg/Components/Encoder/YCbCrForwardConverter{TPixel}.cs

@@ -16,20 +16,23 @@ namespace SixLabors.ImageSharp
     /// For the non-generic <see cref="Image"/> type, the pixel type is only known at runtime.
     /// <see cref="Image"/> is always implemented by a pixel-specific <see cref="Image{TPixel}"/> instance.
     /// </summary>
-    public abstract partial class Image : IImage, IConfigurable
+    public abstract partial class Image : IImage, IConfigurationProvider
     {
         private Size size;
+        private readonly Configuration configuration;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="Image"/> class.
         /// </summary>
-        /// <param name="configuration">The <see cref="Configuration"/>.</param>
+        /// <param name="configuration">
+        /// The configuration which allows altering default behaviour or extending the library.
+        /// </param>
         /// <param name="pixelType">The <see cref="PixelTypeInfo"/>.</param>
         /// <param name="metadata">The <see cref="ImageMetadata"/>.</param>
         /// <param name="size">The <see cref="size"/>.</param>
         protected Image(Configuration configuration, PixelTypeInfo pixelType, ImageMetadata metadata, Size size)
         {
-            this.Configuration = configuration ?? Configuration.Default;
+            this.configuration = configuration ?? Configuration.Default;
             this.PixelType = pixelType;
             this.size = size;
             this.Metadata = metadata ?? new ImageMetadata();
@@ -48,11 +51,6 @@ internal Image(
         {
         }
 
-        /// <summary>
-        /// Gets the <see cref="Configuration"/>.
-        /// </summary>
-        protected Configuration Configuration { get; }
-
         /// <summary>
         /// Gets the <see cref="ImageFrameCollection"/> implementing the public <see cref="Frames"/> property.
         /// </summary>
@@ -75,10 +73,8 @@ internal Image(
         /// </summary>
         public ImageFrameCollection Frames => this.NonGenericFrameCollection;
 
-        /// <summary>
-        /// Gets the pixel buffer.
-        /// </summary>
-        Configuration IConfigurable.Configuration => this.Configuration;
+        /// <inheritdoc/>
+        Configuration IConfigurationProvider.Configuration => this.configuration;
 
         /// <inheritdoc />
         public void Dispose()
@@ -108,7 +104,7 @@ public void Save(Stream stream, IImageEncoder encoder)
         /// <typeparam name="TPixel2">The pixel format.</typeparam>
         /// <returns>The <see cref="Image{TPixel2}"/></returns>
         public Image<TPixel2> CloneAs<TPixel2>()
-            where TPixel2 : struct, IPixel<TPixel2> => this.CloneAs<TPixel2>(this.Configuration);
+            where TPixel2 : struct, IPixel<TPixel2> => this.CloneAs<TPixel2>(this.GetConfiguration());
 
         /// <summary>
         /// Returns a copy of the image in the given pixel format.