Add AVIF plugin (decoder + encoder using libavif) #5201

fdintino · 2021-01-11T01:52:55Z

Resolves #7983

This adds support for AVIF encoding and decoding, including AVIF image sequences.

I've added tests, and integrated libavif into the windows, linux, and mac CI builds. I haven't done anything to integrate with the docker-images repo.

I chose libavif rather than libheif because the former has been embraced by AOMedia and it's what Chromium uses. Packaging support is spotty at the moment, but I expect that to change soon (currently it's in Debian testing, Fedora rawhide, Ubuntu hirsute, and Alpine edge).

A few notes on the implementation here:

The plugin currently only supports encoding 8-bit images, and all images are decoded to 8-bit RGB(A). I wasn't totally clear on how best to deal with higher bit depths (somewhat related issue: Add support for high bit depth multichannel images #1888)
The RGB to YUV conversion isn't exposed to python at all. Chroma subsampling and the presence of an alpha channel make it non-trivial to return decoded images as YCbCr. It would not be difficult to permit encoding from a YCbCr source.
Since there isn't a way to pass parameters to Image.open (Parameters for Image.open() #569), I'm using module globals in AvifImagePlugin.py to make decoder codec choice and chroma upsampling configurable. I suspect there's a better way to do this.

The star.avifs test file is licensed as CC-BY

I linted the C code with the new clang-format settings, but made the following change so that it didn't make PyObject_HEAD and the threading macros look wonky:

diff --git a/.clang-format b/.clang-format
index be32e6d1..300f8e54 100644
--- a/.clang-format
+++ b/.clang-format
@@ -18,3 +18,7 @@ SpaceBeforeParens: ControlStatements
 SpacesInParentheses: false
 TabWidth: 4
 UseTab: Never
+StatementMacros:
+  - PyObject_HEAD
+  - Py_BEGIN_ALLOW_THREADS
+  - Py_END_ALLOW_THREADS

radarhere · 2021-01-11T02:21:53Z

Tests/helper.py

@@ -206,6 +207,7 @@ def _test_leak(self, core):
        start_mem = self._get_mem_usage()
        for cycle in range(self.iterations):
            core()
+            gc.collect()


Did you want to talk about why you added this?

I accidentally left this in here while I was debugging. I'll remove it.

Actually, I realized now why I added this: without it the leak tests are non-deterministic. I could pad the memory limit to counteract the fact that it may not have hit the gc generation threshold before it checks the memory, but forcing garbage collection after each iteration ensures that the test is deterministic.

wiredfool · 2021-01-11T20:17:46Z

src/_avif.c

+    }
+
+    avifRGBImageAllocatePixels(&rgb);
+    memcpy(rgb.pixels, rgb_bytes, size);


Please document in a comment that this is safe for r/w, and potentially add an explict check that the rgb_bytes/rgb.pixels is large enough.

wiredfool · 2021-01-11T20:20:51Z

src/_avif.c

+        return NULL;
+    }
+
+    memcpy(self->data, avif_bytes, size);


Document here as well.

I wasn't entirely sure what you wanted documented for this line. I added this, let me know if it's what you had in mind:

Pillow/src/_avif.c

Lines 484 to 485 in b84a8e0

// We need to allocate storage for the decoder for the lifetime of the object

// (avifDecoderSetIOMemory does not copy the data passed into it)

I was able to avoid a memcpy here by having PyArg_ParseTuple pass in a PyBytesObject and incrementing the reference in the new / decrementing in the dealloc. That also avoids an unnecessary malloc during decoding.

Realized it would probably be better to have you resolve these conversations, to confirm that the feedback has indeed been addressed.

wiredfool · 2021-01-11T20:29:01Z

src/_avif.c

+        return NULL;
+    }
+
+    size = rgb.rowBytes * rgb.height;


Is this guaranteed to not overflow, even in the face of invalid input?

libavif currently restricts images to a maximum of 2^28 pixels. If the dimensions are larger than 16384x16384 then the function that sets decoder->image->width and decoder->image->height fails. So I suppose that a 4-channel 16384x16384 8-bit image could overflow on a 32-bit platform. I'm not certain because the codecs used by libavif have their own overflow limit checks. For instance, dav1d enforces a maximum of 2^26 pixels on 32-bit systems. Should I add a check against PY_SSIZE_T_MAX to be sure? (edit: answering my own question and adding this check)

Added here

Pillow/src/_avif.c

Lines 619 to 622 in b84a8e0

if (rgb.height > PY_SSIZE_T_MAX / row_bytes) {

PyErr_SetString(PyExc_MemoryError, "Integer overflow in pixel size");

return NULL;

}

