Merge branch 'ci/add_cxx_build' into 'main'

jason-mao · jason-mao · commit ca96e1973804 · 2025-10-29T10:17:26.000+08:00
ci(esp-gmf): Add test_cxx_build

See merge request adf/multimedia/esp-gmf!112
diff --git a/.gitlab/ci/build_ut.yml b/.gitlab/ci/build_ut.yml
@@ -39,6 +39,7 @@ variables:
                 --build-dir ${IDF_VERSION_TAG}/build_@t_@w \
                 --parallel-count ${parallel##*/} \
                 --parallel-index ${parallel%%/*}
+    - python $CI_PROJECT_DIR/tools/ci/check_test_cxx_build.py
   after_script:
     - find "${TEST_DIR}" -type d -name "managed_components" -exec rm -rf {} +
 
diff --git a/.gitlab/ci/pre_check.yml b/.gitlab/ci/pre_check.yml
@@ -47,6 +47,7 @@ check_commit_format:
     - *check_branch_script
     - *check_commit_script
     - *check_code_script
+    - check_project_root_dir_change
   allow_failure: true
   artifacts:
     paths:
diff --git a/.gitlab/ci/rules.yml b/.gitlab/ci/rules.yml
@@ -1,3 +1,10 @@
+.patterns-build_components: &patterns-build_components
+  - ".gitlab/**/*"
+  - "tools/**/*"
+  - "elements/**/*"
+  - "gmf_core/**/*"
+  - "packages/**/*"
+
 ##############
 # if anchors #
 ##############
@@ -100,10 +107,12 @@
 
 .rules:build:enable-gmf-unit-test:
   rules:
+    - <<: *if-dev-push
+      when: never
     - <<: *if-label-skip_unit_test
       when: never
     - <<: *if-web
     - <<: *if-protected
     - <<: *if-trigger
     - <<: *if-schedule
-    - <<: *if-merge_request_event
+    - changes: *patterns-build_components
diff --git a/elements/gmf_audio/CHANGELOG.md b/elements/gmf_audio/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.7.2
+
+### Features
+
+- Support C++ build
+
 ## v0.7.1
 
 ### Bug Fixes
diff --git a/elements/gmf_audio/idf_component.yml b/elements/gmf_audio/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.7.1"
+version: "0.7.2"
 description: Espressif GMF Audio Elements Module
 url: https://github.com/espressif/esp-gmf/tree/main/elements/gmf_audio
 documentation: "https://github.com/espressif/esp-gmf/blob/main/elements/gmf_audio/README.md"
diff --git a/elements/gmf_audio/include/esp_gmf_alc.h b/elements/gmf_audio/include/esp_gmf_alc.h
@@ -17,8 +17,8 @@ extern "C" {
 
 #define DEFAULT_ESP_GMF_ALC_CONFIG() {  \
     .sample_rate     = 48000,           \
-    .bits_per_sample = 16,              \
     .channel         = 2,               \
+    .bits_per_sample = 16,              \
 }
 
 /**
diff --git a/elements/gmf_audio/include/esp_gmf_bit_cvt.h b/elements/gmf_audio/include/esp_gmf_bit_cvt.h
@@ -17,8 +17,8 @@ extern "C" {
 
 #define DEFAULT_ESP_GMF_BIT_CVT_CONFIG() {  \
     .sample_rate = 48000,                   \
-    .src_bits    = 16,                      \
     .channel     = 2,                       \
+    .src_bits    = 16,                      \
     .dest_bits   = 16,                      \
 }
 
diff --git a/elements/gmf_audio/include/esp_gmf_eq.h b/elements/gmf_audio/include/esp_gmf_eq.h
@@ -22,8 +22,8 @@ extern "C" {
  */
 #define DEFAULT_ESP_GMF_EQ_CONFIG() {  \
     .sample_rate     = 48000,          \
-    .bits_per_sample = 16,             \
     .channel         = 2,              \
+    .bits_per_sample = 16,             \
     .filter_num      = 0,              \
     .para            = NULL,           \
 }
diff --git a/elements/gmf_audio/include/esp_gmf_fade.h b/elements/gmf_audio/include/esp_gmf_fade.h
@@ -16,12 +16,12 @@ extern "C" {
 #endif /* __cplusplus */
 
 #define DEFAULT_ESP_GMF_FADE_CONFIG() {           \
-    .sample_rate     = 48000,                     \
-    .bits_per_sample = 16,                        \
-    .channel         = 2,                         \
-    .transit_time    = 500,                       \
     .mode            = ESP_AE_FADE_MODE_FADE_IN,  \
     .curve           = ESP_AE_FADE_CURVE_LINE,    \
+    .transit_time    = 500,                       \
+    .sample_rate     = 48000,                     \
+    .channel         = 2,                         \
+    .bits_per_sample = 16,                        \
 }
 
 /**
diff --git a/elements/gmf_audio/include/esp_gmf_mixer.h b/elements/gmf_audio/include/esp_gmf_mixer.h
@@ -22,8 +22,8 @@ extern "C" {
  */
 #define DEFAULT_ESP_GMF_MIXER_CONFIG() {  \
     .sample_rate     = 48000,             \
-    .bits_per_sample = 16,                \
     .channel         = 2,                 \
+    .bits_per_sample = 16,                \
     .src_num         = 0,                 \
     .src_info        = NULL,              \
 }
