Skip to content

Commit 9a1ff29

Browse files
committed
Merge branch 'bugfix/fix_component_requires' into 'main'
Fix the components require See merge request adf/multimedia/esp-gmf!16
2 parents 3a45bd4 + 170d553 commit 9a1ff29

File tree

14 files changed

+39
-30
lines changed

14 files changed

+39
-30
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ ESP-GMF consists of three modules: **GMF-Core**, **GMF-Elements**, and **GMF-Exa
77

88
- **GMF-Core** is the core of the ESP-GMF software framework and includes the main components such as GMF-Element, GMF-Pipeline, and GMF-Task.
99
- **GMF-Elements** implements various functional elements based on GMF-Core, such as codec algorithms, audio processing algorithms, and more.
10-
- **GMF-Examples** provides examples of how to use GMF-Pipeline to implement simple functionalities, such as playing music from flash or an SD card. It also includes examples of high-level components implemented using GMF-Pipeline, such as the **Audio Simple Player**, a basic audio decoding player.
10+
- **GMF-Examples** provides examples of how to use GMF-Pipeline to implement simple functionalities, such as playing music from flash or an SD card. It also includes examples of high-level components implemented using GMF-Pipeline, such as the **ESP Audio Simple Player**, a basic audio decoding player.
1111

1212
# ESP-GMF Component Overview
1313

14-
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-image, [GMF-Misc](./gmf_elements/gmf_misc/README.md), and [GMF-IO](./gmf_elements/gmf_io/README.md).
14+
Each ESP-GMF functional module exists as a component, currently including [ESP-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), and [ESP-GMF-IO](./gmf_elements/gmf_io/README.md).
1515

