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

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

Author: 3 people

.ci/install.sh

@@ -23,7 +23,7 @@ if [[ $(uname) != CYGWIN* ]]; then
     sudo apt-get -qq install libfreetype6-dev liblcms2-dev libtiff-dev python3-tk\
                              ghostscript libjpeg-turbo8-dev libopenjp2-7-dev\
                              cmake meson imagemagick libharfbuzz-dev libfribidi-dev\
-                             sway wl-clipboard libopenblas-dev
+                             sway wl-clipboard libopenblas-dev nasm
 fi
 
 python3 -m pip install --upgrade pip
@@ -62,6 +62,9 @@ if [[ $(uname) != CYGWIN* ]]; then
     # raqm
     pushd depends && ./install_raqm.sh && popd
 
+    # libavif
+    pushd depends && CMAKE_POLICY_VERSION_MINIMUM=3.5 ./install_libavif.sh && popd
+
     # extra test images
     pushd depends && ./install_extra_test_images.sh && popd
 else

.github/workflows/macos-install.sh

@@ -6,6 +6,8 @@ if [[ "$ImageOS" == "macos13" ]]; then
     brew uninstall gradle maven
 fi
 brew install \
+    aom \
+    dav1d \
     freetype \
     ghostscript \
     jpeg-turbo \
@@ -14,6 +16,8 @@ brew install \
     libtiff \
     little-cms2 \
     openjpeg \
+    rav1e \
+    svt-av1 \
     webp
 export PKG_CONFIG_PATH="/usr/local/opt/openblas/lib/pkgconfig"
 
@@ -27,5 +31,8 @@ python3 -m pip install -U pytest-timeout
 python3 -m pip install pyroma
 python3 -m pip install numpy
 
+# libavif
+pushd depends && ./install_libavif.sh && popd
+
 # extra test images
 pushd depends && ./install_extra_test_images.sh && popd

.github/workflows/test-mingw.yml

@@ -60,6 +60,7 @@ jobs:
               mingw-w64-x86_64-gcc \
               mingw-w64-x86_64-ghostscript \
               mingw-w64-x86_64-lcms2 \
+              mingw-w64-x86_64-libavif \
               mingw-w64-x86_64-libimagequant \
               mingw-w64-x86_64-libjpeg-turbo \
               mingw-w64-x86_64-libraqm \

.github/workflows/test-windows.yml

@@ -42,7 +42,7 @@ jobs:
             # Test the oldest Python on 32-bit
             - { python-version: "3.9", architecture: "x86", os: "windows-2019" }
 
-    timeout-minutes: 30
+    timeout-minutes: 45
 
     name: Python ${{ matrix.python-version }} (${{ matrix.architecture }})
 
@@ -145,6 +145,10 @@ jobs:
       if: steps.build-cache.outputs.cache-hit != 'true'
       run: "& winbuild\\build\\build_dep_libpng.cmd"
 
+    - name: Build dependencies / libavif
+      if: steps.build-cache.outputs.cache-hit != 'true' && matrix.architecture == 'x64'
+      run: "& winbuild\\build\\build_dep_libavif.cmd"
+
     # for FreeType WOFF2 font support
     - name: Build dependencies / brotli
       if: steps.build-cache.outputs.cache-hit != 'true'

.github/workflows/wheels-dependencies.sh

@@ -25,7 +25,7 @@ else
     MB_ML_LIBC=${AUDITWHEEL_POLICY::9}
     MB_ML_VER=${AUDITWHEEL_POLICY:9}
 fi
-PLAT=$CIBW_ARCHS
+PLAT="${CIBW_ARCHS:-$AUDITWHEEL_ARCH}"
 
 # Define custom utilities
 source wheels/multibuild/common_utils.sh
@@ -51,6 +51,7 @@ LIBWEBP_VERSION=1.5.0
 BZIP2_VERSION=1.0.8
 LIBXCB_VERSION=1.17.0
 BROTLI_VERSION=1.1.0
