Removed quality parameter everywhere.

Added Quality From EncodedFormat Extension
Kareadita · maxpiva · Aug 15, 2024 · Aug 15, 2024 · Aug 23, 2024 · Aug 23, 2024
commit a0f804ba175cda90d40a38219ef4a81589c12756
diff --git a/API.Benchmark/ArchiveServiceBenchmark.cs b/API.Benchmark/ArchiveServiceBenchmark.cs
@@ -26,7 +26,7 @@ public class ArchiveServiceBenchmark
     private readonly IImageService _imageService;
     private readonly IImageFactory _imageFactory;
     private const string SourceImage = "Data/comic-normal.jpg";
-        
+
 
     public ArchiveServiceBenchmark()
     {
@@ -71,7 +71,7 @@ public void ImageMagick_ExtractImage_PNG()
         int width = 320;
         int height = (int)(thumbnail2.Height * (width / (double)thumbnail2.Width));
         thumbnail2.Thumbnail(width, height);
-        thumbnail2.Save(_directoryService.FileSystem.Path.Join(outputDirectory, "imagesharp.png"), EncodeFormat.PNG, 100);
+        thumbnail2.Save(_directoryService.FileSystem.Path.Join(outputDirectory, "imagesharp.png"), EncodeFormat.PNG);
     }
 
     [Benchmark]
@@ -85,7 +85,7 @@ public void ImageMagick_ExtractImage_WebP()
         int width = 320;
         int height = (int)(thumbnail2.Height * (width / (double)thumbnail2.Width));
         thumbnail2.Thumbnail(width, height);
-        thumbnail2.Save(_directoryService.FileSystem.Path.Join(outputDirectory, "imagesharp.webp"), EncodeFormat.PNG, 100);
+        thumbnail2.Save(_directoryService.FileSystem.Path.Join(outputDirectory, "imagesharp.webp"), EncodeFormat.PNG);
     }
 
 

diff --git a/API.Tests/Services/ArchiveServiceTests.cs b/API.Tests/Services/ArchiveServiceTests.cs
@@ -177,7 +177,7 @@ public void GetCoverImage_Default_Test(string inputFile, string expectedOutputFi
         int height = (int)(thumbnail.Height * (width / (double)thumbnail.Width));
         thumbnail.Thumbnail(width, height);
         using MemoryStream stream = new MemoryStream();
-        thumbnail.Save(stream, EncodeFormat.PNG, 100);
+        thumbnail.Save(stream, EncodeFormat.PNG);
         var expectedBytes = stream.ToArray();
 
         archiveService.Configure().CanOpen(Path.Join(testDirectory, inputFile)).Returns(ArchiveLibrary.Default);

diff --git a/API.Tests/Services/ImageServiceTests.cs b/API.Tests/Services/ImageServiceTests.cs
@@ -63,7 +63,7 @@ private void GenerateFiles(string outputExtension)
             var thumbnail = factory.Create(imagePath);
             thumbnail = ImageService.Thumbnail(thumbnail, dims.Width, dims.Height);
             var outputFileName = fileName + outputExtension + ".png";
-            thumbnail.Save(Path.Join(_testDirectory, outputFileName), EncodeFormat.PNG,100);
+            thumbnail.Save(Path.Join(_testDirectory, outputFileName), EncodeFormat.PNG);
         }
     }
 
@@ -166,7 +166,7 @@ private static void GenerateColorImage(string hexColor, string outputPath)
         ImageMagickImageFactory factory = new ImageMagickImageFactory();
         var color = ImageService.HexToRgb(hexColor);
         using var colorImage = factory.Create(200,100,color.R, color.G, color.B);
-        colorImage.Save(outputPath, EncodeFormat.PNG, 100);
+        colorImage.Save(outputPath, EncodeFormat.PNG);
     }
 
     private void GenerateHtmlFileForColorScape()

diff --git a/API/Extensions/EncodeFormatExtensions.cs b/API/Extensions/EncodeFormatExtensions.cs
@@ -17,4 +17,16 @@ public static string GetExtension(this EncodeFormat encodeFormat)
             _ => throw new ArgumentOutOfRangeException(nameof(encodeFormat), encodeFormat, null)
         };
     }
+
+    public static int DefaultQuality(this EncodeFormat encodeFormat)
+    {
+        return encodeFormat switch
+        {
+            EncodeFormat.PNG => 100, // (Image Magick Maximum Deflate Compression) (In case of PNG, png is always lossless, Quality indicate the compression level)
+            EncodeFormat.WEBP => 100,
+            EncodeFormat.AVIF => 100,
+            EncodeFormat.JPEG => 99, // (Best Compression speed, with almost no visual quality loss)
+            _ => throw new ArgumentOutOfRangeException(nameof(encodeFormat), encodeFormat, null)
+        };
+    }
 }