diff --git a/elements/gmf_audio/include/esp_gmf_rate_cvt.h b/elements/gmf_audio/include/esp_gmf_rate_cvt.h
@@ -17,9 +17,9 @@ extern "C" {
 
 #define DEFAULT_ESP_GMF_RATE_CVT_CONFIG() {              \
     .src_rate        = 44100,                            \
-    .bits_per_sample = 16,                               \
-    .channel         = 2,                                \
     .dest_rate       = 48000,                            \
+    .channel         = 2,                                \
+    .bits_per_sample = 16,                               \
     .complexity      = 2,                                \
     .perf_type       = ESP_AE_RATE_CVT_PERF_TYPE_SPEED,  \
 }
diff --git a/elements/gmf_io/CHANGELOG.md b/elements/gmf_io/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.7.6
+
+### Features
+
+- Support C++ build
+
 ## v0.7.5
 
 ### Bug Fixes
diff --git a/elements/gmf_io/idf_component.yml b/elements/gmf_io/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.7.5"
+version: "0.7.6"
 description: Espressif GMF IO Module
 url: https://github.com/espressif/esp-gmf/tree/main/elements/gmf_io
 documentation: "https://github.com/espressif/esp-gmf/blob/main/elements/gmf_io/README.md"
diff --git a/elements/gmf_io/include/esp_gmf_io_http.h b/elements/gmf_io/include/esp_gmf_io_http.h
@@ -69,12 +69,12 @@ typedef struct {
 } http_io_cfg_t;
 
 #define HTTP_STREAM_CFG_DEFAULT() {                    \
-    .dir               = ESP_GMF_IO_DIR_READER,        \
-    .out_buf_size      = HTTP_STREAM_RINGBUFFER_SIZE,  \
     .task_stack        = HTTP_STREAM_TASK_STACK,       \
     .task_core         = HTTP_STREAM_TASK_CORE,        \
     .task_prio         = HTTP_STREAM_TASK_PRIO,        \
     .stack_in_ext      = true,                         \
+    .dir               = ESP_GMF_IO_DIR_READER,        \
+    .out_buf_size      = HTTP_STREAM_RINGBUFFER_SIZE,  \
     .event_handle      = NULL,                         \
     .user_data         = NULL,                         \
     .cert_pem          = NULL,                         \
