Migration to SkiaSharp

Author: mialeska

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Aquality.Selenium.Core.csproj

@@ -53,6 +53,6 @@
     <PackageReference Include="NLog" Version="5.1.2" />
     <PackageReference Include="Selenium.Support" Version="4.8.1" />
     <PackageReference Include="Selenium.WebDriver" Version="4.8.1" />
-    <PackageReference Include="System.Drawing.Common" Version="6.0.0" />    
+    <PackageReference Include="SkiaSharp" Version="2.88.3" />    
   </ItemGroup>
 </Project>

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Aquality.Selenium.Core.xml

@@ -1,9 +1,9 @@
 using Aquality.Selenium.Core.Configurations;
 using Aquality.Selenium.Core.Elements.Interfaces;
 using Aquality.Selenium.Core.Localization;
+using SkiaSharp;
 using System;
 using System.Collections.Generic;
-using System.Drawing;
 using System.Globalization;
 using System.IO;
 using System.Linq;
@@ -64,7 +64,7 @@ public virtual float Compare(string dumpName = null)
                 }
                 else
                 {
-                    comparisonResult += existingElements[key].Visual.GetDifference(Image.FromFile(imageFile.FullName));
+                    comparisonResult += existingElements[key].Visual.GetDifference(SKImage.FromEncodedData(imageFile.FullName));
                     countOfUnproceededElements--;
                     countOfProceededElements++;
                     existingElements.Remove(key);

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Visualization/DumpManager.cs

@@ -1,5 +1,5 @@
 using Aquality.Selenium.Core.Configurations;
-using System.Drawing;
+using SkiaSharp;
 
 namespace Aquality.Selenium.Core.Visualization
 {
@@ -17,6 +17,6 @@ public interface IImageComparator
         /// <param name="theOtherOne">The image to compare with</param>
         /// <param name="threshold">How big a difference will be ignored as a percentage - value between 0 and 1. </param>
         /// <returns>The difference between the two images as a percentage  - value between 0 and 1.</returns>
-        float PercentageDifference(Image thisOne, Image theOtherOne, float? threshold = null);
+        float PercentageDifference(SKImage thisOne, SKImage theOtherOne, float? threshold = null);
     }
 }

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Visualization/IImageComparator.cs

@@ -1,4 +1,5 @@
 using Aquality.Selenium.Core.Configurations;
+using SkiaSharp;
 using System.Drawing;
 
 namespace Aquality.Selenium.Core.Visualization
@@ -22,7 +23,7 @@ public interface IVisualStateProvider
         /// <summary>
         /// Gets an image containing the screenshot of the element.
         /// </summary>
-        Image Image { get; }
+        SKImage Image { get; }
 
         /// <summary>
         /// Gets the difference between the image of the element and the provided image
@@ -32,6 +33,6 @@ public interface IVisualStateProvider
         /// <param name="threshold">How big a difference will be ignored as a percentage - value between 0 and 1.
         /// If the value is null, the default value is got from <see cref="IVisualizationConfiguration"/>.</param>
         /// <returns>The difference between the two images as a percentage  - value between 0 and 1.</returns>
-        float GetDifference(Image theOtherOne, float? threshold = null);
+        float GetDifference(SKImage theOtherOne, float? threshold = null);
     }
 }

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Visualization/IVisualStateProvider.cs

@@ -1,6 +1,6 @@
 using Aquality.Selenium.Core.Configurations;
+using SkiaSharp;
 using System;
