Git Product home page Git Product logo

esp-adf's Introduction

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 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 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 services such as: DLNA, VoIP and etc.
  • 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 lable alt text means supported, and the lable 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 marked as not supported, such as ESP-IDF Release/v4.0. See IDF Supported Periods for details.

ESP-IDF
Release/v4.2
ESP-IDF
Release/v4.3
ESP-IDF
Release/v4.4
ESP-IDF
Release/v5.0
ESP-IDF
Master
ESP-ADF
Master
alt text alt text alt text alt text alt text
ESP-ADF
Release/v2.5
alt text alt text alt text 1 alt text alt text
ESP-ADF
Release/v2.4
alt text alt text alt text 1 alt text alt text
ESP-ADF
Release/v2.3
alt text 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-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
ESP-ADF Master alt text alt text alt text alt text alt text alt text alt text
ESP-ADF Release/v2.5 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
ESP-ADF Release/v2.3 alt text alt text alt text alt text alt text alt text alt text

Examples

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

Resources

esp-adf's People

Contributors

jason-mao avatar krzychb avatar hengyongchao avatar tuanpmt avatar espressif-zhanghu avatar ahhfzhang avatar josephtang avatar houhaiyan avatar vikramdattu avatar majingjing123 avatar tempotian avatar esp-xiaodong avatar charlotudy avatar joy-hao avatar projectgus avatar simple12360 avatar tzxespressio avatar esp-marius avatar su8u7sfkcwtjvh7pjavmej7d avatar fc92 avatar taavihein avatar heyinling avatar nu-ll avatar taoxu1015 avatar raldone01 avatar pmnxis avatar joncmaloney avatar geekxw avatar wujiangang avatar tarun-narain avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.