Remove BitDepth from ImageMetadata

This is obsolete now that we have LogicalPixelFormat
cyanfish · Jan 4, 2024 · 85fa644 · 85fa644
1 parent 3703298
commit 85fa644
Show file tree

Hide file tree

Showing 19 changed files with 64 additions and 98 deletions.
diff --git a/NAPS2.Lib.Tests/Recovery/RecoveryStorageManagerTests.cs b/NAPS2.Lib.Tests/Recovery/RecoveryStorageManagerTests.cs
@@ -52,7 +52,6 @@ public void IndexFileDefaultMetadata()
 
         Assert.Contains("00001.jpg</FileName>", indexFileContent);
         Assert.Contains("00002.jpg</FileName>", indexFileContent);
-        Assert.Contains("<BitDepth>C24Bit</BitDepth>", indexFileContent);
         Assert.Contains("<HighQuality>false</HighQuality>", indexFileContent);
     }
 
@@ -79,14 +78,12 @@ public void IndexFileCustomMetadata()
         var image1 = new UiImage(
             ScanningContext.CreateProcessedImage(
                 ImageContext.Create(100, 100, ImagePixelFormat.RGB24),
-                BitDepth.Grayscale,
                 true,
                 -1,
                 PageSize.A4));
 
         _imageList.Mutate(new ListMutation<UiImage>.Append(image1));
         var indexFileContent = File.ReadAllText(Path.Combine(_recoveryFolder, "index.xml"));
-        Assert.Contains("<BitDepth>Grayscale</BitDepth>", indexFileContent);
         Assert.Contains("<HighQuality>true</HighQuality>", indexFileContent);
         Assert.Contains("<PageSize>210x297 mm</PageSize>", indexFileContent);
     }

