jason-mao/gmf_examples - 0.7.0 - Example pipeline_record

# Recording Audio File to microSD Card - [中文版](./README_CN.md) ## Example Brief This example demonstrates how to capture audio using CODEC_DEV_RX IO from the codec, encode the recorded sound using an encoder element, and save the encoded data back to the microSD card via File IO. This example supports encoding the recording into AAC, G711A, G711U, AMRNB, AMRWB, OPUS, ADPCM, and PCM audio formats, with AAC as the default format. ## Example Set Up ### Default IDF Branch This example supports IDF release/v5.3 and later branches. ### Configuration This example requires a microSD card. The recorded and encoded audio will be automatically stored on the microSD card. Users can modify the encoding format and audio parameter configuration using the `esp_gmf_audio_helper_reconfig_enc_by_type` function. This example supports the ESP32s3_Korvo_2, ESP32p4_Function_EV_Board boards. Other boards support need to modify the following content in the [ system_common ](../../system_common): | Configuration | Related Files | Related Functions | |:----:| :-----: | :---- | |I2S Port and I2S Format| `esp_gmf_gpio_config.h`<br>`esp_gmf_setup_peripheral.c` | `pool_i2s_channel_init` | |I2C Port| `esp_gmf_gpio_config.h`<br>`esp_gmf_setup_peripheral.c` | `esp_gmf_setup_periph_i2c` | |Codec Type and Format |`esp_gmf_setup_peripheral.c` |`setup_periph_new_record_codec` | |Sdmmc Port| `esp_gmf_gpio_config.h`<br>`esp_gmf_setup_peripheral.c` | `esp_gmf_setup_periph_sdmmc` | ### Build and Flash Before compiling this example, ensure that the ESP-IDF environment is properly configured. If it is already set up, you can proceed to the next configuration step. If not, run the following script in the root directory of ESP-IDF to set up the build environment. For detailed steps on configuring and using ESP-IDF, please refer to the [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/index.html) ``` ./install.sh . ./export.sh ``` Here are the summarized steps for compilation: - Enter the location where the audio recording and storage on the microSD card test project is stored ``` cd $YOUR_GMF_PATH/gmf_examples/basic_examples/pipeline_record_sdcard ``` - Select the target chip for compilation. For example, to use the ESP32S3: ``` idf.py set-target esp32s3 ``` - Build the Example ``` idf.py build ``` - Flash the program and run the monitor tool to view serial output (replace PORT with the port name): ``` idf.py -p PORT flash monitor ``` - Exit the debugging interface using ``Ctrl-]`` ## How to use the Example ### Example Functionality - After the example starts running, the recorded data will be encoded and automatically stored on the microSD card, stop and exit after recording is complete, with the following output: ```c I (1020) REC_SDCARD: [ 1 ] Mount sdcard I (1025) gpio: GPIO[15]| InputEn: 0| OutputEn: 0| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0 I (1034) gpio: GPIO[7]| InputEn: 0| OutputEn: 0| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0 I (1044) gpio: GPIO[4]| InputEn: 0| OutputEn: 0| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0 I (1093) REC_SDCARD: [ 2 ] Register all the elements and set audio information to record codec device I (1097) ES7210: Work in Slave mode I (1104) ES7210: Enable ES7210_INPUT_MIC1 I (1107) ES7210: Enable ES7210_INPUT_MIC2 I (1111) ES7210: Enable ES7210_INPUT_MIC3 I (1114) ES7210: Enable TDM mode E (1120) i2s_common: i2s_channel_disable(1107): the channel has not been enabled yet I (1123) I2S_IF: channel mode 0 bits:16/16 channel:2 mask:1 I (1129) I2S_IF: STD Mode 0 bits:16/16 channel:2 sample_rate:16000 mask:1 I (1137) ES7210: Bits 8 I (1147) ES7210: Enable ES7210_INPUT_MIC1 I (1150) ES7210: Enable ES7210_INPUT_MIC2 I (1153) ES7210: Enable ES7210_INPUT_MIC3 I (1157) ES7210: Enable TDM mode I (1163) ES7210: Unmuted I (1163) Adev_Codec: Open codec device OK I (1166) ESP_GMF_POOL: Registered items on pool:0x3c1a7640, app_main-51 I (1173) ESP_GMF_POOL: IO, Item:0x3c1a78e0, H:0x3c1a7850, TAG:codec_dev_rx I (1180) ESP_GMF_POOL: IO, Item:0x3c1a79b0, H:0x3c1a78f0, TAG:http I (1187) ESP_GMF_POOL: IO, Item:0x3c1a7a80, H:0x3c1a79c0, TAG:http I (1194) ESP_GMF_POOL: IO, Item:0x3c1a7b1c, H:0x3c1a7a90, TAG:file I (1201) ESP_GMF_POOL: IO, Item:0x3c1a7bb8, H:0x3c1a7b2c, TAG:file I (1208) ESP_GMF_POOL: IO, Item:0x3c1a7ce8, H:0x3c1a7c54, TAG:embed_flash I (1215) ESP_GMF_POOL: EL, Item:0x3c1a7c44, H:0x3c1a7bc8, TAG:copier I (1222) ESP_GMF_POOL: EL, Item:0x3c1a7dfc, H:0x3c1a7cf8, TAG:encoder I (1229) ESP_GMF_POOL: EL, Item:0x3c1a7ef0, H:0x3c1a7e0c, TAG:decoder I (1237) ESP_GMF_POOL: EL, Item:0x3c1a7fcc, H:0x3c1a7f00, TAG:alc I (1243) ESP_GMF_POOL: EL, Item:0x3c1a8090, H:0x3c1a7fdc, TAG:eq I (1250) ESP_GMF_POOL: EL, Item:0x3c1a80c4, H:0x3c1a81f8, TAG:ch_cvt I (1257) ESP_GMF_POOL: EL, Item:0x3c1a80f4, H:0x3c1a829c, TAG:bit_cvt I (1264) ESP_GMF_POOL: EL, Item:0x3c1a83dc, H:0x3c1a8340, TAG:rate_cvt I (1271) ESP_GMF_POOL: EL, Item:0x3c1a84b8, H:0x3c1a83ec, TAG:fade I (1278) ESP_GMF_POOL: EL, Item:0x3c1a85b4, H:0x3c1a84c8, TAG:sonic I (1285) ESP_GMF_POOL: EL, Item:0x3c1a8694, H:0x3c1a85c4, TAG:deinterleave I (1293) ESP_GMF_POOL: EL, Item:0x3c1a8770, H:0x3c1a86a4, TAG:interleave I (1300) ESP_GMF_POOL: EL, Item:0x3c1a8870, H:0x3c1a8780, TAG:mixer I (1307) REC_SDCARD: [ 3 ] Create audio pipeline, add all elements to pipeline I (1315) REC_SDCARD: [ 3.1 ] Set audio url to record I (1321) REC_SDCARD: [ 3.2 ] Reconfig audio encoder type by url and audio information and report information to the record pipeline W (1333) ESP_GMF_PIPELINE: There is no thread for add jobs, pipe:0x3c1a8880, tsk:0x0, [el:encoder-0x3c1a88b8] I (1344) REC_SDCARD: [ 3.3 ] Create gmf task, bind task to pipeline and load linked element jobs to the bind task I (1355) ESP_GMF_TASK: Waiting to run... [tsk:TSK_0x3fcb1260-0x3fcb1260, wk:0x0, run:0] I (1363) ESP_GMF_THREAD: The TSK_0x3fcb1260 created on internal memory I (1370) ESP_GMF_TASK: Waiting to run... [tsk:TSK_0x3fcb1260-0x3fcb1260, wk:0x3c1a8ba8, run:0] I (1380) REC_SDCARD: [ 3.4 ] Create envent group and listening event from pipeline I (1388) REC_SDCARD: [ 4 ] Start audio_pipeline I (1393) FILE_IO: Open, dir:2, uri:/sdcard/esp_gmf_rec001.aac I (1409) REC_SDCARD: CB: RECV Pipeline EVT: el:OBJ_GET_TAG(event->from)-0x3c1a8880, type:8192, sub:ESP_GMF_EVENT_STATE_OPENING, payload:0x0, size:0,0x0 I (1416) REC_SDCARD: CB: RECV Pipeline EVT: el:OBJ_GET_TAG(event->from)-0x3c1a88b8, type:8192, sub:ESP_GMF_EVENT_STATE_RUNNING, payload:0x0, size:0,0x0 I (1428) ESP_GMF_TASK: One times job is complete, del[wk:0x3c1a8ba8,ctx:0x3c1a88b8, label:encoder_open] I (1438) ESP_GMF_PORT: ACQ IN, new self payload:0x3c1a8ba8, port:0x3c1a8a50, el:0x3c1a88b8-encoder I (1448) ESP_GMF_PORT: ACQ OUT, new self payload:0x3c1b6220, port:0x3c1a8b20, el:0x3c1a88b8-encoder I (1461) REC_SDCARD: [ 5 ] Wait for a while to stop record pipeline I (11494) ESP_GMF_CODEC_IO: CLose, 0x3c1a89e4, pos = 323584/0 I (11494) FILE_IO: CLose, 0x3c1a8a94, pos = 80896/0 I (11495) ESP_GMF_TASK: One times job is complete, del[wk:0x3c1a8bcc,ctx:0x3c1a88b8, label:encoder_close] I (11505) REC_SDCARD: CB: RECV Pipeline EVT: el:OBJ_GET_TAG(event->from)-0x3c1a8880, type:8192, sub:ESP_GMF_EVENT_STATE_STOPPED, payload:0x0, size:0,0x0 I (11519) ESP_GMF_TASK: Waiting to run... [tsk:TSK_0x3fcb1260-0x3fcb1260, wk:0x0, run:0] I (11528) ESP_GMF_TASK: Waiting to run... [tsk:TSK_0x3fcb1260-0x3fcb1260, wk:0x0, run:0] I (11537) REC_SDCARD: [ 6 ] Destroy all the resources E (11546) i2s_common: i2s_channel_disable(1107): the channel has not been enabled yet ```