Merge branch 'feature/afe_manual_trigger_main' into 'main'

feat(gmf_ai_audio): Added interfaces to manual trigger wakeup and sleep state

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

Author: jason-mao

elements/gmf_ai_audio/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.7.2
+
+### Features
+
+- Added `esp_gmf_afe_trigger_wakeup` and `esp_gmf_afe_trigger_sleep` APIs to trigger wakeup and sleep events manually
+
 ## v0.7.1
 
 ### Features

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

@@ -36,7 +36,6 @@
 #else
 #define VCMD_ENABLE (false)
 #endif /* CONFIG_GMF_AI_AUDIO_VOICE_COMMAND_ENABLE */
-#define VAD_ENABLE     (true)
 #define QUIT_CMD_FOUND (BIT0)
 
 #define BOARD_LYRAT_MINI (0)
@@ -64,25 +63,21 @@
 #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 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 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 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")
 #endif  /* AUDIO_BOARD == BOARD_KORVO_2 */
 
 #if WITH_AFE == true
@@ -98,7 +93,9 @@ static bool speeching = false;
 static bool wakeup    = false;
 #endif  /* WITH_AFE == true */
 static EventGroupHandle_t g_event_group = NULL;
+#if WITH_AFE == true
 static esp_gmf_element_handle_t g_afe   = NULL;
