Merge branch 'feature/gmf_app_utils_adapt_esp_board_manager' into 'main'

jason-mao · jason-mao · commit db8fd8f2bad8 · 2025-11-19T17:27:13.000+08:00
feat(gmf_app_utils): Adapt esp board manager

See merge request adf/multimedia/esp-gmf!184
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ Advanced components are encapsulation modules in ESP-GMF that target specific ap
 | :------------: | :------------: | :------------ |
 | [esp_audio_simple_player](./packages/esp_audio_simple_player) | Simple audio player | - `gmf_audio`<br>- `gmf_io` |
 | [gmf_loader](./packages/gmf_loader) | Set up the given GMF pool using the <br> configuration selected via `Kconfig` | - `gmf_core`<br>- `gmf_io`<br>- `gmf_audio`<br>- `gmf_misc`<br>- `gmf_video`<br>- `gmf_ai_audio`<br>- `esp_codec_dev`<br>- `esp_audio_codec`<br>- `esp_video_codec` |
-| [gmf_app_utils](./packages/gmf_app_utils) | Common peripheral configuration, unit <br>testing tools Memory leak detection tools | - `gmf_core`<br>- `protocol_examples_common`<br>- `codec_board`|
+| [gmf_app_utils](./packages/gmf_app_utils) | Common peripheral configuration, unit <br>testing tools Memory leak detection tools | - `gmf_core`<br>- `protocol_examples_common`<br>- `esp_board_manager`|
 | [esp_capture](./packages/esp_capture) | High-level multimedia capture module | - `gmf_core`<br>- `gmf-audio`<br>- `gmf-video`<br>- `esp_muxer`<br>- `esp_codec_dev`<br>- `esp-sr`<br>- `esp_video`<br>- `esp32-camera`|
 | [esp_board_manager](./packages/esp_board_manager) | Intelligent, automated board configuration and management utilities with YAML-based setup | Dependencies vary based on selected board |
 | [esp_audio_render](./packages/esp_audio_render) | Audio render module with mixer support | - `gmf_core`<br>- `gmf-audio`<br>|
diff --git a/README_CN.md b/README_CN.md
@@ -42,7 +42,7 @@ ESP-GMF 各个模块以组件的形式存在，组件又按功能分为**原子
 | :------------: | :------------:|:------------ |
 |  [esp_audio_simple_player](./packages/esp_audio_simple_player) | 简单的音频播放器 | - `gmf_audio`<br>- `gmf_io` |
 |  [gmf_loader](./packages/gmf_loader) | 使用 `Kconfig` 选择的配置<br>设置给定的 GMF Pool | - `gmf_core`<br>- `gmf_io`<br>- `gmf_audio`<br>- `gmf_misc`<br>- `gmf_video`<br>- `gmf_ai_audio`<br>- `esp_codec_dev`<br>- `esp_audio_codec`<br>- `esp_video_codec` |
-|  [gmf_app_utils](./packages/gmf_app_utils) | 常用外设配置，单元测试工具<br>内存泄漏检测工具 | - `gmf_core`<br>- `protocol_examples_common`<br>- `codec_board` |
+|  [gmf_app_utils](./packages/gmf_app_utils) | 常用外设配置，单元测试工具<br>内存泄漏检测工具 | - `gmf_core`<br>- `protocol_examples_common`<br>- `esp_board_manager` |
 |  [esp_capture](./packages/esp_capture) | 易用的音视频采集器 | - `gmf_core`<br>- `gmf-audio`<br>- `gmf-video`<br>- `esp_muxer`<br>- `esp_codec_dev`<br>- `esp-sr`<br>- `esp_video`<br>- `esp32-camera`|
 |  [esp_board_manager](./packages/esp_board_manager) | 智能、自动化的板子配置和管理工具，支持基于 YAML 的设置 | 根据选择的板子变化依赖 |
 | [esp_audio_render](./packages/esp_audio_render) | 支持混音的音频渲染器 | - `gmf_core`<br>- `gmf-audio`<br>|
diff --git a/packages/esp_capture/CHANGELOG.md b/packages/esp_capture/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.7.8
+
+### Features
+
+- Added dependency `codec_board` in video_capture example yaml to adapt `gmf_app_utils` use `esp_board_manager`
+
 ## v0.7.7
 
 ### Features
diff --git a/packages/esp_capture/examples/video_capture/main/idf_component.yml b/packages/esp_capture/examples/video_capture/main/idf_component.yml
@@ -22,4 +22,5 @@ dependencies:
     version: "^0.5"
   espressif/esp_audio_codec:
     version: "^2.3"
