ESP-ADF Pre-release v1.0-beta1
Pre-releaseDocumentation for release v1.0-beta1 is available at: https://esp-adf.readthedocs.io/en/latest/?badge=latest
The following contains the release information for the first release of ESP-ADF (v1.0-beta1).
Known Issues
- Some TS formats are not supported
New Functionalities
Pipeline Framework
Below are the open-source parts of ESP-ADF:
-
Audio Element
- Element: flexible and fully-functional APIs
- Element: non-task oriented
- Support callback input
- Support customized tasks
-
Audio Pipeline
- Flexible and fully-functional APIs
- Non-task oriented implementation
-
Audio Event Interface
-
RingBuffer
ESP ADF Libraries
The planned ADF libraries are shown as below:https://github.com/espressif/esp-adf#espressif-audio-development-framework. Currently, the released libraries include:
Decoder
- MP3-LayerIII
- WAV
- AAC-LC, AAC-HE
- TS
Encoder
- WAV
Filter
- Resample
- Support for
- Single-channel to Single-channel;
- Dual-channel to Dual-channel;
- Single-channel to Dual-channel;
- Dual-channel to Single-channel.
- Up-sample
- Down-sample
- Support for
Others
-
ESP Recorder
- Triggered by APIs
- Supports stop of VAD (Voice Activity Detection) recording
-
ESP Player
- Simple APIs
- Playing by URI
- Recording by URI
-
ESP VAD
- Multiple sampling rate
- Multi frame size
CODEC IC
Currently the supported codec ICs include:
- ES8388
- ES8374
Supported Development Boards
The series of LyraT development boards are designed for the solutions with push buttons, and the LyraTD series are designed for the far-field solutions. Currently the supported boards are as follows:
- LyraT-V4.2
- LyraT-V4.3
Peripherals
- Wi-Fi
- Setting Wi-Fi by Smartconfig
- Wi-Fi event notification
- Touch
- Short touch
- Touch and hold
- Button
- Short press
- Press and hold
- Console
- SD Card
- LED
- LED blink
- LED fade blink
Cloud Platform
The cloud platforms supported by ADF as planned are shown as below https://github.com/espressif/esp-adf#espressif-audio-development-framework. Currently the supported cloud platform is:
- DuerOS DCS 3.0.2
Audio Stream
Currently the supported audio streams include:
- I2S Stream
- HTTP Stream
- FatFs Stream
- Raw Stream
- DAC Stream
- HTTP Live Stream
New Examples of ADF
Examples to demonstrate the usage of ADF components are as follows:
- CLI
- AWS Polly Demo
- Google Translate Demo
- Baidu Speech Demo
- DuerOS Solution
- Resample Demo
- Get-started Demos
- Pipeline BT Sink
- Play http server mp3 music
- Play SD Card MP3 and controlled by touch
- Recording WAV to SD Card Demo
Get This Release
Because we use the git submodules, the source files attached to this version will not work.
It is recommended using "git" to obtain ESP-ADF (v1.0-beta1):
git clone https://github.com/espressif/esp-adf.git esp-adf-v1.0-beta1
cd esp-adf-v1.0-beta1/
git checkout v1.0-beta1
git submodule update --init --recursive
To get the programming guide for Audio Development Framework, please refer to https://esp-adf.readthedocs.io/en/latest/?badge=latest.