RDKEMW-14903: MFV Device Support in Control Manager

include/ctrlm_hal_ble.h

@@ -53,6 +53,14 @@ typedef enum {
    CTRLM_HAL_BLE_VOICE_STREAM_END_UNKNOWN
 } ctrlm_hal_ble_VoiceStreamEnd_t;
 
+/// @brief MFV wake word detection types (matches BleRcuAudioService::DetectionType values).
+typedef enum {
+   CTRLM_HAL_BLE_MFV_DETECTION_UNKNOWN         = 0x00,
+   CTRLM_HAL_BLE_MFV_DETECTION_FULL_POWER      = 0x01,
+   CTRLM_HAL_BLE_MFV_DETECTION_AAD             = 0x02,
+   CTRLM_HAL_BLE_MFV_DETECTION_BELOW_THRESHOLD = 0x03,
+} ctrlm_hal_ble_MfvDetectionType_t;
+
 /// @brief Supported voice data encoding types.
 typedef enum {
    CTRLM_HAL_BLE_PROPERTY_IEEE_ADDDRESS = 0,
@@ -85,6 +93,10 @@ typedef enum {
    CTRLM_HAL_BLE_PROPERTY_WAKEUP_CONFIG,
    CTRLM_HAL_BLE_PROPERTY_WAKEUP_CUSTOM_LIST,
    CTRLM_HAL_BLE_PROPERTY_IRDBS_SUPPORTED,
+   CTRLM_HAL_BLE_PROPERTY_MFV_DETECTION_TYPE,
+   CTRLM_HAL_BLE_PROPERTY_MFV_DETECTION_DATA,
+   CTRLM_HAL_BLE_PROPERTY_MFV_PRIVACY,
+   CTRLM_HAL_BLE_PROPERTY_MFV_CAPABILITIES,
    CTRLM_HAL_BLE_PROPERTY_UNKNOWN
 } ctrlm_hal_ble_RcuProperty_t;
 /// @}
@@ -95,34 +107,40 @@ typedef enum {
 /// @details The Control Manager HAL provides structures that are used in calls to the HAL networks.
 
 typedef struct {
-   int                           device_minor_id;
-   uint8_t                       battery_level;
-   bool                          connected;
-   unsigned long long            ieee_address;
-   char                          fw_revision[CTRLM_MAX_PARAM_STR_LEN];
-   char                          hw_revision[CTRLM_MAX_PARAM_STR_LEN];
-   char                          sw_revision[CTRLM_MAX_PARAM_STR_LEN];
-   char                          manufacturer[CTRLM_MAX_PARAM_STR_LEN];
-   char                          model[CTRLM_MAX_PARAM_STR_LEN];
-   char                          name[CTRLM_MAX_PARAM_STR_LEN];
-   char                          serial_number[CTRLM_MAX_PARAM_STR_LEN];
-   int                           ir_code;
-   uint8_t                       audio_gain_level;
-   uint32_t                      audio_codecs;
-   bool                          audio_streaming;
-   unsigned int                  touch_mode;
-   bool                          touch_mode_settable;
-   bool                          is_upgrading;
-   int                           upgrade_progress;
-   char                          upgrade_error[CTRLM_MAX_PARAM_STR_LEN];
-   ctrlm_ble_RcuUnpairReason_t   unpair_reason;
-   ctrlm_ble_RcuRebootReason_t   reboot_reason;
-   char                          assert_report[CTRLM_RCU_ASSERT_REPORT_MAX_SIZE+1];
-   uint16_t                      last_wakeup_key;
-   uint8_t                       wakeup_config;
-   int                           wakeup_custom_list[CTRLM_WAKEUP_CONFIG_LIST_MAX_SIZE];
-   int                           wakeup_custom_list_size;
-   uint8_t                       irdbs_supported;
+   int                              device_minor_id;
+   uint8_t                          battery_level;
+   bool                             connected;
+   unsigned long long               ieee_address;
+   char                             fw_revision[CTRLM_MAX_PARAM_STR_LEN];
+   char                             hw_revision[CTRLM_MAX_PARAM_STR_LEN];
+   char                             sw_revision[CTRLM_MAX_PARAM_STR_LEN];
+   char                             manufacturer[CTRLM_MAX_PARAM_STR_LEN];
+   char                             model[CTRLM_MAX_PARAM_STR_LEN];
+   char                             name[CTRLM_MAX_PARAM_STR_LEN];
+   char                             serial_number[CTRLM_MAX_PARAM_STR_LEN];
+   int                              ir_code;
+   uint8_t                          audio_gain_level;
+   uint32_t                         audio_codecs;
+   bool                             audio_streaming;
+   unsigned int                     touch_mode;
+   bool                             touch_mode_settable;
+   bool                             is_upgrading;
+   int                              upgrade_progress;
+   char                             upgrade_error[CTRLM_MAX_PARAM_STR_LEN];
+   ctrlm_ble_RcuUnpairReason_t      unpair_reason;
+   ctrlm_ble_RcuRebootReason_t      reboot_reason;
+   char                             assert_report[CTRLM_RCU_ASSERT_REPORT_MAX_SIZE+1];
+   uint16_t                         last_wakeup_key;
+   uint8_t                          wakeup_config;
+   int                              wakeup_custom_list[CTRLM_WAKEUP_CONFIG_LIST_MAX_SIZE];
+   int                              wakeup_custom_list_size;
+   uint8_t                          irdbs_supported;
+   ctrlm_hal_ble_MfvDetectionType_t mfv_detection_type;
+   uint16_t                         mfv_ww_start;
+   uint16_t                         mfv_ww_end;
+   uint16_t                         mfv_confidence; // encoded as percentage * 10 (e.g. 976 = 97.6%)
+   bool                             mfv_privacy_enabled;
+   uint8_t                          mfv_capabilities;
 } ctrlm_hal_ble_rcu_data_t;
 
 typedef struct {

src/ble/ctrlm_ble_controller.cpp

@@ -528,6 +528,76 @@ ctrlm_timestamp_t ctrlm_obj_controller_ble_t::getVoiceStartTimeLocal() const {
    return(voice_start_time_local_);
 }
 
+void ctrlm_obj_controller_ble_t::setMfvDetectionType(ctrlm_hal_ble_MfvDetectionType_t type) {
+   mfv_detection_type_ = type;
+}
+
+ctrlm_hal_ble_MfvDetectionType_t ctrlm_obj_controller_ble_t::getMfvDetectionType() const {
+   return mfv_detection_type_;
+}
+
+void ctrlm_obj_controller_ble_t::setMfvDetectionData(uint16_t start, uint16_t end, uint16_t confidence) {
+   mfv_ww_start_ = start;
+   mfv_ww_end_ = end;
+   mfv_confidence_ = confidence;
+}
+
+uint16_t ctrlm_obj_controller_ble_t::getMfvWwStart() const {
+   return mfv_ww_start_;
+}
+
+uint16_t ctrlm_obj_controller_ble_t::getMfvWwEnd() const {
+   return mfv_ww_end_;
+}
+
+uint16_t ctrlm_obj_controller_ble_t::getMfvConfidence() const {
+   return mfv_confidence_;
+}
+
+float ctrlm_obj_controller_ble_t::getMfvConfidencePercent() const {
+   return mfv_confidence_ / 10.0f;
+}
+
+void ctrlm_obj_controller_ble_t::setMfvPrivacy(bool enabled) {
+   mfv_privacy_enabled_ = enabled;
+}
+
+bool ctrlm_obj_controller_ble_t::getMfvPrivacy() const {
+   return mfv_privacy_enabled_;
+}
+
+void ctrlm_obj_controller_ble_t::setMfvCapabilities(uint8_t caps) {
+   mfv_capabilities_ = caps;
+}
+
+uint8_t ctrlm_obj_controller_ble_t::getMfvCapabilities() const {
+   return mfv_capabilities_;
+}
+
+void ctrlm_obj_controller_ble_t::setMfvDetectionPending(bool pending, int audio_fd) {
+   mfv_detection_pending_  = pending;
+   mfv_detection_audio_fd_ = pending ? audio_fd : -1;
+   if (!pending) {
+      mfv_detection_data_fresh_ = false;
+   }
+}
+
+bool ctrlm_obj_controller_ble_t::isMfvDetectionPending() const {
+   return mfv_detection_pending_;
+}
+
+int ctrlm_obj_controller_ble_t::getMfvDetectionAudioFd() const {
+   return mfv_detection_audio_fd_;
+}
+
+void ctrlm_obj_controller_ble_t::setMfvDetectionDataFresh(bool fresh) {
+   mfv_detection_data_fresh_ = fresh;
+}
+
+bool ctrlm_obj_controller_ble_t::isMfvDetectionDataFresh() const {
+   return mfv_detection_data_fresh_;
+}
+
 void ctrlm_obj_controller_ble_t::setSupportedIrdbs(uint8_t vendor_support_bitmask) {
    this->irdbs_supported_ = vendor_support_bitmask;
 
@@ -689,6 +759,13 @@ void ctrlm_obj_controller_ble_t::print_status() {
    XLOGD_INFO("Programmed AVR IRDB Code     : %s", irdb_entry_id_name_avr_->to_string().c_str());
    XLOGD_INFO("");
    voice_metrics_->print(__FUNCTION__);
+   XLOGD_INFO("");
+   XLOGD_INFO("MFV Detection Type           : 0x%02X", static_cast<unsigned int>(mfv_detection_type_));
+   XLOGD_INFO("MFV WW Start                 : %u", mfv_ww_start_);
+   XLOGD_INFO("MFV WW End                   : %u", mfv_ww_end_);
+   XLOGD_INFO("MFV Confidence               : %.1f%%", mfv_confidence_ / 10.0);
+   XLOGD_INFO("MFV Privacy                  : %s", mfv_privacy_enabled_ ? "enabled" : "disabled");
+   XLOGD_INFO("MFV Capabilities             : 0x%02X", static_cast<unsigned int>(mfv_capabilities_));
    XLOGD_WARN("------------------------------------------------------------");
 }
 

src/ble/ctrlm_ble_controller.h

@@ -147,6 +147,27 @@ class ctrlm_obj_controller_ble_t : public ctrlm_obj_controller_t {
    ctrlm_timestamp_t                getVoiceStartTimeKey() const;
    ctrlm_timestamp_t                getVoiceStartTimeLocal() const;
 
+   void                             setMfvDetectionType(ctrlm_hal_ble_MfvDetectionType_t type);
+   ctrlm_hal_ble_MfvDetectionType_t getMfvDetectionType() const;
+   void                             setMfvDetectionData(uint16_t start, uint16_t end, uint16_t confidence);
+   uint16_t                         getMfvWwStart() const;
+   uint16_t                         getMfvWwEnd() const;
+   uint16_t                         getMfvConfidence() const;        // returns raw value encoded as integer * 10 (e.g. 953 = 95.3%)
+   float                            getMfvConfidencePercent() const; // returns confidence as a percentage (e.g. 95.3)
+   void                             setMfvPrivacy(bool enabled);
+   bool                             getMfvPrivacy() const;
+   void                             setMfvCapabilities(uint8_t caps);
+   uint8_t                          getMfvCapabilities() const;
+
+   // MFV wake-word (detection-triggered) session state.  Such a session starts audio streaming, waits
+   // for the detection data (wake word timing/confidence), then opens the voice session.  See
+   // ctrlm_obj_network_ble_t::req_process_detection_voice_session_begin().
+   void                             setMfvDetectionPending(bool pending, int audio_fd = -1);
+   bool                             isMfvDetectionPending() const;
+   int                              getMfvDetectionAudioFd() const;
+   void                             setMfvDetectionDataFresh(bool fresh); // fresh detection data received for the current pending session (stale-data safeguard)
+   bool                             isMfvDetectionDataFresh() const;
+
    void                             update_controller_id_and_db_entry(std::string name, ctrlm_network_id_t network_id, ctrlm_controller_id_t new_id);
 
 private:
@@ -197,6 +218,16 @@ class ctrlm_obj_controller_ble_t : public ctrlm_obj_controller_t {
 
    bool                                    type_z_supported_     = false;
 
+   ctrlm_hal_ble_MfvDetectionType_t        mfv_detection_type_   = CTRLM_HAL_BLE_MFV_DETECTION_UNKNOWN;
+   uint16_t                                mfv_ww_start_         = 0;
+   uint16_t                                mfv_ww_end_           = 0;
+   uint16_t                                mfv_confidence_       = 0;    // encoded as integer * 10 (e.g. 953 = 95.3%)
+   bool                                    mfv_privacy_enabled_  = false;
+   uint8_t                                 mfv_capabilities_     = 0;
+   bool                                    mfv_detection_pending_    = false; // a wake-word session has started audio and is awaiting its detection data
+   bool                                    mfv_detection_data_fresh_ = false; // fresh detection data arrived for the current pending session
+   int                                     mfv_detection_audio_fd_   = -1;    // fd of the audio stream started for the pending session
+
    bool                                    conn_param_update_before_ota_supported_ = false;
    ctrlm_sw_version_t                      conn_param_update_before_ota_version_;