Revert "Use "rav1e" if available as default ("auto") avif encoder"

This reverts commit ddc8e7e.
python-pillow · hugovk · Apr 1, 2025 · Jan 3, 2021 · Oct 16, 2024 · Oct 16, 2024
commit da2e18de3ebf429b1f4a8ad8e0f7134692961f99
diff --git a/docs/handbook/image-file-formats.rst b/docs/handbook/image-file-formats.rst
@@ -1370,7 +1370,7 @@ The :py:meth:`~PIL.Image.Image.save` method supports the following options:
     YUV range, either "full" or "limited". Defaults to "full"
 
 **codec**
-    AV1 codec to use for encoding. Specific values are "rav1e", "aom", and
+    AV1 codec to use for encoding. Specific values are "aom", "rav1e", and
     "svt", presuming the chosen codec is available. Defaults to "auto", which
     will choose the first available codec in the order of the preceding list.
 

diff --git a/src/_avif.c b/src/_avif.c
@@ -3,8 +3,6 @@
 #include <Python.h>
 #include "avif/avif.h"
 
-static int have_rav1e = 0;
-
 typedef struct {
     avifPixelFormat subsampling;
     int qmin;
@@ -41,22 +39,22 @@
 static PyTypeObject AvifDecoder_Type;

 static int
 normalize_quantize_value(int qvalue) {
    if (qvalue < AVIF_QUANTIZER_BEST_QUALITY) {
        return AVIF_QUANTIZER_BEST_QUALITY;
    } else if (qvalue > AVIF_QUANTIZER_WORST_QUALITY) {
        return AVIF_QUANTIZER_WORST_QUALITY;
    } else {
        return qvalue;
    }
 }

 static int
 normalize_tiles_log2(int value) {
    if (value < 0) {
        return 0;
    } else if (value > 6) {
        return 6;
    } else {
        return value;
    }
@@ -73,8 +71,8 @@
        case AVIF_RESULT_TRUNCATED_DATA:
        case AVIF_RESULT_NO_CONTENT:
            return PyExc_SyntaxError;
        default:
            return PyExc_RuntimeError;
    }
 }

@@ -93,21 +91,21 @@
            return axis ? 7   // 90 degrees anti-clockwise then swap left and right.
                        : 5;  // 90 degrees anti-clockwise then swap top and bottom.
        }
        return 6;  // 90 degrees anti-clockwise.
    }
    if (irot && angle == 2) {
        if (imir) {
            return axis ? 4   // 180 degrees anti-clockwise then swap left and right.
                        : 2;  // 180 degrees anti-clockwise then swap top and bottom.
        }
        return 3;  // 180 degrees anti-clockwise.
    }
    if (irot && angle == 3) {
        if (imir) {
            return axis ? 5   // 270 degrees anti-clockwise then swap left and right.
                        : 7;  // 270 degrees anti-clockwise then swap top and bottom.
        }
        return 8;  // 270 degrees anti-clockwise.
    }
    if (imir) {
        return axis ? 2   // Swap left and right.
@@ -136,16 +134,16 @@
            image->imir.mode = 1;
 #endif
            break;
        case 3:  // The 0th row is at the visual bottom of the image, and the 0th column
                 // is the visual right-hand side.
            image->transformFlags = otherFlags | AVIF_TRANSFORM_IROT;
            image->irot.angle = 2;
 #if AVIF_VERSION_MAJOR >= 1
            image->imir.axis = 0;  // ignored
 #else
            image->imir.mode = 0;  // ignored
 #endif
            break;
        case 4:  // The 0th row is at the visual bottom of the image, and the 0th column
                 // is the visual left-hand side.
            image->transformFlags = otherFlags | AVIF_TRANSFORM_IMIR;
@@ -168,16 +166,16 @@
            image->imir.mode = 0;
 #endif
            break;
        case 6:  // The 0th row is the visual right-hand side of the image, and the 0th
                 // column is the visual top.
            image->transformFlags = otherFlags | AVIF_TRANSFORM_IROT;
            image->irot.angle = 3;
 #if AVIF_VERSION_MAJOR >= 1
            image->imir.axis = 0;  // ignored
 #else
            image->imir.mode = 0;  // ignored
 #endif
            break;
        case 7:  // The 0th row is the visual right-hand side of the image, and the 0th
                 // column is the visual bottom.
            image->transformFlags =
@@ -190,16 +188,16 @@
            image->imir.mode = 0;
 #endif
            break;
        case 8:  // The 0th row is the visual left-hand side of the image, and the 0th
                 // column is the visual bottom.
            image->transformFlags = otherFlags | AVIF_TRANSFORM_IROT;
            image->irot.angle = 1;
 #if AVIF_VERSION_MAJOR >= 1
            image->imir.axis = 0;  // ignored
 #else
            image->imir.mode = 0;  // ignored
 #endif
            break;
    }
 }