diff --git a/NAPS2.Lib/Recovery/RecoverableFolder.cs b/NAPS2.Lib/Recovery/RecoverableFolder.cs
@@ -151,7 +151,7 @@ public bool TryRecover(Action<ProcessedImage> imageCallback, RecoveryParams reco
     private ProcessedImage CreateRecoveredImage(RecoveryParams recoveryParams, IImageStorage storage,
         RecoveryIndexImage indexImage)
     {
-        var processedImage = _scanningContext.CreateProcessedImage(storage, indexImage.BitDepth.ToBitDepth(),
+        var processedImage = _scanningContext.CreateProcessedImage(storage,
             indexImage.HighQuality, -1, PageSize.Parse(indexImage.PageSize),
             indexImage.TransformList!.ToImmutableList());
 

diff --git a/NAPS2.Lib/Recovery/RecoveryIndexImage.cs b/NAPS2.Lib/Recovery/RecoveryIndexImage.cs
@@ -8,8 +8,6 @@ public class RecoveryIndexImage
 
     public List<Transform>? TransformList { get; set; }
 
-    public ScanBitDepth BitDepth { get; set; }
-
     public bool HighQuality { get; set; }
 
     public string? PageSize { get; set; }

diff --git a/NAPS2.Lib/Recovery/RecoveryStorageManager.cs b/NAPS2.Lib/Recovery/RecoveryStorageManager.cs
@@ -91,7 +91,6 @@ private void WriteIndex(IEnumerable<UiImage> images)
                 return new RecoveryIndexImage
                 {
                     FileName = Path.GetFileName(storage.FullPath),
-                    BitDepth = processedImage.Metadata.BitDepth.ToScanBitDepth(),
                     HighQuality = processedImage.Metadata.Lossless,
                     PageSize = processedImage.Metadata.PageSize?.ToString(),
                     TransformList = processedImage.TransformState.Transforms.ToList()

diff --git a/NAPS2.Sdk.Tests/Images/ImageExportHelperTests.cs b/NAPS2.Sdk.Tests/Images/ImageExportHelperTests.cs
@@ -18,7 +18,7 @@ public void SaveSmallestFormat_BlackAndWhite()
         var bw = LoadImage(ImageResources.dog_bw).PerformTransform(new BlackWhiteTransform());
         var path = Path.Combine(FolderPath, "test");
 
-        var fullPath = _helper.SaveSmallestFormat(path, bw, BitDepth.BlackAndWhite, false, -1, out var format);
+        var fullPath = _helper.SaveSmallestFormat(path, bw, false, -1, out var format);
 
         AssertPng(format, fullPath, ImageResources.dog_bw);
     }
@@ -29,42 +29,42 @@ public void SaveSmallestFormat_BlackAndWhiteWithColorBitDepth()
         var bw = LoadImage(ImageResources.dog_bw).PerformTransform(new BlackWhiteTransform());
         var path = Path.Combine(FolderPath, "test");
 
-        var fullPath = _helper.SaveSmallestFormat(path, bw, BitDepth.Color, false, -1, out var format);
+        var fullPath = _helper.SaveSmallestFormat(path, bw, false, -1, out var format);
 
         AssertPng(format, fullPath, ImageResources.dog_bw);
     }
 
     [Fact]
-    public void SaveSmallestFormat_ColorWithBlackWhiteBitDepth()
+    public void SaveSmallestFormat_ColorHighQuality()
     {
         var color = LoadImage(ImageResources.dog);
         var path = Path.Combine(FolderPath, "test");
 
-        var fullPath = _helper.SaveSmallestFormat(path, color, BitDepth.BlackAndWhite, false, -1, out var format);
+        var fullPath = _helper.SaveSmallestFormat(path, color, true, -1, out var format);
 
-        AssertPng(format, fullPath, ImageResources.dog_bw, ImageAsserts.XPLAT_RMSE_THRESHOLD);
+        AssertPng(format, fullPath, ImageResources.dog);
     }
 
     [Fact]
-    public void SaveSmallestFormat_ColorHighQuality()
+    public void SaveSmallestFormat_LogicalBlackWhite()
     {
-        var color = LoadImage(ImageResources.dog);
+        var bw = LoadImage(ImageResources.dog_bw_24bit);
         var path = Path.Combine(FolderPath, "test");
 
-        var fullPath = _helper.SaveSmallestFormat(path, color, BitDepth.Color, true, -1, out var format);
+        var fullPath = _helper.SaveSmallestFormat(path, bw, false, -1, out var format);
 
-        AssertPng(format, fullPath, ImageResources.dog);
+        AssertPng(format, fullPath, ImageResources.dog_bw);
     }
 
     [Fact]
     public void SaveSmallestFormat_SmallerPng()
     {
-        var bw = LoadImage(ImageResources.dog_bw_24bit);
+        var bw = LoadImage(ImageResources.dog_clustered_gray);
         var path = Path.Combine(FolderPath, "test");
 
-        var fullPath = _helper.SaveSmallestFormat(path, bw, BitDepth.Color, false, -1, out var format);
+        var fullPath = _helper.SaveSmallestFormat(path, bw, false, -1, out var format);
 
-        AssertPng(format, fullPath, ImageResources.dog_bw);
+        AssertPng(format, fullPath, ImageResources.dog_clustered_gray);
     }
 
     [Fact]
@@ -73,7 +73,7 @@ public void SaveSmallestFormat_OriginalPng()
         var color = LoadImage(ImageResources.dog_png);
         var path = Path.Combine(FolderPath, "test");
 
-        var fullPath = _helper.SaveSmallestFormat(path, color, BitDepth.Color, false, -1, out var format);
+        var fullPath = _helper.SaveSmallestFormat(path, color, false, -1, out var format);
 
         AssertPng(format, fullPath, ImageResources.dog);
     }
@@ -85,7 +85,7 @@ public void SaveSmallestFormat_SmallerJpeg()
         color.OriginalFileFormat = ImageFileFormat.Unknown;
         var path = Path.Combine(FolderPath, "test");
 
-        var fullPath = _helper.SaveSmallestFormat(path, color, BitDepth.Color, false, -1, out var format);
+        var fullPath = _helper.SaveSmallestFormat(path, color, false, -1, out var format);
 
         AssertJpeg(format, fullPath, ImageResources.dog);
     }
@@ -96,7 +96,7 @@ public void SaveSmallestFormat_OriginalJpeg()
         var color = LoadImage(ImageResources.dog_bw_jpg);
         var path = Path.Combine(FolderPath, "test");
 
-        var fullPath = _helper.SaveSmallestFormat(path, color, BitDepth.Color, false, -1, out var format);
+        var fullPath = _helper.SaveSmallestFormat(path, color, false, -1, out var format);
 
         AssertJpeg(format, fullPath, ImageResources.dog_bw);
     }

diff --git a/NAPS2.Sdk.Tests/Images/ImageSerializerTests.cs b/NAPS2.Sdk.Tests/Images/ImageSerializerTests.cs
@@ -21,7 +21,6 @@ public void SerializesMetadata(StorageConfig config)
 
         using var sourceImage = ScanningContext.CreateProcessedImage(
             LoadImage(ImageResources.dog), // TODO: Use an actual grayscale image
-            BitDepth.Grayscale,
             true,
             -1,
             PageSize.A4,
@@ -33,7 +32,6 @@ public void SerializesMetadata(StorageConfig config)
         Assert.Single(destImage.TransformState.Transforms);
         Assert.Equal(300, Assert.IsType<BrightnessTransform>(destImage.TransformState.Transforms[0]).Brightness);
         Assert.True(destImage.Metadata.Lossless);
-        Assert.Equal(BitDepth.Grayscale, destImage.Metadata.BitDepth);
         Assert.Equal(PageSize.A4, destImage.Metadata.PageSize);
         ImageAsserts.Similar(ImageResources.dog_b_p300, destImage);
     }

