Merge branch 'feature/update_sub_components_to_v0.6.0' into 'main'

jason-mao · jason-mao · commit 47505d50454f · 2025-04-22T14:00:18.000+08:00
Update the audio, io, ai-audio and misc components to v0.6.0

See merge request adf/multimedia/esp-gmf!44
diff --git a/.github/workflows/upload_component.yml b/.github/workflows/upload_component.yml
@@ -14,10 +14,11 @@ jobs:
         uses: espressif/upload-components-ci-action@v2
         with:
           components: |
-            esp_audio_simple_player:./examples/esp_audio_simple_player
             gmf_core:./gmf_core
-            esp_gmf_audio:./gmf_elements/gmf_audio
-            esp_gmf_io:./gmf_elements/gmf_io
-            esp_gmf_misc:./gmf_elements/gmf_misc
+            gmf_audio:./gmf_elements/gmf_audio
+            gmf_io:./gmf_elements/gmf_io
+            gmf_misc:./gmf_elements/gmf_misc
+            esp_audio_simple_player:./examples/esp_audio_simple_player
+            gmf_ai_audio:./gmf_elements/gmf_ai_audio
           namespace: "espressif"
-          api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
+          api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
diff --git a/README.md b/README.md
@@ -11,15 +11,15 @@ ESP-GMF consists of three modules: **GMF-Core**, **GMF-Elements**, and **GMF-Exa
 
 # ESP-GMF Component Overview
 
-Each ESP-GMF functional module exists as a component, currently including [GMF-Core](./gmf_core/README.md), [ESP-GMF-Audio](./gmf_elements/gmf_audio/README.md), ESP-GMF-Image, [ESP-GMF-Misc](./gmf_elements/gmf_misc/README.md), [ESP-GMF-IO](./gmf_elements/gmf_io/README.md), and [GMF-AI-Audio](./gmf_elements/gmf_ai_audio/README.md).
+Each ESP-GMF functional module exists as a component, currently including [GMF-Core](./gmf_core/README.md), [GMF-Audio](./gmf_elements/gmf_audio/README.md),  [GMF-Misc](./gmf_elements/gmf_misc/README.md), [GMF-IO](./gmf_elements/gmf_io/README.md), and [GMF-AI-Audio](./gmf_elements/gmf_ai_audio/README.md).
 
 | Component Name | Function | Dependent Components |
 | :------------: | :------------: | :------------ |
 | [gmf_core](./gmf_core) | Core framework for GMF | None |
-| [esp_gmf_audio](./gmf_elements/gmf_audio) | Elements for audio encoding, decoding,<br>and sound effects processing | - `gmf_core`<br>- `esp_audio_effects`<br>- `esp_audio_codec` |
-| [esp_gmf_misc](./gmf_elements/gmf_misc) | Utility elements | None |
+| [gmf_audio](./gmf_elements/gmf_audio) | Elements for audio encoding, decoding,<br>and sound effects processing | - `gmf_core`<br>- `esp_audio_effects`<br>- `esp_audio_codec` |
+| [gmf_misc](./gmf_elements/gmf_misc) | Utility elements | None |
 | esp_gmf_image | Elements for image encoding, decoding,<br>and image effects processing | - `gmf_core`<br>- `esp_new_jpeg` |
-| [esp_gmf_io](./gmf_elements/gmf_io) | Input/output for files, flash, and HTTP | - `gmf_core`<br>- `esp_codec_dev` |
+| [gmf_io](./gmf_elements/gmf_io) | Input/output for files, flash, and HTTP | - `gmf_core`<br>- `esp_codec_dev` |
 | [gmf_ai_audio](./gmf_elements/gmf_ai_audio) | Elements for intelligence audio processing | - `esp-sr`<br>- `gmf_core` |
 
 When developing a project, it is recommended to use the elements and IOs components from the official GMF-Elements repository. You can also create your own elements and IO components to extend its application scenarios.
diff --git a/README_CN.md b/README_CN.md
@@ -11,15 +11,15 @@ ESP-GMF 包含 GMF-Core、 GMF-Elements 和 GMF-Examples 三个模块。
 
 # ESP-GMF 组件介绍
 
