Add placebo.convert filter

ddennedy · ddennedy · commit ce993648a248 · 2026-05-05T22:29:46.000-07:00
- Introduced new `mlt_image_private` format for module internal use.
- Improved placebo texture reuse across filters.
diff --git a/src/framework/mlt_frame.c b/src/framework/mlt_frame.c
@@ -448,6 +448,7 @@ static int generate_test_image(mlt_properties properties,
         case mlt_image_none:
         case mlt_image_movit:
         case mlt_image_opengl_texture:
+        case mlt_image_private:
             *format = mlt_image_yuv422;
             break;
         case mlt_image_invalid:
@@ -1113,15 +1114,13 @@ mlt_frame mlt_frame_clone(mlt_frame self, int is_deep)
         }
         size = 0;
         data = mlt_properties_get_data(properties, "image", &size);
-        if (data && mlt_image_movit != mlt_properties_get_int(properties, "format")) {
+        mlt_image_format format = mlt_properties_get_int(properties, "format");
+        if (data && format != mlt_image_movit && format != mlt_image_private) {
             int width = mlt_properties_get_int(properties, "width");
             int height = mlt_properties_get_int(properties, "height");
 
             if (!size)
-                size = mlt_image_format_size(mlt_properties_get_int(properties, "format"),
-                                             width,
-                                             height,
-                                             NULL);
+                size = mlt_image_format_size(format, width, height, NULL);
             copy = mlt_pool_alloc(size);
             memcpy(copy, data, size);
             mlt_properties_set_data(new_props, "image", copy, size, mlt_pool_release, NULL);
@@ -1255,15 +1254,13 @@ mlt_frame mlt_frame_clone_image(mlt_frame self, int is_deep)
 
     if (is_deep) {
         data = mlt_properties_get_data(properties, "image", &size);
-        if (data && mlt_image_movit != mlt_properties_get_int(properties, "format")) {
+        mlt_image_format format = mlt_properties_get_int(properties, "format");
+        if (data && format != mlt_image_movit && format != mlt_image_private) {
             int width = mlt_properties_get_int(properties, "width");
             int height = mlt_properties_get_int(properties, "height");
 
             if (!size)
-                size = mlt_image_format_size(mlt_properties_get_int(properties, "format"),
-                                             width,
-                                             height,
-                                             NULL);
+                size = mlt_image_format_size(format, width, height, NULL);
             copy = mlt_pool_alloc(size);
             memcpy(copy, data, size);
             mlt_properties_set_data(new_props, "image", copy, size, mlt_pool_release, NULL);
diff --git a/src/framework/mlt_image.c b/src/framework/mlt_image.c
@@ -188,7 +188,8 @@ int mlt_image_calculate_size(mlt_image self)
         return self->width * self->height * 3 / 2;
     case mlt_image_movit:
     case mlt_image_opengl_texture:
-        return 4;
+    case mlt_image_private:
+        return sizeof(void *);
     case mlt_image_yuv422p16:
         return self->width * self->height * 4;
     case mlt_image_yuv420p10:
@@ -228,6 +229,8 @@ const char *mlt_image_format_name(mlt_image_format format)
         return "glsl";
     case mlt_image_opengl_texture:
         return "opengl_texture";
+    case mlt_image_private:
+        return "private";
     case mlt_image_yuv422p16:
         return "yuv422p16";
     case mlt_image_yuv420p10:
@@ -489,6 +492,7 @@ mlt_colorspace mlt_image_default_colorspace(mlt_image_format format, int height)
     case mlt_image_rgba64:
     case mlt_image_movit:
     case mlt_image_opengl_texture:
+    case mlt_image_private:
         colorspace = mlt_colorspace_rgb;
         break;
     case mlt_image_yuv422:
@@ -605,6 +609,7 @@ void mlt_image_fill_black(mlt_image self)
     case mlt_image_none:
     case mlt_image_movit:
     case mlt_image_opengl_texture:
+    case mlt_image_private:
         return;
     case mlt_image_rgb:
     case mlt_image_rgba:
@@ -693,6 +698,7 @@ void mlt_image_fill_checkerboard(mlt_image self, double sample_aspect_ratio)
     case mlt_image_none:
     case mlt_image_movit:
     case mlt_image_opengl_texture:
+    case mlt_image_private:
         return;
     case mlt_image_rgb:
     case mlt_image_rgba: {
@@ -798,6 +804,7 @@ void mlt_image_fill_white(mlt_image self, int full_range)
     case mlt_image_none:
     case mlt_image_movit:
     case mlt_image_opengl_texture:
+    case mlt_image_private:
         return;
     case mlt_image_rgb:
     case mlt_image_rgba:
@@ -952,9 +959,10 @@ int mlt_image_format_size(mlt_image_format format, int width, int height, int *b
         return width * height * 3 / 2;
     case mlt_image_movit:
     case mlt_image_opengl_texture:
+    case mlt_image_private:
         if (bpp)
             *bpp = 0;
-        return 4;
+        return sizeof(void *);
     case mlt_image_yuv422p16:
         if (bpp)
             *bpp = 4;
diff --git a/src/framework/mlt_types.h b/src/framework/mlt_types.h
@@ -2,7 +2,7 @@
  * \file mlt_types.h
  * \brief Provides forward definitions of all public types
  *
- * Copyright (C) 2003-2025 Meltytech, LLC
+ * Copyright (C) 2003-2026 Meltytech, LLC
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -49,7 +49,8 @@ typedef enum {
     mlt_image_yuv420p10, /**< planar YUV 4:2:0, 15bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian */
     mlt_image_yuv444p10, /**< planar YUV 4:4:4, 30bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian */
     mlt_image_rgba64, /**< 16-bit RGB with alpha channel */
-    mlt_image_invalid
+    mlt_image_invalid,
+    mlt_image_private /**< for module internal use only */
 } mlt_image_format;
 
 /** The set of supported audio formats */
diff --git a/src/modules/avformat/common.c b/src/modules/avformat/common.c
@@ -322,6 +322,7 @@ int mlt_to_av_image_format(mlt_image_format format)
         return AV_PIX_FMT_RGBA64LE;
     case mlt_image_movit:
     case mlt_image_opengl_texture:
+    case mlt_image_private:
     case mlt_image_invalid:
         mlt_log_error(NULL,
                       "[filter_avfilter] Unexpected image format: %s\n",
@@ -339,6 +340,7 @@ mlt_image_format mlt_get_supported_image_format(mlt_image_format format)
     case mlt_image_none:
     case mlt_image_movit:
     case mlt_image_opengl_texture:
+    case mlt_image_private:
     case mlt_image_rgba:
         return mlt_image_rgba;
     case mlt_image_rgb:
diff --git a/src/modules/avformat/filter_avcolour_space.c b/src/modules/avformat/filter_avcolour_space.c
@@ -153,6 +153,14 @@ static int convert_image(mlt_frame frame,
     mlt_properties_clear(properties, "convert_image_height");
 
     if (*format != output_format || out_width) {
+        if (*format == mlt_image_none || *format == mlt_image_movit
+            || *format == mlt_image_opengl_texture || *format == mlt_image_private
+            || *format == mlt_image_invalid || output_format == mlt_image_none
+            || output_format == mlt_image_movit || output_format == mlt_image_opengl_texture
+            || output_format == mlt_image_private || output_format == mlt_image_invalid) {
+            return 1;
+        }
+
         mlt_profile profile = mlt_service_profile(
             MLT_PRODUCER_SERVICE(mlt_frame_get_original_producer(frame)));
         int width = mlt_properties_get_int(properties, "width");
diff --git a/src/modules/avformat/filter_sws_colortransform.c b/src/modules/avformat/filter_sws_colortransform.c
@@ -54,7 +54,7 @@ static int filter_get_image(mlt_frame frame,
 
     // Only process if we have a valid image
     if (!*image || *format == mlt_image_none || *format == mlt_image_movit
-        || *format == mlt_image_opengl_texture)
+        || *format == mlt_image_opengl_texture || *format == mlt_image_private)
         return 0;
 
     // Get the current color transfer characteristics
diff --git a/src/modules/avformat/link_avdeinterlace.c b/src/modules/avformat/link_avdeinterlace.c
@@ -82,6 +82,7 @@ static mlt_image_format validate_format(mlt_image_format format)
     case mlt_image_none:
     case mlt_image_movit:
     case mlt_image_opengl_texture:
+    case mlt_image_private:
     case mlt_image_invalid:
         ret_format = mlt_image_yuv422;
         break;
diff --git a/src/modules/avformat/producer_avformat.c b/src/modules/avformat/producer_avformat.c
@@ -827,8 +827,9 @@ static mlt_image_format pick_image_format(enum AVPixelFormat pix_fmt,
                                           mlt_image_format current_format)
 {
     if (current_format == mlt_image_none || current_format == mlt_image_movit
-        || pix_fmt == AV_PIX_FMT_ARGB || pix_fmt == AV_PIX_FMT_RGBA || pix_fmt == AV_PIX_FMT_ABGR
-        || pix_fmt == AV_PIX_FMT_BGRA || pix_fmt == AV_PIX_FMT_GBRAP) {
+        || current_format == mlt_image_private || pix_fmt == AV_PIX_FMT_ARGB
+        || pix_fmt == AV_PIX_FMT_RGBA || pix_fmt == AV_PIX_FMT_ABGR || pix_fmt == AV_PIX_FMT_BGRA
+        || pix_fmt == AV_PIX_FMT_GBRAP) {
         switch (pix_fmt) {
         case AV_PIX_FMT_ARGB:
         case AV_PIX_FMT_RGBA:
@@ -2516,6 +2517,7 @@ static void convert_image(producer_avformat self,
     case mlt_image_yuv422:
     case mlt_image_movit:
     case mlt_image_opengl_texture:
+    case mlt_image_private:
     case mlt_image_invalid:
         break;
     }
diff --git a/src/modules/core/filter_brightness.c b/src/modules/core/filter_brightness.c
@@ -175,6 +175,7 @@ static int filter_get_image(mlt_frame frame,
             break;
         case mlt_image_movit:
         case mlt_image_opengl_texture:
+        case mlt_image_private:
             *format = mlt_image_rgba;
             break;
         case mlt_image_none:
diff --git a/src/modules/core/filter_color_transform.c b/src/modules/core/filter_color_transform.c
@@ -147,6 +147,7 @@ static void ensure_color_properties(mlt_filter self, mlt_frame frame)
         case mlt_image_rgba64:
         case mlt_image_movit:
         case mlt_image_opengl_texture:
+        case mlt_image_private:
             full_range = 1;
             break;
         case mlt_image_yuv422:
@@ -182,7 +183,8 @@ static int filter_get_image(mlt_frame frame,
     mlt_properties filter_properties = MLT_FILTER_PROPERTIES(self);
     mlt_image_format requested_format = *format;
     int ret = mlt_frame_get_image(frame, image, format, width, height, writable);
-    if (ret || requested_format == mlt_image_movit || requested_format == mlt_image_none)
+    if (ret || requested_format == mlt_image_movit || requested_format == mlt_image_private
+        || requested_format == mlt_image_none)
         return ret;
 
     const char *out_trc_str = mlt_properties_get(filter_properties, "force_trc");
diff --git a/src/modules/core/loader.ini b/src/modules/core/loader.ini
@@ -7,7 +7,7 @@
 # the second and third are applied as applicable).
 
 # image filters
-image_convert=movit.convert,avcolor_space,imageconvert
+image_convert=placebo.convert,movit.convert,avcolor_space,imageconvert
 color=color_transform
 deinterlace=deinterlace,avdeinterlace
 fieldorder=fieldorder
diff --git a/src/modules/core/producer_colour.c b/src/modules/core/producer_colour.c
@@ -94,7 +94,7 @@ static int producer_get_image(mlt_frame frame,
         *format = mlt_image_format_id(mlt_properties_get(producer_props, "mlt_image_format"));
 
     // Choose suitable out values if nothing specific requested
-    if (*format == mlt_image_none || *format == mlt_image_movit)
+    if (*format == mlt_image_none || *format == mlt_image_movit || *format == mlt_image_private)
         *format = mlt_image_rgba;
     // Optimize the format to avoid unnecessary conversion
     if ((requested_format == mlt_image_rgba && *format == mlt_image_rgba64)
@@ -109,7 +109,7 @@ static int producer_get_image(mlt_frame frame,
     // Choose default image format if specific request is unsupported
     if (*format != mlt_image_yuv420p && *format != mlt_image_yuv422 && *format != mlt_image_rgb
         && *format != mlt_image_movit && *format != mlt_image_opengl_texture
-        && *format != mlt_image_rgba64)
+        && *format != mlt_image_private && *format != mlt_image_rgba64)
         *format = mlt_image_rgba;
 
     // See if we need to regenerate
@@ -182,6 +182,7 @@ static int producer_get_image(mlt_frame frame,
                 break;
             case mlt_image_movit:
             case mlt_image_opengl_texture:
+            case mlt_image_private:
                 memset(p, 0, size);
                 break;
             case mlt_image_rgba:
diff --git a/src/modules/placebo/CMakeLists.txt b/src/modules/placebo/CMakeLists.txt
@@ -7,6 +7,7 @@ endif()
 add_library(mltplacebo MODULE
   factory.c
   gpu_context.c gpu_context.h
+  filter_placebo_convert.c
   filter_placebo_render.c
   filter_placebo_shader.c
 )
@@ -49,6 +50,7 @@ set_target_properties(mltplacebo PROPERTIES
 install(TARGETS mltplacebo LIBRARY DESTINATION ${MLT_INSTALL_MODULE_DIR})
 
 install(FILES
+  filter_placebo_convert.yml
   filter_placebo_render.yml
   filter_placebo_shader.yml
   DESTINATION ${MLT_INSTALL_DATA_DIR}/placebo
diff --git a/src/modules/placebo/factory.c b/src/modules/placebo/factory.c
@@ -26,6 +26,10 @@ extern mlt_filter filter_placebo_render_init(mlt_profile profile,
                                              mlt_service_type type,
                                              const char *id,
                                              char *arg);
+extern mlt_filter filter_placebo_convert_init(mlt_profile profile,
+                                              mlt_service_type type,
+                                              const char *id,
+                                              char *arg);
 extern mlt_filter filter_placebo_shader_init(mlt_profile profile,
                                              mlt_service_type type,
                                              const char *id,
@@ -40,8 +44,13 @@ static mlt_properties metadata(mlt_service_type type, const char *id, void *data
 
 MLTPLACEBO_EXPORT MLT_REPOSITORY
 {
+    MLT_REGISTER(mlt_service_filter_type, "placebo.convert", filter_placebo_convert_init);
     MLT_REGISTER(mlt_service_filter_type, "placebo.render", filter_placebo_render_init);
     MLT_REGISTER(mlt_service_filter_type, "placebo.shader", filter_placebo_shader_init);
+    MLT_REGISTER_METADATA(mlt_service_filter_type,
+                          "placebo.convert",
+                          metadata,
+                          "filter_placebo_convert.yml");
     MLT_REGISTER_METADATA(mlt_service_filter_type,
                           "placebo.render",
                           metadata,
diff --git a/src/modules/placebo/filter_placebo_convert.c b/src/modules/placebo/filter_placebo_convert.c
diff --git a/src/modules/placebo/filter_placebo_convert.yml b/src/modules/placebo/filter_placebo_convert.yml
diff --git a/src/modules/placebo/filter_placebo_render.c b/src/modules/placebo/filter_placebo_render.c
diff --git a/src/modules/placebo/filter_placebo_shader.c b/src/modules/placebo/filter_placebo_shader.c
diff --git a/src/modules/placebo/gpu_context.c b/src/modules/placebo/gpu_context.c
diff --git a/src/modules/placebo/gpu_context.h b/src/modules/placebo/gpu_context.h