diff --git a/elements/test_apps/main/test_cxx_build.cpp b/elements/test_apps/main/test_cxx_build.cpp
@@ -0,0 +1,28 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO., LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Test API C++ compilation only, not as a example reference
+ */
+#include "unity.h"
+#include "esp_gmf_io_file.h"
+#include "esp_gmf_io_http.h"
+#include "esp_gmf_io_embed_flash.h"
+#include "esp_gmf_io_i2s_pdm.h"
+
+extern "C" void test_cxx_build(void)
+{
+    file_io_cfg_t file_config = FILE_IO_CFG_DEFAULT();
+    TEST_ASSERT_EQUAL(esp_gmf_io_file_init(&file_config, NULL), ESP_GMF_ERR_INVALID_ARG);
+
+    http_io_cfg_t http_config = HTTP_STREAM_CFG_DEFAULT();
+    TEST_ASSERT_EQUAL(esp_gmf_io_http_init(&http_config, NULL), ESP_GMF_ERR_INVALID_ARG);
+
+    embed_flash_io_cfg_t embed_flash_config = EMBED_FLASH_CFG_DEFAULT();
+    TEST_ASSERT_EQUAL(esp_gmf_io_embed_flash_init(&embed_flash_config, NULL), ESP_GMF_ERR_INVALID_ARG);
+
+    i2s_pdm_io_cfg_t i2s_pdm_config = ESP_GMF_IO_I2S_PDM_CFG_DEFAULT();
+    TEST_ASSERT_EQUAL(esp_gmf_io_i2s_pdm_init(&i2s_pdm_config, NULL), ESP_GMF_ERR_INVALID_ARG);
+}
diff --git a/gmf_core/CHANGELOG.md b/gmf_core/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.7.5
+
+### Features
+
+- Support C++ build
+
 ## v0.7.4
 
 ### Bug Fixes
diff --git a/gmf_core/idf_component.yml b/gmf_core/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.7.4"
+version: "0.7.5"
 description: Espressif General Multimedia Framework (gmf-core) module
 url: https://github.com/espressif/esp-gmf/tree/main/gmf_core
 documentation: "https://github.com/espressif/esp-gmf/blob/main/gmf_core/README.md"
diff --git a/gmf_core/include/esp_gmf_task.h b/gmf_core/include/esp_gmf_task.h
@@ -89,13 +89,15 @@ typedef struct {
 #define DEFAULT_ESP_GMF_TASK_CORE  (0)
 
 #define DEFAULT_ESP_GMF_TASK_CONFIG() {       \
-    .name = NULL,                             \
     .thread = {                               \
         .stack = DEFAULT_ESP_GMF_STACK_SIZE,  \
         .prio = DEFAULT_ESP_GMF_TASK_PRIO,    \
         .core = DEFAULT_ESP_GMF_TASK_CORE,    \
         .stack_in_ext = false,                \
     },                                        \
+    .name = NULL,                             \
+    .ctx = NULL,                              \
+    .cb = NULL,                               \
 }
 
 /**
diff --git a/gmf_core/test_apps/main/CMakeLists.txt b/gmf_core/test_apps/main/CMakeLists.txt
@@ -1,4 +1,5 @@
 idf_component_register(SRCS "test_gmf_core_main.c"
+                            "test_cxx_build.cpp"
                             "./cases/gmf_element_test.c"
                             "./cases/gmf_task_test.c"
                             "./cases/gmf_io_test.c"
diff --git a/gmf_core/test_apps/main/test_cxx_build.cpp b/gmf_core/test_apps/main/test_cxx_build.cpp
@@ -0,0 +1,73 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO., LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Test API C++ compilation only, not as a example reference
+ */
+#include <stdio.h>
+#include <string.h>
+#include "freertos/FreeRTOS.h"
+#include "freertos/event_groups.h"
+#include "esp_log.h"
+#include "esp_err.h"
+#include "esp_gmf_element.h"
+#include "esp_gmf_pipeline.h"
+#include "esp_gmf_pool.h"
+
+static const char *TAG = "CXX_BUILD_TEST";
+
+static esp_gmf_err_t _pipeline_event(esp_gmf_event_pkt_t *event, void *ctx)
+{
+    return ESP_GMF_ERR_OK;
+}
+
+extern "C" void test_cxx_build(void)
+{
+    esp_log_level_set("*", ESP_LOG_INFO);
+    int ret = 0;
+
+    esp_gmf_pool_handle_t pool = NULL;
+    esp_gmf_pool_init(&pool);
+    ESP_GMF_POOL_SHOW_ITEMS(pool);
+
+    esp_gmf_pipeline_handle_t pipe = NULL;
+    const char *name[] = {"aud_enc"};
+    ret = esp_gmf_pool_new_pipeline(pool, "io_codec_dev", name, sizeof(name) / sizeof(char *), "io_file", &pipe);
+    ESP_GMF_RET_ON_NOT_OK(TAG, ret, { return; }, "Failed to new pipeline");
+
+    esp_gmf_pipeline_set_out_uri(pipe, "/sdcard/test.aac");
+
+    esp_gmf_element_handle_t enc_el = NULL;
+    esp_gmf_pipeline_get_el_by_name(pipe, "aud_enc", &enc_el);
+
+    esp_gmf_info_sound_t info = {
+        .format_id = 0,
+        .sample_rates = 16000,
+        .bitrate = 0,
+        .channels = 1,
+        .bits = 16,
+    };
+    esp_gmf_pipeline_report_info(pipe, ESP_GMF_INFO_SOUND, &info, sizeof(info));
+
+    esp_gmf_task_cfg_t cfg = DEFAULT_ESP_GMF_TASK_CONFIG();
+    cfg.ctx = NULL;
+    cfg.cb = NULL;
+    esp_gmf_task_handle_t work_task = NULL;
+    ret = esp_gmf_task_init(&cfg, &work_task);
+    ESP_GMF_RET_ON_NOT_OK(TAG, ret, { return;}, "Failed to create pipeline task");
+    esp_gmf_pipeline_bind_task(pipe, work_task);
+    esp_gmf_pipeline_loading_jobs(pipe);
+
+    esp_gmf_pipeline_set_event(pipe, _pipeline_event, NULL);
+
+    esp_gmf_pipeline_run(pipe);
+
+    vTaskDelay(10000 / portTICK_PERIOD_MS);
+    esp_gmf_pipeline_stop(pipe);
+
+    esp_gmf_task_deinit(work_task);
+    esp_gmf_pipeline_destroy(pipe);
+    esp_gmf_pool_deinit(pool);
+}
diff --git a/packages/esp_audio_simple_player/CHANGELOG.md b/packages/esp_audio_simple_player/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.9.5
+
+### Features
+
+- Support C++ build
+
 ## v0.9.4
 
 ### Features
