MP3 Decoder¶
Decode an audio data stream provided in MP3 format.
Application Examples¶
Implementation of this API is demonstrated in the following examples:
API Reference¶
Header File¶
Functions¶
-
audio_element_handle_t
mp3_decoder_init(mp3_decoder_cfg_t *config)¶ Create an Audio Element handle to decode incoming MP3 data.
- Return
The audio element handle
- Parameters
config: The configuration
-
const esp_id3_info_t *
mp3_decoder_get_id3_info(audio_element_handle_t self)¶ Get ID3 information.
- Return
esp_id3_info_t: success NULL: ID3 is not exist or memory aloocation failed.
- Parameters
self: The audio element handle
Structures¶
-
struct
mp3_decoder_cfg_t¶ Mp3 Decoder configuration.
Public Members
-
int
out_rb_size¶ Size of output ringbuffer
-
int
task_stack¶ Task stack size
-
int
task_core¶ CPU core number (0 or 1) where decoder task in running
-
int
task_prio¶ Task priority (based on freeRTOS priority)
-
bool
stack_in_ext¶ Try to allocate stack in external memory
-
bool
id3_parse_enable¶ True: parse ID3. False: Don’t parse ID3
-
int
Macros¶
-
MP3_DECODER_TASK_STACK_SIZE¶
-
MP3_DECODER_TASK_CORE¶
-
MP3_DECODER_TASK_PRIO¶
-
MP3_DECODER_RINGBUFFER_SIZE¶
-
DEFAULT_MP3_DECODER_CONFIG()¶