Espressif Audio Development Framework
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
components
docs
examples
tools/ci
.editorconfig
.gitignore
.gitlab-ci.yml
.gitmodules
LICENSE
README.md
project.mk

README.md

Espressif Audio Development Framework

Documentation Status

Espressif Systems Audio Development Framework (ESP-ADF) is the official audio development framework for the ESP32 chip.

Overview

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

  • Music player or recorder supports audio formats such as MP3, AAC, FLAC, WAV, OGG, AMR, TS, EQ, Downmixer, Sonic, G.711, SPEEX ...
  • Play music from sources: HTTP, HLS(HTTP Live Streaming), SPIFFS, SDCARD, A2DP-Source, A2DP-Sink, HFP ...
  • Integrate Media services such as: DLNA, WeChat ...
  • Internet Radio
  • Voice recognition and integration with online services such as Alexa, DuerOS, ...

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

ADF Block Diagram

Developing with the ESP-ADF

Quick Start

You need the ESP32-LyraT board and headphone connected, make sure you clone the project recursive:

git clone --recursive https://github.com/espressif/esp-adf.git
cd esp-adf/examples/get-started/play_mp3
make menuconfig
make flash monitor

If you clone project without --recursive flag, please goto the esp-adf directory and run command git submodule update --init before doing anything.

Hardware

Espressif Systems has released a number of boards for ESP-ADF to develop ESP32 audio applications, including:

ESP32-LyraT Development Board ESP32-LyraTD-MSC Development Board
ESP32-LyraT Developement Board ESP32-LyraTD-MSC Developement Board
Getting Started with ESP32-LyraT Getting Started with ESP32-LyraTD-MSC

ESP32-LyraT

An open-source development board, supporting Espressif Systems’ ADF and featuring voice wake-up, a wake-up button and an audio player. Designed for smart speakers and smart-home applications.

ESP32-LyraT Developement Board Overview

ESP32-LyraTD-MSC

Designed for smart speakers and AI applications. Supports Acoustic Echo Cancellation (AEC), Automatic Speech Recognition (ASR), Wake-up Interrupt and Voice Interaction.

ESP32-LyraTD-MSC Developement Board Overview

ESP-IDF

ESP-ADF is based on the application layer of ESP-IDF (Espressif IoT Development Framework). The git clone command, described under Quick Start above, automatically downloads specific version of the ESP-IDF alongside with ESP-ADF. Please take a look at Get Started

Examples

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

Resources