ESP-ADF Release v2.4

Below is the release information of ESP-ADF v2.4, and its documentation is available here.
Supported IDF version please check on here.

Major Changes

• Changed the built-in IDF version from v3.3 to v4.4

Changelog

This is the list of changes since release v2.3:

Framework

New Features

• ADF supports IDF release/v4.4 branch
• Added audio_queue, media_os_ctype, and audio_mutex APIs
• Added esp32 s3 box lite board
• Added esp32 s3 box board
• Added esp32-s3-korvo-2 v3.0 board
• Added audio_board_lcd_init API for board configuration
• Added new Audio_Recorder to support multinet and wake work engine
• Support esp-sr release/v1.0 branch
• Added i2s_stream_sync_delay API to drop or fill PCM data with given time
• Added algo_stream_set_delay to help users debug reference data

Bugfix

• Fixed algorithm stream could not work with new esp_sr APIs

Audio_Hal

New Features

• Added DAC es8156 and ADC es7243e chips
• Modified ZL38063 dsp firmware to reduce the mic gain

Bugfix

• Fixed the bug that es8388 did not work on 8 kHz rate sometimes
• Fixed the bug that es8311 generates noise on 8 kHz - 16 kHz rate

ESP Peripherals

New Features

• Added I/O expander tca9554 driver
• Added peripheral LCD APIs

Bugfix

• Fixed missing partition label when checking for spiffs info
• Fixed the bug that adc_button.c missed RELEASE event on quick press
• Fixed incorrect gpio allocation for one-line mode of sdcard

Media Protocol

Features

• Added media protocol system abstract layer APIs
• Support RFC3581 rport config

Bugfix

• Fixed the loop register bug caused by inviting unknown number
• Fixed the bug that sip could not work on v4.4

ESP Codec Libraries

New Features

• Added JPEG encoder and decoder APIs
• Support HE-AAC(v1 v2)
• Support different MP3 sample rate in one file
• Support multi-channel resample
• Support esp32-c3 chip

Docs

• Added English-Chinese Glossary
• Added English version of esp32-s3-korvo-2 v3.0 user guide
• Fixed broken links
• Upgrade python2 to python3 to build documentation
• Updated integrated module information of dev board user guides

Examples of ESP-ADF

Features

• Updated content and structure of most example readme.md documents
• Added camera capture image and display on lcd example on examples/display/lcd_camera
• Added lcd decoding jpeg exmaple on examples/display/lcd_jpeg
• Added LVGL demo on examples/display/music_player
• Added audio_recoder APIs usage on examples/speech_recognition/wwe

Bugfix

• Fixed the bug of appending the recording information to the fatfs element
• Provided missing tones for asr example
• Modified checks example to support more boards
• Fixed the bug of dueros to support esp32-s3-box
• Fixed the bug that wifi_bt_ble_coex could not build on v4.4
• Fixed crash of google_translate example

Get This Release

Using git commands below to obtain ESP-ADF v2.4 is highly recommended. Note that the submodules should also be updated (using git submodule update --init --recursive). Otherwise, the source files may be not working properly.

git clone https://github.com/espressif/esp-adf.git esp-adf-v2.4

cd esp-adf-v2.4/

git checkout v2.4

git submodule update --init --recursive

To get the programming guide for Audio Development Framework, please check here.