Skip to content
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

fix: IPTC fields have length limits #4568

Merged
merged 2 commits into from
Dec 28, 2024

Conversation

lgritz
Copy link
Collaborator

@lgritz lgritz commented Dec 23, 2024

It escaped our notice before that the IPTC spec dictates length limits for many fields. Getting this wrong can confuse some software, including Photoshop, apparently.

This patch enforces length limits wherever we could figure them out from the IPTC spec -- it will simply truncate those strings that are too long before writing them to a binary IPTC tag.

For this reason, we also are ending the practice of automatically translating several IPTC fields to and from what we figured were the equivalent generic metadata names. This was perhaps a dubious practice to begin with, but now the enforcement of length limits for IPTC (but not the generic metadata) makes it even more frought. There is probably nobody depending on this behavior (and maybe few OIIO users depending on IPTC support at all?), so now anybody purposely using IPTC metadata is fully responsible for setting it and dealing with any issues of whether it's "out of sync" with any other metadata that OIIO stores in or reads from a file.

Fixes #4342

It escaped our notice before that the IPTC spec dictates length limits
for many fields. Getting this wrong can confuse some software,
including Photoshop apparently.

This patch enforces length limits wherever we could figure them out
from the IPTC spec -- it will simply truncate those strings that are
too long before writing them to a binary IPTC tag.

For this reason, we also are ending the practice of automatically
translating several IPTC fields to and from what we figured were the
equivalent generic metadata names. This was perhaps a dubious practice
to begin with, but now the enforcement of length limits for IPTC (but
not the generic metadata) makes it even more frought. There is
probably nobody depending on this behavior (and maybe few OIIO users
depending on IPTC support at all?), so now anybody purposely using
IPTC metadata is fully responsible for setting it and dealing with any
issues of whether it's "out of sync" with any other metadata that OIIO
stores in or reads from a file.

Fixes 4342

Signed-off-by: Larry Gritz <[email protected]>
@BrianHanke
Copy link

Just tested with my build, confirmed working great in Photoshop now!

Copy link
Contributor

@jessey-git jessey-git left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I spot checked about a dozen of the newly added length limits and they all seem to match. Do you have a link to the spec you were using as the only one I found was an unfriendly to parse through PDF. It would be good to list the URL to the spec in the PR description for future archeologists if one is available.

@lgritz
Copy link
Collaborator Author

lgritz commented Dec 27, 2024

I just added some URLs for reference both to the comments in iptc.cpp and the documentation (metadata chapter).

@lgritz lgritz merged commit bff3377 into AcademySoftwareFoundation:main Dec 28, 2024
30 checks passed
@lgritz lgritz deleted the lg-iptc branch December 28, 2024 06:29
lgritz added a commit to lgritz/OpenImageIO that referenced this pull request Dec 28, 2024
It escaped our notice before that the IPTC spec dictates length limits
for many fields. Getting this wrong can confuse some software, including
Photoshop, apparently.

This patch enforces length limits wherever we could figure them out from
the IPTC spec -- it will simply truncate those strings that are too long
before writing them to a binary IPTC tag.

For this reason, we also are ending the practice of automatically
translating several IPTC fields to and from what we figured were the
equivalent generic metadata names. This was perhaps a dubious practice
to begin with, but now the enforcement of length limits for IPTC (but
not the generic metadata) makes it even more frought. There is probably
nobody depending on this behavior (and maybe few OIIO users depending on
IPTC support at all?), so now anybody purposely using IPTC metadata is
fully responsible for setting it and dealing with any issues of whether
it's "out of sync" with any other metadata that OIIO stores in or reads
from a file.

Fixes AcademySoftwareFoundation#4342

---------

Signed-off-by: Larry Gritz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[HELP] "Damaged" JPGs in Photoshop
3 participants