- add some debug logging

- add an option for dumping the engine render layers
- fix omxplayer view updates when using locales that use `,` as the decimal separator

Author: ardera

CMakeLists.txt

@@ -34,7 +34,8 @@ project(flutter-pi LANGUAGES C VERSION "1.0.0")
 message(STATUS "Generator .............. ${CMAKE_GENERATOR}")
 message(STATUS "Build Type ............. ${CMAKE_BUILD_TYPE}")
 
-OPTION(OMXPLAYER_SUPPORTS_RUNTIME_ROTATION "Whether omxplayer supports runtime rotation." OFF)
+option(OMXPLAYER_SUPPORTS_RUNTIME_ROTATION "Whether omxplayer supports runtime rotation." OFF)
+option(DUMP_ENGINE_LAYERS "True if flutter-pi should dump the list of rendering layers that the flutter engine sends to flutter-pi on each draw." OFF)
 
 if(NOT FLUTTER_EMBEDDER_HEADER)
 

include/collection.h

@@ -421,7 +421,7 @@ static inline uint64_t get_monotonic_time(void) {
 
 #ifdef DEBUG
 #define DEBUG_ASSERT(__cond) assert(__cond)
-#define DEBUG_ASSERT_MSG(__cond, __msg) assert((__msg, (__cond))
+#define DEBUG_ASSERT_MSG(__cond, __msg) assert((__cond) && __msg)
 #else
 #define DEBUG_ASSERT(__cond) do {} while (false)
 #define DEBUG_ASSERT_MSG(__cond, __msg) do {} while (false)

src/compositor.c

@@ -21,6 +21,13 @@
 #include <compositor.h>
 #include <cursor.h>
 
+#define LOG_ERROR(...) fprintf(stderr, "[compositor] " __VA_ARGS__)
+#ifdef DEBUG
+#	define LOG_DEBUG(...) fprintf(stderr, "[compositor] " __VA_ARGS__)
+#else
+#	define LOG_DEBUG(...) do {} while (0)
+#endif
+
 struct view_cb_data {
 	int64_t view_id;
 	platform_view_mount_cb mount;
@@ -1061,6 +1068,57 @@ static bool on_present_layers(
 	schedule_fake_page_flip_event = compositor->do_blocking_atomic_commits;
 	use_atomic_modesetting = drmdev->supports_atomic_modesetting;
 
+#ifdef DUMP_ENGINE_LAYERS
+	LOG_DEBUG("layers:\n");
+	for (int i = 0; i < layers_count; i++) {
+		if (layers[i]->type == kFlutterLayerContentTypeBackingStore) {
+			LOG_DEBUG("  backing store (offset: %f, %f. size: %f, %f)\n", layers[i]->offset.x, layers[i]->offset.y, layers[i]->size.width, layers[i]->size.height);
+		} else {
+			DEBUG_ASSERT(layers[i]->type == kFlutterLayerContentTypePlatformView);
+			
+			LOG_DEBUG("  platform view (id: %"PRId64", offset: %f, %f, size: %f, %f) mutations:\n", layers[i]->platform_view->identifier, layers[i]->offset.x, layers[i]->offset.y, layers[i]->size.width, layers[i]->size.height);
+			for (size_t j = 0; j < layers[i]->platform_view->mutations_count; j++) {
+				const FlutterPlatformViewMutation *mut = layers[i]->platform_view->mutations[j];
+				switch (mut->type) {
+					case kFlutterPlatformViewMutationTypeOpacity:
+						LOG_DEBUG("    opacity %f\n", mut->opacity);
+						break;
+					case kFlutterPlatformViewMutationTypeClipRect:
+						LOG_DEBUG("    clip rect (ltrb: %f, %f, %f, %f)\n", mut->clip_rect.left, mut->clip_rect.top, mut->clip_rect.right, mut->clip_rect.bottom);
+						break;
+					case kFlutterPlatformViewMutationTypeClipRoundedRect:
+						LOG_DEBUG(
+							"    clip rounded rect (ltrb: %f, %f, %f, %f, corner radii ul, ur, br, bl: %f, %f, %f, %f)\n",
+							mut->clip_rounded_rect.rect.left, mut->clip_rounded_rect.rect.top, mut->clip_rounded_rect.rect.right, mut->clip_rounded_rect.rect.bottom,
+							mut->clip_rounded_rect.upper_left_corner_radius,
+							mut->clip_rounded_rect.upper_right_corner_radius,
+							mut->clip_rounded_rect.lower_right_corner_radius,
+							mut->clip_rounded_rect.lower_left_corner_radius
+						);
+						break;
+					case kFlutterPlatformViewMutationTypeTransformation:
+						LOG_DEBUG(
+							"    transform (matrix: %f %f %f; %f %f %f; %f %f %f)\n",
+							mut->transformation.scaleX,
+							mut->transformation.skewX,
+							mut->transformation.transX,
+							mut->transformation.skewY,
+							mut->transformation.scaleY,
+							mut->transformation.transY,
+							mut->transformation.pers0,
+							mut->transformation.pers1,
+							mut->transformation.pers2
+						);
+						break;
+					default:
+						DEBUG_ASSERT_MSG(0, "invalid platform view mutation type\n");
+						break;
+				}
+			}
+		}
+	}
+#endif
+
 	req = NULL;
 	if (use_atomic_modesetting) {
 		ok = drmdev_new_atomic_req(compositor->drmdev, &req);
@@ -1414,7 +1472,8 @@ static bool on_present_layers(
 					legacy_rendertarget_set_mode && (plane->type == DRM_PLANE_TYPE_PRIMARY)
 				);
 			}
-		} else if (layers[i]->type == kFlutterLayerContentTypePlatformView) {
+		} else {
+			DEBUG_ASSERT(layers[i]->type == kFlutterLayerContentTypePlatformView);
 			cb_data = get_cbs_for_view_id_locked(layers[i]->platform_view->identifier);
 
 			if ((cb_data != NULL) && (cb_data->present != NULL)) {

src/plugins/omxplayer_video_player.c

@@ -26,6 +26,13 @@
 
 #include <plugins/omxplayer_video_player.h>
 
+#define LOG_ERROR(...) fprintf(stderr, "[omxplayer video player plugin] " __VA_ARGS__)
+#ifdef DEBUG
+#   define LOG_DEBUG(...) fprintf(stderr, "[omxplayer video player plugin] " __VA_ARGS__)
+#else
+#   define LOG_DEBUG(...) do {} while (0)
+#endif
+
 static struct {
     bool initialized;
 
@@ -190,18 +197,17 @@ static int on_mount(
         zpos = -126;
     }
 
-
     struct aa_rect rect = get_aa_bounding_rect(params->rect);
 
     return cqueue_enqueue(
         &player->mgr->task_queue,
         &(struct omxplayer_mgr_task) {
             .type = kUpdateView,
             .responsehandle = NULL,
-            .offset_x = rect.offset.x,
-            .offset_y = rect.offset.y,
-            .width = rect.size.x,
-            .height = rect.size.y,
+            .offset_x = round(rect.offset.x),
+            .offset_y = round(rect.offset.y),
+            .width = round(rect.size.x),
+            .height = round(rect.size.y),
             .zpos = zpos,
             .orientation = get_orientation_from_rotation(params->rotation)
         }
@@ -617,6 +623,8 @@ static void *mgr_entry(void *userdata) {
         goto fail_kill_registered_player;
     }
 
+
+    LOG_DEBUG("respond success on_create(). player_id: %" PRId64 "\n", mgr->player->player_id);
     // creation was a success! respond to the dart-side with our player id.
     platch_respond_success_std(task.responsehandle, &STDINT64(mgr->player->player_id));
 
@@ -761,14 +769,19 @@ static void *mgr_entry(void *userdata) {
             platch_respond_success_std(task.responsehandle, NULL);   
         } else if (task.type == kUpdateView) {
             char video_pos_str[256];
+
+            // Use integers here even if omxplayer supports floats because if we print floats,
+            // snprintf might use `,` as the decimal delimiter depending on the locale.
+            // This is only an issue because I set the application to be locale-aware using setlocale(LC_ALL, "")
+            // since that's needed for locale support.
             snprintf(
                 video_pos_str,
                 sizeof(video_pos_str),
-                "%f %f %f %f",
-                (double) task.offset_x,
-                (double) task.offset_y,
-                (double) (task.offset_x + task.width),
-                (double) (task.offset_y + task.height)
+                "%d %d %d %d",
+                task.offset_x,
+                task.offset_y,
+                task.offset_x + task.width,
+                task.offset_y + task.height
             );
 
             ok = sd_bus_call_method(
@@ -1019,6 +1032,8 @@ static int on_initialize(
         return respond_init_failed(responsehandle);
     }
 
+    LOG_DEBUG("on_initialize\n");
+
     return platch_respond_success_std(responsehandle, NULL);
 }
 
@@ -1110,6 +1125,15 @@ static int on_create(
         );
     }
 
+    LOG_DEBUG(
+        "on_create(sourceType: %s, asset: %s, uri: \"%s\", packageName: %s, formatHint: %s)\n",
+        source_type == kDataSourceTypeAsset ? "asset" : source_type == kDataSourceTypeNetwork ? "network" : "file",
+        asset,
+        uri,
+        package_name,
+        format_hint
+    );
+
     mgr = calloc(1, sizeof *mgr);
     if (mgr == NULL) {
         return platch_respond_native_error_std(responsehandle, ENOMEM);
@@ -1209,6 +1233,8 @@ static int on_dispose(
         return ok;
     }
 
+    LOG_DEBUG("on_dispose(%"PRId64")\n", player->player_id);
+
     return cqueue_enqueue(&player->mgr->task_queue, &(const struct omxplayer_mgr_task) {
         .type = kDispose,
         .responsehandle = responsehandle
@@ -1237,6 +1263,8 @@ static int on_set_looping(
         );
     }
 
+    LOG_DEBUG("on_set_looping(player_id: %"PRId64", looping: %s)\n", player->player_id, loop ? "yes" : "no");
+
     return cqueue_enqueue(&player->mgr->task_queue, &(const struct omxplayer_mgr_task) {
         .type = kSetLooping,
         .loop = loop,
@@ -1266,6 +1294,8 @@ static int on_set_volume(
         );
     }
 
+    LOG_DEBUG("on_set_volume(player_id: %"PRId64", volume: %f)\n", player->player_id, volume);
+
     return cqueue_enqueue(&player->mgr->task_queue, &(const struct omxplayer_mgr_task) {
         .type = kSetVolume,
         .volume = volume,
@@ -1283,6 +1313,8 @@ static int on_play(
     ok = get_player_from_map_arg(arg, &player, responsehandle);
     if (ok != 0) return ok;
 
+    LOG_DEBUG("on_play(player_id: %"PRId64")\n", player->player_id);
+
     return cqueue_enqueue(&player->mgr->task_queue, &(const struct omxplayer_mgr_task) {
         .type = kPlay,
         .responsehandle = responsehandle
@@ -1299,6 +1331,8 @@ static int on_get_position(
     ok = get_player_from_map_arg(arg, &player, responsehandle);
     if (ok != 0) return ok;
 
+    LOG_DEBUG("on_get_position(player_id: %"PRId64")\n", player->player_id);
+
     return cqueue_enqueue(&player->mgr->task_queue, &(const struct omxplayer_mgr_task) {
         .type = kGetPosition,
         .responsehandle = responsehandle
@@ -1327,6 +1361,8 @@ static int on_seek_to(
         );
     }
 
+    LOG_DEBUG("on_seek_to(player_id: %"PRId64", position: %"PRId64")\n", player->player_id, position);
+
     return cqueue_enqueue(&player->mgr->task_queue, &(const struct omxplayer_mgr_task) {
         .type = kSetPosition,
         .position = position,
@@ -1344,6 +1380,8 @@ static int on_pause(
     ok = get_player_from_map_arg(arg, &player, responsehandle);
     if (ok != 0) return ok;
 
+    LOG_DEBUG("on_pause(player_id: %"PRId64")\n", player->player_id);
+
     return cqueue_enqueue(&player->mgr->task_queue, &(const struct omxplayer_mgr_task) {
         .type = kPause,
         .responsehandle = responsehandle
@@ -1371,10 +1409,11 @@ static int on_create_platform_view(
             "Expected `arg['platformViewId']` to be an integer."
         );
     }
+
+    LOG_DEBUG("on_create_platform_view(player_id: %"PRId64", platform view id: %"PRId64")\n", player->player_id, view_id);
 
     if (player->has_view) {
-        fprintf(stderr, "[omxplayer_video_player plugin] Flutter attempted to register more than one platform view for one player instance.\n");
-        
+        LOG_ERROR("Flutter attempted to register more than one platform view for one player instance.\n");
         return platch_respond_illegal_arg_std(
             responsehandle,
             "Attempted to register more than one platform view for this player instance."
@@ -1421,22 +1460,16 @@ static int on_dispose_platform_view(
         );
     }
 
+    LOG_DEBUG("on_dispose_platform_view(player_id: %"PRId64", platform view id: %"PRId64")\n", player->player_id, view_id);
+
     if (player->view_id != view_id) {
-        fprintf(
-            stderr,
-            "[omxplayer_video_player plugin] Flutter attempted to dispose an omxplayer platform view that is not associated with this player.\n"
-        );
+        LOG_ERROR("Flutter attempted to dispose an omxplayer platform view that is not associated with this player.\n");
 
         return platch_respond_illegal_arg_std(responsehandle, "Attempted to dispose on omxplayer view that is not associated with `arg['playerId']`.");
     } else {
         ok = compositor_remove_view_callbacks(view_id);
         if (ok != 0) {
-            fprintf(
-                stderr,
-                "[omxplayer_video_player plugin] Could not remove view callbacks for platform view %" PRId64 ". compositor_remove_view_callbacks: %s\n",
-                view_id,
-                strerror(ok)
-            );
+            LOG_ERROR("Could not remove view callbacks for platform view %" PRId64 ". compositor_remove_view_callbacks: %s\n", view_id, strerror(ok));
             return platch_respond_native_error_std(responsehandle, ok);
         }
 

third_party/backward-cpp

@@ -0,0 +1 @@
+Subproject commit 49243890982c7c8de7aaa3887765f6523c2e10dd