Merge pull request #1176 from SixLabors/sw/property-bag

Add Property bag to Configuration and Image Processing Context

Author: tocsoft

src/ImageSharp/Configuration.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Net.Http;
 using SixLabors.ImageSharp.Formats;
 using SixLabors.ImageSharp.Formats.Bmp;
 using SixLabors.ImageSharp.Formats.Gif;
@@ -73,6 +74,12 @@ public int MaxDegreeOfParallelism
             }
         }
 
+        /// <summary>
+        /// Gets a set of properties for the Congiguration.
+        /// </summary>
+        /// <remarks>This can be used for storing global settings and defaults to be accessable to processors.</remarks>
+        public IDictionary<object, object> Properties { get; } = new Dictionary<object, object>();
+
         /// <summary>
         /// Gets the currently registered <see cref="IImageFormat"/>s.
         /// </summary>

src/ImageSharp/GraphicOptionsDefaultsExtensions.cs

@@ -0,0 +1,100 @@
+// Copyright (c) Six Labors and contributors.
+// Licensed under the Apache License, Version 2.0.
+
+using System;
+using SixLabors.ImageSharp.Processing;
+
+namespace SixLabors.ImageSharp
+{
+    /// <summary>
+    /// Adds extensions that allow the processing of images to the <see cref="Image{TPixel}"/> type.
+    /// </summary>
+    public static class GraphicOptionsDefaultsExtensions
+    {
+        /// <summary>
+        /// Sets the default options against the image processing context.
+        /// </summary>
+        /// <param name="context">The image processing context to store default against.</param>
+        /// <param name="optionsBuilder">The action to update instance of the default options used.</param>
+        /// <returns>The passed in <paramref name="context"/> to allow chaining.</returns>
+        public static IImageProcessingContext SetGraphicsOptions(this IImageProcessingContext context, Action<GraphicsOptions> optionsBuilder)
+        {
+            var cloned = context.GetGraphicsOptions().DeepClone();
+            optionsBuilder(cloned);
+            context.Properties[typeof(GraphicsOptions)] = cloned;
+            return context;
+        }
+
+        /// <summary>
+        /// Sets the default options against the configuration.
+        /// </summary>
+        /// <param name="configuration">The configuration to store default against.</param>
+        /// <param name="optionsBuilder">The default options to use.</param>
+        public static void SetGraphicsOptions(this Configuration configuration, Action<GraphicsOptions> optionsBuilder)
+        {
+            var cloned = configuration.GetGraphicsOptions().DeepClone();
+            optionsBuilder(cloned);
+            configuration.Properties[typeof(GraphicsOptions)] = cloned;
+        }
+
+        /// <summary>
+        /// Sets the default options against the image processing context.
+        /// </summary>
+        /// <param name="context">The image processing context to store default against.</param>
+        /// <param name="options">The default options to use.</param>
+        /// <returns>The passed in <paramref name="context"/> to allow chaining.</returns>
+        public static IImageProcessingContext SetGraphicsOptions(this IImageProcessingContext context, GraphicsOptions options)
+        {
+            context.Properties[typeof(GraphicsOptions)] = options;
+            return context;
+        }
+
+        /// <summary>
+        /// Sets the default options against the configuration.
+        /// </summary>
+        /// <param name="configuration">The configuration to store default against.</param>
+        /// <param name="options">The default options to use.</param>
+        public static void SetGraphicsOptions(this Configuration configuration, GraphicsOptions options)
+        {
+            configuration.Properties[typeof(GraphicsOptions)] = options;
+        }
+
+        /// <summary>
+        /// Gets the default options against the image processing context.
+        /// </summary>
+        /// <param name="context">The image processing context to retrieve defaults from.</param>
+        /// <returns>The globaly configued default options.</returns>
+        public static GraphicsOptions GetGraphicsOptions(this IImageProcessingContext context)
+        {
+            if (context.Properties.TryGetValue(typeof(GraphicsOptions), out var options) && options is GraphicsOptions go)
+            {
+                return go;
+            }
+
+            var configOptions = context.Configuration.GetGraphicsOptions();
+
+            // do not cache the fall back to config into the the processing context
+            // in case someone want to change the value on the config and expects it re trflow thru
+            return configOptions;
+        }
+
+        /// <summary>
+        /// Gets the default options against the image processing context.
+        /// </summary>
+        /// <param name="configuration">The configuration to retrieve defaults from.</param>
+        /// <returns>The globaly configued default options.</returns>
+        public static GraphicsOptions GetGraphicsOptions(this Configuration configuration)
+        {
+            if (configuration.Properties.TryGetValue(typeof(GraphicsOptions), out var options) && options is GraphicsOptions go)
+            {
+                return go;
+            }
+
+            var configOptions = new GraphicsOptions();
+
+            // capture the fallback so the same instance will always be returned in case its mutated
+            configuration.Properties[typeof(GraphicsOptions)] = configOptions;
+            return configOptions;
+        }
+    }
+}