+LIBAVIF_VERSION=1.2.1
 
 if [[ $MB_ML_VER == 2014 ]]; then
     function build_xz {
@@ -116,6 +117,45 @@ function build_harfbuzz {
     touch harfbuzz-stamp
 }
 
+function build_libavif {
+    if [ -e libavif-stamp ]; then return; fi
+
+    python3 -m pip install meson ninja
+
+    if [[ "$PLAT" == "x86_64" ]] || [ -n "$SANITIZER" ]; then
+        build_simple nasm 2.16.03 https://www.nasm.us/pub/nasm/releasebuilds/2.16.03
+    fi
+
+    # For rav1e
+    curl https://sh.rustup.rs -sSf | sh -s -- -y
+    . "$HOME/.cargo/env"
+    if [ -z "$IS_ALPINE" ] && [ -z "$SANITIZER" ] && [ -z "$IS_MACOS" ]; then
+        yum install -y perl
+        if [[ "$MB_ML_VER" == 2014 ]]; then
+            yum install -y perl-IPC-Cmd
+        fi
+    fi
+
+    local out_dir=$(fetch_unpack https://github.com/AOMediaCodec/libavif/archive/refs/tags/v$LIBAVIF_VERSION.tar.gz libavif-$LIBAVIF_VERSION.tar.gz)
+    (cd $out_dir \
+        && CMAKE_POLICY_VERSION_MINIMUM=3.5 cmake \
+            -DCMAKE_INSTALL_PREFIX=$BUILD_PREFIX \
+            -DCMAKE_INSTALL_LIBDIR=$BUILD_PREFIX/lib \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DBUILD_SHARED_LIBS=OFF \
+            -DAVIF_LIBSHARPYUV=LOCAL \
+            -DAVIF_LIBYUV=LOCAL \
+            -DAVIF_CODEC_AOM=LOCAL \
+            -DAVIF_CODEC_DAV1D=LOCAL \
+            -DAVIF_CODEC_RAV1E=LOCAL \
+            -DAVIF_CODEC_SVT=LOCAL \
+            -DENABLE_NASM=ON \
+            -DCMAKE_MODULE_PATH=/tmp/cmake/Modules \
+            . \
+        && make install)
+    touch libavif-stamp
+}
+
 function build {
     build_xz
     if [ -z "$IS_ALPINE" ] && [ -z "$SANITIZER" ] && [ -z "$IS_MACOS" ]; then
@@ -150,6 +190,7 @@ function build {
         build_tiff
     fi
 
+    build_libavif
     build_libpng
     build_lcms2
     build_openjpeg

.github/workflows/wheels.yml

@@ -160,6 +160,11 @@ jobs:
           & python.exe winbuild\build_prepare.py -v --no-imagequant --architecture=${{ matrix.cibw_arch }}
         shell: pwsh
 
+      - name: Update rust
+        if: matrix.cibw_arch == 'AMD64'
+        run: |
+          rustup update
+
       - name: Build wheels
         run: |
           setlocal EnableDelayedExpansion

Tests/check_wheel.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import platform
+import struct
 import sys
 
 from PIL import features
@@ -9,7 +10,7 @@
 
 
 def test_wheel_modules() -> None:
-    expected_modules = {"pil", "tkinter", "freetype2", "littlecms2", "webp"}
+    expected_modules = {"pil", "tkinter", "freetype2", "littlecms2", "webp", "avif"}
 
     # tkinter is not available in cibuildwheel installed CPython on Windows
     try:
@@ -19,6 +20,11 @@ def test_wheel_modules() -> None:
     except ImportError:
         expected_modules.remove("tkinter")
 
+    # libavif is not available on Windows for x86 and ARM64 architectures
+    if sys.platform == "win32":
+        if platform.machine() == "ARM64" or struct.calcsize("P") == 4:
+            expected_modules.remove("avif")
+
     assert set(features.get_supported_modules()) == expected_modules