-using System.Drawing;
 
 namespace Aquality.Selenium.Core.Visualization
 {
@@ -33,7 +33,7 @@ public ImageComparator(IVisualizationConfiguration visualizationConfiguration)
         /// If the value is null, the default value is got from <see cref="IVisualizationConfiguration"/>.</param>
         /// <returns>The difference between the two images as a percentage  - value between 0 and 1.</returns>
         /// <remarks>See https://web.archive.org/web/20130208001434/http://tech.pro:80/tutorial/660/csharp-tutorial-convert-a-color-image-to-grayscale for more details.</remarks>
-        public virtual float PercentageDifference(Image thisOne, Image theOtherOne, float? threshold = null)
+        public virtual float PercentageDifference(SKImage thisOne, SKImage theOtherOne, float? threshold = null)
         {
             var thresholdValue = threshold ?? DefaultThreshold;
             if (thresholdValue < 0 || thresholdValue > 1)
@@ -53,7 +53,7 @@ public virtual float PercentageDifference(Image thisOne, Image theOtherOne, floa
         /// <param name="threshold">How big a difference (out of 255) will be ignored - the default is 3.</param>
         /// <returns>The difference between the two images as a percentage</returns>
         /// <remarks>See https://web.archive.org/web/20130208001434/http://tech.pro:80/tutorial/660/csharp-tutorial-convert-a-color-image-to-grayscale for more details</remarks>
-        protected virtual float PercentageDifference(Image thisOne, Image theOtherOne, byte threshold = 3)
+        protected virtual float PercentageDifference(SKImage thisOne, SKImage theOtherOne, byte threshold = 3)
         {
             var differences = GetDifferences(thisOne, theOtherOne);
 
@@ -73,7 +73,7 @@ protected virtual float PercentageDifference(Image thisOne, Image theOtherOne, b
         /// <param name="thisOne">The first image</param>
         /// <param name="theOtherOne">The image to compare with</param>
         /// <returns>the differences between the two images as a double-array</returns>
-        protected virtual byte[,] GetDifferences(Image thisOne, Image theOtherOne)
+        protected virtual byte[,] GetDifferences(SKImage thisOne, SKImage theOtherOne)
         {
             var firstGray = GetResizedGrayScaleValues(thisOne);
             var secondGray = GetResizedGrayScaleValues(theOtherOne);
@@ -95,17 +95,17 @@ protected virtual float PercentageDifference(Image thisOne, Image theOtherOne, b
         /// </summary>
         /// <param name="img">The image to get the lightness for</param>
         /// <returns>A double-array (16x16 by default) containing the lightness of the sections(256 by default)</returns>
-        protected virtual byte[,] GetResizedGrayScaleValues(Image img)
+        protected virtual byte[,] GetResizedGrayScaleValues(SKImage img)
         {
-            using (var thisOne = (Bitmap)img.Resize(ComparisonWidth, ComparisonHeight).GetGrayScaleVersion())
+            using (var thisOne = SKBitmap.FromImage(img.Resize(ComparisonWidth, ComparisonHeight).GetGrayScaleVersion()))
             {
                 byte[,] grayScale = new byte[thisOne.Width, thisOne.Height];
 
                 for (int y = 0; y < thisOne.Height; y++)
                 {
                     for (int x = 0; x < thisOne.Width; x++)
                     {
-                        grayScale[x, y] = (byte)Math.Abs(thisOne.GetPixel(x, y).R);
+                        grayScale[x, y] = (byte)Math.Abs(thisOne.GetPixel(x, y).Red);
                     }
                 }
 

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Visualization/ImageComparator.cs

@@ -1,6 +1,6 @@
-using System.Drawing;
-using System.Drawing.Drawing2D;
-using System.Drawing.Imaging;
+using SkiaSharp;
+using System.Drawing;
+using System.IO;
 
 namespace Aquality.Selenium.Core.Visualization
 {
@@ -10,13 +10,12 @@ namespace Aquality.Selenium.Core.Visualization
     /// </summary>
     public static class ImageExtensions
     {
-        private static readonly ColorMatrix ColorMatrix = new ColorMatrix(new float[][]
+        private static readonly SKColorFilter ColorMatrix = SKColorFilter.CreateColorMatrix(new float[]
         {
-            new float[] {.3f, .3f, .3f, 0, 0},
-            new float[] {.59f, .59f, .59f, 0, 0},
-            new float[] {.11f, .11f, .11f, 0, 0},
-            new float[] {0, 0, 0, 1, 0},
-            new float[] {0, 0, 0, 0, 1}
+            .3f, .3f, .3f, 0, 0,
+            .59f, .59f, .59f, 0, 0,
+            .11f, .11f, .11f, 0, 0,
+            0, 0, 0, 1, 0
         });
 
         /// <summary>
@@ -26,18 +25,16 @@ public static class ImageExtensions
         /// <param name="newWidth">The new width in pixels</param>
         /// <param name="newHeight">The new height in pixels</param>
         /// <returns>A resized version of the original image</returns>
-        public static Image Resize(this Image originalImage, int newWidth, int newHeight)
+        public static SKImage Resize(this SKImage originalImage, int newWidth, int newHeight)
         {
-            var smallVersion = new Bitmap(newWidth, newHeight);
-            using (var graphics = Graphics.FromImage(smallVersion))
+            using (var srcBitmap = SKBitmap.FromImage(originalImage))
             {
-                graphics.SmoothingMode = SmoothingMode.HighQuality;
-                graphics.InterpolationMode = InterpolationMode.HighQualityBicubic;
-                graphics.PixelOffsetMode = PixelOffsetMode.HighQuality;
-                graphics.DrawImage(originalImage, 0, 0, newWidth, newHeight);
-            }
-
-            return smallVersion;
+                var resizeInfo = new SKImageInfo(newWidth, newHeight);
+                using (var smallVersion = srcBitmap.Resize(resizeInfo, SKFilterQuality.High))
+                {
+                    return SKImage.FromBitmap(smallVersion);
+                }
+            }                
         }
 
         /// <summary>
@@ -46,27 +43,38 @@ public static Image Resize(this Image originalImage, int newWidth, int newHeight
         /// <param name="original">The image to gray scale</param>
         /// <returns>A gray scale version of the image</returns>
         /// <remarks>See http://www.switchonthecode.com/tutorials/csharp-tutorial-convert-a-color-image-to-grayscale for more details</remarks>
-        public static Image GetGrayScaleVersion(this Image original)
+        public static SKImage GetGrayScaleVersion(this SKImage original)
         {
             //create a blank bitmap the same size as original
-            var newBitmap = new Bitmap(original.Width, original.Height);
+            var info = new SKImageInfo(original.Width, original.Height);
+            var newBitmap = new SKBitmap(info);
+            
 
+            //create some image attributes
+            using (var paint = new SKPaint())
             //get a graphics object from the new image
-            using (var graphics = Graphics.FromImage(newBitmap))
+            using (var graphics = new SKCanvas(newBitmap))
             {
-                //create some image attributes
-                var attributes = new ImageAttributes();
-
                 //set the color matrix attribute
-                attributes.SetColorMatrix(ColorMatrix);
+                paint.ColorFilter = ColorMatrix;                
 
                 //draw the original image on the new image
                 //using the gray-scale color matrix
-                graphics.DrawImage(original, new Rectangle(0, 0, original.Width, original.Height),
-                   0, 0, original.Width, original.Height, GraphicsUnit.Pixel, attributes);
+                graphics.DrawImage(original, 0, 0, paint);
             }
 
-            return newBitmap;
+            return SKImage.FromBitmap(newBitmap);
+        }
+
+        public static Size Size(this SKImage image) => new Size(image.Width, image.Height);
+
+        public static void Save(this SKImage image, string name, SKEncodedImageFormat format = SKEncodedImageFormat.Png)
+        {
+            using (Stream stream = new FileStream(name, FileMode.OpenOrCreate))
+            {
+                SKData d = image.Encode(format, 100);
+                d.SaveTo(stream);
+            }
         }
     }
 }