11 Star 37 Fork 11

乐鑫开源 / esp-adf

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

Espressif Audio Development Framework

Documentation Status

Espressif Systems Audio Development Framework (ESP-ADF) is the official audio development framework for the ESP32, ESP32-S2, ESP32-C3, ESP32-C6, ESP32-S3, and ESP32-P4 SoCs.

Overview

ESP-ADF supports development of audio applications for the Espressif Systems SoCs in the most comprehensive way. With ESP-ADF, you can easily add features, develop audio and video applications from simple to complex:

  • Music player or recorder supports audio formats such as MP3, AAC, FLAC, WAV, OGG, OPUS, AMR, TS, EQ, Downmixer, Sonic, ALC, G.711 and etc.
  • Play music from sources: HTTP, HLS (HTTP Live Streaming), SPIFFS, SDCARD, A2DP-Source, A2DP-Sink, HFP and etc.
  • Integrate media protocols, such as: DLNA, VoIP, RMTP, ESP-RTC (SIP, RTSP, and RTCP), etc.
  • Video call, video recording and video live streaming
  • Internet Radio
  • Voice recognition and integration with online services such as Alexa, DuerOS and etc.

As a general, the ESP-ADF features will be supported as shown below:

ADF Block Diagram

Developing with the ESP-ADF

IDF Version

The following table shows the ESP-IDF versions supported by ESP-ADF at the current time. The label alt text means supported, and the label alt text means not supported.

The ESP-IDF master branch is marked as not supported because the major feature changes it has introduced may cause conflicts with ESP-ADF. Yet, the ADF examples not affected by those feature changes can still run correctly on the IDF master branch.

End of Life IDF branches are removed. See IDF Supported Periods for details.

ESP-IDF
Release/v4.4
ESP-IDF
Release/v5.0
ESP-IDF
Release/v5.1
ESP-IDF
Release/v5.2
ESP-IDF
Master
ESP-ADF
Master
alt text alt text alt text alt text alt text
ESP-ADF
Release/v2.6
alt text 1 alt text alt text alt text alt text
ESP-ADF
Release/v2.5
alt text 1 alt text alt text alt text alt text
ESP-ADF
Release/v2.4
alt text 1 alt text alt text alt text alt text

Note 1: The built-in IDF branch of ESP-ADF v2.4 is IDF Release/v4.4 at the current time.

Quick Start

You need one of ESP-IDF versions described in ESP-ADF Releases, one of audio boards below and headphones.

Note: If this is your first exposure to ESP-IDF, proceed to Getting Started documentation specific for ESP32, ESP32-S2, or ESP32-S3 SoCs.

Click on one of audio boards shown below to set up and start using ESP-ADF.

Hardware

Espressif Systems has released a number of boards for ESP-ADF to develop audio applications. Click the links below to learn more information on each board.

It is recommended to use the ESP-ADF master branch, as it has the latest bugfixes and the new features.

ESP32-LyraT ESP32-LyraTD-MSC ESP32-LyraT-Mini ESP32-Korvo-DU1906 ESP32-S2-Kaluga-1 Kit ESP32-S3-Korvo-2 ESP32-C3-Lyra ESP32-S3-Box Serials
ESP32-LyraT Development Board 2 ESP32-LyraTD-MSC Development Board 2 ESP32-LyraT-Mini Development Board ESP32-Korvo-DU1906 Development Board 2 ESP32-LyraT-Mini Development Board 2 ESP32-S3-Korvo-2 Development Board ESP32-C3-Lyra Development Board ESP32-S3-Box Development Board
ESP-ADF Master alt text alt text alt text alt text alt text alt text alt text alt text
ESP-ADF Release/v2.6 alt text alt text alt text alt text alt text alt text alt text alt text 1
ESP-ADF Release/v2.5 alt text alt text alt text alt text alt text alt text alt text alt text
ESP-ADF Release/v2.4 alt text alt text alt text alt text alt text alt text alt text alt text

Note 1: For the development board of esp-box series, only esp32-s3-box and esp32-s3-box-lite are supported in ESP-ADF Release/v2.6.

Note 2: The board has reached its end of life.

Examples

Check folder examples that contains sample applications to demonstrate API features of the ESP-ADF.

Resources

ESPRESSIF MIT License Copyright (c) 2018 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD> Permission is hereby granted for use on all ESPRESSIF SYSTEMS products, in which case, it is free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

ESP-ADF 是由乐鑫官方推出的针对 ESP32 和 ESP32-S2 系列芯片的音频开发框架。ESP-ADF 国内镜像仓库,Issues 和 PRs 请仍旧提交到 github。 展开 收起
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
C
1
https://gitee.com/EspressifSystems/esp-adf.git
git@gitee.com:EspressifSystems/esp-adf.git
EspressifSystems
esp-adf
esp-adf
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891