diff --git a/API/Services/BookService.cs b/API/Services/BookService.cs
@@ -1280,7 +1280,7 @@ private void GetPdfPage(IDocReader docReader, int pageNumber, Stream stream)
         var height = pageReader.GetPageHeight();
         IImage image = _imageService.ImageFactory.CreateFromBGRAByteArray(rawBytes, width, height);
         stream.Seek(0, SeekOrigin.Begin);
-        image.Save(stream, EncodeFormat.PNG, 100);
+        image.Save(stream, EncodeFormat.PNG);
         stream.Seek(0, SeekOrigin.Begin);
     }
 

diff --git a/API/Services/ImageService.cs b/API/Services/ImageService.cs
diff --git a/API/Services/ImageServices/IImage.cs b/API/Services/ImageServices/IImage.cs
@@ -64,15 +64,15 @@ public interface IImage : IDisposable
     /// <param name="filename">The name of the file to save the image to.</param>
     /// <param name="format">The format to save the image in.</param>
     /// <param name="quality">The quality of the saved image.</param>
-    void Save(string filename, EncodeFormat format, int quality);
+    void Save(string filename, EncodeFormat format);
 
     /// <summary>
     /// Saves the image to the specified stream with the specified format and quality.
     /// </summary>
     /// <param name="stream">The stream to save the image to.</param>
     /// <param name="format">The format to save the image in.</param>
     /// <param name="quality">The quality of the saved image.</param>
-    void Save(Stream stream, EncodeFormat format, int quality);
+    void Save(Stream stream, EncodeFormat format);
 
     /// <summary>
     /// Asynchronously saves the image to the specified file with the specified format and quality.
@@ -82,7 +82,7 @@ public interface IImage : IDisposable
     /// <param name="quality">The quality of the saved image.</param>
     /// <param name="token">The cancellation token.</param>
     /// <returns>A task representing the asynchronous save operation.</returns>
-    Task SaveAsync(string filename, EncodeFormat format, int quality, CancellationToken token = default);
+    Task SaveAsync(string filename, EncodeFormat format, CancellationToken token = default);
 
     /// <summary>
     /// Asynchronously saves the image to the specified stream with the specified format and quality.
@@ -92,7 +92,7 @@ public interface IImage : IDisposable
     /// <param name="quality">The quality of the saved image.</param>
     /// <param name="token">The cancellation token.</param>
     /// <returns>A task representing the asynchronous save operation.</returns>
-    Task SaveAsync(Stream stream, EncodeFormat format, int quality, CancellationToken token = default);
+    Task SaveAsync(Stream stream, EncodeFormat format, CancellationToken token = default);
 
     /// <summary>
     /// Gets the RGBA image data as an array of floats.

diff --git a/API/Services/ImageServices/ImageMagick/ImageMagickImage.cs b/API/Services/ImageServices/ImageMagick/ImageMagickImage.cs
@@ -3,6 +3,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using API.Entities.Enums;
+using API.Extensions;
 using ImageMagick;
 
 namespace API.Services.ImageServices.ImageMagick;
@@ -139,30 +140,30 @@ public void Composite(IImage overlay, int x, int y)
     }
 
     /// <inheritdoc/>
-    public void Save(string filename, EncodeFormat format, int quality)
+    public void Save(string filename, EncodeFormat format)
     {
-        _image.Quality = quality;
+        _image.Quality = format.DefaultQuality();
         _image.Write(filename, MagickFormatFromEncodeFormat(format));
     }
 
     /// <inheritdoc/>
-    public void Save(Stream stream, EncodeFormat format, int quality)
+    public void Save(Stream stream, EncodeFormat format)
     {
-        _image.Quality = quality;
+        _image.Quality = format.DefaultQuality();
         _image.Write(stream, MagickFormatFromEncodeFormat(format));
     }
 
     /// <inheritdoc/>
-    public Task SaveAsync(string filename, EncodeFormat format, int quality, CancellationToken token = default)
+    public Task SaveAsync(string filename, EncodeFormat format, CancellationToken token = default)
     {
-        _image.Quality = quality;
+        _image.Quality = format.DefaultQuality();
         return _image.WriteAsync(filename, MagickFormatFromEncodeFormat(format), token);
     }
 
     /// <inheritdoc/>
-    public Task SaveAsync(Stream stream, EncodeFormat format, int quality, CancellationToken token = default)
+    public Task SaveAsync(Stream stream, EncodeFormat format, CancellationToken token = default)
     {
-        _image.Quality = quality;
+        _image.Quality = format.DefaultQuality();
         return _image.WriteAsync(stream, MagickFormatFromEncodeFormat(format), token);
     }