Basically, I'm the one who will get a CVE on this if there's a problem, and I'd like really clear guidelines about what the assumptions are for sizes of things and where they come from for dangerous operations like memset, malloc, and pointer reads/writes. This isn't so much for now, but a couple years down the line, things need to be clear. This will be fuzzed, this will be run under valgrind, so hopefully there won't be problems.

I've basically had to reverse engineer how SgiRleDecode works over the last month or so, and I'd like to be preventing that sort of experience in the future.

Does raising a MemoryError if rgb.height > PY_SSIZE_T_MAX / row_bytes (as I have in the latest PR push) suffice to address that concern?

.ci/install.sh

wiredfool · 2021-01-11T20:35:05Z

.ci/install.sh

@@ -29,6 +30,7 @@ python3 -m pip install -U pytest
 python3 -m pip install -U pytest-cov
 python3 -m pip install pyroma
 python3 -m pip install test-image-results
+python3 -m pip install meson


Does meson need to be added to the requirements.txt?

I don't think so. It's a build dependency of dav1d so it's used when building libavif in CI, but it's not otherwise required to run tests.

wiredfool · 2021-01-11T20:38:19Z

Tests/test_file_avif.py

+
+
+@skip_unless_feature("avif")
+class TestAvifLeaks(PillowLeakTestCase):


I'd prefer not iterating a leak test in the standard test suite, as that can be expensive from a time POV. It's ok for the initial cut, but I'd rather not have it long term.

nulano · 2021-01-11T20:56:26Z

Adding libavif to MSYS2 fails to compile due to a few missing defines (AVIF_CHROMA_UPSAMPLING_AUTOMATIC, AVIF_CHROMA_UPSAMPLING_FASTEST, AVIF_CHROMA_UPSAMPLING_BEST_QUALITY): https://github.com/nulano/Pillow/runs/1683386633?check_suite_focus=true#step:5:77

fdintino · 2021-01-11T23:44:35Z

@nulano it looks like those defines were only added in libavif 0.8.3. I'll figure some #if version checks around their usage.

fdintino · 2021-01-12T15:55:15Z

@nulano Is it okay if I cherry-pick your MSYS commit into this PR?

nulano

@nulano Is it okay if I cherry-pick your MSYS commit into this PR?

Of course, cherry-pick away!

I have a few nitpicks for winbuild/build_prepare, I haven't looked at the rest yet.

nulano · 2021-01-11T18:38:43Z

winbuild/build_prepare.py

+            'cmd.exe /c "aom.cmd"',
+            "if errorlevel 1 echo AOM build failed! && exit /B 1",
+            'cmd.exe /c "dav1d.cmd"',
+            "if errorlevel 1 echo dav1d build failed! && exit /B 1",


The last line of aom.cmd is cd ../.. which will never fail, so the errorlevel checks have absolutely no effect. The build fails on my system as I don't have git on PATH, yet it continues anyway. However, there should also be a "clean" step, probably cmd_rmdir, so that it is possible to re-run the generated scripts when debugging build_prepare locally.

Suggested change

'cmd.exe /c "aom.cmd"',

"if errorlevel 1 echo AOM build failed! && exit /B 1",

'cmd.exe /c "dav1d.cmd"',

"if errorlevel 1 echo dav1d build failed! && exit /B 1",

cmd_rmdir("aom"),

'cmd.exe /c "aom.cmd"',

cmd_rmdir("dav1d"),

'cmd.exe /c "dav1d.cmd"',

I would prefer to build these as separate steps (similar to libpng and freetype, or raqm and its dependencies), but AFAICT AOM can only be downloaded using git, so it's probably simpler this way. But the extra dependencies (git, meson, ninja) should at least be noted in the winbuild/build.rst and winbuild/readme.md documents as well as maybe docs/installation.rst (Bulding on Windows section). There should also be a way to disable these similar to the --no-imagequant and --no-raqm flags, such as --no-avif.

winbuild/build_prepare.py

fdintino · 2021-01-18T17:23:25Z

@radarhere @wiredfool @nulano I think I've addressed all feedback (except for the requests for docs on building), but I've left it up to you all to resolve conversations (or not).

Is this PR generally on the right track? I've held off on writing docs until I've gotten a signal one way or the other.

fdintino · 2021-02-15T18:25:03Z

Since it's been a month since I asked my question without response, I'll try to reframe it as more specific questions that might be more answerable.

