Skip to content

Add AVIF to wheels using only aomenc and dav1d AVIF codecs for reduced size #8858

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 32 commits into from
Jun 26, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
8b4e66e
fix(avif): use only aomenc and dav1d to reduce wheel size
fdintino Apr 1, 2025
a2cbce7
Include comment about CONFIG_AV1_DECODER=0
fdintino Apr 2, 2025
84485e1
s/AVIF/AV1/
fdintino Apr 2, 2025
ab55e54
remove ENABLE_NASM and CMAKE_MODULE_PATH libavif cmake args
fdintino Apr 2, 2025
8a6e5af
Remove rust installation via rustup, which is no longer needed
fdintino Apr 3, 2025
deb1c9d
Build libavif with -Os and with LTO enabled
fdintino Apr 4, 2025
6d7f396
Do not install perl (#35)
radarhere Apr 6, 2025
7aca46c
Do not disable CMAKE_MACOSX_RPATH (#36)
radarhere Apr 6, 2025
8bc14e2
Update .github/workflows/wheels-dependencies.sh
fdintino Apr 7, 2025
621bcd5
Removed CMAKE_INTERPROCEDURAL_OPTIMIZATION (#37)
radarhere Apr 8, 2025
1c40ea5
Re-add CMAKE_INTERPROCEDURAL_OPTIMIZATION=ON on windows
fdintino Apr 8, 2025
331354a
only disable CMAKE_INTERPROCEDURAL_OPTIMIZATION on macOS
fdintino Apr 8, 2025
8cac43f
Use elif
radarhere Apr 8, 2025
ce01f19
Merge branch 'main' into chore/remove-rav1e
radarhere Apr 13, 2025
8ab93db
Disable AOM high-bit-depth support
fdintino Apr 17, 2025
a005e28
Use CMAKE_BUILD_TYPE=MinSizeRel on aarch64 manylinux2014
fdintino Apr 17, 2025
6c918a0
use alternative mirror for nasm, since nasm.us is down
fdintino Apr 23, 2025
5573242
Further reduce size (LTO on macOS, more aggressive symbol stripping)
fdintino Apr 23, 2025
8a174f5
Revert "use alternative mirror for nasm, since nasm.us is down"
fdintino Apr 24, 2025
f40eed2
Merge branch 'main' into chore/remove-rav1e
radarhere May 1, 2025
8905480
Set CMAKE_POLICY_VERSION_MINIMUM=3.9 to allow IPO with gcc
fdintino May 1, 2025
f20ce67
bump libavif to 1.3.0
fdintino May 12, 2025
5a8313c
Remove -DCMAKE_POLICY_VERSION_MINIMUM=3.5 from build_prepare
fdintino May 14, 2025
a3cba6a
Merge branch 'main' into chore/remove-rav1e
radarhere May 23, 2025
01daa3d
Merge branch 'main' into chore/remove-rav1e
radarhere May 27, 2025
3ffce33
Merge branch 'main' into chore/remove-rav1e
radarhere Jun 14, 2025
7607474
Simplified code
radarhere Jun 14, 2025
2222237
Include in Windows x86 wheels (#38)
radarhere Jun 20, 2025
1cabcba
Merge branch 'main' into chore/remove-rav1e
radarhere Jun 20, 2025
c993fbc
Windows arm64 wheels do not have libavif
radarhere Jun 22, 2025
7f44ca6
Removed trailing space
radarhere Jun 23, 2025
124c1a5
Updated capitalisation
radarhere Jun 24, 2025
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
10 changes: 7 additions & 3 deletions .github/workflows/wheels-dependencies.sh
Original file line number Diff line number Diff line change
Expand Up @@ -133,18 +133,22 @@ function build_libavif {
fi

local out_dir=$(fetch_unpack https://github.com/AOMediaCodec/libavif/archive/refs/tags/v$LIBAVIF_VERSION.tar.gz libavif-$LIBAVIF_VERSION.tar.gz)
# CONFIG_AV1_DECODER=0 is a flag for libaom (included as a subproject of
# libavif) to disable the compilation and inclusion of aom's AVIF decoder.
(cd $out_dir \
&& CMAKE_POLICY_VERSION_MINIMUM=3.5 cmake \
-DCMAKE_INSTALL_PREFIX=$BUILD_PREFIX \
-DCMAKE_INSTALL_LIBDIR=$BUILD_PREFIX/lib \
-DCMAKE_INSTALL_NAME_DIR=$BUILD_PREFIX/lib \
-DCMAKE_MACOSX_RPATH=OFF \
-DCMAKE_BUILD_TYPE=Release \
-DBUILD_SHARED_LIBS=OFF \
-DBUILD_SHARED_LIBS=ON \

Choose a reason for hiding this comment

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

Did you mean to change BUILD_SHARED_LIBS to ON? It is still OFF in winbuild/build_prepare.py.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did. Using the linker to generate the shared library file allows it to remove unused objects. There is a mechanism for including shared library dependencies of a python extension inside a wheel file on macOS and linux (delocate and auditwheel, respectively) but there is no such standard mechanism for doing the same on windows. So the windows library has to be built statically.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The savings are modest, about 0.5 MB, but there isn't any cost to switching to a shared library.

Copy link
Member

Choose a reason for hiding this comment

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

When you say 0.5mb, I presume that's per wheel. Which wheel(s) were you using to check that?

-DAVIF_LIBSHARPYUV=LOCAL \
-DAVIF_LIBYUV=LOCAL \
-DAVIF_CODEC_AOM=LOCAL \
-DCONFIG_AV1_DECODER=0 \
-DAVIF_CODEC_AOM_DECODE=OFF \
Copy link

@wantehchang wantehchang Apr 7, 2025

Choose a reason for hiding this comment

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

Frankie: Is it possible to build with the libaom and dav1d packages in Linux distributions (i.e., -DAVIF_CODEC_AOM=SYSTEM -DAVIF_CODEC_DAV1D=LOCAL)? That will allow the Pillow Library to share the libaom and dav1d shared libraries with other applications on the system.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The shared libraries linked from the pillow extension are all included in the distributed binary, so that people installing Pillow don't need to install the libraries themselves. This is why libjpeg-turbo, libpng, libtiff, and other libraries are included in the wheel files on PyPI. Nothing would be gained by using libaom from the linux distribution.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If someone were to build Pillow from source, they could use libavif from the distro, or build libavif against system libraries. The binary wheels are tagged for python version, system architecture, and ABI compatibility (musl and two different versions of glibc). They are intended to be installed in any compatible environment without any other dependencies.

-DAVIF_CODEC_DAV1D=LOCAL \
-DAVIF_CODEC_RAV1E=LOCAL \
-DAVIF_CODEC_SVT=LOCAL \
-DENABLE_NASM=ON \
-DCMAKE_MODULE_PATH=/tmp/cmake/Modules \
. \
Expand Down
25 changes: 0 additions & 25 deletions wheels/dependency_licenses/RAV1E.txt

This file was deleted.

26 changes: 0 additions & 26 deletions wheels/dependency_licenses/SVT-AV1.txt

This file was deleted.

4 changes: 2 additions & 2 deletions winbuild/build_prepare.py
Original file line number Diff line number Diff line change
Expand Up @@ -392,9 +392,9 @@ def cmd_msbuild(
"-DAVIF_LIBSHARPYUV=LOCAL",
"-DAVIF_LIBYUV=LOCAL",
"-DAVIF_CODEC_AOM=LOCAL",
"-DCONFIG_AV1_DECODER=0",
"-DAVIF_CODEC_AOM_DECODE=OFF",
"-DAVIF_CODEC_DAV1D=LOCAL",
"-DAVIF_CODEC_RAV1E=LOCAL",
"-DAVIF_CODEC_SVT=LOCAL",
"-DCMAKE_POLICY_VERSION_MINIMUM=3.5",
),
cmd_xcopy("include", "{inc_dir}"),
Expand Down
Loading