Merge pull request #949 from dmanning23/AoT_iOS_compiler

#946: AoT compiler fixes and cleaned up AoTCompilerTools

src/ImageSharp/Advanced/AotCompilerTools.cs

@@ -1,12 +1,15 @@
-// Copyright (c) Six Labors and contributors.
+// Copyright (c) Six Labors and contributors.
 // Licensed under the Apache License, Version 2.0.
 
 using System.Numerics;
 using SixLabors.ImageSharp.Formats;
 using SixLabors.ImageSharp.Formats.Jpeg.Components;
 using SixLabors.ImageSharp.PixelFormats;
+using SixLabors.ImageSharp.Processing;
 using SixLabors.ImageSharp.Processing.Processors.Dithering;
 using SixLabors.ImageSharp.Processing.Processors.Quantization;
+using SixLabors.ImageSharp.Processing.Processors.Transforms;
+using SixLabors.Primitives;
 
 namespace SixLabors.ImageSharp.Advanced
 {
@@ -15,8 +18,10 @@ namespace SixLabors.ImageSharp.Advanced
     /// compiled on demand by a JIT compiler. This means there are a few limitations with respect to generics,
     /// these are caused because not every possible generic instantiation can be determined up front at compile time.
     /// The Aot Compiler is designed to overcome the limitations of this compiler.
+    /// None of the methods in this class should ever be called, the code only has to exist at compile-time to be picked up by the AoT compiler.
+    /// (Very similar to the LinkerIncludes.cs technique used in Xamarin.Android projects.)
     /// </summary>
-    public static class AotCompilerTools
+    internal static class AotCompilerTools
     {
         static AotCompilerTools()
         {
@@ -25,21 +30,59 @@ namespace SixLabors.ImageSharp.Advanced
             System.Runtime.CompilerServices.Unsafe.SizeOf<float>();
             System.Runtime.CompilerServices.Unsafe.SizeOf<double>();
             System.Runtime.CompilerServices.Unsafe.SizeOf<byte>();
+            System.Runtime.CompilerServices.Unsafe.SizeOf<int>();
             System.Runtime.CompilerServices.Unsafe.SizeOf<Block8x8>();
             System.Runtime.CompilerServices.Unsafe.SizeOf<Vector4>();
         }
 
+        /// <summary>
+        /// This is the method that seeds the AoT compiler.
+        /// None of these seed methods needs to actually be called to seed the compiler.
+        /// The calls just need to be present when the code is compiled, and each implementation will be built.
+        /// </summary>
+        private static void SeedEverything()
+        {
+            Seed<Alpha8>();
+            Seed<Argb32>();
+            Seed<Bgr24>();
+            Seed<Bgr565>();
+            Seed<Bgra32>();
+            Seed<Bgra4444>();
+            Seed<Bgra5551>();
+            Seed<Byte4>();
+            Seed<Gray16>();
+            Seed<Gray8>();
+            Seed<HalfSingle>();
+            Seed<HalfVector2>();
+            Seed<HalfVector4>();
+            Seed<NormalizedByte2>();
+            Seed<NormalizedByte4>();
+            Seed<NormalizedShort2>();
+            Seed<NormalizedShort4>();
+            Seed<Rg32>();
+            Seed<Rgb24>();
+            Seed<Rgb48>();
+            Seed<Rgba1010102>();
+            Seed<Rgba32>();
+            Seed<Rgba64>();
+            Seed<RgbaVector>();
+            Seed<Short2>();
+            Seed<Short4>();
+        }
+
         /// <summary>
         /// Seeds the compiler using the given pixel format.
         /// </summary>
         /// <typeparam name="TPixel">The pixel format.</typeparam>
-        public static void Seed<TPixel>()
+        private static void Seed<TPixel>()
              where TPixel : struct, IPixel<TPixel>
         {
             // This is we actually call all the individual methods you need to seed.
             AotCompileOctreeQuantizer<TPixel>();
             AotCompileWuQuantizer<TPixel>();
             AotCompileDithering<TPixel>();
+            AotCompilePixelOperations<TPixel>();
+            AotCompileResizeOperations<TPixel>();
 
             System.Runtime.CompilerServices.Unsafe.SizeOf<TPixel>();
 
@@ -51,34 +94,6 @@ namespace SixLabors.ImageSharp.Advanced
             // TODO: Do the discovery work to figure out what works and what doesn't.
         }
 
-        /// <summary>
-        /// Seeds the compiler using the given pixel formats.
-        /// </summary>
-        /// <typeparam name="TPixel">The first pixel format.</typeparam>
-        /// <typeparam name="TPixel2">The second pixel format.</typeparam>
-        public static void Seed<TPixel, TPixel2>()
-             where TPixel : struct, IPixel<TPixel>
-             where TPixel2 : struct, IPixel<TPixel2>
-        {
-            Seed<TPixel>();
-            Seed<TPixel2>();
-        }
-
-        /// <summary>
-        /// Seeds the compiler using the given pixel formats.
-        /// </summary>
-        /// <typeparam name="TPixel">The first pixel format.</typeparam>
-        /// <typeparam name="TPixel2">The second pixel format.</typeparam>
-        /// <typeparam name="TPixel3">The third pixel format.</typeparam>
-        public static void Seed<TPixel, TPixel2, TPixel3>()
-             where TPixel : struct, IPixel<TPixel>
-             where TPixel2 : struct, IPixel<TPixel2>
-             where TPixel3 : struct, IPixel<TPixel3>
-        {
-            Seed<TPixel, TPixel2>();
-            Seed<TPixel3>();
-        }
-
         /// <summary>
         /// This method doesn't actually do anything but serves an important purpose...
         /// If you are running ImageSharp on iOS and try to call SaveAsGif, it will throw an excepion:
@@ -146,5 +161,28 @@ namespace SixLabors.ImageSharp.Advanced
             {
             }
         }
+
+        /// <summary>
+        /// This method pre-seeds the PixelOperations engine for the AoT compiler on iOS.
+        /// </summary>
+        /// <typeparam name="TPixel">The pixel format.</typeparam>
+        private static void AotCompilePixelOperations<TPixel>()
+            where TPixel : struct, IPixel<TPixel>
+        {
+            var pixelOp = new PixelOperations<TPixel>();
+            pixelOp.GetPixelBlender(PixelColorBlendingMode.Normal, PixelAlphaCompositionMode.Clear);
+        }
+
+        /// <summary>
+        /// This method pre-seeds the ResizeProcessor for the AoT compiler on iOS.
+        /// </summary>
+        /// <typeparam name="TPixel">The pixel format.</typeparam>
+        private static void AotCompileResizeOperations<TPixel>()
+            where TPixel : struct, IPixel<TPixel>
+        {
+            var resizeProcessor = new ResizeProcessor(new ResizeOptions(), default);
+            var genericResizeProcessor = new ResizeProcessor<TPixel>(resizeProcessor.CreatePixelSpecificProcessor<TPixel>() as ResizeProcessor);
+            genericResizeProcessor.AotCreateDestination(new Image<TPixel>(0, 0), default);
+        }
     }
 }