@@ -239,34 +237,34 @@
    PyObject *keyval, *py_key, *py_val;
    char *key, *val;
    if (!PyTuple_Check(opts)) {
        PyErr_SetString(PyExc_ValueError, "Invalid advanced codec options");
        return 1;
    }
    size = PyTuple_GET_SIZE(opts);

    for (i = 0; i < size; i++) {
        keyval = PyTuple_GetItem(opts, i);
        if (!PyTuple_Check(keyval) || PyTuple_GET_SIZE(keyval) != 2) {
            PyErr_SetString(PyExc_ValueError, "Invalid advanced codec options");
            return 1;
        }
        py_key = PyTuple_GetItem(keyval, 0);
        py_val = PyTuple_GetItem(keyval, 1);
        if (!PyBytes_Check(py_key) || !PyBytes_Check(py_val)) {
            PyErr_SetString(PyExc_ValueError, "Invalid advanced codec options");
            return 1;
        }
        key = PyBytes_AsString(py_key);
        val = PyBytes_AsString(py_val);

        avifResult result = avifEncoderSetCodecSpecificOption(encoder, key, val);
        if (result != AVIF_RESULT_OK) {
            PyErr_Format(
                exc_type_for_avif_result(result),
                "Setting advanced codec options failed: %s",
                avifResultToString(result)
            );
            return 1;
        }
    }
    return 0;
@@ -348,24 +346,20 @@
        enc_options.qmax = normalize_quantize_value(100 - quality);
 #endif
    } else {
        enc_options.qmin = normalize_quantize_value(qmin);
        enc_options.qmax = normalize_quantize_value(qmax);
    }
    enc_options.quality = quality;

    if (speed < AVIF_SPEED_SLOWEST) {
        speed = AVIF_SPEED_SLOWEST;
    } else if (speed > AVIF_SPEED_FASTEST) {
        speed = AVIF_SPEED_FASTEST;
    }
     enc_options.speed = speed;
 
     if (strcmp(codec, "auto") == 0) {
-        if (have_rav1e) {
-            enc_options.codec = AVIF_CODEC_CHOICE_RAV1E;
-        } else {
-            enc_options.codec = AVIF_CODEC_CHOICE_AUTO;
-        }
+        enc_options.codec = AVIF_CODEC_CHOICE_AUTO;
     } else {
         enc_options.codec = avifCodecChoiceFromName(codec);
     }
@@ -381,8 +375,8 @@

    // Validate canvas dimensions
    if (width <= 0 || height <= 0) {
        PyErr_SetString(PyExc_ValueError, "invalid canvas dimensions");
        return NULL;
    }

    enc_options.tile_rows_log2 = normalize_tiles_log2(tile_rows_log2);
@@ -412,9 +406,9 @@
        encoder->maxThreads = is_aom_encode && max_threads > 64 ? 64 : max_threads;
 #if AVIF_VERSION >= 1000000
        if (enc_options.qmin != -1 && enc_options.qmax != -1) {
            encoder->minQuantizer = enc_options.qmin;
            encoder->maxQuantizer = enc_options.qmax;
        } else {
            encoder->quality = enc_options.quality;
        }
 #else
@@ -434,7 +428,7 @@
        if (advanced != Py_None) {
 #if AVIF_VERSION >= 80200
            if (_add_codec_specific_options(encoder, advanced)) {
                return NULL;
            }
 #else
            PyErr_SetString(
@@ -471,12 +465,12 @@
                PyBytes_GET_SIZE(icc_bytes)
            );
            if (result != AVIF_RESULT_OK) {
                PyErr_Format(
                    exc_type_for_avif_result(result),
                    "Setting ICC profile failed: %s",
                    avifResultToString(result)
                );
                return NULL;
            }
        } else {
            image->colorPrimaries = AVIF_COLOR_PRIMARIES_BT709;
@@ -484,21 +478,21 @@
        }

        if (PyBytes_GET_SIZE(exif_bytes)) {
            self->exif_bytes = exif_bytes;
            Py_INCREF(exif_bytes);

            result = avifImageSetMetadataExif(
                image,
                (uint8_t *)PyBytes_AS_STRING(exif_bytes),
                PyBytes_GET_SIZE(exif_bytes)
            );
            if (result != AVIF_RESULT_OK) {
                PyErr_Format(
                    exc_type_for_avif_result(result),
                    "Setting EXIF data failed: %s",
                    avifResultToString(result)
                );
                return NULL;
            }
        }
        if (PyBytes_GET_SIZE(xmp_bytes)) {
@@ -511,12 +505,12 @@
                PyBytes_GET_SIZE(xmp_bytes)
            );
            if (result != AVIF_RESULT_OK) {
                PyErr_Format(
                    exc_type_for_avif_result(result),
                    "Setting XMP data failed: %s",
                    avifResultToString(result)
                );
                return NULL;
            }
        }
        if (exif_orientation > 1) {
@@ -528,8 +522,8 @@

        return (PyObject *)self;
    }
    PyErr_SetString(PyExc_RuntimeError, "could not create encoder object");
    return NULL;
 }

 PyObject *
