Apply updates to XY and Anchor positions based on EXIF metadata

Author: JimBobSquarePants

.github/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# How to contribute to ImageSharp.Web
+# How to contribute to SixLabors.ImageSharp.Web
 
 #### **Did you find a bug?**
 
@@ -16,20 +16,18 @@
 
 #### **Do you intend to add a new feature or change an existing one?**
 
-* Suggest your change in the [ImageSharp Gitter Chat Room](https://gitter.im/ImageSharp/General) and start writing code.
+* Suggest your change in the [Ideas Discussions Channel](https://github.com/SixLabors/ImageSharp.Web/discussions?discussions_q=category%3AIdeas) and start writing code.
 
 * Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
 
 #### **Do you have questions about consuming the library or the source code?**
 
-* Ask any question about how to use ImageSharp in the [ImageSharp Gitter Chat Room](https://gitter.im/ImageSharp/General).
+* Ask any question about how to use SixLabors.ImageSharp.Web in the [Help Discussions Channel](https://github.com/SixLabors/ImageSharp.Web/discussions?discussions_q=category%3AHelp).
 
-#### Code of Conduct
+#### Code of Conduct  
 This project has adopted the code of conduct defined by the [Contributor Covenant](https://contributor-covenant.org/) to clarify expected behavior in our community.
 For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
 
-And please remember. ImageSharp.Web is the work of a very, very, small number of developers who struggle balancing time to contribute to the project with family time and work commitments. We encourage you to pitch in and help make our vision of simple accessible imageprocessing available to all. Open Source can only exist with your help.
+And please remember. SixLabors.ImageSharp.Web is the work of a very, very, small number of developers who struggle balancing time to contribute to the project with family time and work commitments. We encourage you to pitch in and help make our vision of simple accessible image processing available to all. Open Source can only exist with your help.
 
 Thanks for reading!
-
-James Jackson-South :heart:

src/ImageSharp.Web/FormattedImage.cs

@@ -6,6 +6,7 @@
 using System.Runtime.CompilerServices;
 using SixLabors.ImageSharp.Advanced;
 using SixLabors.ImageSharp.Formats;
+using SixLabors.ImageSharp.Metadata.Profiles.Exif;
 using SixLabors.ImageSharp.PixelFormats;
 
 namespace SixLabors.ImageSharp.Web
@@ -97,6 +98,45 @@ public static FormattedImage Load(Configuration configuration, Stream source)
         /// <param name="destination">The destination stream.</param>
         public void Save(Stream destination) => this.Image.Save(destination, this.encoder);
 
+        /// <summary>
+        /// Returns a value indicating whether the source image contains EXIF metadata for <see cref="ExifTag.Orientation"/>
+        /// indicating that the image is rotated (not flipped).
+        /// </summary>
+        /// <param name="orientation">The captured orientation. Use <see cref="ExifOrientationMode"/> for comparison.</param>
+        /// <returns>The <see cref="bool"/> indicating whether the image contains EXIF metadata indicating that the image is rotated.</returns>
+        public bool IsExifRotated(out ushort orientation)
+        {
+            orientation = ExifOrientationMode.Unknown;
+            if (this.Image.Metadata.ExifProfile != null)
+            {
+                IExifValue<ushort> value = this.Image.Metadata.ExifProfile.GetValue(ExifTag.Orientation);
+                if (value is null)
+                {
+                    return false;
+                }
+
+                if (value.DataType == ExifDataType.Short)
+                {
+                    orientation = value.Value;
+                }
+                else
+                {
+                    orientation = Convert.ToUInt16(value.Value);
+                }
+
+                return orientation switch
+                {
+                    ExifOrientationMode.LeftTop
+                    or ExifOrientationMode.RightTop
+                    or ExifOrientationMode.RightBottom
+                    or ExifOrientationMode.LeftBottom => true,
+                    _ => false,
+                };
+            }
+
+            return false;
+        }
+
         /// <summary>
         /// Performs application-defined tasks associated with freeing, releasing, or resetting
         /// unmanaged resources.

src/ImageSharp.Web/Processors/ResizeWebProcessor.cs

@@ -80,7 +80,7 @@ public FormattedImage Process(
             CommandParser parser,
             CultureInfo culture)
         {
-            ResizeOptions options = GetResizeOptions(image.Image, commands, parser, culture);
+            ResizeOptions options = GetResizeOptions(image, commands, parser, culture);
 
             if (options != null)
             {
@@ -90,8 +90,18 @@ public FormattedImage Process(
             return image;
         }
 
-        private static ResizeOptions GetResizeOptions(
-            Image image,
+        /// <summary>
+        /// Parses the command collection returning the resize options.
+        /// </summary>
+        /// <param name="image">The image to process.</param>
+        /// <param name="commands">The ordered collection containing the processing commands.</param>
+        /// <param name="parser">The command parser use for parting commands.</param>
+        /// <param name="culture">
+        /// The <see cref="CultureInfo"/> to use as the current parsing culture.
+        /// </param>
+        /// <returns>The <see cref="ResizeOptions"/>.</returns>
+        internal static ResizeOptions GetResizeOptions(
+            FormattedImage image,
             CommandCollection commands,
             CommandParser parser,
             CultureInfo culture)
@@ -101,18 +111,20 @@ private static ResizeOptions GetResizeOptions(
                 return null;
             }
 
-            Size size = ParseSize(image, commands, parser, culture);
+            bool rotated = ShouldHandleExifRotation(image, commands, parser, culture, out ushort orientation);
+
+            Size size = ParseSize(rotated, commands, parser, culture);
 
             if (size.Width <= 0 && size.Height <= 0)
             {
                 return null;
             }
 
-            var options = new ResizeOptions
+            ResizeOptions options = new()
             {
                 Size = size,
-                CenterCoordinates = GetCenter(commands, parser, culture),
-                Position = GetAnchor(commands, parser, culture),
+                CenterCoordinates = GetCenter(rotated, commands, parser, culture),
+                Position = GetAnchor(orientation, commands, parser, culture),
                 Mode = GetMode(commands, parser, culture),
                 Compand = GetCompandMode(commands, parser, culture),
             };
@@ -124,43 +136,19 @@ private static ResizeOptions GetResizeOptions(
         }
 
         private static Size ParseSize(
-            Image image,
+            bool rotated,
             CommandCollection commands,
             CommandParser parser,
             CultureInfo culture)
         {
             // The command parser will reject negative numbers as it clamps values to ranges.
             int width = (int)parser.ParseValue<uint>(commands.GetValueOrDefault(Width), culture);
             int height = (int)parser.ParseValue<uint>(commands.GetValueOrDefault(Height), culture);
-
-            // Browsers now implement 'image-orientation: from-image' by default.
-            // https://developer.mozilla.org/en-US/docs/web/css/image-orientation
-            // This makes orientation handling confusing for users who expect images to be resized in accordance
-            // to what they observe rather than pure (and correct) methods.
-            //
-            // To accomodate this we parse the dimensions to use based upon decoded EXIF orientation values, switching
-            // the width/height parameters when images are rotated (not flipped).
-            // We default to 'true' for EXIF orientation handling. By passing 'false' it can be turned off.
-            if (!commands.Contains(Orient) || parser.ParseValue<bool>(commands.GetValueOrDefault(Orient), culture))
-            {
-                if (image.Metadata.ExifProfile != null)
-                {
-                    IExifValue<ushort> orientation = image.Metadata.ExifProfile.GetValue(ExifTag.Orientation);
-                    return orientation.Value switch
-                    {
-                        ExifOrientationMode.LeftTop
-                        or ExifOrientationMode.RightTop
-                        or ExifOrientationMode.RightBottom
-                        or ExifOrientationMode.LeftBottom => new Size(height, width),
-                        _ => new Size(width, height),
-                    };
-                }
-            }
-
-            return new Size(width, height);
+            return rotated ? new Size(height, width) : new Size(width, height);
         }
 
         private static PointF? GetCenter(
+            bool rotated,
             CommandCollection commands,
             CommandParser parser,
             CultureInfo culture)
@@ -172,7 +160,7 @@ or ExifOrientationMode.RightBottom
                 return null;
             }
 
-            return new PointF(coordinates[0], coordinates[1]);
+            return rotated ? new PointF(coordinates[1], coordinates[0]) : new PointF(coordinates[0], coordinates[1]);
         }
 
         private static ResizeMode GetMode(
@@ -182,10 +170,79 @@ private static ResizeMode GetMode(
             => parser.ParseValue<ResizeMode>(commands.GetValueOrDefault(Mode), culture);
 
         private static AnchorPositionMode GetAnchor(
+            ushort orientation,
             CommandCollection commands,
             CommandParser parser,
             CultureInfo culture)
-            => parser.ParseValue<AnchorPositionMode>(commands.GetValueOrDefault(Anchor), culture);
+        {
+            AnchorPositionMode anchor = parser.ParseValue<AnchorPositionMode>(commands.GetValueOrDefault(Anchor), culture);
+            if (orientation is >= ExifOrientationMode.Unknown and <= ExifOrientationMode.TopLeft)
+            {
+                return anchor;
+            }
+
+            return anchor switch
+            {
+                AnchorPositionMode.Center => anchor,
+                AnchorPositionMode.Top => orientation switch
+                {
+                    ExifOrientationMode.BottomLeft or ExifOrientationMode.BottomRight => AnchorPositionMode.Bottom,
+                    ExifOrientationMode.LeftTop or ExifOrientationMode.RightTop => AnchorPositionMode.Left,
+                    ExifOrientationMode.LeftBottom or ExifOrientationMode.RightBottom => AnchorPositionMode.Right,
+                    _ => anchor,
+                },
+                AnchorPositionMode.Bottom => orientation switch
+                {
+                    ExifOrientationMode.BottomLeft or ExifOrientationMode.BottomRight => AnchorPositionMode.Top,
+                    ExifOrientationMode.LeftTop or ExifOrientationMode.RightTop => AnchorPositionMode.Right,
+                    ExifOrientationMode.LeftBottom or ExifOrientationMode.RightBottom => AnchorPositionMode.Left,
+                    _ => anchor,
+                },
+                AnchorPositionMode.Left => orientation switch
+                {
+                    ExifOrientationMode.TopRight or ExifOrientationMode.BottomRight => AnchorPositionMode.Right,
+                    ExifOrientationMode.LeftTop or ExifOrientationMode.LeftBottom => AnchorPositionMode.Bottom,
+                    ExifOrientationMode.RightTop or ExifOrientationMode.RightBottom => AnchorPositionMode.Top,
+                    _ => anchor,
+                },
+                AnchorPositionMode.Right => orientation switch
+                {
+                    ExifOrientationMode.TopRight or ExifOrientationMode.BottomRight => AnchorPositionMode.Left,
+                    ExifOrientationMode.LeftTop or ExifOrientationMode.LeftBottom => AnchorPositionMode.Top,
+                    ExifOrientationMode.RightTop or ExifOrientationMode.RightBottom => AnchorPositionMode.Bottom,
+                    _ => anchor,
+                },
+                AnchorPositionMode.TopLeft => orientation switch
+                {
+                    ExifOrientationMode.BottomLeft or ExifOrientationMode.LeftTop => AnchorPositionMode.BottomLeft,
+                    ExifOrientationMode.TopRight or ExifOrientationMode.RightBottom => AnchorPositionMode.TopRight,
+                    ExifOrientationMode.BottomRight or ExifOrientationMode.LeftBottom => AnchorPositionMode.BottomRight,
+                    _ => anchor,
+                },
+                AnchorPositionMode.TopRight => orientation switch
+                {
+                    ExifOrientationMode.TopRight or ExifOrientationMode.LeftTop => AnchorPositionMode.TopLeft,
+                    ExifOrientationMode.BottomLeft or ExifOrientationMode.RightBottom => AnchorPositionMode.BottomRight,
+                    ExifOrientationMode.BottomRight or ExifOrientationMode.RightTop => AnchorPositionMode.BottomLeft,
+                    _ => anchor,
+                },
+                AnchorPositionMode.BottomRight => orientation switch
+                {
+                    ExifOrientationMode.TopRight or ExifOrientationMode.RightBottom => AnchorPositionMode.BottomLeft,
+                    ExifOrientationMode.BottomLeft or ExifOrientationMode.LeftTop => AnchorPositionMode.TopRight,
+                    ExifOrientationMode.BottomRight or ExifOrientationMode.LeftBottom => AnchorPositionMode.TopLeft,
+                    _ => anchor,
+                },
+                AnchorPositionMode.BottomLeft => orientation switch
+                {
+                    ExifOrientationMode.TopRight or ExifOrientationMode.LeftTop => AnchorPositionMode.BottomRight,
+                    ExifOrientationMode.BottomLeft or ExifOrientationMode.RightBottom => AnchorPositionMode.TopLeft,
+                    ExifOrientationMode.BottomRight or ExifOrientationMode.RightTop => AnchorPositionMode.TopRight,
+                    _ => anchor,
+                },
+                _ => anchor,
+            };
+        }
 
         private static bool GetCompandMode(
             CommandCollection commands,
@@ -222,5 +279,24 @@ private static IResampler GetSampler(CommandCollection commands)
 
             return KnownResamplers.Bicubic;
         }
+
+        private static bool ShouldHandleExifRotation(FormattedImage image, CommandCollection commands, CommandParser parser, CultureInfo culture, out ushort orientation)
+        {
+            // Browsers now implement 'image-orientation: from-image' by default.
+            // https://developer.mozilla.org/en-US/docs/web/css/image-orientation
+            // This makes orientation handling confusing for users who expect images to be resized in accordance
+            // to what they observe rather than pure (and correct) methods.
+            //
+            // To accomodate this we parse the dimensions to use based upon decoded EXIF orientation values, switching
+            // the width/height parameters when images are rotated (not flipped).
+            // We default to 'true' for EXIF orientation handling. By passing 'false' it can be turned off.
+            if (commands.Contains(Orient) && !parser.ParseValue<bool>(commands.GetValueOrDefault(Orient), culture))
+            {
+                orientation = ExifOrientationMode.Unknown;
+                return false;
+            }
+
+            return image.IsExifRotated(out orientation);
+        }
     }
 }