1616
| Component Name | Function | Dependent Components |
1717
| :------------: | :------------: | :------------ |
18-
| [GMF-Core](./gmf_core) | Core framework for GMF | None |
19-
| [GMF-Element-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` |
20-
| [GMF-Element-MISC](./gmf_elements/gmf_misc) | Utility elements | None |
21-
| GMF-Element-Image | Elements for image encoding, decoding,<br>and image effects processing | - `gmf-core`<br>- `esp_new_jpeg` |
22-
| [GMF-IO](./gmf_elements/gmf_io) | Input/output for files, flash, and HTTP | - `gmf-core`<br>- `esp_codec_dev` |
18+
| [esp_gmf_core](./gmf_core) | Core framework for GMF | None |
19+
| [esp_gmf_audio](./gmf_elements/gmf_audio) | Elements for audio encoding, decoding,<br>and sound effects processing | - `esp_gmf_core`<br>- `esp_audio_effects`<br>- `esp_audio_codec` |
20+
| [esp_gmf_misc](./gmf_elements/gmf_misc) | Utility elements | None |
21+
| esp_gmf_image | Elements for image encoding, decoding,<br>and image effects processing | - `esp_gmf_core`<br>- `esp_new_jpeg` |
22+
| [esp_gmf_io](./gmf_elements/gmf_io) | Input/output for files, flash, and HTTP | - `esp_gmf_core`<br>- `esp_codec_dev` |
2323

2424
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.
2525

README_CN.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ ESP-GMF 包含 GMF-Core、 GMF-Elements 和 GMF-Examples 三个模块。
77

88
- GMF-Core 是 ESP-GMF 软件框架的核心,有 GMF-Element、GMF-Pipeline、GMF-Task 等主要部件。
99
- GMF-Elements 是基于 GMF-Core 实现的各种具体功能 element,比如编解码算法、音效处理算法等。
10-
- GMF-Examples 提供如何使用 GMF-Pipeline 实现简单功能的示例,比如播放 flash 或 SD 卡中的音乐,同时还有基于 GMF-Pipeline 实现的 High Level 功能的组件示例,比如 **Audio Simple Player** 是一个简单音频解码播放器。
10+
- GMF-Examples 提供如何使用 GMF-Pipeline 实现简单功能的示例,比如播放 flash 或 SD 卡中的音乐,同时还有基于 GMF-Pipeline 实现的 High Level 功能的组件示例,比如 **ESP Audio Simple Player** 是一个简单音频解码播放器。
1111

1212
# ESP-GMF 组件介绍
1313

14-
ESP-GMF 各个功能模块以组件的形式存在,目前包含 [GMF-Core](./gmf_core/README_CN.md)[GMF-Audio](./gmf_elements/gmf_audio/README_CN.md)、GMF-Image、[GMF-Misc](./gmf_elements/gmf_misc/README_CN.md)[GMF-IO](./gmf_elements/gmf_io/README_CN.md)
14+
ESP-GMF 各个功能模块以组件的形式存在,目前包含 [ESP-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)
1515

1616
| 组件名称 | 功能 | 依赖的组件 |
1717
| :------------: | :------------:|:------------ |
18-
| [GMF-Core](./gmf_core) | GMF 基础框架 ||
19-
| [GMF-Element-Audio](./gmf_elements/gmf_audio) | GMF 音频编解码和<br>音效处理 element | - `gmf-core`<br>- `esp_audio_effects`<br> - `esp_audio_codec` |
20-
| [GMF-Element-Misc](./gmf_elements/gmf_misc) | 工具类 element ||
21-
| GMF-Element-Image | GMF 图像编解码和<br>图像效果处理 element | - `gmf-core`<br>- `esp_new_jpeg` |
22-
| [GMF-IO](./gmf_elements/gmf_io) | 文件、flash、HTTP 输入输出 | - `gmf-core`<br>- `esp_codec_dev` |
18+
| [esp_gmf_core](./gmf_core) | GMF 基础框架 ||
19+
| [esp_gmf_audio](./gmf_elements/gmf_audio) | GMF 音频编解码和<br>音效处理 element | - `esp_gmf_core`<br>- `esp_audio_effects`<br> - `esp_audio_codec` |
20+
| [esp_gmf_misc](./gmf_elements/gmf_misc) | 工具类 element ||
21+
| esp_gmf_image | GMF 图像编解码和<br>图像效果处理 element | - `esp_gmf_core`<br>- `esp_new_jpeg` |
22+
| [esp_gmf_io](./gmf_elements/gmf_io) | 文件、flash、HTTP 输入输出 | - `esp_gmf_core`<br>- `esp_codec_dev` |
2323

2424
在开发项目时,推荐使用官方 GMF-Elements 仓库的 elements 和 IOs 组件进行开发,也可以自行创建 element 和 IO 组件来扩展其应用场景。
2525

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11

22
idf_component_register(SRC_DIRS "src"
33
INCLUDE_DIRS "include"
4-
REQUIRES "gmf_core" "gmf_io" "gmf_audio")
4+
REQUIRES)

examples/esp_audio_simple_player/idf_component.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
version: "0.9.0"
1+
version: "0.9.1"
22
description: Espressif audio simple player based on ESP-GMF
33
url: https://github.com/espressif/esp-gmf/tree/main/examples/esp_audio_simple_player
44
documentation: "https://github.com/espressif/esp-gmf/blob/main/examples/esp_audio_simple_player/README.md"
55
issues: "https://github.com/espressif/esp-gmf/issues"
66

77
tags:
8-
- "audio_player"
98
- "gmf"
9+
- "audio_player"
1010

1111
dependencies:
1212
espressif/esp_gmf_audio:

examples/system_common/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ message("Defined preprocessor variables-USER: ${defined_defs}")
33

44
idf_component_register(SRC_DIRS "./"
55
INCLUDE_DIRS "./"
6-
REQUIRES "sdmmc" "fatfs" "esp_wifi" "nvs_flash" "gmf_core" "gmf_io" "gmf_audio" "gmf_misc")
6+
REQUIRES "sdmmc" "fatfs" "esp_wifi" "nvs_flash")
Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
dependencies:
2-
espressif/gmf_misc:
3-
git: "https://github.com/espressif/esp-gmf.git"
4-
path: "gmf_elements/gmf_misc"
2+
espressif/esp_gmf_misc:
3+
require: public
4+
version: "*"
5+
espressif/esp_gmf_audio:
6+
require: public
7+
version: "*"
8+
espressif/esp_gmf_io:
9+
require: public
510
version: "*"

gmf_core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Overview of the GMF-Core Framework
2-
[中文版](gmf_core/README_CN.md)
2+
[中文版](./README_CN.md)
33

44
The following diagram illustrates the class relationships within the GMF-Core framework.
55
```mermaid

gmf_core/README_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# GMF-Core 框架介绍
2-
[English](gmf_core/README.md)
2+
[English](./README.md)
33

44
下图展示了 GMF-Core 框架的类图关系。
55
```mermaid
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
idf_component_register(SRC_DIRS "./"
22
INCLUDE_DIRS "./include"
3-
PRIV_INCLUDE_DIRS "./private_include"
4-
REQUIRES "gmf_core" "esp_audio_codec" "esp_audio_effects")
3+
PRIV_INCLUDE_DIRS "./private_include")

gmf_elements/gmf_audio/idf_component.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: "0.5.0"
1+
version: "0.5.1"
22
description: Espressif GMF Elements Audio Module
33
url: https://github.com/espressif/esp-gmf/tree/main/gmf_elements/gmf_audio
44
documentation: "https://github.com/espressif/esp-gmf/blob/main/gmf_elements/gmf_audio/README.md"
@@ -9,8 +9,11 @@ tags:
99

1010
dependencies:
1111
espressif/esp_audio_codec:
12+
require: public
1213
version: "*"
1314
espressif/esp_audio_effects:
15+
require: public
1416
version: "*"
1517
espressif/esp_gmf_core:
18+
require: public
1619
version: "^0.5"

0 commit comments

Comments
 (0)