NCLX color profile rework (#66)

* Adds support for read nclx values and fixes #64

* CI & CD: trigger push analyze only on main branch

Author: bigcat88

.github/workflows/analysis-coverage.yml

@@ -8,6 +8,7 @@ on:
       - 'setup.*'
       - 'pyproject.toml'
   push:
+    branches: [master]
     paths:
       - 'pillow_heif/*.*'
       - 'tests/**'

CHANGELOG.md

@@ -2,16 +2,19 @@ _# Changelog
 
 All notable changes to this project will be documented in this file.
 
-## [0.9.1 - 202x-xx-xx]
+## [0.9.1 - 2023-01-xx]
 
 ### Added
 
 ### Changed
 
 - Drop support for Python 3.6
+- info["nclx_profile"] changed type from bytes(format of which was not described) to dict.
 
 ### Fixed
 
+- Small memory leak when opening image with `nclx` color profile. #64
+
 ## [0.9.0 - 2022-12-15]
 
 ### Added

docs/reference/HeifImage.rst

@@ -36,11 +36,9 @@ HeifImage object
         Possible values: ``prof`` or ``rICC``. Can be absent.
 
     .. py:attribute:: info["nclx_profile"]
-        :type: bytes
-
-        Can be absent. Maybe later, will be added some stuff to work with nclx profiles.
+        :type: dict
 
-        If you need it now, look at `public_api.h` for struct describing it in ``C`` language.
+        Can be absent. Look at `public_api.h` for struct describing it in ``C`` language.
 
     .. py:attribute:: info["primary"]
         :type: bool

examples/heif_dump_info.py

@@ -32,7 +32,7 @@
             else:
                 print("\tICC: Empty")
         if image.info.get("nclx_profile", None):
-            print("\tNCLX:", "soon :)")
+            print("\tNCLX:", image.info["nclx_profile"])
         if image.info.get("exif", None):
             print("\tExif:")
             exif_dict = piexif.load(image.info["exif"], key_is_name=True)

examples/pillow_dump_info.py

@@ -29,7 +29,7 @@
             else:
                 print("\tICC: Empty")
         if image.info.get("nclx_profile", None):
-            print("\tNCLX:", "will do soon :)")
+            print("\tNCLX:", image.info["nclx_profile"])
         exif = image.getexif()
         if exif:
             exif = exif._get_merged_dict()  # noqa

pillow_heif/private.py

@@ -114,24 +114,38 @@ def get_pure_stride(mode: str, width: int) -> int:
 }
 
 
+NCLX_FIELDS = ("color_primaries", "transfer_characteristics", "matrix_coefficients", "full_range_flag")
+NCLX_DECODE_ONLY_FIELDS = (
+    "color_primary_red_x",
+    "color_primary_red_y",
+    "color_primary_green_x",
+    "color_primary_green_y",
+    "color_primary_blue_x",
+    "color_primary_blue_y",
+    "color_primary_white_x",
+    "color_primary_white_y",
+)
+
+
 def read_color_profile(handle) -> dict:
     profile_type = lib.heif_image_handle_get_color_profile_type(handle)
     if profile_type == HeifColorProfileType.NOT_PRESENT:
         return {}
     if profile_type == HeifColorProfileType.NCLX:
-        _type = "nclx"
         pp_data = ffi.new("struct heif_color_profile_nclx **")
-        data_length = ffi.sizeof("struct heif_color_profile_nclx")
         error = lib.heif_image_handle_get_nclx_color_profile(handle, pp_data)
-        p_data = pp_data[0]
+        check_libheif_error(error)
+        libheif_nclx_profile = pp_data[0]
         ffi.release(pp_data)
-    else:
-        _type = "prof" if profile_type == HeifColorProfileType.PROF else "rICC"
-        data_length = lib.heif_image_handle_get_raw_color_profile_size(handle)
-        if data_length == 0:
-            return {"type": _type, "data": b""}
-        p_data = ffi.new("char[]", data_length)
-        error = lib.heif_image_handle_get_raw_color_profile(handle, p_data)
+        nclx_profile = {i: getattr(libheif_nclx_profile, i) for i in NCLX_FIELDS + NCLX_DECODE_ONLY_FIELDS}
+        lib.heif_nclx_color_profile_free(libheif_nclx_profile)
+        return {"type": "nclx", "data": nclx_profile}
+    _type = "prof" if profile_type == HeifColorProfileType.PROF else "rICC"
+    data_length = lib.heif_image_handle_get_raw_color_profile_size(handle)
+    if data_length == 0:
+        return {"type": _type, "data": b""}
+    p_data = ffi.new("char[]", data_length)
+    error = lib.heif_image_handle_get_raw_color_profile(handle, p_data)
     check_libheif_error(error)
     data_buffer = ffi.buffer(p_data, data_length)
     return {"type": _type, "data": bytes(data_buffer)}
@@ -146,10 +160,14 @@ def set_color_profile(heif_img, info: dict) -> None:
         )
         check_libheif_error(error)
     elif info.get("nclx_profile", None):
-        error = lib.heif_image_set_nclx_color_profile(
-            heif_img,
-            ffi.cast("const struct heif_color_profile_nclx*", ffi.from_buffer(info["nclx_profile"])),
-        )
+        nclx_profile = info["nclx_profile"]
+        libheif_nclx_profile = lib.heif_nclx_color_profile_alloc()
+        for i in NCLX_FIELDS:
+            v = nclx_profile.get(i, None)
+            if v is not None:
+                setattr(libheif_nclx_profile, i, v)
+        error = lib.heif_image_set_nclx_color_profile(heif_img, libheif_nclx_profile)
+        lib.heif_nclx_color_profile_free(libheif_nclx_profile)
         check_libheif_error(error)
 
 

tests/helpers.py

@@ -112,7 +112,8 @@ def compare_images_fields(heif_image: Union[HeifImage, HeifThumbnail], pillow_im
                     assert heif_image.info[k] == pillow_image.info[k]
                 else:
                     assert len(heif_image.info[k]) == len(pillow_image.info[k])
-        for k in ("icc_profile", "icc_profile_type", "nclx_profile"):
+        assert heif_image.info.get("nclx_profile", None) == pillow_image.info.get("nclx_profile", None)
+        for k in ("icc_profile", "icc_profile_type"):
             if heif_image.info.get(k, None):
                 assert len(heif_image.info[k]) == len(pillow_image.info[k])
 

tests/leaks_test.py

@@ -79,3 +79,20 @@ def test_open_to_numpy_mem_leaks():
             mem_limit = mem + 1
             continue
         assert mem <= mem_limit, f"memory usage limit exceeded after {i + 1} iterations"
+
+
+@pytest.mark.skipif(sys.platform.lower() == "win32", reason="requires Unix or macOS")
+@pytest.mark.skipif(machine().find("x86_64") == -1, reason="run only on x86_64")
+def test_nclx_profile_leaks():
+    mem_limit = None
+    im_path = Path("images/heif_other/cat.hif")
+    heif_file = pillow_heif.open_heif(im_path, convert_hdr_to_8bit=False)
+    for i in range(800):
+        _nclx = pillow_heif.private.read_color_profile(heif_file[0]._handle)  # noqa
+        _nclx = None  # noqa
+        gc.collect()
+        mem = _get_mem_usage()
+        if i < 300:
+            mem_limit = mem + 1
+            continue
+        assert mem <= mem_limit, f"memory usage limit exceeded after {i + 1} iterations"