Is the general structure of this plugin acceptable? I tried to hew closely to the conventions elsewhere in the repo, so I assume so, but would appreciate confirmation.
Is the test coverage sufficient? The gaps are all in the error handling. I'd be happy to try to add test cases for those to make it more complete.
I'd appreciate feedback on the encoder settings. For instance: should yuv_format be renamed subsampling to be consistent with the Jpeg plugin? Should I offer a jpeg-like 0-100 quality setting that maps the min/max quantizer? (The colorist library has such a quality setting that still allows qmin/qmax as an advanced override option). Should I eliminate any options? (My vote would be to get rid of qmin_alpha and qmax_alpha).
What would you like to see, CI-wise, with this pull request? While waiting for feedback I worked on putting this plugin in its own package, which builds manylinux wheels in the same manner as the pillow-wheels repo. I setup builds for all the codecs supported by libavif, on all platforms, and also added cached dependencies (see pillow-avif-plugin-depends). That includes a crate vendor tarball for rav1e, as I've found crates.io to be too unreliable for frequent CI builds. Would you want to wait until this PR is wrapped up and merged before I opened a pull request against pillow-wheels?
- Note: I think licensing shouldn't be an issue for anything: AOM, rav1e, dav1d, SVT-AV1 and libyuv are all BSD-2 licensed, libgav1 is Apache, and they all are covered under the Alliance for Open Media Patent License.
- It might be overkill to include all codecs in the manylinux and windows wheels. In particular, SVT-AV1 is far from ready for prime-time. My recommendation would be to include AOM, dav1d, and rav1e by default. AOM, being the reference implementation, is the most complete and has the highest quality, while dav1d and rav1e are the fastest (setting aside SVT-AV1).

Tests/test_file_avif.py

radarhere · 2021-03-26T12:14:56Z

This might be a libavif bug, but I find that if I run this PR, libavif has stopped working for macOS.

https://github.com/radarhere/Pillow/runs/2201531959#step:8:1174

/Users/runner/work/Pillow/Pillow/depends/libavif-0.8.4/ext/libyuv/include/libyuv/row.h:750:5: error: 'LIBYUV_UNLIMITED_DATA' is not defined, evaluates to 0 [-Werror,-Wundef]
#if LIBYUV_UNLIMITED_DATA
^
1 error generated.

LIBYUV_UNLIMITED_DATA was a change introduced in libyuv in the last month - https://chromium.googlesource.com/libyuv/libyuv/+/ba033a11e3948e4b3%5E%21/#F2

wiredfool · 2021-03-28T13:53:16Z

We're going to need to add the required libraries to the docker images as well, and we're going to need to add these to the oss-fuzz builder to get fuzzer support.

Might as well make a PR to the Pillow-wheels for whatever needs to happen on build. That will also be potentially helpful for getting the dependencies into oss-fuzz.

* Use filename placeholder in URL * Removed unused upsampling setting * Use has_transparency_data * Removed unnecessary load() * Test getexif() change --------- Co-authored-by: Andrew Murray <[email protected]>

doublex · 2024-11-26T12:45:36Z

Is there a chance to merge this pull request into Pillow 11.1?
Kind regards!

radarhere · 2024-11-30T05:35:50Z

This is a complex pull request, meaning that it's hard to make predictions about the review status. Before merging, I would like to thoroughly review, I would like the original creator of this pull request to respond to any suggestions, and I would also like some of members of the core Pillow team to take a look at this.

Since aclark4life's comment, I've been making a variety of suggestions, and currently have one open. So I think of this as an ongoing conversation between people, and because I can only speak for myself, all I can say is that as long as there is activity, this is moving forward.

src/PIL/AvifImagePlugin.py

doublex · 2024-12-07T09:42:03Z

@radarhere
Thank you so much for all of your efforts!

* Do not ignore SyntaxError when saving EXIF data * Do not save orientation in EXIF data * Do not save XMP and EXIF data from info dictionary --------- Co-authored-by: Andrew Murray <[email protected]>

* Allow libavif to install rav1e, except on manylinux2014 and aarch64 * Allow libavif to install rav1e on Windows --------- Co-authored-by: Andrew Murray <[email protected]>

Co-authored-by: Andrew Murray <[email protected]>

* Removed unittest mock * Updated license * Increased timeout --------- Co-authored-by: Andrew Murray <[email protected]>

* Use cmds_cmake * Added libsharpyuv * Combine meson into libavif install script * Simplified condition --------- Co-authored-by: Andrew Murray <[email protected]>

fdintino · 2024-12-13T16:03:29Z

Since this PR is so far along in review, I figure I should run any non-trivial changes past the reviewers before undertaking them:

libaom is a very capable codec, but it has absolutely awful performance and compression efficiency with default settings. This gets reported as an issue to pillow-avif-plugin, and my advice is usually to use rav1e. How would people feel about changing the order of encoder codecs such that rav1e is preferred over aom?

codingjoe · 2024-12-13T17:00:26Z

Since this PR is so far along in review, I figure I should run any non-trivial changes past the reviewers before undertaking them:

libaom is a very capable codec, but it has absolutely awful performance and compression efficiency with default settings. This gets reported as an issue to pillow-avif-plugin, and my advice is usually to use rav1e. How would people feel about changing the order of encoder codecs such that rav1e is preferred over aom?

I can second that. rav1e isn't only faster in my experience, but some might consider it more open…

radarhere · 2024-12-14T05:27:58Z

If it is more performant, then I raise no objection to changing the order of preference.

radarhere added the Enhancement label Jan 11, 2021

radarhere reviewed Jan 11, 2021

View reviewed changes

wiredfool requested changes Jan 11, 2021

View reviewed changes

fdintino requested a review from wiredfool January 12, 2021 15:53

nulano reviewed Jan 12, 2021

View reviewed changes

fdintino mentioned this pull request Jan 13, 2021

AVIF support thumbor/thumbor#1314

Closed

fdintino force-pushed the libavif-plugin branch from 7efcefc to 3ae762e Compare January 23, 2021 16:16

fdintino mentioned this pull request Jan 30, 2021

Fix memcpy/sizeof typo in avifImageCopy AOMediaCodec/libavif#483

Merged

fdintino force-pushed the libavif-plugin branch 3 times, most recently from b433571 to ff56a9c Compare February 24, 2021 03:54

japsu mentioned this pull request Mar 2, 2021

Replace WebP previews with AVIF con2/edegal#197

Open

2 tasks

radarhere reviewed Mar 26, 2021

View reviewed changes

Tests/test_file_avif.py Outdated Show resolved Hide resolved

radarhere reviewed Mar 26, 2021

View reviewed changes

Tests/test_file_avif.py Outdated Show resolved Hide resolved

radarhere mentioned this pull request Mar 26, 2021

Updated libavif to 0.9.0 fdintino/Pillow#1

Merged

fdintino force-pushed the libavif-plugin branch from a9b00e0 to 09567f6 Compare March 28, 2021 16:37

fdintino force-pushed the libavif-plugin branch 5 times, most recently from b851ca6 to 649f5f3 Compare April 12, 2021 12:44

This was referenced Apr 12, 2021

Add libavif dependencies python-pillow/pillow-depends#37

Open

Add libavif build python-pillow/pillow-wheels#193

Closed

radarhere mentioned this pull request Nov 12, 2024

Removed unused upsampling setting fdintino/Pillow#5

Merged

