ESP-ADF Release v2.2
Below is the release information of ESP-ADF v2.2, and its documentation is available here.
Changes since v2.1
Major New Features
Pipeline Framework
New Features
-
Added the
audio_sys_get_real_time_stats
API -
Added the
audio_element_get_read_cb
API to obtain the read callback -
Added the
audio_element_get_write_cb
API to obtain the write callback -
Added the
audio_pipeline_wait_for_stop_with_ticks
andaudio_pipeline_terminate_with_ticks
APIs -
Added a lot of thread safe APIs, such as
audio_element_set_reserve_user0
,audio_element_set_reserve_user1
,audio_element_set_reserve_user2
,audio_element_set_reserve_user3
, andaudio_element_set_reserve_user4
-
Changed the
audio_event_iface_cleanup_listener
return value to ESP_OK -
Added the
audio_mem_spiram_stack_is_enabled
API to check if the “stack on external memory” can be supported in different ESP32 chip versions
Bugfix
-
Fixed the issue that return value of the
audio_element_process_init
API is not clear -
Fixed the bug that
abort ringbuffer
is missing from theaudio_element_stop
API -
Fixed the bug that the top command is missing due to the invalid
is_running
flag with live stream -
Fixed the bug that element state is not changed from
AEL_STATE_RUNNING
toAEL_STATE_STOPPED
when destroying element -
Fixed the bug that the registered queues are not cleared because of a wrong discard API was used
ESP_Dispatcher
New Features
-
Modfied the
esp_dispatcher
to support async and sync delegation -
Added the
esp_delegate
instance to theesp_dispatcher
-
Added a
nvs_action
module to delegate NVS operation
Audio Stream
New Features
-
Added option to contain an AMR header in fatfs and spiffs
-
Added support to override the write callback of
i2s_stream
-
Added default PDM configuration in
i2s_stream
-
Added support for
tone_stream
to work with external ram stack -
Added unbuffered APIs to improved the read speed of
fatfs_stream
Bugfix
-
Fixed the bug that living stream reads invalid data due to wrong content length is used in the content sent from the server
-
Fixed the bug that I2S bit flipping occurs in single channel wav audio
Service Framework
New Features
- Added support for
wifi_service
to work with external ram stack - Update the
lightduer
version to v3.1.1
Bugfix
- Fixed the issue that the
wifi_service
reconnect times is not limited
ESP Peripherals
New Features
- Added support for
periph_sdcard_init
to customize SD card modes
Bugfix
-
Fixed the bug that
periph_led
is not thread safe for stop operation -
Fixed a bug that
periph_console
crashes on space character
Audio Protocol
SIP
- Fixed a bug that skip not current sip session
- Fixed a bug that not handle ACK SDP data
ESP Codec and Filter Libraries
New Features
-
Added support for
amr_encoder
andapus_decoder
to select task cores -
Added support for AMR codec to include or exclude AMR header
ESP Audio
-
Improved the
esp_audio_stop
response time -
Added support for
esp_audio
player so it can also be called by multi-thread -
Update the
esp_audio
player version to v1.6.5
Docs
-
Added the link to module datasheet in the Chinese version of the Du1906 Getting Started guide
-
Provided a section to list third party frameworks, libraries, modules, and boards
New Examples of ESP-ADF
Bugfix
-
Fixed the bug that the Bluetooth examples build fails in IDF 4.0 and IDF 4.1
-
Fixed the bug that the DLNA example build fails with cmake
-
Fixed the issues that led to build warnings in IDF v4.1
Korvo Du1906
-
Released
korvo_du1906
v1.2.0 -
Released
korvo_du1906
v1.3.0 -
Fixed a bug that firmware size exceeds the maximum length of the default configuration
-
Fixed the compatibility issues of the du1906 board
-
Changed the
korvo_du1906
example to use the default build configuration -
Added a OTA patch for the
korvo_du1906
example
Get This Release
Using git commands below to obtain ESP-ADF v2.2 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.2
cd esp-adf-v2.2/
git checkout v2.2
git submodule update --init --recursive
To get the programming guide for Audio Development Framework, please check here.