Merge pull request #235 from SixLabors/js/optimize-pixel-memory

Allow ImageSharp to determine the best pixel format on load.

Author: JimBobSquarePants

samples/ImageSharp.Web.Sample/wwwroot/imagesharp-logo.png

@@ -17,11 +17,7 @@
   <Import Project="$(MSBuildThisFileDirectory)..\Directory.Build.targets" />
 
   <ItemGroup>
-    <PackageReference Update="AWSSDK.S3" Version="3.7.7.16" />
-    <PackageReference Update="Azure.Storage.Blobs" Version="12.10.0" />
-    <PackageReference Update="Microsoft.IO.RecyclableMemoryStream" Version="2.2.0" />
     <PackageReference Update="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All"/>
-    <PackageReference Update="SixLabors.ImageSharp"  Version="2.0.0" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' != 'netcoreapp2.1'">

samples/ImageSharp.Web.Sample/wwwroot/index.html

@@ -31,7 +31,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="AWSSDK.S3" />
+    <PackageReference Include="AWSSDK.S3" Version="3.7.8.8" />
   </ItemGroup>
 
   <ItemGroup>

samples/ImageSharp.Web.Sample/wwwroot/sixlabors.imagesharp.web.png

@@ -31,7 +31,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Azure.Storage.Blobs" />
+    <!--TODO: Do not upgrade this. Last Version that supports .NET Core 2.1-->
+    <PackageReference Include="Azure.Storage.Blobs" Version="12.10.0" />
   </ItemGroup>
 
   <ItemGroup>

src/Directory.Build.targets

