refactor: simplify the msgpack protocol implementation (#225)

Co-authored-by: Hu Yueh-Wei <[email protected]>

core/include/ten_runtime/ten.h

@@ -19,7 +19,6 @@
 #include "ten_runtime/extension_group/extension_group.h"  // IWYU pragma: export
 #include "ten_runtime/msg/audio_frame/audio_frame.h"      // IWYU pragma: export
 #include "ten_runtime/msg/cmd/close_app/cmd.h"            // IWYU pragma: export
-#include "ten_runtime/msg/cmd/custom/cmd.h"               // IWYU pragma: export
 #include "ten_runtime/msg/cmd_result/cmd_result.h"        // IWYU pragma: export
 #include "ten_runtime/msg/data/data.h"                    // IWYU pragma: export
 #include "ten_runtime/msg/msg.h"                          // IWYU pragma: export

core/include_internal/ten_runtime/msg/cmd_base/cmd/custom/cmd.h

@@ -42,7 +42,7 @@ TEN_RUNTIME_PRIVATE_API ten_json_t *ten_raw_cmd_custom_to_json(
 TEN_RUNTIME_API ten_cmd_t *ten_raw_cmd_custom_create_from_json(
     ten_json_t *json, ten_error_t *err);
 
-TEN_RUNTIME_API ten_shared_ptr_t *ten_cmd_custom_create_empty(void);
+TEN_RUNTIME_API ten_shared_ptr_t *ten_cmd_custom_create(void);
 
 TEN_RUNTIME_PRIVATE_API ten_cmd_t *ten_raw_cmd_custom_create(
     const char *cmd_name);

core/include_internal/ten_runtime/msg/loop_fields.h

@@ -9,6 +9,7 @@
 #include "ten_runtime/ten_config.h"
 
 #include "ten_utils/lib/error.h"
+#include "ten_utils/lib/smart_ptr.h"
 #include "ten_utils/value/value_kv.h"
 
 typedef struct ten_msg_t ten_msg_t;
@@ -46,3 +47,7 @@ TEN_RUNTIME_API void ten_msg_field_process_data_init(
 TEN_RUNTIME_API bool ten_raw_msg_loop_all_fields(
     ten_msg_t *self, ten_raw_msg_process_one_field_func_t cb, void *user_data,
     ten_error_t *err);
+
+TEN_RUNTIME_API bool ten_msg_loop_all_fields(
+    ten_shared_ptr_t *self, ten_raw_msg_process_one_field_func_t cb,
+    void *user_data, ten_error_t *err);

core/include_internal/ten_runtime/msg/msg_info.h

@@ -23,7 +23,6 @@
 #include "include_internal/ten_runtime/msg/data/data.h"
 #include "include_internal/ten_runtime/msg/msg.h"
 #include "include_internal/ten_runtime/msg/video_frame/video_frame.h"
-#include "ten_runtime/msg/cmd/custom/cmd.h"
 #include "ten_runtime/msg/cmd/start_graph/cmd.h"
 #include "ten_runtime/msg/msg.h"
 

core/include_internal/ten_utils/value/value_set.h

@@ -36,6 +36,10 @@ TEN_UTILS_API bool ten_value_set_float64(ten_value_t *self, double value);
 
 TEN_UTILS_API bool ten_value_set_string(ten_value_t *self, const char *value);
 
+TEN_UTILS_API bool ten_value_set_string_with_size(ten_value_t *self,
+                                                  const char *value,
+                                                  size_t len);
+
 TEN_UTILS_API bool ten_value_set_array_with_move(ten_value_t *self,
                                                  ten_list_t *value);
 

core/src/ten_runtime/binding/go/native/msg/cmd/cmd.c

@@ -32,7 +32,7 @@ ten_go_status_t ten_go_cmd_create_cmd(const void *cmd_name, int cmd_name_len,
   ten_go_status_t status;
   ten_go_status_init_with_errno(&status, TEN_ERRNO_OK);
 
-  ten_shared_ptr_t *cmd = ten_cmd_custom_create_empty();
+  ten_shared_ptr_t *cmd = ten_cmd_custom_create();
   TEN_ASSERT(cmd && ten_cmd_check_integrity(cmd), "Should not happen.");
 
   ten_msg_set_name_with_size(cmd, cmd_name, cmd_name_len, NULL);

core/src/ten_runtime/msg/cmd_base/cmd/custom/cmd.c

@@ -4,13 +4,12 @@
 // Licensed under the Apache License, Version 2.0, with certain conditions.
 // Refer to the "LICENSE" file in the root directory for more information.
 //
-#include "ten_runtime/msg/cmd/custom/cmd.h"
+#include "include_internal/ten_runtime/msg/cmd_base/cmd/cmd.h"
 
 #include <stdlib.h>
 #include <string.h>
 
 #include "include_internal/ten_runtime/common/constant_str.h"
-#include "include_internal/ten_runtime/msg/cmd_base/cmd/cmd.h"
 #include "include_internal/ten_runtime/msg/cmd_base/cmd/custom/cmd.h"
 #include "include_internal/ten_runtime/msg/cmd_base/cmd/custom/field/field_info.h"
 #include "include_internal/ten_runtime/msg/field/field_info.h"
@@ -25,7 +24,6 @@
 #include "ten_utils/lib/smart_ptr.h"
 #include "ten_utils/lib/string.h"
 #include "ten_utils/macro/check.h"
-#include "ten_utils/macro/mark.h"
 #include "ten_utils/value/value.h"
 
 static void ten_raw_cmd_custom_destroy(ten_cmd_t *self) {
@@ -53,7 +51,7 @@ static ten_cmd_t *ten_raw_cmd_custom_create_empty(void) {
   return raw_cmd;
 }
 
-ten_shared_ptr_t *ten_cmd_custom_create_empty(void) {
+ten_shared_ptr_t *ten_cmd_custom_create(void) {
   return ten_shared_ptr_create(ten_raw_cmd_custom_create_empty(),
                                ten_raw_cmd_custom_destroy);
 }
@@ -69,13 +67,6 @@ ten_cmd_t *ten_raw_cmd_custom_create(const char *cmd_name) {
   return cmd;
 }
 
-ten_shared_ptr_t *ten_cmd_custom_create(const char *cmd_name) {
-  TEN_ASSERT(cmd_name, "Should not happen.");
-
-  ten_cmd_t *cmd = ten_raw_cmd_custom_create(cmd_name);
-  return ten_shared_ptr_create(cmd, ten_raw_cmd_custom_destroy);
-}
-
 static bool ten_raw_cmd_custom_init_from_json(ten_cmd_t *self, ten_json_t *json,
                                               ten_error_t *err) {
   TEN_ASSERT(self && ten_raw_cmd_check_integrity((ten_cmd_t *)self),

core/src/ten_runtime/msg/loop_fields.c

@@ -38,3 +38,13 @@ bool ten_raw_msg_loop_all_fields(ten_msg_t *self,
 
   return loop_all_fields(self, cb, user_data, err);
 }
+
+bool ten_msg_loop_all_fields(ten_shared_ptr_t *self,
+                             ten_raw_msg_process_one_field_func_t cb,
+                             void *user_data, ten_error_t *err) {
+  TEN_ASSERT(self && ten_msg_check_integrity(self), "Invalid argument.");
+  TEN_ASSERT(cb, "Invalid argument.");
+
+  return ten_raw_msg_loop_all_fields(ten_msg_get_raw_msg(self), cb, user_data,
+                                     err);
+}

core/src/ten_runtime/msg/msg.c

@@ -29,6 +29,7 @@
 #include "ten_runtime/common/errno.h"
 #include "ten_runtime/msg/audio_frame/audio_frame.h"
 #include "ten_runtime/msg/cmd/close_app/cmd.h"
+#include "ten_runtime/msg/cmd/stop_graph/cmd.h"
 #include "ten_runtime/msg/cmd_result/cmd_result.h"
 #include "ten_runtime/msg/data/data.h"
 #include "ten_runtime/msg/msg.h"
@@ -862,7 +863,13 @@ ten_shared_ptr_t *ten_msg_create_from_msg_type(TEN_MSG_TYPE msg_type) {
     case TEN_MSG_TYPE_CMD_CLOSE_APP:
       return ten_cmd_close_app_create();
     case TEN_MSG_TYPE_CMD:
-      return ten_cmd_custom_create_empty();
+      return ten_cmd_custom_create();
+    case TEN_MSG_TYPE_CMD_START_GRAPH:
+      return ten_cmd_start_graph_create();
+    case TEN_MSG_TYPE_CMD_STOP_GRAPH:
+      return ten_cmd_stop_graph_create();
+    case TEN_MSG_TYPE_CMD_TIMEOUT:
+      return ten_cmd_timeout_create(0);
     case TEN_MSG_TYPE_CMD_RESULT:
       return ten_cmd_result_create_from_cmd(TEN_STATUS_CODE_OK, NULL);
     case TEN_MSG_TYPE_DATA:

core/src/ten_utils/lib/sys/general/buf.c

@@ -11,9 +11,9 @@
 #include <string.h>
 
 #include "include_internal/ten_utils/lib/buf.h"
-#include "ten_utils/macro/check.h"
 #include "ten_utils/lib/alloc.h"
 #include "ten_utils/lib/signature.h"
+#include "ten_utils/macro/check.h"
 #include "ten_utils/macro/memory.h"
 
 bool ten_buf_check_integrity(ten_buf_t *self) {
@@ -26,7 +26,7 @@ bool ten_buf_check_integrity(ten_buf_t *self) {
   return true;
 }
 
-static void ten_buf_reset_to_empty_directly(ten_buf_t *self) {
+static void ten_buf_init_empty(ten_buf_t *self) {
   TEN_ASSERT(self, "Invalid argument.");
 
   ten_signature_set(&self->signature, TEN_BUF_SIGNATURE);
@@ -76,7 +76,7 @@ bool ten_buf_init_with_owned_data(ten_buf_t *self, size_t size) {
     return false;
   }
 
-  ten_buf_reset_to_empty_directly(self);
+  ten_buf_init_empty(self);
 
   if (size != 0) {
     self->data = TEN_MALLOC(size);
@@ -98,7 +98,7 @@ bool ten_buf_init_with_unowned_data(ten_buf_t *self, uint8_t *data,
     return false;
   }
 
-  ten_buf_reset_to_empty_directly(self);
+  ten_buf_init_empty(self);
 
   self->data = data;
   self->content_size = size;
@@ -118,7 +118,7 @@ bool ten_buf_init_with_copying_data(ten_buf_t *self, uint8_t *data,
     return false;
   }
 
-  ten_buf_reset_to_empty_directly(self);
+  ten_buf_init_empty(self);
 
   self->data = TEN_MALLOC(size);
   TEN_ASSERT(self->data, "Failed to allocate memory.");
@@ -300,5 +300,9 @@ void ten_buf_move(ten_buf_t *self, ten_buf_t *other) {
   self->owns_memory = other->owns_memory;
   self->is_fixed_size = other->is_fixed_size;
 
+  // The buf_t 'other' being moved to 'self' means that the ownership of the
+  // memory has been transferred.
+  other->owns_memory = false;
+
   ten_buf_init_with_owned_data(other, 0);
 }

core/src/ten_utils/value/value_set.c

@@ -121,6 +121,17 @@ bool ten_value_set_string(ten_value_t *self, const char *value) {
   return true;
 }
 
+TEN_UTILS_API bool ten_value_set_string_with_size(ten_value_t *self,
+                                                  const char *value,
+                                                  size_t len) {
+  TEN_ASSERT(self && ten_value_check_integrity(self), "Invalid argument.");
+  TEN_ASSERT(self->type == TEN_TYPE_STRING, "Invalid argument.");
+
+  ten_string_init_formatted(&self->content.string, "%.*s", len, value);
+
+  return true;
+}
+
 bool ten_value_set_array_with_move(ten_value_t *self, ten_list_t *value) {
   TEN_ASSERT(self, "Invalid argument.");
   TEN_ASSERT(self->type == TEN_TYPE_ARRAY, "Invalid argument.");

packages/core_protocols/msgpack/common/parser.c

@@ -83,8 +83,8 @@ ten_shared_ptr_t *ten_msgpack_parser_parse_data(ten_msgpack_parser_t *self) {
     ten_msgpack_parser_feed_data(&msg_parser, self->unpacked.data.via.ext.ptr,
                                  self->unpacked.data.via.ext.size);
 
-    new_msg = ten_msgpack_deserialize_msg_internal(&msg_parser.unpacker,
-                                                   &msg_parser.unpacked);
+    new_msg =
+        ten_msgpack_deserialize_msg(&msg_parser.unpacker, &msg_parser.unpacked);
 
     ten_msgpack_parser_deinit(&msg_parser);
   } else if (rc == MSGPACK_UNPACK_CONTINUE) {