Skip to content

espressif/esp-adf

Repository files navigation

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, and ESP32-S3 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 ESP32-LyraTD-MSC Development Board ESP32-LyraT-Mini Development Board ESP32-Korvo-DU1906 Development Board ESP32-LyraT-Mini Development Board 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.

Examples

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

Resources