gmf_ai_audio: Added function to set keep awake mode

   The `esp_gmf_afe_keep_awake` function can be used to enable or disable the `keep awake` mode,
   when enabled, the wakeup state machine will remain in the `wakeup` state even if noise is detected,
   and it will not trigger the `ESP_GMF_AFE_EVT_WAKEUP_END` event

Author: JosephTang

elements/gmf_ai_audio/CHANGELOG.md

@@ -7,7 +7,8 @@
 - Added `esp_gmf_afe_set_event_cb` API to register AFE element event callbacks
 - Replaced the interface for decoder reconfiguration
 - Introduced `esp_gmf_wn` element to support wake word detection
-- Corrected return value validation for *acq_write and *acq_release callback function implementations
+- Corrected return value validation for *acq_write* and *acq_release* callback function implementations
+- Added `esp_gmf_afe_keep_awake` API to enable/disable the keep awake feature
 
 ### Bug Fixes
 

elements/gmf_ai_audio/examples/aec_rec/main/CMakeLists.txt

@@ -1,3 +1,2 @@
 idf_component_register(SRCS "main.c"
-                    INCLUDE_DIRS "."
-                    REQUIRES gmf_setup cli)
+                    INCLUDE_DIRS ".")

elements/gmf_ai_audio/examples/aec_rec/main/idf_component.yml

@@ -15,4 +15,4 @@ dependencies:
   espressif/gmf_loader:
     version: "^0.6"
   espressif/gmf_app_utils:
-    version: "^0.6"
+    version: "^0.7"

elements/gmf_ai_audio/examples/aec_rec/main/main.c

@@ -10,7 +10,6 @@
 #include "esp_err.h"
 #include "esp_log.h"
 
-#include "esp_codec_dev.h"
 #include "esp_gmf_err.h"
 #include "esp_gmf_io_codec_dev.h"
 #include "esp_gmf_obj.h"