diff --git a/NAPS2.Sdk.Tests/Images/ProcessedImageTests.cs b/NAPS2.Sdk.Tests/Images/ProcessedImageTests.cs
@@ -11,21 +11,19 @@ public void Construct()
     {
         var storage = LoadImage(ImageResources.dog);
 
-        var metadata1 = new ImageMetadata(BitDepth.Color, false, null);
+        var metadata1 = new ImageMetadata(false, null);
         var postProcessingData1 = new PostProcessingData();
         var transformState1 = TransformState.Empty;
         var image1 = new ProcessedImage(ImageContext, storage, metadata1, postProcessingData1, transformState1);
         Assert.Equal(storage, image1.Storage);
-        Assert.Equal(BitDepth.Color, image1.Metadata.BitDepth);
         Assert.False(image1.Metadata.Lossless);
         Assert.True(image1.TransformState.IsEmpty);
 
-        var metadata2 = new ImageMetadata(BitDepth.BlackAndWhite, true, null);
+        var metadata2 = new ImageMetadata(true, null);
         var postProcessingData2 = new PostProcessingData();
         var transformState2 = new TransformState(ImmutableList<Transform>.Empty.Add(new CropTransform(0, 50, 0, 50)));
         var image2 = new ProcessedImage(ImageContext, storage, metadata2, postProcessingData2, transformState2);
         Assert.Equal(storage, image2.Storage);
-        Assert.Equal(BitDepth.BlackAndWhite, image2.Metadata.BitDepth);
         Assert.True(image2.Metadata.Lossless);
         Assert.Single(image2.TransformState.Transforms);
         var cropTransform = Assert.IsType<CropTransform>(image2.TransformState.Transforms[0]);
@@ -39,7 +37,7 @@ public void Construct()
     public void StorageDisposed()
     {
         var storageMock = Substitute.For<IImageStorage>();
-        var metadata = new ImageMetadata(BitDepth.Color, false, null);
+        var metadata = new ImageMetadata(false, null);
 
         var image = new ProcessedImage(
             ImageContext, storageMock, metadata, new PostProcessingData(), TransformState.Empty);
@@ -52,7 +50,7 @@ public void StorageDisposed()
     public void StorageDisposedOnlyAfterAllClonesDisposed()
     {
         var storageMock = Substitute.For<IImageStorage>();
-        var metadata = new ImageMetadata(BitDepth.Color, false, null);
+        var metadata = new ImageMetadata(false, null);
 
         var image = new ProcessedImage(
             ImageContext, storageMock, metadata, new PostProcessingData(), TransformState.Empty);
@@ -80,7 +78,7 @@ public void StorageDisposedOnlyAfterAllClonesDisposed()
     public void TransformSimplification()
     {
         var storageMock = Substitute.For<IImageStorage>();
-        var metadata = new ImageMetadata(BitDepth.Color, false, null);
+        var metadata = new ImageMetadata(false, null);
 
         var image = new ProcessedImage(
             ImageContext, storageMock, metadata, new PostProcessingData(), TransformState.Empty);
@@ -118,7 +116,7 @@ public void TransformSimplification()
     public void MultipleTransforms()
     {
         var storageMock = Substitute.For<IImageStorage>();
-        var metadata = new ImageMetadata(BitDepth.Color, false, null);
+        var metadata = new ImageMetadata(false, null);
 
         var image = new ProcessedImage(
             ImageContext, storageMock, metadata, new PostProcessingData(), TransformState.Empty);
@@ -157,7 +155,7 @@ public void MultipleTransforms()
     public void CloneAfterDisposed()
     {
         var storageMock = Substitute.For<IImageStorage>();
-        var metadata = new ImageMetadata(BitDepth.Color, false, null);
+        var metadata = new ImageMetadata(false, null);
 
         var image = new ProcessedImage(
             ImageContext, storageMock, metadata, new PostProcessingData(), TransformState.Empty);

diff --git a/NAPS2.Sdk.Tests/ImportExport/ImageImporterTests.cs b/NAPS2.Sdk.Tests/ImportExport/ImageImporterTests.cs
@@ -32,7 +32,6 @@ public async Task ImportPngImage()
         Assert.True(File.Exists(storage.FullPath));
         Assert.Equal(Path.Combine(FolderPath, "recovery"), Path.GetDirectoryName(storage.FullPath));
         Assert.True(result[0].Metadata.Lossless);
-        Assert.Equal(BitDepth.Color, result[0].Metadata.BitDepth);
         Assert.Null(result[0].PostProcessingData.Thumbnail);
         Assert.False(result[0].PostProcessingData.Barcode.IsDetectionAttempted);
         Assert.True(result[0].TransformState.IsEmpty);
@@ -54,7 +53,6 @@ public async Task ImportJpegImage()
         Assert.True(File.Exists(storage.FullPath));
         Assert.Equal(Path.Combine(FolderPath, "recovery"), Path.GetDirectoryName(storage.FullPath));
         Assert.False(result[0].Metadata.Lossless);
-        Assert.Equal(BitDepth.Color, result[0].Metadata.BitDepth);
         Assert.Null(result[0].PostProcessingData.Thumbnail);
         Assert.False(result[0].PostProcessingData.Barcode.IsDetectionAttempted);
         Assert.True(result[0].TransformState.IsEmpty);
@@ -79,12 +77,10 @@ public async Task ImportTiffImage()
         Assert.Equal(3, result.Count);
         AssertUsesRecoveryStorage(result[0].Storage, "00001.jpg");
         Assert.False(result[0].Metadata.Lossless);
-        Assert.Equal(BitDepth.Color, result[0].Metadata.BitDepth);
         ImageAsserts.Similar(ImageResources.dog, result[0]);
 
         AssertUsesRecoveryStorage(result[2].Storage, "00003.jpg");
         Assert.False(result[2].Metadata.Lossless);
-        Assert.Equal(BitDepth.Color, result[2].Metadata.BitDepth);
         ImageAsserts.Similar(ImageResources.stock_cat, result[2]);
 
         result[0].Dispose();

diff --git a/NAPS2.Sdk.Tests/Pdf/PdfBenchmarkTests.cs b/NAPS2.Sdk.Tests/Pdf/PdfBenchmarkTests.cs
@@ -9,7 +9,7 @@ public class PdfBenchmarkTests : ContextualTests
     public async Task PdfSharpExport300()
     {
         var filePath = Path.Combine(FolderPath, "test");
-        using var image = ScanningContext.CreateProcessedImage(LoadImage(ImageResources.dog), BitDepth.Color,
+        using var image = ScanningContext.CreateProcessedImage(LoadImage(ImageResources.dog),
             false, -1, null, Enumerable.Empty<Transform>());
 
         var pdfExporter = new PdfExporter(ScanningContext);
@@ -24,7 +24,7 @@ public async Task PdfSharpExportHuge()
     {
         var filePath = Path.Combine(FolderPath, "test");
         using var image = ScanningContext.CreateProcessedImage(LoadImage(ImageResources.dog_huge),
-            BitDepth.Color, false, -1, null, Enumerable.Empty<Transform>());
+            false, -1, null, Enumerable.Empty<Transform>());
 
         var pdfExporter = new PdfExporter(ScanningContext);
         await pdfExporter.Export(filePath + ".pdf", new[] { image });
@@ -35,7 +35,7 @@ public async Task PdfSharpExportHugePng()
     {
         var filePath = Path.Combine(FolderPath, "test");
         using var image = ScanningContext.CreateProcessedImage(LoadImage(ImageResources.dog_huge_png),
-            BitDepth.Color, true, -1, null, Enumerable.Empty<Transform>());
+            true, -1, null, Enumerable.Empty<Transform>());
 
         var pdfExporter = new PdfExporter(ScanningContext);
         await pdfExporter.Export(filePath + ".pdf", new[] { image });
@@ -45,7 +45,7 @@ public async Task PdfSharpExportHugePng()
     public async Task PdfiumExport300()
     {
         var filePath = Path.Combine(FolderPath, "test");
-        using var image = ScanningContext.CreateProcessedImage(LoadImage(ImageResources.dog), BitDepth.Color,
+        using var image = ScanningContext.CreateProcessedImage(LoadImage(ImageResources.dog),
             false, -1, null, Enumerable.Empty<Transform>());
 
         var pdfExporter = new PdfiumPdfExporter(ScanningContext);
@@ -60,7 +60,7 @@ public async Task PdfiumExportHuge()
     {
         var filePath = Path.Combine(FolderPath, "test");
         using var image = ScanningContext.CreateProcessedImage(LoadImage(ImageResources.dog_huge),
-            BitDepth.Color, false, -1, null, Enumerable.Empty<Transform>());
+            false, -1, null, Enumerable.Empty<Transform>());
 
         var pdfExporter = new PdfiumPdfExporter(ScanningContext);
         await pdfExporter.Export(filePath + ".pdf", new[] { image });
@@ -71,7 +71,7 @@ public async Task PdfiumExportHugePng()
     {
         var filePath = Path.Combine(FolderPath, "test");
         using var image = ScanningContext.CreateProcessedImage(LoadImage(ImageResources.dog_huge_png),
-            BitDepth.Color, true, -1, null, Enumerable.Empty<Transform>());
+            true, -1, null, Enumerable.Empty<Transform>());
 
         var pdfExporter = new PdfiumPdfExporter(ScanningContext);
         await pdfExporter.Export(filePath + ".pdf", new[] { image });

diff --git a/NAPS2.Sdk.Tests/Pdf/PdfExportTests.cs b/NAPS2.Sdk.Tests/Pdf/PdfExportTests.cs
@@ -101,7 +101,7 @@ public async Task ExportPngImage(StorageConfig storageConfig)
 
         var filePath = Path.Combine(FolderPath, "test.pdf");
         using var image = ScanningContext.CreateProcessedImage(
-            LoadImage(ImageResources.dog_png), BitDepth.Color, true, -1, null);
+            LoadImage(ImageResources.dog_png), true, -1, null);
 
         await _exporter.Export(filePath, new[] { image });
 
@@ -118,7 +118,7 @@ public async Task ExportUnalignedPngImage(StorageConfig storageConfig)
         var filePath = Path.Combine(FolderPath, "test.pdf");
         // Width is 99 (not divisible by 4)
         var image = ScanningContext.CreateProcessedImage(
-            LoadImage(ImageResources.dog_99w), BitDepth.Color, true, -1, null);
+            LoadImage(ImageResources.dog_99w), true, -1, null);
 
         await _exporter.Export(filePath, new[] { image });
 
@@ -134,7 +134,7 @@ public async Task ExportAlphaImage(StorageConfig storageConfig)
 
         var filePath = Path.Combine(FolderPath, "test.pdf");
         using var image = ScanningContext.CreateProcessedImage(
-            LoadImage(ImageResources.dog_alpha), BitDepth.Color, false, -1, null);
+            LoadImage(ImageResources.dog_alpha), false, -1, null);
 
         await _exporter.Export(filePath, new[] { image });
 
@@ -151,7 +151,7 @@ public async Task ExportMaskedImage(StorageConfig storageConfig)
 
         var filePath = Path.Combine(FolderPath, "test.pdf");
         using var image = ScanningContext.CreateProcessedImage(
-            LoadImage(ImageResources.dog_mask), BitDepth.Color, false, -1, null);
+            LoadImage(ImageResources.dog_mask), false, -1, null);
 
         await _exporter.Export(filePath, new[] { image });
 
@@ -218,7 +218,7 @@ public async Task ExportBlackAndWhiteImageByMetadata(StorageConfig storageConfig
 
         var filePath = Path.Combine(FolderPath, "test.pdf");
         using var image = ScanningContext.CreateProcessedImage(LoadImage(ImageResources.dog_bw_24bit),
-            BitDepth.BlackAndWhite, true, -1, null);
+            true, -1, null);
 
         await _exporter.Export(filePath, new[] { image });
 
@@ -426,7 +426,7 @@ public async Task ExportWithPageSize(StorageConfig storageConfig)
         var filePath = Path.Combine(FolderPath, "test.pdf");
         var sourceImage = ImageContext.Create(850, 1100, ImagePixelFormat.RGB24);
         sourceImage.SetResolution(99.4f, 99.4f);
-        using var image = ScanningContext.CreateProcessedImage(sourceImage, BitDepth.Color, false, -1, PageSize.Letter);
+        using var image = ScanningContext.CreateProcessedImage(sourceImage, false, -1, PageSize.Letter);
 
         await _exporter.Export(filePath, new[] { image });
 
@@ -443,7 +443,7 @@ public async Task ExportWithMismatchedPageSize(StorageConfig storageConfig)
         var filePath = Path.Combine(FolderPath, "test.pdf");
         var sourceImage = ImageContext.Create(850, 1100, ImagePixelFormat.RGB24);
         sourceImage.SetResolution(98, 98);
-        using var image = ScanningContext.CreateProcessedImage(sourceImage, BitDepth.Color, false, -1, PageSize.Letter);
+        using var image = ScanningContext.CreateProcessedImage(sourceImage, false, -1, PageSize.Letter);
 
         await _exporter.Export(filePath, new[] { image });