Skip to content

Support saving JPEG comments #6774

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.

Sign up for GitHub

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
radarhere merged 12 commits into from
Dec 7, 2022
Merged

Support saving JPEG comments #6774

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d822d85
support round-tripping JPEG comments
smason Dec 2, 2022
e9f4858
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 2, 2022
976ad57
Save comments from any image format by default
radarhere Dec 2, 2022
c1d0a00
Use _binary instead of struct
radarhere Dec 2, 2022
525c011
Test that comment is reread
radarhere Dec 2, 2022
e71f7c1
Merge pull request #1 from radarhere/write-jpeg-com
smason Dec 3, 2022
1ed1a3a
make sure passing a blank comment removes existing comment
smason Dec 3, 2022
e50ae85
Use jpeg_write_marker to write comment
radarhere Dec 5, 2022
399975f
Merge pull request #2 from radarhere/write-jpeg-com
smason Dec 5, 2022
eddc9bd
switch to #z for comment parameter
smason Dec 5, 2022
1d78008
Free comment when returning early
radarhere Dec 6, 2022
6ca08a4
Merge pull request #3 from radarhere/write-jpeg-com
smason Dec 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions src/PIL/JpegImagePlugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,9 +736,7 @@ def validate_qtables(qtables):
)
i += 1

comment = info.get("comment", im.info.get("comment")) or b""
if isinstance(comment, str):
comment = comment.encode()
comment = info.get("comment", im.info.get("comment"))

# "progressive" is the official name, but older documentation
# says "progression"
Expand Down
2 changes: 1 addition & 1 deletion src/encode.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1057,7 +1057,7 @@ PyImaging_JpegEncoderNew(PyObject *self, PyObject *args) {

if (!PyArg_ParseTuple(
args,
"ss|nnnnnnnnOy#y#y#",
"ss|nnnnnnnnOz#y#y#",
&mode,
&rawmode,
&quality,
Expand Down
2 changes: 1 addition & 1 deletion src/libImaging/JpegEncode.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ ImagingJpegEncode(Imaging im, ImagingCodecState state, UINT8 *buf, int bytes) {

case 4:

if (context->comment_size > 0) {
if (context->comment) {
Copy link
Contributor Author

@smason smason Dec 5, 2022

Choose a reason for hiding this comment

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

the rest of the code is conditional on comment != NULL rather than comment_size > 0

they should be the same, but keeping things consistent feels nicer to me

Copy link
Member

@radarhere radarhere Dec 6, 2022

Choose a reason for hiding this comment

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

When you say "the rest of the code", what are you referring to?

Copy link
Contributor Author

@smason smason Dec 6, 2022

Choose a reason for hiding this comment

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

sorry, that wasn't explained well

PyImaging_JpegEncoderNew seems to imply that comment_size is only valid when comment is non-NULL. e.g. comment is initialised to NULL, but comment_size isn't initialised to zero, and later in function (line 1109) it only sets comment = NULL

jpeg_write_marker(&context->cinfo, JPEG_COM, (unsigned char *)context->comment, context->comment_size);
}
state->state++;
Expand Down