uploaded 4 months ago
Espressif GMF Audio Elements Module

readme

ESP-GMF-Audio

  • Component Registry

  • 中文版

ESP GMF Audio is a collection of GMF elements related to audio processing, including audio encoding, decoding, and audio effect processing algorithms. The currently supported audio modules are listed in the table below.

Name TAG Function Method Input Port Output Port Input blocking time Output blocking time Dependent on Audio Information
AUDIO_DEC aud_dec Audio decoder: MP3,AAC,AMRNB,
AMRWB,FLAC,WAV,M4A,TS
Nil Single Single User configurable, default value is maximum delay User configurable, default value is maximum delay No
AUDIO_ENC aud_enc Audio encoder: AAC,AMRNB,AMRWB,
ADPCM,OPUS,PCM
Nil Single Single User configurable, default value is maximum delay User configurable, default value is maximum delay Yes
RATE_CVT aud_rate_cvt Audio sampling rate adjustment set_dest_rate Single Single Maximum delay Maximum delay Yes
BIT_CVT aud_bit_cvt Audio bit-depth conversion set_dest_bits Single Single Maximum delay Maximum delay Yes
CH_CVT aud_ch_cvt Audio channel conversion set_dest_ch Single Single Maximum delay Maximum delay Yes
ALC aud_alc Audio volume adjustment set_gain
get_gain
Single Single Maximum delay Maximum delay Yes
EQ aud_eq Audio equalizer adjustment set_para
get_para
enable_filter
disable_filter
Single Single Maximum delay Maximum delay Yes
FADE aud_fade Audio fade-in and fade-out effects set_mode
get_mode
reset_weight
Single Single Maximum delay Maximum delay Yes
SONIC aud_sonic Audio pitch and speed shifting effects set_speed
get_speed
set_pitch
get_pitch
Single Single Maximum delay Maximum delay Yes
MIXER aud_mixer Audio mixing effects set_info
set_mode
Multiple Single The blocking time for the first channel is 0, while the blocking time for other channels is maximum delay Maximum delay No
INTERLEAVE aud_intlv Data interleaving Nil Multiple Single User configurable, default value is maximum delay Maximum delay Yes
DEINTERLEAVE aud_deintlv Data de-interleaving Nil Single Multiple Maximum delay User configurable, default value is maximum delay Yes

Usage

The ESP GMF Audio is often used in combination to form a pipeline. For example code, please refer to test_app。

You can also create and compile a project using the following commands, taking the pipeline_play_embed_music project as an example. Before starting, make sure you have a working ESP-IDF environment.

1. Create the Example Project

Create the pipeline_play_embed_music example project based on the gmf_examples component (using version v0.7.0 as an example; update the version as needed):

Shell

idf.py create-project-from-example "espressif/gmf_examples=0.7.0:pipeline_play_embed_music"

2. Build and Flash the Project Using an ESP32-S3 Board

Shell

cd pipeline_play_embed_music
idf.py set-target esp32s3
idf.py -p YOUR_PORT flash monitor

Links

Supports all targets

License: Custom

Tags

To add this component to your project, run:

idf.py add-dependency "espressif/gmf_audio^0.7.0"

download archive

Stats

  • Archive size
    Archive size ~ 68.44 KB
  • Downloaded in total
    Downloaded in total 3.3k times
  • Downloaded this version
    This version: 1.4k times

Badge

espressif/gmf_audio version: 0.7.0
|