-ESP-GMF 各个功能模块以组件的形式存在，目前包含 [GMF-Core](./gmf_core/README_CN.md)、[ESP-GMF-Audio](./gmf_elements/gmf_audio/README_CN.md)、ESP-GMF-Image、[ESP-GMF-Misc](./gmf_elements/gmf_misc/README_CN.md)、[ESP-GMF-IO](./gmf_elements/gmf_io/README_CN.md) 和 [GMF-AI-Audio](./gmf_elements/gmf_ai_audio/README_CN.md)。
+ESP-GMF 各个功能模块以组件的形式存在，目前包含 [GMF-Core](./gmf_core/README_CN.md)、[GMF-Audio](./gmf_elements/gmf_audio/README_CN.md)、ESP-GMF-Image、[GMF-Misc](./gmf_elements/gmf_misc/README_CN.md)、[GMF-IO](./gmf_elements/gmf_io/README_CN.md) 和 [GMF-AI-Audio](./gmf_elements/gmf_ai_audio/README_CN.md)。
 
 |  组件名称 |  功能 | 依赖的组件  |
 | :------------: | :------------:|:------------ |
 |  [gmf_core](./gmf_core) | GMF 基础框架  |  无 |
-|  [esp_gmf_audio](./gmf_elements/gmf_audio) | GMF 音频编解码和<br>音效处理 element  | - `gmf_core`<br>- `esp_audio_effects`<br> - `esp_audio_codec` |
-|  [esp_gmf_misc](./gmf_elements/gmf_misc) | 工具类 element   | 无  |
+|  [gmf_audio](./gmf_elements/gmf_audio) | GMF 音频编解码和<br>音效处理 element  | - `gmf_core`<br>- `esp_audio_effects`<br> - `esp_audio_codec` |
+|  [gmf_misc](./gmf_elements/gmf_misc) | 工具类 element   | 无  |
 |  esp_gmf_image | GMF 图像编解码和<br>图像效果处理 element  | - `gmf_core`<br>- `esp_new_jpeg` |
-|  [esp_gmf_io](./gmf_elements/gmf_io) | 文件、flash、HTTP 输入输出  | - `gmf_core`<br>- `esp_codec_dev`  |
+|  [gmf_io](./gmf_elements/gmf_io) | 文件、flash、HTTP 输入输出  | - `gmf_core`<br>- `esp_codec_dev`  |
 |  [gmf_ai_audio](./gmf_elements/gmf_ai_audio) | 智能语音算法和<br>语音识别 element | - `esp-sr`<br>- `gmf_core` |
 
 在开发项目时，推荐使用官方 GMF-Elements 仓库的 elements 和 IOs 组件进行开发，也可以自行创建 element 和 IO 组件来扩展其应用场景。
diff --git a/examples/basic_examples/pipeline_play_embed_music/main/idf_component.yml b/examples/basic_examples/pipeline_play_embed_music/main/idf_component.yml
@@ -1,10 +1,10 @@
 dependencies:
   espressif/gmf_audio:
-    path: ../../../../gmf_elements/gmf_audio
+    override_path: ../../../../gmf_elements/gmf_audio
   espressif/gmf_io:
-    path: ../../../../gmf_elements/gmf_io
+    override_path: ../../../../gmf_elements/gmf_io
   espressif/gmf_misc:
-    path: ../../../../gmf_elements/gmf_misc
+    override_path: ../../../../gmf_elements/gmf_misc
   espressif/esp_wifi_remote:
     version: '*'
     rules:
diff --git a/examples/basic_examples/pipeline_play_sdcard_music/main/idf_component.yml b/examples/basic_examples/pipeline_play_sdcard_music/main/idf_component.yml
@@ -1,10 +1,10 @@
 dependencies:
   espressif/gmf_audio:
-    path: ../../../../gmf_elements/gmf_audio
+    override_path: ../../../../gmf_elements/gmf_audio
   espressif/gmf_io:
-    path: ../../../../gmf_elements/gmf_io
+    override_path: ../../../../gmf_elements/gmf_io
   espressif/gmf_misc:
-    path: ../../../../gmf_elements/gmf_misc
+    override_path: ../../../../gmf_elements/gmf_misc
   espressif/esp_wifi_remote:
     version: '*'
     rules:
diff --git a/examples/basic_examples/pipeline_record_sdcard/main/idf_component.yml b/examples/basic_examples/pipeline_record_sdcard/main/idf_component.yml
@@ -1,10 +1,10 @@
 dependencies:
   espressif/gmf_audio:
-    path: ../../../../gmf_elements/gmf_audio
+    override_path: ../../../../gmf_elements/gmf_audio
   espressif/gmf_io:
-    path: ../../../../gmf_elements/gmf_io
+    override_path: ../../../../gmf_elements/gmf_io
   espressif/gmf_misc:
