Configuration Options¶
Compile-time configuration options specific to ESP-ADF.
Audio Recorder¶
AFE_MIC_NUM¶
Number of micphones used for AFE
Found in: Audio Recorder
Now only support 1 or 2 mic
Audio Codec Device Configuration¶
CODEC_ES8311_SUPPORT¶
Support ES8311 Codec Chip
Found in: Component config > Audio Codec Device Configuration
Enable this option to support codec ES8311.
CODEC_ES7210_SUPPORT¶
Support ES7210 Codec Chip
Found in: Component config > Audio Codec Device Configuration
Enable this option to support codec ES7210.
CODEC_ES7243_SUPPORT¶
Support ES7243 Codec Chip
Found in: Component config > Audio Codec Device Configuration
Enable this option to support codec ES7243.
CODEC_ES7243E_SUPPORT¶
Support ES7243E Codec Chip
Found in: Component config > Audio Codec Device Configuration
Enable this option to support codec ES7243E.
CODEC_ES8156_SUPPORT¶
Support ES8156 Codec Chip
Found in: Component config > Audio Codec Device Configuration
Enable this option to support codec ES8156.
CODEC_ES8374_SUPPORT¶
Support ES8374 Codec Chip
Found in: Component config > Audio Codec Device Configuration
Enable this option to support codec ES8374.
CODEC_ES8388_SUPPORT¶
Support ES8388 Codec Chip
Found in: Component config > Audio Codec Device Configuration
Enable this option to support codec ES8388.
CODEC_TAS5805M_SUPPORT¶
Support TAS5805M Codec Chip
Found in: Component config > Audio Codec Device Configuration
Enable this option to support codec TAS5805M.
CODEC_ZL38063_SUPPORT¶
Support ZL38063 Codec Chip
Found in: Component config > Audio Codec Device Configuration
Enable this option to support codec ZL38063. ZL38063 firmware only support xtensa, don’t enable for RISC-V IC.
Audio HAL¶
AUDIO_BOARD¶
Audio board
Found in: Audio HAL
Select an audio board to use with the ESP-ADF
- Available options:
AUDIO_BOARD_CUSTOM
ESP_LYRAT_V4_3_BOARD
ESP_LYRAT_V4_2_BOARD
ESP_LYRATD_MSC_V2_1_BOARD
ESP_LYRATD_MSC_V2_2_BOARD
ESP_LYRAT_MINI_V1_1_BOARD
ESP32_KORVO_DU1906_BOARD
ESP32_S2_KALUGA_1_V1_2_BOARD
ESP32_S3_KORVO2_V3_BOARD
ESP32_S3_KORVO2L_V1_BOARD
ESP32_S3_BOX_LITE_BOARD
ESP32_S3_BOX_BOARD
ESP32_S3_BOX_3_BOARD
ESP32_C3_LYRA_V2_BOARD
ESP32_C6_DEVKIT_BOARD
ESP32_KORVO_DU1906_DAC¶
ESP32 KORVO DU1906 Board DAC chip
Found in: Audio HAL
Select DAC chip to use on ESP32_KORVO_DU1906 board
- Available options:
ESP32_KORVO_DU1906_DAC_TAS5805M
ESP32_KORVO_DU1906_DAC_ES7148
ESP32_KORVO_DU1906_ADC¶
ESP32 KORVO DU1906 Board ADC chip
Found in: Audio HAL
Select ADC chip to use on ESP32_KORVO_DU1906 board
- Available options:
ESP32_KORVO_DU1906_ADC_ES7243
ADF Features¶
ESP_DISPATCHER_DELEGATE_TASK_CORE¶
Delegation task core
Found in: ADF Features
Pinned delegate task to core 0 or core 1.
ESP_DISPATCHER_DELEGATE_TASK_PRIO¶
Delegate task’s prio
Found in: ADF Features
The delegate task’s prio.
ESP_DISPATCHER_DELEGATE_STACK_SIZE¶
Delegate task’s stack size
Found in: ADF Features
The delegate task’s stack is located in DRAM, modify this size to make sure all the needed operation can be run success in the it.
ADF Library Configuration¶
MEDIA_PROTOCOL_LIB_ENABLE¶
Enable Media Protocol Library
Found in: ADF Library Configuration
MEDIA_LIB_MEM_AUTO_TRACE¶
Support trace memory automatically after media_lib_sal init
Found in: ADF Library Configuration
MEDIA_LIB_MEM_TRACE_DEPTH¶
Memory trace stack depth
Found in: ADF Library Configuration
Set memory trace depth
MEDIA_LIB_MEM_TRACE_NUM¶
Memory trace number
Found in: ADF Library Configuration
Set memory trace number
MEDIA_LIB_MEM_TRACE_MODULE¶
Trace for module memory usage
Found in: ADF Library Configuration
MEDIA_LIB_MEM_TRACE_LEAKAGE¶
Trace for memory leakage
Found in: ADF Library Configuration
MEDIA_LIB_MEM_TRACE_SAVE_HISTORY¶
Trace to save memory history
Found in: ADF Library Configuration
MEDIA_LIB_MEM_SAVE_CACHE_SIZE¶
Cache buffer size to store save history
Found in: ADF Library Configuration
Set cache size for memory history
MEDIA_LIB_MEM_TRACE_SAVE_PATH¶
Memory trace save path
Found in: ADF Library Configuration
Set memory trace save path
RECORD_ENGINE_MODE¶
Choose recorder engine functionality
Found in: ADF Library Configuration
Recorder engine have VAD, WWE and AMR encoding functionality. AMR encoding enabled, the binary size increase 144kB. WWE enabled, the binary size increase 103kB.
- Available options:
REC_ENG_ENABLE_VAD_ONLY
REC_ENG_ENABLE_VAD_WWE
REC_ENG_ENABLE_VAD_WWE_AMR