@@ -84,7 +84,7 @@ internal static string GetCacheRoot(PhysicalFileSystemCacheOptions cacheOptions,
         /// <inheritdoc/>
         public Task<IImageCacheResolver> GetAsync(string key)
         {
-            string path = ToFilePath(key, this.cacheFolderDepth);
+            string path = Path.Combine(this.cacheRootPath, ToFilePath(key, this.cacheFolderDepth));
 
             var metaFileInfo = new FileInfo(this.ToMetaDataFilePath(path));
             if (!metaFileInfo.Exists)

src/ImageSharp.Web.Providers.AWS/ImageSharp.Web.Providers.AWS.csproj

@@ -27,17 +27,17 @@ public sealed class FormattedImage : IDisposable
         /// </summary>
         /// <param name="image">The image.</param>
         /// <param name="format">The format.</param>
-        internal FormattedImage(Image<Rgba32> image, IImageFormat format)
+        internal FormattedImage(Image image, IImageFormat format)
         {
             this.Image = image;
             this.imageFormatsManager = image.GetConfiguration().ImageFormatsManager;
             this.Format = format;
         }
 
         /// <summary>
-        /// Gets the image.
+        /// Gets the decoded image.
         /// </summary>
-        public Image<Rgba32> Image { get; private set; }
+        public Image Image { get; private set; }
 
         /// <summary>
         /// Gets or sets the format.
@@ -82,41 +82,36 @@ public IImageEncoder Encoder
         }
 
         /// <summary>
-        /// Loads the specified source.
+        /// Create a new instance of the <see cref="FormattedImage"/> class from the given stream.
         /// </summary>
+        /// <typeparam name="TPixel">The pixel format.</typeparam>
         /// <param name="configuration">The configuration.</param>
         /// <param name="source">The source.</param>
-        /// <returns>The <see cref="FormattedImage"/>.</returns>
-        public static FormattedImage Load(Configuration configuration, Stream source)
+        /// <returns>A <see cref="Task{FormattedImage}"/> representing the asynchronous operation.</returns>
+        internal static async Task<FormattedImage> LoadAsync<TPixel>(Configuration configuration, Stream source)
+            where TPixel : unmanaged, IPixel<TPixel>
         {
-            var image = ImageSharp.Image.Load<Rgba32>(configuration, source, out IImageFormat format);
+            (Image<TPixel> image, IImageFormat format) = await Image.LoadWithFormatAsync<TPixel>(configuration, source);
             return new FormattedImage(image, format);
         }
 
         /// <summary>
-        /// Loads the specified source.
+        /// Create a new instance of the <see cref="FormattedImage"/> class from the given stream.
         /// </summary>
         /// <param name="configuration">The configuration.</param>
         /// <param name="source">The source.</param>
         /// <returns>A <see cref="Task{FormattedImage}"/> representing the asynchronous operation.</returns>
-        public static async Task<FormattedImage> LoadAsync(Configuration configuration, Stream source)
+        internal static async Task<FormattedImage> LoadAsync(Configuration configuration, Stream source)
         {
-            (Image<Rgba32> image, IImageFormat format) = await ImageSharp.Image.LoadWithFormatAsync<Rgba32>(configuration, source);
+            (Image image, IImageFormat format) = await Image.LoadWithFormatAsync(configuration, source);
             return new FormattedImage(image, format);
         }
 
         /// <summary>
-        /// Saves image to the specified destination stream.
-        /// </summary>
-        /// <param name="destination">The destination stream.</param>
-        public void Save(Stream destination) => this.Image.Save(destination, this.encoder);
-
-        /// <summary>
-        /// Saves image to the specified destination stream.
+        /// Saves the <see cref="FormattedImage"/> to the specified destination stream.
         /// </summary>
         /// <param name="destination">The destination stream.</param>
-        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
-        public Task SaveAsync(Stream destination) => this.Image.SaveAsync(destination, this.encoder);
+        internal void Save(Stream destination) => this.Image.Save(destination, this.encoder);
 
         /// <summary>
         /// Gets the EXIF orientation metata for the <see cref="FormattedImage"/>.

src/ImageSharp.Web.Providers.Azure/ImageSharp.Web.Providers.Azure.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <AssemblyTitle>SixLabors.ImageSharp.Web</AssemblyTitle>
@@ -44,8 +44,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.IO.RecyclableMemoryStream" />
-    <PackageReference Include="SixLabors.ImageSharp" />
+    <PackageReference Include="Microsoft.IO.RecyclableMemoryStream" Version="2.2.0" />
+    <PackageReference Include="SixLabors.ImageSharp"  Version="2.1.0" />
   </ItemGroup>
 
   <Import Project="..\..\shared-infrastructure\src\SharedInfrastructure\SharedInfrastructure.projitems" Label="Shared" />

src/ImageSharp.Web/Caching/PhysicalFileSystemCache.cs

@@ -13,6 +13,7 @@
 using Microsoft.Extensions.Options;
 using Microsoft.IO;
 using SixLabors.ImageSharp.Formats;
+using SixLabors.ImageSharp.PixelFormats;
 using SixLabors.ImageSharp.Web.Caching;
 using SixLabors.ImageSharp.Web.Commands;
 using SixLabors.ImageSharp.Web.Processors;
@@ -334,19 +335,43 @@ private async Task ProcessRequestAsync(
                                 }
                                 else
                                 {
-                                    using FormattedImage image = await FormattedImage.LoadAsync(this.options.Configuration, inStream);
-
-                                    image.Process(
-                                        this.logger,
-                                        this.processors,
-                                        commands,
-                                        this.commandParser,
-                                        this.parserCulture);
-
-                                    await this.options.OnBeforeSaveAsync.Invoke(image);
-
-                                    image.Save(outStream);
-                                    format = image.Format;
+                                    FormattedImage image = null;
+                                    try
+                                    {
+                                        // Now we can finally process the image.
+                                        // We first sort the processor collection by command order then use that collection to determine whether the decoded image pixel format
+                                        // explicitly requires an alpha component in order to allow correct processing.
+                                        //
+                                        // The non-generic variant will decode to the correct pixel format based upon the encoded image metadata which can yield
+                                        // massive memory savings.
+                                        IReadOnlyList<(int Index, IImageWebProcessor Processor)> sortedProcessors = this.processors.OrderBySupportedCommands(commands);
+                                        bool requiresAlpha = sortedProcessors.RequiresTrueColorPixelFormat(commands, this.commandParser, this.parserCulture);
+
+                                        if (requiresAlpha)
+                                        {
+                                            image = await FormattedImage.LoadAsync<Rgba32>(this.options.Configuration, inStream);
+                                        }
+                                        else
+                                        {
+                                            image = await FormattedImage.LoadAsync(this.options.Configuration, inStream);
+                                        }
+
+                                        image.Process(
+                                            this.logger,
+                                            sortedProcessors,
+                                            commands,
+                                            this.commandParser,
+                                            this.parserCulture);
+
+                                        await this.options.OnBeforeSaveAsync.Invoke(image);
+
+                                        image.Save(outStream);
+                                        format = image.Format;
+                                    }
+                                    finally
+                                    {
+                                        image?.Dispose();
+                                    }
                                 }
                             }