src/ImageSharp/Processing/Processors/Transforms/Resize/ResizeProcessor{TPixel}.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 System;
@@ -64,6 +64,15 @@ namespace SixLabors.ImageSharp.Processing.Processors.Transforms
         /// </summary>
         public bool Compand => this.parameterSource.Compand;
 
+        /// <summary>
+        /// This is a shim for tagging the CreateDestination virtual generic method for the AoT iOS compiler.
+        /// This method should never be referenced outside of the AotCompiler code.
+        /// </summary>
+        /// <param name="source">Passed through as source to the CreateDestination method.</param>
+        /// <param name="sourceRectangle">Passed through as sourceRectangle to the CreateDestination method.</param>
+        /// <returns>The result returned from CreateDestination.</returns>
+        internal Image<TPixel> AotCreateDestination(Image<TPixel> source, Rectangle sourceRectangle) => this.CreateDestination(source, sourceRectangle);
+
         /// <inheritdoc/>
         protected override Image<TPixel> CreateDestination(Image<TPixel> source, Rectangle sourceRectangle)
         {
@@ -188,4 +197,4 @@ namespace SixLabors.ImageSharp.Processing.Processors.Transforms
             this.verticalKernelMap = null;
         }
     }
-}
+}

tests/ImageSharp.Tests/Advanced/AotCompilerTests.cs

@@ -1,15 +0,0 @@
-// Copyright (c) Six Labors and contributors.
-// Licensed under the Apache License, Version 2.0.
-
-using SixLabors.ImageSharp.Advanced;
-using SixLabors.ImageSharp.PixelFormats;
-using Xunit;
-
-namespace SixLabors.ImageSharp.Tests.Advanced
-{
-    public class AotCompilerTests
-    {
-        [Fact]
-        public void AotCompiler_NoExceptions() => AotCompilerTools.Seed<Rgba32, Rgb24, Bgr24>();
-    }
-}