@@ -95,8 +94,6 @@ static esp_gmf_err_io_t pcm_buf_release_write(void *handle, esp_gmf_payload_t *l
 
 void app_main(void)
 {
-    esp_err_t ret = ESP_OK;
-
     esp_log_level_set("*", ESP_LOG_INFO);
 
     pcm_buffer = heap_caps_malloc(buf_size, MALLOC_CAP_SPIRAM);
@@ -174,7 +171,7 @@ void app_main(void)
     esp_gmf_io_codec_dev_set_dev(ESP_GMF_PIPELINE_GET_OUT_INSTANCE(play_pipe), esp_gmf_app_get_playback_handle());
 
     esp_gmf_obj_handle_t bit_cvt = NULL;
-    esp_gmf_pipeline_get_el_by_name(play_pipe, "aud_bit_cvt", &aud_bit_cvt);
+    esp_gmf_pipeline_get_el_by_name(play_pipe, "aud_bit_cvt", &bit_cvt);
     esp_gmf_bit_cvt_set_dest_bits(bit_cvt, DAC_I2S_BITS);
     esp_gmf_obj_handle_t ch_cvt = NULL;
     esp_gmf_pipeline_get_el_by_name(play_pipe, "aud_ch_cvt", &ch_cvt);

elements/gmf_ai_audio/examples/wwe/CMakeLists.txt

@@ -2,8 +2,6 @@
 # CMakeLists in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.5)
 
-set(EXTRA_COMPONENT_DIRS ${EXTRA_COMPONENT_DIRS} "../common")
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
 project(gmf_wwe_demo)

elements/gmf_ai_audio/examples/wwe/main/idf_component.yml

@@ -5,3 +5,5 @@ dependencies:
     version: "^0.6"
   espressif/gmf_io:
     version: "^0.6"
+  espressif/gmf_app_utils:
+    version: "^0.7"

elements/gmf_ai_audio/examples/wwe/main/main.c

@@ -4,12 +4,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+#include <stdbool.h>
 #include <stdio.h>
 #include <string.h>
 
 #include "esp_err.h"
 #include "esp_log.h"
 #include "soc/soc_caps.h"
+#include "esp_console.h"
+#include "argtable3/argtable3.h"
 
 #include "esp_gmf_io.h"
 #include "esp_gmf_pipeline.h"
@@ -23,7 +26,16 @@
 #if SOC_SDMMC_HOST_SUPPORTED == 1
 #define VOICE2FILE     (true)
 #endif  /* SOC_SDMMC_HOST_SUPPORTED == 1 */
+#ifdef CONFIG_GMF_AI_AUDIO_WAKEUP_ENABLE
 #define WAKENET_ENABLE (true)
+#else
+#define WAKENET_ENABLE (false)
+#endif /* CONFIG_GMF_AI_AUDIO_WAKEUP_ENABLE */
+#ifdef CONFIG_GMF_AI_AUDIO_VOICE_COMMAND_ENABLE
+#define VCMD_ENABLE (true)
+#else
+#define VCMD_ENABLE (false)
+#endif /* CONFIG_GMF_AI_AUDIO_VOICE_COMMAND_ENABLE */
 #define VAD_ENABLE     (true)
 #define QUIT_CMD_FOUND (BIT0)
 
@@ -47,41 +59,25 @@
 #endif  /* defined CONFIG_IDF_TARGET_ESP32S3 */
 
 #if AUDIO_BOARD == BOARD_KORVO_2
-#define AEC_ENABLE          (true)
-#define VCMD_ENABLE         (true)
-
-#define ADC_I2S_PORT        (0)
 #define ADC_I2S_CH          (2)
 #define ADC_I2S_BITS        (32)
 #define INPUT_CH_NUM        (4)
 #define INPUT_CH_BITS       (16) /* For board `ESP32-S3-Korvo-2`, the es7210 is configured as 32-bit,
                                    2-channel mode to accommodate 16-bit, 4-channel data */
 #define INPUT_CH_ALLOCATION ("RMNM")
 #elif AUDIO_BOARD == BOARD_LYRAT_MINI
-#define AEC_ENABLE          (false)
-#define VCMD_ENABLE         (false)
-
-#define ADC_I2S_PORT        (1)
 #define ADC_I2S_CH          (2)
 #define ADC_I2S_BITS        (16)
 #define INPUT_CH_NUM        (ADC_I2S_CH)
 #define INPUT_CH_BITS       (ADC_I2S_BITS)
 #define INPUT_CH_ALLOCATION ("RM")
 #elif AUDIO_BOARD == BOARD_XD_AIOT_C3
-#define AEC_ENABLE          (false)
-#define VCMD_ENABLE         (false)
-
-#define ADC_I2S_PORT        (0)
 #define ADC_I2S_CH          (2)
 #define ADC_I2S_BITS        (16)
 #define INPUT_CH_NUM        (ADC_I2S_CH)
 #define INPUT_CH_BITS       (ADC_I2S_BITS)
 #define INPUT_CH_ALLOCATION ("MR")
 #elif AUDIO_BOARD == BOARD_ESP_SPOT
-#define AEC_ENABLE          (false)
-#define VCMD_ENABLE         (false)
-
-#define ADC_I2S_PORT        (0)
 #define ADC_I2S_CH          (2)
 #define ADC_I2S_BITS        (16)
 #define INPUT_CH_NUM        (ADC_I2S_CH)
@@ -102,6 +98,7 @@ static bool speeching = false;
 static bool wakeup    = false;
 #endif  /* WITH_AFE == true */
 static EventGroupHandle_t g_event_group = NULL;
+static esp_gmf_element_handle_t g_afe   = NULL;
 
 static esp_err_t _pipeline_event(esp_gmf_event_pkt_t *event, void *ctx)
 {
@@ -158,14 +155,6 @@ void esp_gmf_afe_event_cb(esp_gmf_obj_handle_t obj, esp_gmf_afe_evt_t *event, vo
             esp_gmf_afe_vcmd_info_t *info = event->event_data;
             ESP_LOGW(TAG, "Command %d, phrase_id %d, prob %f, str: %s",
                      event->type, info->phrase_id, info->prob, info->str);
-            /* Here use the first command to quit this demo
-             * For Chinese model, the first default command is `ba xiao shi hou guan ji`
-             * For English model, the first default command is `tell me a joke`
-             * If user had modified the commands, please refer to the commands setting.
-             */
-            if (event->type == 1) {
-                xEventGroupSetBits(g_event_group, QUIT_CMD_FOUND);
-            }
             break;
         }
     }
@@ -225,9 +214,58 @@ static esp_gmf_err_io_t outport_release_write(void *handle, esp_gmf_payload_t *l
     return ESP_GMF_IO_OK;
 }
 
+static struct {
+    struct arg_int *keep;
+    struct arg_end *end;
+} keep_args;
+
+static int keep_awake(int argc, char **argv)
+{
+    int nerrors = arg_parse(argc, argv, (void **)&keep_args);
+    if (nerrors != 0) {
+        arg_print_errors(stderr, keep_args.end, argv[0]);
+        return ESP_FAIL;
+    }
+    if (g_afe) {
+        esp_gmf_afe_keep_awake(g_afe, keep_args.keep->ival[0]);
+        printf("Keep awake: %d\n", keep_args.keep->ival[0]);
+    } else {
+        ESP_LOGE(TAG, "AFE not found");
+    }
+    return ESP_OK;
+}
+
+static int quit(int argc, char **argv)
+{
+    xEventGroupSetBits(g_event_group, QUIT_CMD_FOUND);
+    return 0;
+}
+
+static void wwe_cmds_register(void)
+{
+    esp_console_cmd_t cmd_keep = {
+        .command = "keep",
+        .help = "keep awake",
+        .hint = NULL,
+        .func = &keep_awake,
+        .argtable = &keep_args,
+    };
+    keep_args.keep = arg_int0(NULL, NULL, "<0 - 1>", "Keep awake");
+    keep_args.end = arg_end(1);
+    esp_console_cmd_register(&cmd_keep);
+
+    esp_console_cmd_t cmd_quit = {
+        .command = "quit",
+        .help = "quit",
+        .hint = NULL,
+        .func = &quit,
+        .argtable = NULL,
+    };
+    esp_console_cmd_register(&cmd_quit);
+}
+
 void app_main(void)
 {
-    int ret = 0;
     esp_log_level_set("*", ESP_LOG_INFO);
     esp_gmf_app_codec_info_t codec_info = ESP_GMF_APP_CODEC_INFO_DEFAULT();
     codec_info.record_info.sample_rate = 16000;
@@ -255,9 +293,9 @@ void app_main(void)
         goto __quit;
     }
     esp_gmf_io_codec_dev_set_dev(ESP_GMF_PIPELINE_GET_IN_INSTANCE(pipe), esp_gmf_app_get_record_handle());
-    esp_gmf_element_handle_t afe = NULL;
-    esp_gmf_pipeline_get_el_by_name(pipe, "ai_afe", &afe);
-    esp_gmf_afe_set_event_cb(afe, esp_gmf_afe_event_cb, NULL);
+#if WITH_AFE == true
+    esp_gmf_pipeline_get_el_by_name(pipe, "ai_afe", &g_afe);
+    esp_gmf_afe_set_event_cb(g_afe, esp_gmf_afe_event_cb, NULL);
 #else
     esp_gmf_element_handle_t wn = NULL;
     esp_gmf_pipeline_get_el_by_name(pipe, "ai_wn", &wn);
@@ -291,7 +329,7 @@ void app_main(void)
     esp_gmf_pipeline_set_event(pipe, _pipeline_event, NULL);
     esp_gmf_pipeline_run(pipe);
 
-    esp_gmf_app_cli_init("Audio >", NULL);
+    esp_gmf_app_cli_init("Audio >", wwe_cmds_register);
 
     while (1) {
         EventBits_t bits = xEventGroupWaitBits(g_event_group, QUIT_CMD_FOUND, pdTRUE, pdFALSE, portMAX_DELAY);

elements/gmf_ai_audio/include/esp_gmf_afe.h

@@ -160,6 +160,24 @@ esp_gmf_err_t esp_gmf_afe_vcmd_detection_cancel(esp_gmf_element_handle_t handle)
  */
 esp_gmf_err_t esp_gmf_afe_set_event_cb(esp_gmf_element_handle_t handle, esp_gmf_afe_event_cb_t cb, void *ctx);
 
+/**
+ * @brief  Enable or disable keep-awake mode
+ *
+ *         When keep-awake mode is enabled, the system will remain in the wake state
+ *         and prevent wakeup_end events from being triggered automatically
+ *         This is useful for scenarios where you want to keep the system active
+ *         without automatic timeout
+ *
+ * @param  handle  The handle to the AFE element
+ * @param  enable  True to enable keep-awake mode, false to disable
+ *
+ * @return
+ *       - ESP_GMF_ERR_OK             Success
+ *       - ESP_GMF_ERR_INVALID_ARG    Invalid argument
+ *       - ESP_GMF_ERR_INVALID_STATE  Config not exist
+ */
+esp_gmf_err_t esp_gmf_afe_keep_awake(esp_gmf_element_handle_t handle, bool enable);
+
 #ifdef __cplusplus
 }
 #endif  /* __cplusplus */