+#endif  /* WITH_AFE == true */
 
 static esp_err_t _pipeline_event(esp_gmf_event_pkt_t *event, void *ctx)
 {
@@ -118,8 +115,12 @@ void esp_gmf_afe_event_cb(esp_gmf_obj_handle_t obj, esp_gmf_afe_evt_t *event, vo
             esp_gmf_afe_vcmd_detection_cancel(obj);
             esp_gmf_afe_vcmd_detection_begin(obj);
 #endif  /* WAKENET_ENABLE == true && VCMD_ENABLE == true */
-            esp_gmf_afe_wakeup_info_t *info = event->event_data;
-            ESP_LOGI(TAG, "WAKEUP_START [%d : %d]", info->wake_word_index, info->wakenet_model_index);
+            if (event->event_data) {
+                esp_gmf_afe_wakeup_info_t *info = event->event_data;
+                ESP_LOGI(TAG, "WAKEUP_START [%d : %d]", info->wake_word_index, info->wakenet_model_index);
+            } else {
+                ESP_LOGI(TAG, "WAKEUP_START");
+            }
             break;
         }
         case ESP_GMF_AFE_EVT_WAKEUP_END: {
@@ -172,7 +173,7 @@ static void esp_gmf_wn_event_cb(esp_gmf_obj_handle_t obj, int32_t trigger_ch, vo
 
 static void voice_2_file(uint8_t *buffer, int len)
 {
-#if VOICE2FILE == true
+#if VOICE2FILE == true && WITH_AFE == true
 #define MAX_FNAME_LEN (50)
 
     static FILE *fp = NULL;
@@ -198,7 +199,7 @@ static void voice_2_file(uint8_t *buffer, int len)
             fp = NULL;
         }
     }
-#endif  /* VOICE2FILE == true */
+#endif  /* VOICE2FILE == true && WITH_AFE == true */
 }
 
 static esp_gmf_err_io_t outport_acquire_write(void *handle, esp_gmf_payload_t *load, int wanted_size, int block_ticks)
@@ -214,6 +215,7 @@ static esp_gmf_err_io_t outport_release_write(void *handle, esp_gmf_payload_t *l
     return ESP_GMF_IO_OK;
 }
 
+#if WITH_AFE == true
 static struct {
     struct arg_int *keep;
     struct arg_end *end;
@@ -235,6 +237,29 @@ static int keep_awake(int argc, char **argv)
     return ESP_OK;
 }
 
+static struct {
+    struct arg_str *cmd;
+    struct arg_end *end;
+} trigger_args;
+
+static int trigger(int argc, char **argv)
+{
+    int nerrors = arg_parse(argc, argv, (void **)&trigger_args);
+    if (nerrors != 0) {
+        arg_print_errors(stderr, trigger_args.end, argv[0]);
+        return ESP_FAIL;
+    }
+    if (g_afe) {
+        if (strcmp(trigger_args.cmd->sval[0], "wakeup") == 0) {
+            esp_gmf_afe_trigger_wakeup(g_afe);
+        } else if (strcmp(trigger_args.cmd->sval[0], "sleep") == 0) {
+            esp_gmf_afe_trigger_sleep(g_afe);
+        }
+    }
+    return 0;
+}
+#endif  /* WITH_AFE == true */
+
 static int quit(int argc, char **argv)
 {
     xEventGroupSetBits(g_event_group, QUIT_CMD_FOUND);
@@ -243,6 +268,7 @@ static int quit(int argc, char **argv)
 
 static void wwe_cmds_register(void)
 {
+#if WITH_AFE == true
     esp_console_cmd_t cmd_keep = {
         .command = "keep",
         .help = "keep awake",
@@ -254,6 +280,18 @@ static void wwe_cmds_register(void)
     keep_args.end = arg_end(1);
     esp_console_cmd_register(&cmd_keep);
 
+    esp_console_cmd_t cmd_trigger_wakeup = {
+        .command = "trigger",
+        .help = "trigger wakeup or sleep",
+        .hint = NULL,
+        .func = &trigger,
+        .argtable = &trigger_args,
+    };
+    trigger_args.cmd = arg_str0(NULL, NULL, "<wakeup|sleep>", "Trigger wakeup or sleep");
+    trigger_args.end = arg_end(1);
+    esp_console_cmd_register(&cmd_trigger_wakeup);
+#endif  /* WITH_AFE == true */
+
     esp_console_cmd_t cmd_quit = {
         .command = "quit",
         .help = "quit",

elements/gmf_ai_audio/idf_component.yml

@@ -1,4 +1,4 @@
-version: "0.7.1"
+version: "0.7.2"
 description: Espressif GMF AI Audio Elements Module
 url: https://github.com/espressif/esp-gmf/tree/main/elements/gmf_ai_audio
 documentation: "https://github.com/espressif/esp-gmf/blob/main/elements/gmf_ai_audio/README.md"

elements/gmf_ai_audio/include/esp_gmf_afe.h

@@ -175,9 +175,49 @@ esp_gmf_err_t esp_gmf_afe_set_event_cb(esp_gmf_element_handle_t handle, esp_gmf_
  *       - ESP_GMF_ERR_OK             Success
  *       - ESP_GMF_ERR_INVALID_ARG    Invalid argument
  *       - ESP_GMF_ERR_INVALID_STATE  Config not exist
+ *       - ESP_GMF_ERR_TIMEOUT        Command send timeout
  */
 esp_gmf_err_t esp_gmf_afe_keep_awake(esp_gmf_element_handle_t handle, bool enable);
 
+/**
+ * @brief  Manually trigger wakeup state
+ *
+ *         This function allows manual activation of the wakeup state without waiting
+ *         for automatic wakeword detection. It is useful in the following scenarios:
+ *
+ *         1. **Button-triggered activation**: When users press a physical button to
+ *            activate voice interaction, bypassing the need for wakewords
+ *         2. **External event-driven activation**: When the system needs to enter
+ *            wakeup state based on external triggers (sensors, timers, network events)
+ *
+ *         After calling this function, the AFE will enter wakeup state and begin
+ *         listening for voice commands (if voice command detection is enabled).
+ *         The system will generate ESP_GMF_AFE_EVT_WAKEUP_START event and remain
+ *         active according to the configured wakeup_time duration.
+ *
+ * @param[in]  handle  Handle to the GMF object
+ *
+ * @return
+ *       - ESP_GMF_ERR_OK             Success
+ *       - ESP_GMF_ERR_INVALID_ARG    Invalid argument
+ *       - ESP_GMF_ERR_INVALID_STATE  Element not opened
+ *       - ESP_GMF_ERR_TIMEOUT        Command send timeout
+ */
+esp_gmf_err_t esp_gmf_afe_trigger_wakeup(esp_gmf_element_handle_t handle);
+
+/**
+ * @brief  Manually trigger sleep of wakeup state
+ *
+ * @param[in]  handle  Handle to the GMF object
+ *
+ * @return
+ *       - ESP_GMF_ERR_OK             Success
+ *       - ESP_GMF_ERR_INVALID_ARG    Invalid argument
+ *       - ESP_GMF_ERR_INVALID_STATE  Element not opened
+ *       - ESP_GMF_ERR_TIMEOUT        Command send timeout
+ */
+esp_gmf_err_t esp_gmf_afe_trigger_sleep(esp_gmf_element_handle_t handle);
+
 #ifdef __cplusplus
 }
 #endif  /* __cplusplus */