Renamed ExifParts to ExifIfds and renamed ExifProfile.Parts to ExifProfile.AllowedIfds and mark the old names as obsolete.

Author: dlemstra

src/Magick.NET.Core/Profiles/Exif/ExifIfds.cs

@@ -0,0 +1,38 @@
+// Copyright Dirk Lemstra https://github.com/dlemstra/Magick.NET.
+// Licensed under the Apache License, Version 2.0.
+
+using System;
+
+namespace ImageMagick;
+
+/// <summary>
+/// Specifies the different IFDs that can be found in an Exif profile.
+/// </summary>
+[Flags]
+public enum ExifIfds
+{
+    /// <summary>
+    /// None.
+    /// </summary>
+    None = 0,
+
+    /// <summary>
+    /// Primary IFD.
+    /// </summary>
+    Ifd0 = 1,
+
+    /// <summary>
+    /// Thumbnail IFD.
+    /// </summary>
+    Exif = 4,
+
+    /// <summary>
+    /// GPS IFD.
+    /// </summary>
+    Gps = 8,
+
+    /// <summary>
+    /// All.
+    /// </summary>
+    All = Ifd0 | Exif | Gps,
+}

src/Magick.NET.Core/Profiles/Exif/ExifParts.cs

@@ -9,6 +9,7 @@ namespace ImageMagick;
 /// Specifies which parts will be written when the profile is added to an image.
 /// </summary>
 [Flags]
+[Obsolete($"This enum will be removed in the next major release, use {nameof(ExifIfds)} instead.")]
 public enum ExifParts
 {
     /// <summary>

src/Magick.NET.Core/Profiles/Exif/ExifProfile.cs

@@ -51,9 +51,15 @@ public ExifProfile(Stream stream)
     {
     }
 
+    /// <summary>
+    /// Gets or sets which ifds will be written when the profile is added to an image.
+    /// </summary>
+    public ExifIfds AllowedIfds { get; set; } = ExifIfds.All;
+
     /// <summary>
     /// Gets or sets which parts will be written when the profile is added to an image.
     /// </summary>
+    [Obsolete($"This property will be removed in the next major release, use {nameof(AllowedIfds)} instead.")]
     public ExifParts Parts { get; set; } = ExifParts.All;
 
     /// <summary>
@@ -209,7 +215,7 @@ protected override void UpdateData()
             return;
         }
 
-        var writer = new ExifWriter(Parts);
+        var writer = new ExifWriter(AllowedIfds);
         SetData(writer.Write(_data.Values));
     }
 

src/Magick.NET.Core/Profiles/Exif/ExifTags.cs

@@ -5,7 +5,7 @@ namespace ImageMagick;
 
 internal static class ExifTags
 {
-    public static ExifParts GetPart(ExifTag tag)
+    public static ExifIfds GetIfd(ExifTag tag)
         => (ExifTagValue)(ushort)tag switch
         {
             ExifTagValue.SubfileType or
@@ -133,7 +133,7 @@ ExifTagValue.XPAuthor or
             ExifTagValue.XPKeywords or
             ExifTagValue.XPSubject or
             ExifTagValue.GDALMetadata or
-            ExifTagValue.GDALNoData => ExifParts.IfdTags,
+            ExifTagValue.GDALNoData => ExifIfds.Ifd0,
 
             ExifTagValue.ExposureTime or
             ExifTagValue.FNumber or
@@ -226,7 +226,7 @@ ExifTagValue.SerialNumber or
             ExifTagValue.LensInfo or
             ExifTagValue.LensMake or
             ExifTagValue.LensModel or
-            ExifTagValue.LensSerialNumber => ExifParts.ExifTags,
+            ExifTagValue.LensSerialNumber => ExifIfds.Exif,
 
             ExifTagValue.GPSVersionID or
             ExifTagValue.GPSLatitudeRef or
@@ -258,8 +258,8 @@ ExifTagValue.GPSDestDistance or
             ExifTagValue.GPSProcessingMethod or
             ExifTagValue.GPSAreaInformation or
             ExifTagValue.GPSDateStamp or
-            ExifTagValue.GPSDifferential => ExifParts.GpsTags,
+            ExifTagValue.GPSDifferential => ExifIfds.Gps,
 
-            _ => ExifParts.None,
+            _ => ExifIfds.None,
         };
 }

src/Magick.NET.Core/Profiles/Exif/ExifWriter.cs