src/ImageSharp/Processing/DefaultImageProcessorContext{TPixel}.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Six Labors and contributors.
 // Licensed under the Apache License, Version 2.0.
 
+using System.Collections.Generic;
 using SixLabors.ImageSharp.PixelFormats;
 using SixLabors.ImageSharp.Processing.Processors;
 
@@ -39,6 +40,9 @@ public DefaultImageProcessorContext(Configuration configuration, Image<TPixel> s
         /// <inheritdoc/>
         public Configuration Configuration { get; }
 
+        /// <inheritdoc/>
+        public IDictionary<object, object> Properties { get; } = new Dictionary<object, object>();
+
         /// <inheritdoc/>
         public Image<TPixel> GetResultImage()
         {

src/ImageSharp/Processing/Extensions/Drawing/DrawImageExtensions.cs

@@ -23,7 +23,7 @@ public static IImageProcessingContext DrawImage(
             Image image,
             float opacity)
         {
-            var options = new GraphicsOptions();
+            var options = source.GetGraphicsOptions();
             return source.ApplyProcessor(
                 new DrawImageProcessor(
                 image,
@@ -51,7 +51,7 @@ public static IImageProcessingContext DrawImage(
                     image,
                     Point.Empty,
                     colorBlending,
-                    new GraphicsOptions().AlphaCompositionMode,
+                    source.GetGraphicsOptions().AlphaCompositionMode,
                     opacity));
 
         /// <summary>
@@ -104,7 +104,7 @@ public static IImageProcessingContext DrawImage(
             Point location,
             float opacity)
         {
-            var options = new GraphicsOptions();
+            var options = source.GetGraphicsOptions();
             return source.ApplyProcessor(
                 new DrawImageProcessor(
                 image,
@@ -134,7 +134,7 @@ public static IImageProcessingContext DrawImage(
                     image,
                     location,
                     colorBlending,
-                    new GraphicsOptions().AlphaCompositionMode,
+                    source.GetGraphicsOptions().AlphaCompositionMode,
                     opacity));
 
         /// <summary>

src/ImageSharp/Processing/Extensions/Filters/LomographExtensions.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Six Labors and contributors.
+// Copyright (c) Six Labors and contributors.
 // Licensed under the Apache License, Version 2.0.
 
 using SixLabors.ImageSharp.Processing.Processors.Filters;
@@ -17,7 +17,7 @@ public static class LomographExtensions
         /// <param name="source">The image this method extends.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Lomograph(this IImageProcessingContext source)
-            => source.ApplyProcessor(new LomographProcessor());
+            => source.ApplyProcessor(new LomographProcessor(source.GetGraphicsOptions()));
 
         /// <summary>
         /// Alters the colors of the image recreating an old Lomograph camera effect.
@@ -28,6 +28,6 @@ public static IImageProcessingContext Lomograph(this IImageProcessingContext sou
         /// </param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Lomograph(this IImageProcessingContext source, Rectangle rectangle)
-            => source.ApplyProcessor(new LomographProcessor(), rectangle);
+            => source.ApplyProcessor(new LomographProcessor(source.GetGraphicsOptions()), rectangle);
     }
-}
+}

src/ImageSharp/Processing/Extensions/Filters/PolaroidExtensions.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Six Labors and contributors.
+// Copyright (c) Six Labors and contributors.
 // Licensed under the Apache License, Version 2.0.
 
 using SixLabors.ImageSharp.Processing.Processors.Filters;
@@ -17,7 +17,7 @@ public static class PolaroidExtensions
         /// <param name="source">The image this method extends.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Polaroid(this IImageProcessingContext source)
-            => source.ApplyProcessor(new PolaroidProcessor());
+            => source.ApplyProcessor(new PolaroidProcessor(source.GetGraphicsOptions()));
 
         /// <summary>
         /// Alters the colors of the image recreating an old Polaroid camera effect.
@@ -28,6 +28,6 @@ public static IImageProcessingContext Polaroid(this IImageProcessingContext sour
         /// </param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Polaroid(this IImageProcessingContext source, Rectangle rectangle)
-            => source.ApplyProcessor(new PolaroidProcessor(), rectangle);
+            => source.ApplyProcessor(new PolaroidProcessor(source.GetGraphicsOptions()), rectangle);
     }
 }

src/ImageSharp/Processing/Extensions/Overlays/BackgroundColorExtensions.cs

@@ -18,7 +18,7 @@ public static class BackgroundColorExtensions
         /// <param name="color">The color to set as the background.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext BackgroundColor(this IImageProcessingContext source, Color color) =>
-            BackgroundColor(source, new GraphicsOptions(), color);
+            BackgroundColor(source, source.GetGraphicsOptions(), color);
 
         /// <summary>
         /// Replaces the background color of image with the given one.
@@ -33,7 +33,7 @@ public static IImageProcessingContext BackgroundColor(
             this IImageProcessingContext source,
             Color color,
             Rectangle rectangle) =>
-            BackgroundColor(source, new GraphicsOptions(), color, rectangle);
+            BackgroundColor(source, source.GetGraphicsOptions(), color, rectangle);
 
         /// <summary>
         /// Replaces the background color of image with the given one.

src/ImageSharp/Processing/Extensions/Overlays/GlowExtensions.cs

@@ -17,7 +17,7 @@ public static class GlowExtensions
         /// <param name="source">The image this method extends.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Glow(this IImageProcessingContext source) =>
-            Glow(source, new GraphicsOptions());
+            Glow(source, source.GetGraphicsOptions());
 
         /// <summary>
         /// Applies a radial glow effect to an image.
@@ -27,7 +27,7 @@ public static IImageProcessingContext Glow(this IImageProcessingContext source)
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Glow(this IImageProcessingContext source, Color color)
         {
-            return Glow(source, new GraphicsOptions(), color);
+            return Glow(source, source.GetGraphicsOptions(), color);
         }
 
         /// <summary>
@@ -37,7 +37,7 @@ public static IImageProcessingContext Glow(this IImageProcessingContext source,
         /// <param name="radius">The the radius.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Glow(this IImageProcessingContext source, float radius) =>
-            Glow(source, new GraphicsOptions(), radius);
+            Glow(source, source.GetGraphicsOptions(), radius);
 
         /// <summary>
         /// Applies a radial glow effect to an image.
@@ -48,7 +48,7 @@ public static IImageProcessingContext Glow(this IImageProcessingContext source,
         /// </param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Glow(this IImageProcessingContext source, Rectangle rectangle) =>
-            source.Glow(new GraphicsOptions(), rectangle);
+            source.Glow(source.GetGraphicsOptions(), rectangle);
 
         /// <summary>
         /// Applies a radial glow effect to an image.
@@ -65,7 +65,7 @@ public static IImageProcessingContext Glow(
             Color color,
             float radius,
             Rectangle rectangle) =>
-            source.Glow(new GraphicsOptions(), color, ValueSize.Absolute(radius), rectangle);
+            source.Glow(source.GetGraphicsOptions(), color, ValueSize.Absolute(radius), rectangle);
 
         /// <summary>
         /// Applies a radial glow effect to an image.

src/ImageSharp/Processing/Extensions/Overlays/VignetteExtensions.cs

@@ -17,7 +17,7 @@ public static class VignetteExtensions
         /// <param name="source">The image this method extends.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Vignette(this IImageProcessingContext source) =>
-            Vignette(source, new GraphicsOptions());
+            Vignette(source, source.GetGraphicsOptions());
 
         /// <summary>
         /// Applies a radial vignette effect to an image.
@@ -26,7 +26,7 @@ public static IImageProcessingContext Vignette(this IImageProcessingContext sour
         /// <param name="color">The color to set as the vignette.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Vignette(this IImageProcessingContext source, Color color) =>
-            Vignette(source, new GraphicsOptions(), color);
+            Vignette(source, source.GetGraphicsOptions(), color);
 
         /// <summary>
         /// Applies a radial vignette effect to an image.
@@ -39,7 +39,7 @@ public static IImageProcessingContext Vignette(
             this IImageProcessingContext source,
             float radiusX,
             float radiusY) =>
-            Vignette(source, new GraphicsOptions(), radiusX, radiusY);
+            Vignette(source, source.GetGraphicsOptions(), radiusX, radiusY);
 
         /// <summary>
         /// Applies a radial vignette effect to an image.
@@ -50,7 +50,7 @@ public static IImageProcessingContext Vignette(
         /// </param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Vignette(this IImageProcessingContext source, Rectangle rectangle) =>
-            Vignette(source, new GraphicsOptions(), rectangle);
+            Vignette(source, source.GetGraphicsOptions(), rectangle);
 
         /// <summary>
         /// Applies a radial vignette effect to an image.
@@ -69,7 +69,7 @@ public static IImageProcessingContext Vignette(
             float radiusX,
             float radiusY,
             Rectangle rectangle) =>
-            source.Vignette(new GraphicsOptions(), color, radiusX, radiusY, rectangle);
+            source.Vignette(source.GetGraphicsOptions(), color, radiusX, radiusY, rectangle);
 
         /// <summary>
         /// Applies a radial vignette effect to an image.

src/ImageSharp/Processing/IImageProcessingContext.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Six Labors and contributors.
 // Licensed under the Apache License, Version 2.0.
 
+using System.Collections.Generic;
 using SixLabors.ImageSharp.Processing.Processors;
 
 namespace SixLabors.ImageSharp.Processing
@@ -15,6 +16,12 @@ public interface IImageProcessingContext
         /// </summary>
         Configuration Configuration { get; }
 
+        /// <summary>
+        /// Gets a set of properties for the Image Processing Context.
+        /// </summary>
+        /// <remarks>This can be used for storing global settings and defaults to be accessable to processors.</remarks>
+        IDictionary<object, object> Properties { get; }
+
         /// <summary>
         /// Gets the image dimensions at the current point in the processing pipeline.
         /// </summary>