write 10bit HDR10PQ AVIF image

Author: manoreken2

README.md

@@ -1,8 +1,4 @@
-# pillow-avif-plugin
-
-This is a plugin that adds support for AVIF files until official support has been added (see [this pull request](https://github.com/python-pillow/Pillow/pull/5201)).
-
-To register this plugin with pillow you will need to add `import pillow_avif` somewhere in your application.
+# pillow-avif-plugin quick hack to support HDR10 ouput
 
 ## how to build and install on Windows
 
@@ -12,12 +8,30 @@ To register this plugin with pillow you will need to add `import pillow_avif` so
 - install TortoiseGit
 - install MSYS2 and add C:\MSYS\usr\bin to PATH environment variable
 - download https://www.nasm.us/pub/nasm/releasebuilds/2.15.05/win64/nasm-2.15.05-win64.zip , unzip onto C:\apps\NASM and add D:\apps\NASM to PATH environment variable.
-- on Administrator miniforge prompt, pip install pillow meson
+- on Administrator miniforge prompt, pip install meson
+- build and install quick hack pillow to support R16G16B16 https://github.com/manoreken2/Pillow/tree/main/winbuild
 - on Administrator miniforge prompt, cd to this directory, cd winbuild and python build_prepare.py
 - cd winbuild/build and build_dep_all.cmd and build_pillow_avif_plugin.cmd
 - cd to this directory and python -m pip install -e .
 - pip list should show pillow-avif-plugin
 
+## how to write HDR10PQ AVIF file
+
+```
+from PIL import Image
+from pillow_avif import AvifImagePlugin
+from pillow_avif import _avif
+import cv2
+
+imCV = cv2.imread("a.png", cv2.IMREAD_UNCHANGED)
+imCV = cv2.cvtColor(imCV, cv2.COLOR_BGR2RGB)
+
+print("imCV {0} {1}".format(imCV.dtype, imCV.shape))
+
+im = Image.fromarray(imCV, mode="R16G16B16")
+im.save("out.avif", quality=100, range="full", subsampling="4:4:4", depth=10, color_primaries=9, transfer_characteristics=16, matrix_coefficients=0)
+```
+
 ## encoding options
 
 ## "qmin"

src/pillow_avif/AvifImagePlugin.py

@@ -17,7 +17,7 @@
 DECODE_CODEC_CHOICE = "auto"
 CHROMA_UPSAMPLING = "auto"
 
-_VALID_AVIF_MODES = {"RGB", "RGBA"}
+_VALID_AVIF_MODES = {"RGB", "RGBA", "R16G16B16"}
 
 
 if sys.version_info[0] == 2:
@@ -147,6 +147,7 @@ def _save(im, fp, filename, save_all=False):
     speed = info.get("speed", 6)
     codec = info.get("codec", "auto")
     range_ = info.get("range", "full")
+    depth = info.get("depth", 8)
 
     color_primaries = info.get("color_primaries", 1)
     transfer_characteristics = info.get("transfer_characteristics", 1)
@@ -195,7 +196,7 @@ def _save(im, fp, filename, save_all=False):
         speed,
         codec,
         range_,
-        qcolor,
+        depth,
         color_primaries,
         transfer_characteristics,
         matrix_coefficients,
@@ -225,7 +226,13 @@ def _save(im, fp, filename, save_all=False):
                 # Make sure image mode is supported
                 frame = ims
                 rawmode = ims.mode
+
+                print("AvifImagePlugin.py _save rawmode={0}".format(rawmode))
+
                 if ims.mode not in _VALID_AVIF_MODES:
+                    
+                    print("AvifImagePlugin.py _save ims.mode is not valid avif mode. converting. {0}".format(ims.mode))
+
                     alpha = (
                         "A" in ims.mode
                         or "a" in ims.mode
@@ -241,6 +248,9 @@ def _save(im, fp, filename, save_all=False):
                     frame_dur = duration
 
                 # Append the frame to the animation encoder
+
+                print("AvifImagePlugin.py _save enc.add start")
+
                 enc.add(
                     frame.tobytes("raw", rawmode),
                     frame_dur,
@@ -250,6 +260,8 @@ def _save(im, fp, filename, save_all=False):
                     is_single_frame,
                 )
 
+                print("AvifImagePlugin.py _save enc.add end")
+
                 # Update frame index
                 frame_idx += 1
 
@@ -266,6 +278,8 @@ def _save(im, fp, filename, save_all=False):
 
     fp.write(data)
 
+    print("AvifImagePlugin.py _save end.")
+
 
 Image.register_open(AvifImageFile.format, AvifImageFile, _accept)
 if SUPPORTED:

src/pillow_avif/_avif.c

@@ -202,6 +202,8 @@ AvifEncoderNew(PyObject *self_, PyObject *args) {
     AvifEncoderObject *self = NULL;
     avifEncoder *encoder = NULL;
 
+    printf("%s:%d AvifEncoderNew\n", __FILE__, __LINE__);
+
     char *subsampling = "4:2:0";
     int qmin = AVIF_QUANTIZER_BEST_QUALITY;  // =0
     int qmax = 10;                           // "High Quality", but not lossless
@@ -226,7 +228,7 @@ AvifEncoderNew(PyObject *self_, PyObject *args) {
 
     if (!PyArg_ParseTuple(
             args,
-            "IIsiiissiiOOSSSO",
+            "IIsiiissiiiiiiOOSSSO",
             &width,
             &height,
             &subsampling,
@@ -346,6 +348,24 @@ AvifEncoderNew(PyObject *self_, PyObject *args) {
         _add_codec_specific_options(encoder, advanced);
 #endif
 
+        printf(
+            " maxT=%d qmin=%d qmax=%d codec=%d speed=%d yuvRange=%d subsampling=%d "
+            "color_primaries=%d transferCharacteristics=%d matrix_coefficients=%d "
+            "width=%d height=%d depth=%d\n",
+            max_threads,
+            enc_options.qmin,
+            enc_options.qmax,
+            (int)enc_options.codec,
+            enc_options.speed,
+            (int)enc_options.range,
+            (int)enc_options.subsampling,
+            color_primaries,
+            transfer_characteristics,
+            matrix_coefficients,
+            width,
+            height,
+            depth);
+
         self->encoder = encoder;
 
         avifImage *image = avifImageCreateEmpty();
@@ -431,6 +451,8 @@ _encoder_add(AvifEncoderObject *self, PyObject *args) {
     avifImage *image = self->image;
     avifImage *frame = NULL;
 
+    printf("%s:%d _encoder_add\n", __FILE__, __LINE__);
+
     if (!PyArg_ParseTuple(
             args,
             "z#IIIsO",
@@ -483,16 +505,21 @@ _encoder_add(AvifEncoderObject *self, PyObject *args) {
     rgb.depth = self->image->depth;
 
     if (strcmp(mode, "RGBA") == 0) {
+        printf("%s:%d mode=%s\n", __FILE__, __LINE__, mode);
         rgb.format = AVIF_RGB_FORMAT_RGBA;
         channels = 4;
     } else {
+        printf("%s:%d mode=%s\n", __FILE__, __LINE__, mode);
         rgb.format = AVIF_RGB_FORMAT_RGB;
         channels = 3;
     }
 
     avifRGBImageAllocatePixels(&rgb);
 
+    printf(" rgb.rowBytes=%u rgb.height=%u size=%d\n", rgb.rowBytes, rgb.height, (int)size);
+
     if (rgb.rowBytes * rgb.height != size) {
+        printf("%s:%d\n", __FILE__, __LINE__);
         PyErr_Format(
             PyExc_RuntimeError,
             "rgb data is incorrect size: %u * %u (%u) != %zd",
@@ -505,13 +532,39 @@ _encoder_add(AvifEncoderObject *self, PyObject *args) {
     }
 
     // rgb.pixels is safe for writes
-    memcpy(rgb.pixels, rgb_bytes, size);
+    {
+        int w = 0;
+        const uint16_t *hR = (const uint16_t *)rgb_bytes;
+        uint16_t *hW = (uint16_t *)rgb.pixels;
+        switch (frame->depth) {
+            case 8:
+                // original code path.
+                memcpy(rgb.pixels, rgb_bytes, size);
+                break;
+            case 10:
+                // R16G16B16 16bit => 10bit
+                for (int i = 0; i < rgb.width * rgb.height * 3; ++i) {
+                    hW[i] = hR[i] >> 6;
+                }
+                break;
+            case 12:
+                // R16G16B16 16bit => 12bit
+                for (int i = 0; i < rgb.width * rgb.height * 3; ++i) {
+                    hW[i] = hR[i] >> 4;
+                }
+                break;
+            default:
+                assert(0);
+                break;
+        }
+    }
 
     Py_BEGIN_ALLOW_THREADS
     result = avifImageRGBToYUV(frame, &rgb);
     Py_END_ALLOW_THREADS
 
     if (result != AVIF_RESULT_OK) {
+        printf("%s:%d\n", __FILE__, __LINE__);
         PyErr_Format(
             exc_type_for_avif_result(result),
             "Conversion to YUV failed: %s",
@@ -522,6 +575,7 @@ _encoder_add(AvifEncoderObject *self, PyObject *args) {
 
     uint32_t addImageFlags = AVIF_ADD_IMAGE_FLAG_NONE;
     if (PyObject_IsTrue(is_single_frame)) {
+        printf("%s:%d\n", __FILE__, __LINE__);
         addImageFlags |= AVIF_ADD_IMAGE_FLAG_SINGLE;
     }
 
@@ -530,6 +584,7 @@ _encoder_add(AvifEncoderObject *self, PyObject *args) {
     Py_END_ALLOW_THREADS
 
     if (result != AVIF_RESULT_OK) {
+        printf("%s:%d\n", __FILE__, __LINE__);
         PyErr_Format(
             exc_type_for_avif_result(result),
             "Failed to encode image: %s",
@@ -539,15 +594,19 @@ _encoder_add(AvifEncoderObject *self, PyObject *args) {
     }
 
 end:
+    printf("%s:%d\n", __FILE__, __LINE__);
     avifRGBImageFreePixels(&rgb);
     if (!is_first_frame) {
+        printf("%s:%d\n", __FILE__, __LINE__);
         avifImageDestroy(frame);
     }
 
     if (ret == Py_None) {
+        printf("%s:%d _encoder_add success. frame_index=%d\n", __FILE__, __LINE__, self->frame_index);
         self->frame_index++;
         Py_RETURN_NONE;
     } else {
+        printf("%s:%d error\n", __FILE__, __LINE__);
         return ret;
     }
 }
@@ -556,6 +615,8 @@ PyObject *
 _encoder_finish(AvifEncoderObject *self) {
     avifEncoder *encoder = self->encoder;
 
+    printf("%s:%d _encoder_finish\n", __FILE__, __LINE__);
+
     avifRWData raw = AVIF_DATA_EMPTY;
     avifResult result;
     PyObject *ret = NULL;