Merge branch 'bugfix/fix_sdcard_play_fail' into 'main'

bugfix(basic_examples): Fixed play_sdcard_music play fail due to format not set

See merge request adf/multimedia/esp-gmf!118

Author: jason-mao

gmf_examples/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v0.7.1
+
+### Bug Fixes
+
+- Fixed `pipeline_play_sdcard_music` example playback fail due to format not set
+- Fixed examples codec device setting mismatch with process output
+
 ## v0.7.0
 
 ### Features

gmf_examples/basic_examples/pipeline_play_embed_music/main/play_embed_music.c

@@ -42,7 +42,16 @@ void app_main(void)
     ESP_GMF_MEM_SHOW(TAG);
     int ret;
     ESP_LOGI(TAG, "[ 1 ] Mount peripheral");
-    esp_gmf_app_setup_codec_dev(NULL);
+    // Configuration of codec to be aligned with audio pipeline output
+    esp_gmf_app_codec_info_t codec_info = ESP_GMF_APP_CODEC_INFO_DEFAULT();
+    codec_info.play_info.sample_rate = CONFIG_GMF_AUDIO_EFFECT_RATE_CVT_DEST_RATE;
+    codec_info.play_info.channel = CONFIG_GMF_AUDIO_EFFECT_CH_CVT_DEST_CH;
+    codec_info.play_info.bits_per_sample = CONFIG_GMF_AUDIO_EFFECT_BIT_CVT_DEST_BITS;
+    codec_info.record_info = codec_info.play_info;
+    esp_gmf_app_setup_codec_dev(&codec_info);
+
+    // Set default output volume range from [0, 100]
+    esp_codec_dev_set_out_vol((esp_codec_dev_handle_t)esp_gmf_app_get_playback_handle() , 80);
 
     ESP_LOGI(TAG, "[ 2 ] Register all the elements and set audio information to play codec device");
     esp_gmf_pool_handle_t pool = NULL;

gmf_examples/basic_examples/pipeline_play_sdcard_music/main/play_sdcard_music.c

@@ -21,9 +21,10 @@
 
 static const char *TAG = "PLAY_SDCARD_MUSIC";
 
-#define PIPELINE_BLOCK_BIT BIT(0)
+#define PIPELINE_BLOCK_BIT  BIT(0)
+#define DEFAULT_PLAY_URL    "/sdcard/test.mp3"
 
