Merge pull request #162 from baba-dev/codex/add-kconfig-for-audio-long-demo

feat(audio): gate long demo track

Author: baba-dev

platforms/tab5/main/CMakeLists.txt

@@ -18,6 +18,15 @@ file(GLOB_RECURSE MY_HAL_SRCS
     ./hal/*.cpp
 )
 
+set(APP_EMBED_TXTFILES
+    "../audio/startup_sfx.mp3"
+    "../audio/shutdown_sfx.mp3"
+)
+
+if(CONFIG_HAL_AUDIO_ENABLE_LONG_DEMO)
+    list(APPEND APP_EMBED_TXTFILES "../audio/canon_in_d.mp3")
+endif()
+
 idf_component_register(
     SRCS "app_main.cpp" ${APP_LAYER_SRCS} ${MY_HAL_SRCS}
     INCLUDE_DIRS "." ${APP_LAYER_INCS}
@@ -26,5 +35,5 @@ idf_component_register(
              esp_http_server chmorgan__esp-audio-player mooncake mooncake_log
              smooth_ui_toolkit power_monitor_ina226 esp_video esp_cam_sensor
              sensor_bmi270 espressif__usb_host_hid usb imlib json
-    EMBED_TXTFILES "../audio/canon_in_d.mp3" "../audio/startup_sfx.mp3" "../audio/shutdown_sfx.mp3")
+    EMBED_TXTFILES ${APP_EMBED_TXTFILES})
 

platforms/tab5/main/Kconfig.projbuild

@@ -8,4 +8,12 @@ config APP_LOG_LEVEL
       Sets the default log verbosity for the application layer.
       0 = none, 1 = error, 2 = warn, 3 = info, 4 = debug, 5 = verbose.
 
+config HAL_AUDIO_ENABLE_LONG_DEMO
+    bool "Enable long Canon in D demo"
+    default n
+    help
+      Enable this option to embed the long-form Canon in D MP3 demo track in
+      the firmware. Disable it for CI or release builds to save flash space and
+      reduce build times.
+
 endmenu

platforms/tab5/main/hal/components/hal_audio.cpp

@@ -251,24 +251,36 @@ hal::HalBase::MicTestState_t HalEsp32::getHeadphoneMicRecordTestState()
 /* -------------------------------------------------------------------------- */
 /*                               Music play test                              */
 /* -------------------------------------------------------------------------- */
+#if CONFIG_HAL_AUDIO_ENABLE_LONG_DEMO
 extern const uint8_t canon_in_d_mp3_start[] asm("_binary_canon_in_d_mp3_start");
 extern const uint8_t canon_in_d_mp3_end[] asm("_binary_canon_in_d_mp3_end");
+#endif
 extern const uint8_t startup_sfx_mp3_start[] asm("_binary_startup_sfx_mp3_start");
 extern const uint8_t startup_sfx_mp3_end[] asm("_binary_startup_sfx_mp3_end");
 extern const uint8_t shutdown_sfx_mp3_start[] asm("_binary_shutdown_sfx_mp3_start");
 extern const uint8_t shutdown_sfx_mp3_end[] asm("_binary_shutdown_sfx_mp3_end");
 
-enum Mp3PlayTarget_t {
+enum Mp3PlayTarget_t
+{
+#if CONFIG_HAL_AUDIO_ENABLE_LONG_DEMO
     MP3_PLAY_TARGET_CANON_IN_D,
+#endif
     MP3_PLAY_TARGET_STARTUP_SFX,
     MP3_PLAY_TARGET_SHUTDOWN_SFX,
 };
 
-struct MusicTestData_t {
-    std::mutex mutex;
-    bool killSignal                      = false;
-    hal::HalBase::MusicPlayState_t state = hal::HalBase::MUSIC_PLAY_IDLE;
-    Mp3PlayTarget_t target               = MP3_PLAY_TARGET_CANON_IN_D;
+#if CONFIG_HAL_AUDIO_ENABLE_LONG_DEMO
+static constexpr Mp3PlayTarget_t kDefaultMusicTarget = MP3_PLAY_TARGET_CANON_IN_D;
+#else
+static constexpr Mp3PlayTarget_t kDefaultMusicTarget = MP3_PLAY_TARGET_STARTUP_SFX;
+#endif
+
+struct MusicTestData_t
+{
+    std::mutex                     mutex;
+    bool                           killSignal = false;
+    hal::HalBase::MusicPlayState_t state      = hal::HalBase::MUSIC_PLAY_IDLE;
+    Mp3PlayTarget_t                target     = kDefaultMusicTarget;
 };
 static MusicTestData_t _music_test_data;
 
@@ -286,7 +298,8 @@ static void audio_player_callback(audio_player_cb_ctx_t* ctx)
     audio_player_state_t state = audio_player_get_state();
     mclog::tagInfo(TAG, "audio state: {}", (int)state);
 
-    if (state == AUDIO_PLAYER_STATE_IDLE) {
+    if (state == AUDIO_PLAYER_STATE_IDLE)
+    {
         GetHAL()->stopPlayMusicTest();
     }
 }
@@ -308,12 +321,15 @@ static void _music_play_task(void* param)
     audio_player_callback_register(audio_player_callback, NULL);
 
     size_t mp3_size = 0;
-    FILE* fp        = nullptr;
-    switch (_music_test_data.target) {
+    FILE*  fp       = nullptr;
+    switch (_music_test_data.target)
+    {
+#if CONFIG_HAL_AUDIO_ENABLE_LONG_DEMO
         case MP3_PLAY_TARGET_CANON_IN_D:
             mp3_size = (canon_in_d_mp3_end - canon_in_d_mp3_start) - 1;
             fp       = fmemopen((void*)canon_in_d_mp3_start, mp3_size, "rb");
             break;
+#endif
         case MP3_PLAY_TARGET_STARTUP_SFX:
             mp3_size = (startup_sfx_mp3_end - startup_sfx_mp3_start) - 1;
             fp       = fmemopen((void*)startup_sfx_mp3_start, mp3_size, "rb");
@@ -325,7 +341,8 @@ static void _music_play_task(void* param)
     }
 
     esp_err_t ret = audio_player_play(fp);
-    if (ret != ESP_OK) {
+    if (ret != ESP_OK)
+    {
         mclog::tagError(TAG, "audio play failed");
         vTaskDelete(NULL);
         return;
@@ -355,20 +372,23 @@ static void _music_play_task(void* param)
 
 void try_create_music_play_task(Mp3PlayTarget_t target)
 {
-    if (_music_test_data.state == hal::HalBase::MUSIC_PLAY_IDLE) {
+    if (_music_test_data.state == hal::HalBase::MUSIC_PLAY_IDLE)
+    {
         _music_test_data.state      = hal::HalBase::MUSIC_PLAY_PLAYING;
         _music_test_data.target     = target;
         _music_test_data.killSignal = false;
         xTaskCreate(_music_play_task, "music", 3000, nullptr, 5, nullptr);
-    } else {
+    }
+    else
+    {
         mclog::tagWarn(TAG, "music play is running");
     }
 }
 
 void HalEsp32::startPlayMusicTest()
 {
     std::lock_guard<std::mutex> lock(_music_test_data.mutex);
-    try_create_music_play_task(MP3_PLAY_TARGET_CANON_IN_D);
+    try_create_music_play_task(kDefaultMusicTarget);
 }
 
 hal::HalBase::MusicPlayState_t HalEsp32::getMusicPlayTestState()

platforms/tab5/sdkconfig.defaults

@@ -50,3 +50,4 @@ CONFIG_LV_USE_FONT_COMPRESSED=y
 CONFIG_LV_USE_DEMO_BENCHMARK=y
 CONFIG_IDF_EXPERIMENTAL_FEATURES=y
 CONFIG_ESP_HOSTED_IDF_SLAVE_TARGET="esp32c6"
+# CONFIG_HAL_AUDIO_ENABLE_LONG_DEMO is not set