@@ -576,7 +570,7 @@
            &mode,
            &is_single_frame
        )) {
        return NULL;
    }

    is_first_frame = (self->frame_index == -1);
@@ -626,25 +620,25 @@

    result = avifRGBImageAllocatePixels(&rgb);
    if (result != AVIF_RESULT_OK) {
        PyErr_Format(
            exc_type_for_avif_result(result),
            "Pixel allocation failed: %s",
            avifResultToString(result)
        );
        return NULL;
    }

    if (rgb.rowBytes * rgb.height != size) {
        PyErr_Format(
            PyExc_RuntimeError,
            "rgb data is incorrect size: %u * %u (%u) != %u",
            rgb.rowBytes,
            rgb.height,
            rgb.rowBytes * rgb.height,
            size
        );
        ret = NULL;
        goto end;
    }

    // rgb.pixels is safe for writes
@@ -654,13 +648,13 @@
    Py_END_ALLOW_THREADS

        if (result != AVIF_RESULT_OK) {
        PyErr_Format(
            exc_type_for_avif_result(result),
            "Conversion to YUV failed: %s",
            avifResultToString(result)
        );
        ret = NULL;
        goto end;
    }

    uint32_t addImageFlags = AVIF_ADD_IMAGE_FLAG_NONE;
@@ -708,13 +702,13 @@
    Py_END_ALLOW_THREADS

        if (result != AVIF_RESULT_OK) {
        PyErr_Format(
            exc_type_for_avif_result(result),
            "Failed to finish encoding: %s",
            avifResultToString(result)
        );
        avifRWDataFree(&raw);
        return NULL;
    }

    ret = PyBytes_FromStringAndSize((char *)raw.data, raw.size);
@@ -748,8 +742,8 @@

    self = PyObject_New(AvifDecoderObject, &AvifDecoder_Type);
    if (!self) {
        PyErr_SetString(PyExc_RuntimeError, "could not create decoder object");
        return NULL;
    }
    self->decoder = NULL;

@@ -776,15 +770,15 @@
        PyBytes_GET_SIZE(self->data)
    );
    if (result != AVIF_RESULT_OK) {
        PyErr_Format(
            exc_type_for_avif_result(result),
            "Setting IO memory failed: %s",
            avifResultToString(result)
        );
        avifDecoderDestroy(self->decoder);
        self->decoder = NULL;
        Py_DECREF(self);
        return NULL;
    }

    result = avifDecoderParse(self->decoder);
@@ -875,18 +869,18 @@
    decoder = self->decoder;

    if (!PyArg_ParseTuple(args, "I", &frame_index)) {
        return NULL;
    }

    result = avifDecoderNthImage(decoder, frame_index);
    if (result != AVIF_RESULT_OK) {
        PyErr_Format(
            exc_type_for_avif_result(result),
            "Failed to decode frame %u: %s",
            decoder->imageIndex + 1,
            avifResultToString(result)
        );
        return NULL;
    }

    image = decoder->image;
@@ -906,31 +900,31 @@
    row_bytes = rgb.width * avifRGBImagePixelSize(&rgb);

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

    result = avifRGBImageAllocatePixels(&rgb);
    if (result != AVIF_RESULT_OK) {
        PyErr_Format(
            exc_type_for_avif_result(result),
            "Pixel allocation failed: %s",
            avifResultToString(result)
        );
        return NULL;
    }

    Py_BEGIN_ALLOW_THREADS result = avifImageYUVToRGB(image, &rgb);
    Py_END_ALLOW_THREADS

        if (result != AVIF_RESULT_OK) {
        PyErr_Format(
            exc_type_for_avif_result(result),
            "Conversion from YUV failed: %s",
            avifResultToString(result)
        );
        avifRGBImageFreePixels(&rgb);
        return NULL;
    }

    size = rgb.rowBytes * rgb.height;
 if (rgb.height > PY_SSIZE_T_MAX / row_bytes) { 
     PyErr_SetString(PyExc_MemoryError, "Integer overflow in pixel size"); 
     return NULL; 
 } 
 if (rgb.height > PY_SSIZE_T_MAX / row_bytes) { 
     PyErr_SetString(PyExc_MemoryError, "Integer overflow in pixel size"); 
     return NULL; 
 } 
@@ -1003,7 +997,7 @@
 static int
 setup_module(PyObject *m) {
    if (PyType_Ready(&AvifDecoder_Type) < 0 || PyType_Ready(&AvifEncoder_Type) < 0) {
        return -1;
    }

    PyObject *d = PyModule_GetDict(m);
@@ -1011,8 +1005,6 @@
     PyDict_SetItemString(d, "libavif_version", v ? v : Py_None);
     Py_XDECREF(v);
 
-    have_rav1e = _codec_available("rav1e", AVIF_CODEC_FLAG_CAN_ENCODE);
-
     return 0;
 }
 
@@ -1029,8 +1021,8 @@

    m = PyModule_Create(&module_def);
    if (setup_module(m) < 0) {
        Py_DECREF(m);
        return NULL;
    }

    return m;