diff --git a/packages/esp_audio_simple_player/idf_component.yml b/packages/esp_audio_simple_player/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.9.4~2"
+version: "0.9.5"
 description: Espressif audio simple player based on ESP-GMF
 url: https://github.com/espressif/esp-gmf/tree/main/packages/esp_audio_simple_player
 documentation: "https://github.com/espressif/esp-gmf/blob/main/packages/esp_audio_simple_player/README.md"
diff --git a/packages/esp_audio_simple_player/test_apps/main/test_cxx_build.cpp b/packages/esp_audio_simple_player/test_apps/main/test_cxx_build.cpp
@@ -0,0 +1,38 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO., LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Test API C++ compilation only, not as a example reference
+ */
+#include "unity.h"
+#include "esp_gmf_pool.h"
+
+#include "esp_audio_simple_player.h"
+#include "esp_audio_simple_player_advance.h"
+
+extern "C" void test_cxx_build(void)
+{
+    esp_asp_cfg_t cfg = {
+        .in = { .cb = NULL, .user_ctx = NULL },
+        .out = { .cb = NULL, .user_ctx = NULL },
+        .task_prio = 5,
+        .task_stack = 1024,
+        .task_core = 0,
+        .task_stack_in_ext = 1,
+        .prev = NULL,
+        .prev_ctx = NULL,
+    };
+    esp_asp_handle_t handle = NULL;
+    esp_gmf_err_t err = esp_audio_simple_player_new(&cfg, &handle);
+    TEST_ASSERT_EQUAL(ESP_OK, err);
+    TEST_ASSERT_NOT_NULL(handle);
+    err = esp_audio_simple_player_set_event(handle, NULL, NULL);
+    TEST_ASSERT_EQUAL(ESP_OK, err);
+    const char *name[] = {"aud_dec", "aud_rate_cvt", "aud_ch_cvt", "aud_bit_cvt", "aud_alc"};
+    err = esp_audio_simple_player_set_pipeline(handle, NULL, name, 5);
+    TEST_ASSERT_EQUAL(ESP_OK, err);
+    err = esp_audio_simple_player_destroy(handle);
+    TEST_ASSERT_EQUAL(ESP_OK, err);
+}
diff --git a/packages/esp_board_manager/test_apps/main/test_cxx_build.cpp b/packages/esp_board_manager/test_apps/main/test_cxx_build.cpp
@@ -17,7 +17,7 @@
 
 static const char *TAG = "CXX_BUILD_TEST";
 
