Refactor image conversion (#1235)

* Refactor image conversion

- Refactored image conversion handling across various modules to use new framework functions for better clarity and maintainability.
- Now, there can be multiple possible image converters per frame stopping after the first success. But also, one converter can part of the work (e.g. dowload from GPU) while a later one converts it to the actual requested format.
- Replaced direct calls to `convert_image` with `mlt_frame_convert_image` and added checks for the existence of conversion functions.
- Improved documentation in YAML files to clarify the purpose of image conversion callbacks.
- Added tests to verify the correct propagation of image conversion functions through frames and producers.

* Apply suggestions from code review

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* fix early returns not releasing lock

* change a log to debug level

* add `mlt_frame_prepend_convert_image()`

* fix cppcheck and redundant workflow runs

* fix ctest on msvc

* mlt_frame_append_convert_image()

---------

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: ddennedy

.github/workflows/build-distros.yml

@@ -20,6 +20,9 @@ on:
           - debian-stable
           - fedora-44
           - fedora-38
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 
 jobs:
   build:

.github/workflows/build-linux.yml

@@ -1,6 +1,14 @@
 name: build-test-linux-on-push
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 
 jobs:
   python:

.github/workflows/build-msys2-mingw64.yml

@@ -1,6 +1,15 @@
 name: build-test-msys2-mingw64-on-push
 
-on: [push, pull_request, workflow_dispatch]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 
 jobs:
   build:

.github/workflows/build-windows-msvc.yml

@@ -1,6 +1,14 @@
 name: build-test-windows-msvc-on-push
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 
 permissions:
   packages: write
@@ -55,4 +63,4 @@ jobs:
 
       - name: Run tests
         run: |
-          ctest --test-dir build -C Debug
+          ctest --test-dir build -C Debug --rerun-failed --output-on-failure

.github/workflows/static-code-analysis.yml

@@ -1,6 +1,14 @@
 name: static-code-analysis
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 
 jobs:
   cppcheck:

CMakeLists.txt

@@ -103,7 +103,7 @@ endif()
 
 if(NOT EXISTS ${MLT_DATA_OUTPUT_DIRECTORY})
   if(WIN32) # symlinks require admin rights on Windows
-    file(COPY "${CMAKE_SOURCE_DIR}/src/modules" DESTINATION "${CMAKE_BINARY_DIR}/out/share" FILES_MATCHING REGEX yml|txt)
+    file(COPY "${CMAKE_SOURCE_DIR}/src/modules" DESTINATION "${CMAKE_BINARY_DIR}/out/share" FILES_MATCHING REGEX "yml|txt|ini|dict")
     file(RENAME "${CMAKE_BINARY_DIR}/out/share/modules" "${MLT_DATA_OUTPUT_DIRECTORY}")
     file(COPY "${CMAKE_SOURCE_DIR}/presets" DESTINATION "${MLT_DATA_OUTPUT_DIRECTORY}")
     file(COPY "${CMAKE_SOURCE_DIR}/profiles" DESTINATION "${MLT_DATA_OUTPUT_DIRECTORY}")

NEWS

@@ -1,6 +1,31 @@
 MLT Release Notes
 -----------------
 
+Version 7.42.0
+
+Framework
+  - Added list-based image-conversion callback dispatch on mlt_frame.
+    Use `mlt_frame_append_convert_image()` to register a converter instead of
+    setting `frame->convert_image` directly. Multiple converters are tried in
+    registration order; the first that succeeds wins. New public API:
+    - `mlt_frame_prepend_convert_image()`
+    - `mlt_frame_append_convert_image()`
+    - `mlt_frame_convert_image()`
+    - `mlt_frame_next_convert_image()`
+    - `mlt_frame_has_convert_image()`
+    - `mlt_frame_copy_convert_image()`
+  - API behavior change: `mlt_frame_s::convert_image` is now read-only after
+    init and is permanently set to the dispatcher `mlt_frame_convert_image()`.
+    External code that set this field directly to a custom function will no
+    longer have that function called. If you really need that (never heard of
+    someone who does), clear the frame's "_convert_image_callbacks" property
+    and use `mlt_frame_append_convert_image()` instead.
+
+Modules
+  - Image converters (`movit.convert`, `avcolor_space`, `imageconvert`) are
+    now attached data-driven via `loader.ini` key `image_convert`.
+
+
 Version 7.40.0
 
 Framework

makefile

@@ -29,4 +29,8 @@ cppcheck:
 		--include=src/framework/mlt_types.h \
 		--library=cppcheck.cfg \
 		--suppress=ctuOneDefinitionRuleViolation \
-		--suppress=syntaxError:src/modules/xml/common.c
+		--suppress=syntaxError:src/modules/xml/common.c \
+        --suppress=syntaxError:src/modules/placebo/filter_placebo_convert.c \
+        --suppress=syntaxError:src/modules/placebo/filter_placebo_render.c \
+        --suppress=syntaxError:src/modules/placebo/filter_placebo_shader.c \
+        --suppress=syntaxError:src/modules/placebo/gpu_context.c

src/framework/mlt.vers

@@ -687,3 +687,13 @@ MLT_7.36.0 {
     mlt_color_convert_trc;
     mlt_profile_is_valid;
 } MLT_7.34.0;
+
+MLT_7.40.0 {
+  global:
+    mlt_frame_append_convert_image;
+    mlt_frame_prepend_convert_image;
+    mlt_frame_has_convert_image;
+    mlt_frame_convert_image;
+    mlt_frame_next_convert_image;
+    mlt_frame_copy_convert_image;
+} MLT_7.36.0;