-  
+  tempotian/codec_board:
+    version: "^1.0"
diff --git a/packages/esp_capture/idf_component.yml b/packages/esp_capture/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.7.7"
+version: "0.7.8"
 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/gmf_app_utils/CHANGELOG.md b/packages/gmf_app_utils/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.7.6
+
+### Features
+
+- Updated dependency `esp_board_manager` instead of `codec_board`
+
 ## 0.7.5
 
 ### Bug Fixes
diff --git a/packages/gmf_app_utils/README.md b/packages/gmf_app_utils/README.md
@@ -31,8 +31,7 @@ The `gmf_app_utils` component also provides configuration options via **menuconf
   - SD card initialization and mounting
 - Connectivity management
   - Wi-Fi initialization and connection
-- Use menuconfig to select supported board
-  - For other board support see [Other Board Support](#other-board-support) section
+- Use `esp_board_manager` to select supported board and custom board, see [ESP Board Manager](https://components.espressif.com/components/espressif/esp_board_manager)
 
 ### System Tools (`esp_gmf_app_sys.h`)
 Provides start/stop functionality for system resource monitoring, facilitating runtime performance tracking and resource usage monitoring. To use this feature, you need to enable `CONFIG_FREERTOS_VTASKLIST_INCLUDE_COREID` and `CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS` in menuconfig.
@@ -69,43 +68,3 @@ Provide common functions for GMF application unit tests
   - Call `esp_gmf_app_test_case_uses_tcpip()` in tests that require network functionality
   - Use test annotations like `[leaks]` or `[leaks=1024]` to control leak checking
   - The main function calls' esp_gmf_app_test_main() 'to create the unit test Task
-
-### Other Board Support
-
-Peripheral management currently uses `codec_board` as a reference implementation for fast verification. If you want to use supported peripherals on a custom board, follow these steps:
-
-1. **Get `codec_board`** and put into project `components` folder
-   
-   Can use either of following methods:
-   
-   1.1 Build firstly to trigger auto download then copy it into project folder:
-   ```bash
-   idf.py build
-   mkdir -p components/codec_board
-   cp -rf managed_components/tempotian__codec_board components/codec_board
-   ```
-   
-   1.2 Download [codec_board](https://components.espressif.com/components/tempotian/codec_board/) from component registry and manual copy into project folder
-
-2. **Add a new section** to `components/codec_board/board_cfg.txt` to describe your custom board:
-   ```
-   Board: MY_BOARD
-   i2c: {sda: 1, scl: 2}
-   i2s: {mclk: 42, bclk: 40, ws: 41, dout: 39}
-   out: {codec: ES8311, pa: 38, use_mclk: 0, pa_gain: 6}
-   ```
-
-3. **Set the board type** in your application code before calling any peripheral APIs:
-   ```c
-   #include "codec_board.h"
-   void app_main(void)
-   {
-       set_codec_board_type("MY_BOARD");
-   }
-   ```
-
-4. **Rebuild to take effects**
-   ```bash
-   idf.py fullclean
-   idf.py -p /dev/XXXXX flash monitor
-   ```
diff --git a/packages/gmf_app_utils/README_CN.md b/packages/gmf_app_utils/README_CN.md
@@ -31,8 +31,7 @@ GMF 应用工具包（gmf_app_utils）是一个为方便 ESP GMF 开发应用程
   - SD 卡初始化和挂载
 - 连接管理
   - Wi-Fi 初始化连接
-- 通过 Menuconfig 选择支持的开发板
-  - 其他开发板支持请参阅 [其他开发板支持](#其他开发板支持) 小节
+- 通过 `esp_board_manager` 选择支持的开发板或自定义开发板，请参阅 [ESP Board Manager](https://components.espressif.com/components/espressif/esp_board_manager)
 
 ### 系统工具（`esp_gmf_app_sys.h`）
 提供系统资源监控功能的启动/停止，便于用户运行时性能跟踪以及资源使用情况监控，使用时需要在 menuconfig 中开启 `CONFIG_FREERTOS_VTASKLIST_INCLUDE_COREID` 和 `CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS`。
@@ -69,43 +68,3 @@ GMF 应用工具包（gmf_app_utils）是一个为方便 ESP GMF 开发应用程
   - 使用`esp_gmf_app_test_case_uses_tcpip()`进行网络测试项资源预分配
   - 支持通过测试项描述如 `[leaks]` 或 `[leaks=1024]` 控制泄漏检查阈值
   - main 函数调用 `esp_gmf_app_test_main()` 创建单元测试线程
-
-### 其他开发板支持
-
-外设管理目前使用 `codec_board` 作为参考板卡实现，便于快速验证。若要在自定义开发板上使用支持的外设，请按照以下步骤操作：
-
-1. **获取 `codec_board`** 并将其放入项目的 `components` 文件夹
-   
-   可以使用以下任一方法：
-   
-   1.1 首先构建代码以触发自动下载，然后复制到项目文件夹：
-   ```bash
-   idf.py build
-   mkdir -p components/codec_board
-   cp -rf managed_components/tempotian__codec_board components/codec_board
-   ```
-   
-   1.2 从组件注册表下载 [codec_board](https://components.espressif.com/components/tempotian/codec_board/) 并手动复制到项目文件夹
-
-2. **在 `components/codec_board/board_cfg.txt` 中添加新的开发板配置节**，例如：
-   ```
-   Board: MY_BOARD
-   i2c: {sda: 1, scl: 2}
-   i2s: {mclk: 42, bclk: 40, ws: 41, dout: 39}
-   out: {codec: ES8311, pa: 38, use_mclk: 0, pa_gain: 6}
-   ```
-
-3. **在调用任何外设 API 之前，在应用代码中设置板卡类型**：
-   ```c
-   #include "codec_board.h"
-   void app_main(void)
-   {
-       set_codec_board_type("MY_BOARD");
-   }
-   ```
-
-4. **重新构建代码使修改生效**：
-   ```bash
-   idf.py fullclean
-   idf.py -p /dev/XXXXX flash monitor
-   ```
diff --git a/packages/gmf_app_utils/idf_component.yml b/packages/gmf_app_utils/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.7.5"
+version: "0.7.6"
 description: Espressif GMF App Utils is a module that provides utility functions for the GMF application
 url: https://github.com/espressif/esp-gmf/tree/main/packages/gmf_app_utils
 documentation: "https://github.com/espressif/esp-gmf/blob/main/packages/gmf_app_utils/README.md"
@@ -12,6 +12,6 @@ dependencies:
   espressif/gmf_core:
     require: public
     version: "^0.7"
-  tempotian/codec_board:
+  espressif/esp_board_manager:
     require: public
-    version: "^1.0.0"
+    version: "^0.4.0"
diff --git a/packages/gmf_app_utils/include/esp_gmf_app_setup_peripheral.h b/packages/gmf_app_utils/include/esp_gmf_app_setup_peripheral.h
@@ -48,7 +48,7 @@ typedef struct {
  * @brief  Codec information structure
  */
 typedef struct {
-    void                  *i2c_handle;   /*!<  User-initialized I2C handle; otherwise, set to NULL to let the `esp_gmf_app_setup_codec_dev` initialize it. */
+    void                  *i2c_handle;   /*!< User-initialized I2C handle; otherwise, set to NULL to let the `esp_gmf_app_setup_codec_dev` initialize it */
     esp_gmf_app_i2s_cfg_t  play_info;    /*!< Audio information for playback. Currently,
                                               only ESP_GMF_APP_I2S_MODE_STD I2S mode is supported */
     esp_gmf_app_i2s_cfg_t  record_info;  /*!< Audio information for recording */
@@ -82,8 +82,8 @@ void esp_gmf_app_teardown_sdcard(void *sdcard_handle);
 /**
  * @brief  Setup codec with configuration
  *
- * @note  It will initialize I2S and I2C. And open I2S.
- *        If codec_info is NULL, it will use default codec configuration(ESP_GMF_APP_CODEC_INFO_DEFAULT()).
+ * @note  It will initialize I2S and I2C. And open I2S
+ *        If codec_info is NULL, it will use default codec configuration(ESP_GMF_APP_CODEC_INFO_DEFAULT())
  *
  * @param[in]  codec_info  The codec information
  */
@@ -108,7 +108,7 @@ void *esp_gmf_app_get_i2c_handle(void);
 void *esp_gmf_app_get_playback_handle(void);
 
 /**
- * @brief  Get the record handle
+ * @brief  Get the record handle after `esp_gmf_app_setup_codec_dev`
  *
  * @return
  *       - The record handle
diff --git a/packages/gmf_app_utils/src/esp_gmf_app_setup_peripheral.c b/packages/gmf_app_utils/src/esp_gmf_app_setup_peripheral.c
@@ -11,13 +11,9 @@
 #include "nvs_flash.h"
 #include "esp_event.h"
 #include "protocol_examples_common.h"
-#include "codec_init.h"
-#include "codec_board.h"
+#include "esp_board_manager_includes.h"
 #include "esp_gmf_app_setup_peripheral.h"
-
-#ifndef CONFIG_AUDIO_BOARD
-#define CONFIG_AUDIO_BOARD "NULL"
-#endif  /* CONFIG_AUDIO_BOARD */
+#include "esp_codec_dev.h"
 
 #define SETUP_AUDIO_FORCED_CHANNELS 2
 #define DEFAULT_VOLUME              60.0
@@ -55,61 +51,62 @@ static void setup_create_codec_dev(esp_gmf_app_codec_info_t *codec_info)
 
 void esp_gmf_app_setup_sdcard(void **sdcard_handle)
 {
-    set_codec_board_type(CONFIG_AUDIO_BOARD);
-    mount_sdcard();
+    ESP_ERROR_CHECK(esp_board_manager_init_device_by_name(ESP_BOARD_DEVICE_NAME_FS_SDCARD));
     if (sdcard_handle) {
-        *sdcard_handle = get_sdcard_handle();
+        esp_board_manager_get_device_handle(ESP_BOARD_DEVICE_NAME_FS_SDCARD, sdcard_handle);
     }
 }
 
 void esp_gmf_app_teardown_sdcard(void *sdcard_handle)
 {
-    unmount_sdcard();
+    ESP_ERROR_CHECK(esp_board_manager_deinit_device_by_name(ESP_BOARD_DEVICE_NAME_FS_SDCARD));
 }
 
 void esp_gmf_app_setup_codec_dev(esp_gmf_app_codec_info_t *codec_info)
 {
-    set_codec_board_type(CONFIG_AUDIO_BOARD);
+    ESP_ERROR_CHECK(esp_board_manager_init_device_by_name(ESP_BOARD_DEVICE_NAME_AUDIO_DAC));
+    ESP_ERROR_CHECK(esp_board_manager_init_device_by_name(ESP_BOARD_DEVICE_NAME_AUDIO_ADC));
     if (codec_info) {
-        codec_init_cfg_t codec_cfg = {
-            .in_mode = codec_info->record_info.mode,
-            .out_mode = codec_info->play_info.mode,
-            .in_use_tdm = false,
-            .reuse_dev = false,
-        };
-        ESP_ERROR_CHECK(init_codec(&codec_cfg));
         setup_create_codec_dev(codec_info);
     } else {
         esp_gmf_app_codec_info_t _info = ESP_GMF_APP_CODEC_INFO_DEFAULT();
-        codec_init_cfg_t codec_cfg = {
-            .in_mode = _info.record_info.mode,
-            .out_mode = _info.play_info.mode,
-            .in_use_tdm = false,
-            .reuse_dev = false,
-        };
-        ESP_ERROR_CHECK(init_codec(&codec_cfg));
         setup_create_codec_dev(&_info);
     }
 }
 
 void *esp_gmf_app_get_i2c_handle(void)
 {
-    return get_i2c_bus_handle(0);
+    void *i2c_handle = NULL;
+    esp_board_manager_get_periph_handle("i2c_master", &i2c_handle);
+    return i2c_handle;
 }
 
 void *esp_gmf_app_get_playback_handle(void)
 {
-    return get_playback_handle();
+    void *playback_handle = NULL;
+    dev_audio_codec_handles_t *device_handle = NULL;
+    esp_board_manager_get_device_handle(ESP_BOARD_DEVICE_NAME_AUDIO_DAC, (void **)&device_handle);
+    if (device_handle) {
+        playback_handle = device_handle->codec_dev;
+    }
+    return playback_handle;
 }
 
 void *esp_gmf_app_get_record_handle(void)
 {
-    return get_record_handle();
+    void *record_handle = NULL;
+    dev_audio_codec_handles_t *device_handle = NULL;
+    esp_board_manager_get_device_handle(ESP_BOARD_DEVICE_NAME_AUDIO_ADC, (void **)&device_handle);
+    if (device_handle) {
+        record_handle = device_handle->codec_dev;
+    }
+    return record_handle;
 }
 
 void esp_gmf_app_teardown_codec_dev(void)
 {
-    deinit_codec();
+    ESP_ERROR_CHECK(esp_board_manager_deinit_device_by_name(ESP_BOARD_DEVICE_NAME_AUDIO_ADC));
+    ESP_ERROR_CHECK(esp_board_manager_deinit_device_by_name(ESP_BOARD_DEVICE_NAME_AUDIO_DAC));
 }
 
 void esp_gmf_app_wifi_connect(void)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version: "0.7.7"`
	`1`	`+version: "0.7.8"`
`2`	`2`	`description: Espressif Capture is a module for capture media stream from camera and microphone`
`3`	`3`	`url: https://github.com/espressif/esp-gmf/tree/main/packages/esp_capture`
`4`	`4`	`documentation: "https://github.com/espressif/esp-gmf/blob/main/packages/esp_capture/README.md"`