Removed unused upsampling setting (#5)

671e3c8

* Use filename placeholder in URL * Removed unused upsampling setting * Use has_transparency_data * Removed unnecessary load() * Test getexif() change --------- Co-authored-by: Andrew Murray <[email protected]>

radarhere mentioned this pull request Nov 13, 2024

Removed ld64 flag fdintino/Pillow#6

Merged

radarhere added 2 commits November 19, 2024 09:51

Merge branch 'main' into libavif-plugin

658cdf3

Merge branch 'main' into libavif-plugin

7225cb9

dairiki mentioned this pull request Nov 24, 2024

Add support for webp and avif images and add a global thumbnail format config lektor/lektor#1196

Draft

4 tasks

radarhere and others added 2 commits November 30, 2024 19:33

Merge branch 'main' into libavif-plugin

3730bf2

Improved error handling

c40bcbf

radarhere reviewed Dec 3, 2024

View reviewed changes

src/PIL/AvifImagePlugin.py Outdated Show resolved Hide resolved

This was referenced Dec 6, 2024

Allow libavif to install rav1e, except on manylinux2014 and aarch64 fdintino/Pillow#7

Merged

Do not ignore SyntaxError when saving EXIF data fdintino/Pillow#8

Merged

radarhere and others added 4 commits December 7, 2024 12:28

Do not ignore SyntaxError when saving EXIF data (#8)

d76ae2f

* Do not ignore SyntaxError when saving EXIF data * Do not save orientation in EXIF data * Do not save XMP and EXIF data from info dictionary --------- Co-authored-by: Andrew Murray <[email protected]>

Allow libavif to install rav1e, except on manylinux2014 and aarch64 (#7)

9ad8311

* Allow libavif to install rav1e, except on manylinux2014 and aarch64 * Allow libavif to install rav1e on Windows --------- Co-authored-by: Andrew Murray <[email protected]>

Removed ld64 flag (#6)

de4c6c1

Co-authored-by: Andrew Murray <[email protected]>

fix: set exif orientation from irot/imir when decoding AVIF

524d802

This was referenced Dec 9, 2024

Use cmds_cmake fdintino/Pillow#9

Merged

Removed unittest mock fdintino/Pillow#10

Merged

radarhere and others added 4 commits December 13, 2024 22:39

Merge branch 'main' into libavif-plugin

7b73d77

Removed unittest mock (#10)

a56acd8

* Removed unittest mock * Updated license * Increased timeout --------- Co-authored-by: Andrew Murray <[email protected]>

Use cmds_cmake (#9)

f5dc957

* Use cmds_cmake * Added libsharpyuv * Combine meson into libavif install script * Simplified condition --------- Co-authored-by: Andrew Murray <[email protected]>

chore(docs): update quality and speed with correct defaults

8d77678

radarhere mentioned this pull request Dec 14, 2024

Removed _avif.HAVE_AVIF and _avif.VERSION fdintino/Pillow#11

Open

radarhere mentioned this pull request Dec 14, 2024

Simplified EXIF code fdintino/Pillow#12

Open

Merge branch 'main' into libavif-plugin

4eaa6b7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add AVIF plugin (decoder + encoder using libavif) #5201

Add AVIF plugin (decoder + encoder using libavif) #5201

fdintino commented Jan 11, 2021 •

edited by radarhere

Loading

radarhere Jan 11, 2021

fdintino Jan 11, 2021

fdintino Jan 12, 2021 •

edited

Loading

wiredfool Jan 11, 2021

wiredfool Jan 11, 2021

fdintino Jan 12, 2021

fdintino Jan 23, 2021

fdintino Sep 24, 2023

wiredfool Jan 11, 2021

fdintino Jan 12, 2021 •

edited

Loading

fdintino Jan 12, 2021

wiredfool Jan 12, 2021

fdintino Jan 12, 2021

wiredfool Jan 11, 2021

fdintino Jan 11, 2021

wiredfool Jan 11, 2021

nulano commented Jan 11, 2021

fdintino commented Jan 11, 2021

fdintino commented Jan 12, 2021

nulano left a comment

nulano Jan 11, 2021

fdintino commented Jan 18, 2021

fdintino commented Feb 15, 2021 •

edited

Loading

radarhere commented Mar 26, 2021 •

edited

Loading

wiredfool commented Mar 28, 2021

doublex commented Nov 26, 2024 •

edited

Loading

radarhere commented Nov 30, 2024

doublex commented Dec 7, 2024

fdintino commented Dec 13, 2024 •

edited

Loading

codingjoe commented Dec 13, 2024

radarhere commented Dec 14, 2024

	// We need to allocate storage for the decoder for the lifetime of the object
	// (avifDecoderSetIOMemory does not copy the data passed into it)

	if (rgb.height > PY_SSIZE_T_MAX / row_bytes) {
	PyErr_SetString(PyExc_MemoryError, "Integer overflow in pixel size");
	return NULL;
	}



		@skip_unless_feature("avif")
		class TestAvifLeaks(PillowLeakTestCase):

Add AVIF plugin (decoder + encoder using libavif) #5201

Are you sure you want to change the base?

Add AVIF plugin (decoder + encoder using libavif) #5201

Conversation

fdintino commented Jan 11, 2021 • edited by radarhere Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fdintino Jan 12, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fdintino Jan 12, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nulano commented Jan 11, 2021

fdintino commented Jan 11, 2021

fdintino commented Jan 12, 2021

nulano left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fdintino commented Jan 18, 2021

fdintino commented Feb 15, 2021 • edited Loading

radarhere commented Mar 26, 2021 • edited Loading

wiredfool commented Mar 28, 2021

doublex commented Nov 26, 2024 • edited Loading

radarhere commented Nov 30, 2024

doublex commented Dec 7, 2024

fdintino commented Dec 13, 2024 • edited Loading

codingjoe commented Dec 13, 2024

radarhere commented Dec 14, 2024

fdintino commented Jan 11, 2021 •

edited by radarhere

Loading

fdintino Jan 12, 2021 •

edited

Loading

fdintino Jan 12, 2021 •

edited

Loading

fdintino commented Feb 15, 2021 •

edited

Loading

radarhere commented Mar 26, 2021 •

edited

Loading

doublex commented Nov 26, 2024 •

edited

Loading

fdintino commented Dec 13, 2024 •

edited

Loading