-
-
Notifications
You must be signed in to change notification settings - Fork 878
V4 Use EXIF byte order for EXIF encoded strings. #2943
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates EXIF metadata handling to correctly use the TIFF byte order for decoding and encoding EXIF encoded strings while cleaning up and modernizing the code.
- Implements BOM detection and byte order handling for Unicode encoded strings.
- Applies new C# pattern matching and array initializer syntax throughout the EXIF value implementations.
- Improves XML documentation and equality operator implementations for ExifTag.
Reviewed Changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
IExifValue.cs | Updated XML comments and added explicit public member modifiers. |
ExifSignedShortArray.cs, ExifSignedShort.cs, ExifSignedByte.cs, ExifShortArray.cs, ExifShort.cs, ExifRationalArray.cs, ExifNumberArray.cs | Refactored value range checks and array initializations to use new C# syntax patterns. |
ExifEncodedString.cs | Changed TrySetValue to accept a ByteOrder parameter with a parameterless wrapper defaulting to LittleEndian. |
ExifByteArray.cs, ExifByte.cs, ExifArrayValue{TValueType}.cs | Updated array initializer syntax for brevity. |
ExifTag.cs | Revised operator overloads and documentation capitalization. |
ExifWriter.cs, ExifReader.cs, ExifProfile.cs, ExifEncodedStringHelpers.cs, ExifDataType.cs, Ifd/EntryReader.cs | Modernized collection initializations and applied minor name/style updates. |
gfoidl
reviewed
Jun 12, 2025
src/ImageSharp/Metadata/Profiles/Exif/ExifEncodedStringHelpers.cs
Outdated
Show resolved
Hide resolved
src/ImageSharp/Metadata/Profiles/Exif/ExifEncodedStringHelpers.cs
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites
Description
Fixes #2906
When decoding Unicode-encoded text from EXIF, we should follow the specification's guidance and determine the correct decoding approach based on the following priority:
Check for a Byte Order Mark (BOM):
If a BOM is present at the start of the encoded string, its endianness should override any other assumptions. This is explicitly allowed by the EXIF 2.2 and 2.3 specifications, even though later versions (e.g., CIPA DC-X008-2019) no longer mention it directly.
Fallback to TIFF Byte Order:
If no BOM is present, the byte order of the Unicode text must match the byte order declared in the TIFF header. This was the originally intended behavior according to EXIF 2.2/2.3, and is still necessary for correctly decoding existing conformant files.
This change ensures that we're correctly interpreting the
UserComment
,GPSProcessingMethod
, andGPSAreaInformation
tags, all of which use the 8-byte encoding prefix scheme and may contain UTF-16 encoded text.On encoding, we now honor the TIFF byte order for Unicode strings and optionally support emitting a BOM when desired.
This brings ImageSharp into alignment with the EXIF specification and improves compatibility with real-world image metadata.
In addition to this fix, I've also correctly reimplemented the equality operators for
ExifTag
and performed code quality cleanup to match standards.