@@ -12,16 +12,16 @@ internal sealed class ExifWriter
 {
     private const int HeaderSize = 2 + 2 + 4 + 4;
 
-    private readonly ExifParts _allowedParts;
+    private readonly ExifIfds _allowedIfds;
 
-    public ExifWriter(ExifParts allowedParts)
-        => _allowedParts = allowedParts;
+    public ExifWriter(ExifIfds allowedIfds)
+        => _allowedIfds = allowedIfds;
 
     public byte[]? Write(Collection<IExifValue> values)
     {
-        var ifdValues = GetPartValues(values, ExifParts.IfdTags);
-        var exifValues = GetPartValues(values, ExifParts.ExifTags);
-        var gpsValues = GetPartValues(values, ExifParts.GpsTags);
+        var ifdValues = GetPartValues(values, ExifIfds.Ifd0);
+        var exifValues = GetPartValues(values, ExifIfds.Exif);
+        var gpsValues = GetPartValues(values, ExifIfds.Gps);
 
         RemoveOffsetValues(ifdValues, ExifTag.SubIFDOffset, ExifTag.GPSIFDOffset);
 
@@ -297,19 +297,19 @@ private static void WriteSignedRational(MemoryStream stream, SignedRational valu
         stream.WriteBytes(BitConverter.GetBytes(value.Denominator));
     }
 
-    private Collection<IExifValue> GetPartValues(Collection<IExifValue> values, ExifParts part)
+    private Collection<IExifValue> GetPartValues(Collection<IExifValue> values, ExifIfds ifd)
     {
         var result = new Collection<IExifValue>();
 
-        if (!EnumHelper.HasFlag(_allowedParts, part))
+        if (!EnumHelper.HasFlag(_allowedIfds, ifd))
             return result;
 
         foreach (var value in values)
         {
             if (!HasValue(value))
                 continue;
 
-            if (ExifTags.GetPart(value.Tag) == part)
+            if (ExifTags.GetIfd(value.Tag) == ifd)
                 result.Add(value);
         }
 

src/Magick.NET.Core/Profiles/Exif/IExifProfile.cs

@@ -1,6 +1,7 @@
 // Copyright Dirk Lemstra https://github.com/dlemstra/Magick.NET.
 // Licensed under the Apache License, Version 2.0.
 
+using System;
 using System.Collections.Generic;
 
 namespace ImageMagick;
@@ -10,9 +11,15 @@ namespace ImageMagick;
 /// </summary>
 public interface IExifProfile : IImageProfile
 {
+    /// <summary>
+    /// Gets or sets which ifds will be written when the profile is added to an image.
+    /// </summary>
+    ExifIfds AllowedIfds { get; set; }
+
     /// <summary>
     /// Gets or sets which parts will be written when the profile is added to an image.
     /// </summary>
+    [Obsolete($"This property will be removed in the next major release, use {nameof(AllowedIfds)} instead.")]
     ExifParts Parts { get; set; }
 
     /// <summary>

…xif/ExifProfileTests/ThePartsProperty.cs …ifProfileTests/TheAllowedIfdsProperty.cstests/Magick.NET.Tests/Profiles/Exif/ExifProfileTests/ThePartsProperty.cs renamed to tests/Magick.NET.Tests/Profiles/Exif/ExifProfileTests/TheAllowedIfdsProperty.cs tests/Magick.NET.Tests/Profiles/Exif/ExifProfileTests/ThePartsProperty.cs renamed to tests/Magick.NET.Tests/Profiles/Exif/ExifProfileTests/TheAllowedIfdsProperty.cs

@@ -2,15 +2,14 @@
 // Licensed under the Apache License, Version 2.0.
 
 using System.IO;
-using System.Linq;
 using ImageMagick;
 using Xunit;
 
 namespace Magick.NET.Tests;
 
 public partial class ExifProfileTests
 {
-    public class ThePartsProperty
+    public class TheAllowedIfdsProperty
     {
         [Fact]
         public void ShouldFilterTheTagsWhenWritten()
@@ -21,9 +20,9 @@ public void ShouldFilterTheTagsWhenWritten()
 
             Assert.NotNull(profile);
 
-            Assert.Equal(44, profile.Values.Count());
+            Assert.Equal(44, profile.Values.Count);
 
-            profile.Parts = ExifParts.ExifTags;
+            profile.AllowedIfds = ExifIfds.Exif;
             input.SetProfile(profile);
             input.Write(memStream);
 
@@ -32,7 +31,7 @@ public void ShouldFilterTheTagsWhenWritten()
             profile = output.GetExifProfile();
 
             Assert.NotNull(profile);
-            Assert.Equal(24, profile.Values.Count());
+            Assert.Equal(24, profile.Values.Count);
         }
     }
 }