-    path: ../../../../gmf_elements/gmf_misc
+    override_path: ../../../../gmf_elements/gmf_misc
   espressif/esp_wifi_remote:
     version: '*'
     rules:
diff --git a/examples/esp_audio_simple_player/CHANGELOG.md b/examples/esp_audio_simple_player/CHANGELOG.md
@@ -0,0 +1,19 @@
+# Changelog
+
+## v0.9.2
+
+### Features
+- Updated the dependencies to version 0.6.0
+
+## v0.9.1
+
+### Bug Fixes
+
+- Fixed the component requirements
+
+
+## v0.9.0
+
+### Features
+
+- Initial version of `esp_audio_simple_player`
diff --git a/examples/esp_audio_simple_player/idf_component.yml b/examples/esp_audio_simple_player/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.9.1"
+version: "0.9.2"
 description: Espressif audio simple player based on ESP-GMF
 url: https://github.com/espressif/esp-gmf/tree/main/examples/esp_audio_simple_player
 documentation: "https://github.com/espressif/esp-gmf/blob/main/examples/esp_audio_simple_player/README.md"
@@ -9,7 +9,7 @@ tags:
    - "audio_player"
 
 dependencies:
-  espressif/esp_gmf_audio:
-    version: "^0.5"
-  espressif/esp_gmf_io:
-    version: "^0.5"
+  espressif/gmf_audio:
+    version: "^0.6"
+  espressif/gmf_io:
+    version: "^0.6"
diff --git a/examples/esp_audio_simple_player/src/esp_audio_simple_player.c b/examples/esp_audio_simple_player/src/esp_audio_simple_player.c
@@ -217,10 +217,10 @@ static int __setup_pipeline(esp_audio_simple_player_t *player, const char *uri,
             esp_gmf_port_handle_t in_port = NULL;
             if (io_type == ESP_GMF_IO_TYPE_BYTE) {
                 in_port = NEW_ESP_GMF_PORT_IN_BYTE(esp_gmf_io_acquire_read, esp_gmf_io_release_read, NULL, new_io,
-                                                   (ESP_GMF_ELEMENT_GET(player->pipe->head_el)->in_attr.size), ESP_GMF_MAX_DELAY);
+                                                   (ESP_GMF_ELEMENT_GET(player->pipe->head_el)->in_attr.data_size), ESP_GMF_MAX_DELAY);
             } else if (io_type == ESP_GMF_IO_TYPE_BLOCK) {
                 in_port = NEW_ESP_GMF_PORT_IN_BLOCK(esp_gmf_io_acquire_read, esp_gmf_io_release_read, NULL, new_io,
-                                                    (ESP_GMF_ELEMENT_GET(player->pipe->head_el)->in_attr.size), ESP_GMF_MAX_DELAY);
+                                                    (ESP_GMF_ELEMENT_GET(player->pipe->head_el)->in_attr.data_size), ESP_GMF_MAX_DELAY);
             } else {
                 ESP_LOGE(TAG, "The IN type is incorrect,%d, [%p-%s]", io_type, new_io, OBJ_GET_TAG(new_io));
                 ret = ESP_GMF_ERR_NOT_SUPPORT;
diff --git a/examples/esp_audio_simple_player/test_apps/CMakeLists.txt b/examples/esp_audio_simple_player/test_apps/CMakeLists.txt
@@ -4,7 +4,6 @@ cmake_minimum_required(VERSION 3.16)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
-set(EXTRA_COMPONENT_DIRS ${EXTRA_COMPONENT_DIRS} "../../esp_audio_simple_player")
 set(EXTRA_COMPONENT_DIRS ${EXTRA_COMPONENT_DIRS} "../../system_common")
 
 project(test_aud_simp_player)
diff --git a/examples/system_common/idf_component.yml b/examples/system_common/idf_component.yml
@@ -1,10 +1,10 @@
 dependencies:
-  espressif/esp_gmf_misc:
+  espressif/gmf_misc:
     require: public
-    version: "*"
-  espressif/esp_gmf_audio:
+    version: "^0.6"
+  espressif/gmf_audio:
     require: public
-    version: "*"
-  espressif/esp_gmf_io:
+    version: "^0.6"
+  espressif/gmf_io:
     require: public
-    version: "*"
+    version: "^0.6"
diff --git a/gmf_core/CHANGELOG.md b/gmf_core/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.6.1
+
+### Bug Fixes
+
+- Fixed an issue where gmf_task failed to wait for event bits
+- Fixed compilation failure when building for P4
+
+
 ## v0.6.0
 
 ### Features
diff --git a/gmf_core/idf_component.yml b/gmf_core/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.6.0"
+version: "0.6.1"
 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/oal/esp_gmf_oal_thread.c b/gmf_core/oal/esp_gmf_oal_thread.c
@@ -12,6 +12,7 @@
 #include "esp_log.h"
 #include "esp_gmf_oal_mem.h"
 #include "esp_gmf_oal_thread.h"
+#include "esp_memory_utils.h"
 
 static const char *TAG = "ESP_GMF_THREAD";
 
diff --git a/gmf_core/src/esp_gmf_task.c b/gmf_core/src/esp_gmf_task.c
@@ -31,7 +31,7 @@ static const char *TAG = "ESP_GMF_TASK";
 #define GMF_TASK_EXIT_BIT   (1 << 4)
 
 #define GMF_TASK_WAIT_FOR_STATE_BITS(event_group, bits, timeout) \
-    (bits == xEventGroupWaitBits((EventGroupHandle_t)event_group, bits, true, true, timeout))
+    (bits == (bits & xEventGroupWaitBits((EventGroupHandle_t)event_group, bits, true, true, timeout)))
 
 #define GMF_TASK_SET_STATE_BITS(event_group, bits) \
     xEventGroupSetBits((EventGroupHandle_t)event_group, bits);
diff --git a/gmf_elements/gmf_ai_audio/README.md b/gmf_elements/gmf_ai_audio/README.md
@@ -4,11 +4,11 @@
 
 `GMF AI Audio` is an artificial intelligence audio processing module that provides users with convenient and easy-to-use intelligent audio processing algorithms at the [GMF](https://github.com/espressif/esp-gmf) framework, such as voice wake-up, command word recognition, and echo cancellation. Currently, it offers the following modules based on `esp-sr`:
 
-* [esp_afe_manager](./src/esp_afe_manager.c): `audio front end(afe)` manager
+* [esp_gmf_afe_manager](./src/esp_gmf_afe_manager.c): `audio front end(afe)` manager
 * [esp_gmf_aec](./src/esp_gmf_aec.c): Echo Cancellation
 * [esp_gmf_afe](./src/esp_gmf_afe.c): An easy-to-use interface based on the `audio front end (afe)` from `esp-sr`, providing functionalities such as voice wake-up, command word recognition, and speech detection
 
-## AFE Manager `esp_afe_manager`
+## AFE Manager `esp_gmf_afe_manager`
 
 ### Features
 
@@ -87,7 +87,7 @@
     end
 
     subgraph GMF_AFE
-        AFE_MGR[AFE Manager<br>esp_afe_manager]
+        AFE_MGR[AFE Manager<br>esp_gmf_afe_manager]
         INPUT_RB[Input Buffer]
         OUTPUT_RB[Output Buffer]
         STATE_MACHINE[Wake-Up/VAD State Machine]
@@ -196,6 +196,6 @@ Users need to decide when to start command word detection. A typical use case is
 * Command word detection is independent of the wake word state machine
 * Command word detection supports continuous detection until timeout
 
-## License
+## Usage
 
-Follows the `Espressif Modified MIT License`. See file headers for details
+For example code, refer to the [examples](./examples) folder for the Wake Word Detection and Audio Echo Cancellation demos.
diff --git a/gmf_elements/gmf_ai_audio/README_CN.md b/gmf_elements/gmf_ai_audio/README_CN.md
@@ -4,11 +4,11 @@
 
 `GMF AI Audio` 是一个人工智能语音处理模块，它在 [GMF](https://github.com/espressif/esp-gmf) 层面为用户提供方便、易用的语音唤醒、命令词识别和回声消除等常用智能语音处理算法。目前基于 `esp-sr` 提供以下模块：
 
-* [esp_afe_manager](./src/esp_afe_manager.c): `audio front end(afe)` 管理器
+* [esp_gmf_afe_manager](./src/esp_gmf_afe_manager.c): `audio front end(afe)` 管理器
 * [esp_gmf_aec](./src/esp_gmf_aec.c): 回声消除
 * [esp_gmf_afe](./src/esp_gmf_afe.c): 基于 `esp-sr` 中 `audio front end (afe)` 实现的易用接口，提供了语音唤醒，命令词识别，人声检测等语音识别的功能
 
-## AFE 管理器 `esp_afe_manager`
+## AFE 管理器 `esp_gmf_afe_manager`
 
 ### 功能
 
@@ -87,7 +87,7 @@
     end
 
     subgraph GMF_AFE
-        AFE_MGR[AFE管理器<br>esp_afe_manager]
+        AFE_MGR[AFE管理器<br>esp_gmf_afe_manager]
         INPUT_RB[输入缓存]
         OUTPUT_RB[输出缓存]
         STATE_MACHINE[唤醒/VAD状态机]
@@ -196,6 +196,6 @@
 * 命令词检测与唤醒状态机独立
 * 命令词支持连续检测，直到超时
 
-## 许可协议
+## 示例
 
-遵循 `Espressif 修改版 MIT 协议`，详情见文件头声明
+示例代码，请参阅 [示例](./examples) 文件夹中的唤醒词检测和音频回声消除程序。
diff --git a/gmf_elements/gmf_audio/CHANGELOG.md b/gmf_elements/gmf_audio/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Changelog
 
+## v0.6.0
+
+### Features
+- Updated the logic for GMF capabilities and method handling
+- Added support for NULL object configuration
+- Added GMF port attribution for elements
+- Added gmf_cache and optimized the loop path for the audio encoder and decoder
+- Renamed component to `gmf_audio`
+- Updated the License
+
 ## v0.5.2
 
 ### Bug Fixes
diff --git a/gmf_elements/gmf_audio/idf_component.yml b/gmf_elements/gmf_audio/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.5.2"
+version: "0.6.0"
 description: Espressif GMF Elements Audio Module
 url: https://github.com/espressif/esp-gmf/tree/main/gmf_elements/gmf_audio
 documentation: "https://github.com/espressif/esp-gmf/blob/main/gmf_elements/gmf_audio/README.md"
diff --git a/gmf_elements/gmf_io/CHANGELOG.md b/gmf_elements/gmf_io/CHANGELOG.md
@@ -0,0 +1,24 @@
+# Changelog
+
+## v0.6.0
+
+### Features
+- Added support for NULL object configuration
+- Renamed component to `gmf_io`
+- Updated the License
+
+### Bug Fixes
+- Standardized return values of port and data bus acquire/release APIs to esp_gmf_err_io_t only
+
+## v0.5.1
+
+### Bug Fixes
+
+- Fixed the component requirements
+
+
+## v0.5.0
+
+### Features
+
+- Initial version of `esp-gmf-io`
diff --git a/gmf_elements/gmf_io/idf_component.yml b/gmf_elements/gmf_io/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.5.1"
+version: "0.6.0"
 description: Espressif GMF IO Module
 url: https://github.com/espressif/esp-gmf/tree/main/gmf_elements/gmf_io
 documentation: "https://github.com/espressif/esp-gmf/blob/main/gmf_elements/gmf_io/README.md"
diff --git a/gmf_elements/gmf_misc/CHANGELOG.md b/gmf_elements/gmf_misc/CHANGELOG.md
@@ -0,0 +1,22 @@
+# Changelog
+
+## v0.6.0
+
+### Features
+- Added GMF port attribution for elements
+- Renamed component to `gmf_misc`
+- Updated the License
+
+
+## v0.5.1
+
+### Bug Fixes
+
+- Fixed the component requirements
+
+
+## v0.5.0
+
+### Features
+
+- Initial version of `esp-gmf-misc`
diff --git a/gmf_elements/gmf_misc/idf_component.yml b/gmf_elements/gmf_misc/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.5.1"
+version: "0.6.0"
 description: Espressif GMF Elements Misc Module
 url: https://github.com/espressif/esp-gmf/tree/main/gmf_elements/gmf_misc
 documentation: "https://github.com/espressif/esp-gmf/blob/main/gmf_elements/gmf_misc/README.md"
diff --git a/gmf_elements/test_apps/main/idf_component.yml b/gmf_elements/test_apps/main/idf_component.yml
@@ -1,10 +1,10 @@
 dependencies:
   espressif/gmf_audio:
-    path: ../../gmf_audio
+    override_path: ../../gmf_audio
   espressif/gmf_io:
-    path: ../../gmf_io
+    override_path: ../../gmf_io
   espressif/gmf_misc:
-    path: ../../gmf_misc
+    override_path: ../../gmf_misc
   espressif/gmf_ai_audio:
-    path: ../../gmf_ai_audio
+    override_path: ../../gmf_ai_audio
   espressif/esp-dsp: <=1.5.0