-extern "C" void cxx_build_test(void)
+extern "C" void test_cxx_build(void)
 {
     ESP_LOGI(TAG, "Starting ESP Board Manager Test Application");
     esp_board_manager_print_board_info();
diff --git a/packages/esp_capture/CHANGELOG.md b/packages/esp_capture/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.7.6
+
+### Features
+
+- Support C++ build
+
 ## v0.7.5
 
 ### Bug Fixes
diff --git a/packages/esp_capture/idf_component.yml b/packages/esp_capture/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.7.5"
+version: "0.7.6"
 description: Espressif Capture is a module for capture media stream from camera and microphone
 url: https://github.com/espressif/esp-gmf/tree/main/packages/esp_capture
 documentation: "https://github.com/espressif/esp-gmf/blob/main/packages/esp_capture/README.md"
diff --git a/packages/esp_capture/test_apps/main/CMakeLists.txt b/packages/esp_capture/test_apps/main/CMakeLists.txt
@@ -1,5 +1,6 @@
 idf_component_register(SRCS "main.c" "capture_test.c" "capture_builder.c"
                        "capture_fake_aud_src.c"  "capture_fake_vid_src.c"
+                       "test_cxx_build.cpp"
                        INCLUDE_DIRS "."
                        PRIV_REQUIRES  esp_timer esp_muxer
                        WHOLE_ARCHIVE)
diff --git a/packages/esp_capture/test_apps/main/test_cxx_build.cpp b/packages/esp_capture/test_apps/main/test_cxx_build.cpp
diff --git a/packages/gmf_app_utils/CHANGELOG.md b/packages/gmf_app_utils/CHANGELOG.md
diff --git a/packages/gmf_app_utils/idf_component.yml b/packages/gmf_app_utils/idf_component.yml
diff --git a/packages/gmf_app_utils/test_apps/main/test_cxx_build.cpp b/packages/gmf_app_utils/test_apps/main/test_cxx_build.cpp
diff --git a/packages/gmf_loader/CHANGELOG.md b/packages/gmf_loader/CHANGELOG.md
diff --git a/packages/gmf_loader/idf_component.yml b/packages/gmf_loader/idf_component.yml
diff --git a/packages/gmf_loader/test_apps/main/test_cxx_build.cpp b/packages/gmf_loader/test_apps/main/test_cxx_build.cpp
diff --git a/tools/ci/build_apps.py b/tools/ci/build_apps.py
diff --git a/tools/ci/check_test_cxx_build.py b/tools/ci/check_test_cxx_build.py
diff --git a/tools/ci/utils.sh b/tools/ci/utils.sh

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version: "0.7.1"`
	`1`	`+version: "0.7.2"`
`2`	`2`	`description: Espressif GMF Audio Elements Module`
`3`	`3`	`url: https://github.com/espressif/esp-gmf/tree/main/elements/gmf_audio`
`4`	`4`	`documentation: "https://github.com/espressif/esp-gmf/blob/main/elements/gmf_audio/README.md"`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@ extern "C" {`
`17`	`17`
`18`	`18`	`#define DEFAULT_ESP_GMF_ALC_CONFIG() { \`
`19`	`19`	`.sample_rate = 48000, \`
`20`		`- .bits_per_sample = 16, \`
`21`	`20`	`.channel = 2, \`
	`21`	`+ .bits_per_sample = 16, \`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`/**`