-esp_err_t _pipeline_event(esp_gmf_event_pkt_t *event, void *ctx)
+esp_gmf_err_t _pipeline_event(esp_gmf_event_pkt_t *event, void *ctx)
 {
     ESP_LOGI(TAG, "CB: RECV Pipeline EVT: el: %s-%p, type: %x, sub: %s, payload: %p, size: %d, %p",
              "OBJ_GET_TAG(event->from)", event->from, event->type, esp_gmf_event_get_state_str(event->sub),
@@ -33,15 +34,27 @@ esp_err_t _pipeline_event(esp_gmf_event_pkt_t *event, void *ctx)
         || (event->sub == ESP_GMF_EVENT_STATE_ERROR)) {
         xEventGroupSetBits((EventGroupHandle_t)ctx, PIPELINE_BLOCK_BIT);
     }
-    return 0;
+    return ESP_GMF_ERR_OK;
 }
 
 void app_main(void)
 {
     esp_log_level_set("*", ESP_LOG_INFO);
     int ret;
+
+    // Configuration of codec to be aligned with audio pipeline output
+    esp_gmf_app_codec_info_t codec_info = ESP_GMF_APP_CODEC_INFO_DEFAULT();
+    codec_info.play_info.sample_rate = CONFIG_GMF_AUDIO_EFFECT_RATE_CVT_DEST_RATE;
+    codec_info.play_info.channel = CONFIG_GMF_AUDIO_EFFECT_CH_CVT_DEST_CH;
+    codec_info.play_info.bits_per_sample = CONFIG_GMF_AUDIO_EFFECT_BIT_CVT_DEST_BITS;
+    codec_info.record_info = codec_info.play_info;
+    esp_gmf_app_setup_codec_dev(&codec_info);
+
+    // Set default output volume range from [0, 100]
+    esp_codec_dev_set_out_vol((esp_codec_dev_handle_t)esp_gmf_app_get_playback_handle() , 80);
+
     ESP_LOGI(TAG, "[ 1 ] Mount sdcard");
-    esp_gmf_app_setup_codec_dev(NULL);
+
     void *sdcard_handle = NULL;
     esp_gmf_app_setup_sdcard(&sdcard_handle);
 
@@ -54,19 +67,21 @@ void app_main(void)
 
     ESP_LOGI(TAG, "[ 3 ] Create audio pipeline");
     esp_gmf_pipeline_handle_t pipe = NULL;
-    const char *name[] = {"aud_dec", "aud_rate_cvt", "aud_ch_cvt", "aud_bit_cvt"};
+    const char *name[] = {"aud_dec", "aud_ch_cvt", "aud_bit_cvt", "aud_rate_cvt"};
     ret = esp_gmf_pool_new_pipeline(pool, "io_file", name, sizeof(name) / sizeof(char *), "io_codec_dev", &pipe);
     ESP_GMF_RET_ON_NOT_OK(TAG, ret, { return; }, "Failed to new pipeline");
 
     esp_gmf_io_codec_dev_set_dev(ESP_GMF_PIPELINE_GET_OUT_INSTANCE(pipe), esp_gmf_app_get_playback_handle());
 
     esp_gmf_element_handle_t dec_el = NULL;
     esp_gmf_pipeline_get_el_by_name(pipe, "aud_dec", &dec_el);
-    esp_gmf_info_sound_t info = {0};
+
+    esp_gmf_info_sound_t info = {};
+    esp_gmf_audio_helper_get_audio_type_by_uri(DEFAULT_PLAY_URL, &info.format_id);
     esp_gmf_audio_dec_reconfig_by_sound_info(dec_el, &info);
 
     ESP_LOGI(TAG, "[ 3.1 ] Set audio url to play");
-    esp_gmf_pipeline_set_in_uri(pipe, "/sdcard/test.mp3");
+    esp_gmf_pipeline_set_in_uri(pipe, DEFAULT_PLAY_URL);
 
     ESP_LOGI(TAG, "[ 3.2 ] Create gmf task, bind task to pipeline and load linked element jobs to the bind task");
     esp_gmf_task_cfg_t cfg = DEFAULT_ESP_GMF_TASK_CONFIG();

gmf_examples/basic_examples/pipeline_record_sdcard/main/play_record_sdcard.c

@@ -19,23 +19,37 @@
 
 static const char *TAG = "REC_SDCARD";
 
-esp_err_t _pipeline_event(esp_gmf_event_pkt_t *event, void *ctx)
+#define DEFAULT_RECORD_SAMPLE_RATE  16000
+#define DEFAULT_RECORD_CHANNEL      1
+#define DEFAULT_RECORD_BITS         16
+
+esp_gmf_err_t _pipeline_event(esp_gmf_event_pkt_t *event, void *ctx)
 {
     ESP_LOGI(TAG, "CB: RECV Pipeline EVT: el:%s-%p, type:%d, sub:%s, payload:%p, size:%d,%p",
              "OBJ_GET_TAG(event->from)", event->from, event->type, esp_gmf_event_get_state_str(event->sub),
              event->payload, event->payload_size, ctx);
-    return 0;
+    return ESP_GMF_ERR_OK;
 }
 
 void app_main(void)
 {
     esp_log_level_set("*", ESP_LOG_INFO);
     int ret = 0;
     ESP_LOGI(TAG, "[ 1 ] Mount sdcard");
-    esp_gmf_app_setup_codec_dev(NULL);
     void *sdcard_handle = NULL;
     esp_gmf_app_setup_sdcard(&sdcard_handle);
 
+    // Configuration of codec to be aligned with audio pipeline input
+    esp_gmf_app_codec_info_t codec_info = ESP_GMF_APP_CODEC_INFO_DEFAULT();
+    codec_info.record_info.sample_rate = DEFAULT_RECORD_SAMPLE_RATE;
+    codec_info.record_info.bits_per_sample = DEFAULT_RECORD_BITS;
+    codec_info.record_info.channel = DEFAULT_RECORD_CHANNEL;
+    codec_info.play_info = codec_info.record_info;
+    esp_gmf_app_setup_codec_dev(&codec_info);
+
+    // Set default microphone gain
+    esp_codec_dev_set_in_gain((esp_codec_dev_handle_t)esp_gmf_app_get_record_handle(), 32);
+
     ESP_LOGI(TAG, "[ 2 ] Register all the elements and set audio information to record codec device");
     esp_gmf_pool_handle_t pool = NULL;
     esp_gmf_pool_init(&pool);
@@ -59,9 +73,9 @@ void app_main(void)
     esp_gmf_element_handle_t enc_el = NULL;
     esp_gmf_pipeline_get_el_by_name(pipe, "aud_enc", &enc_el);
     esp_gmf_info_sound_t info = {
-        .sample_rates = 16000,
-        .channels = 1,
-        .bits = 16,
+        .sample_rates = DEFAULT_RECORD_SAMPLE_RATE,
+        .channels = DEFAULT_RECORD_CHANNEL,
+        .bits = DEFAULT_RECORD_BITS,
         .format_id = ESP_AUDIO_TYPE_AAC,
     };
     esp_gmf_audio_enc_reconfig_by_sound_info(enc_el, &info);

gmf_examples/idf_component.yml

@@ -1,4 +1,4 @@
-version: "0.7.0"
+version: "0.7.1"
 description: Espressif GMF Related Examples
 url: https://github.com/espressif/esp-gmf/tree/main/gmf_examples
 documentation: "https://github.com/espressif/esp-gmf/blob/main/gmf_examples/README.md"