Rebase

.github/copilot-instructions.md

@@ -0,0 +1,18 @@
+# Copilot Instructions
+
+## Repository overview
+This is the **ctrlm-main** (Control Manager) plugin — a Thunder/WPEFramework plugin for RDK remote control management.
+
+## ci/ directory
+The `ci/` directory contains **native CI build support files only**. It is not part of the application.
+
+- `ci/build_dependencies.sh` / `ci/cov_build.sh` — scripts that build the plugin in a CI container without a full RDK target image
+- `ci/mocks/xlog_ci_compat.h` — minimal shim that pulls `std::string`, `std::map`, `std::tuple`, `std::get` into the global namespace (mirrors the transitive effect of the real rdkx_logger.h in the Yocto build)
+- `ci/mocks/testframework_overrides.h` — supplements testframework mocks with declarations ctrlm needs that are not yet upstream
+- `ci/mocks/devicesettings_ctrlm.patch` — patch applied to the testframework `devicesettings.h` at CI time for ctrlm-specific additions (ducking types, `setAudioDucking`, `Manager::IsInitialized`). Remove once these land in testframework develop.
+- `ci/mocks/safec_lib.h` — compatibility shim mapping `safec_lib.h` to system libsafec headers
+- `ci/headers/` — empty stub headers and real xr-voice-sdk headers generated/copied at CI build time; not committed to source
+
+CI currently pins `xr-voice-sdk` to tag `1.0.13` in `build_dependencies.sh`. Real xr-voice-sdk headers (including `rdkx_logger.h`, `xr_voice_sdk.h`, and generated `rdkx_logger_modules.h`) are produced by `build_dependencies.sh` and placed in `ci/headers/xr-voice-sdk/`. Mock/stub headers for platform libraries (IARM, DeviceSettings, RFC, etc.) are sourced from `entservices-testframework/` at CI build time.
+
+When suggesting code or answering questions, treat CI mocks as scaffolding, not as authoritative API definitions. For real API shapes refer to the installed headers under `install/usr/include/` or the upstream repositories (Thunder, entservices-apis, xr-voice-sdk).

.github/workflows/native_full_build.yml

@@ -0,0 +1,29 @@
+name: Build Control Manager in Native Environment
+
+on:
+  push:
+    branches: [ main, 'sprint/**', 'release/**', develop ]
+  pull_request:
+    branches: [ main, 'sprint/**', 'release/**', topic/RDK*, develop ]
+
+permissions:
+  contents: read
+
+jobs:
+  build-control-on-pr:
+    name: Build Control Manager in github rdkcentral
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/rdkcentral/docker-rdk-ci:latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: build dependencies
+        run: |
+          sh -x ci/build_dependencies.sh
+
+      - name: cov build
+        run: |
+          sh -x ci/cov_build.sh

CMakeLists.txt

@@ -34,32 +34,19 @@ set(CMAKE_NO_SYSTEM_FROM_IMPORTED ON)
 project(ctrlm-main VERSION ${CMAKE_PROJECT_VERSION})
 
 # OPTIONS
-option(A5000_ENABLE "ES1 A5000 use libse051" OFF)
-option(ANSI_CODES_DISABLED "Disable ANSI code logging" OFF)
-option(ASSERT_ON_WRONG_THREAD "Assert on wrong thread" OFF)
 option(AUTH_ENABLED "Enable AUTH" OFF)
 option(BLE_ENABLED "Enable BLE" ON)
 option(BLE_SERVICES "Enable BLE Services" OFF)
 option(BREAKPAD "Enable BREAKPAD" OFF)
 option(BUILD_CTRLM_FACTORY "Build Control Factory Test" OFF)
-option(DEEPSLEEP_CLOSE_DB "Deep Sleep Close DB" OFF)
-option(ENABLE_NETWORKED_STANDBY_MODE "Enable Networked Standby Mode)" OFF)
-option(FACTORY_AUDIO_PLAYBACK "Factory test audio playback" OFF)
-option(FACTORY_CUSTOM_AUDIO_ANALYSIS "Factory custom audio analysis" OFF)
 option(FDC_ENABLED "Enable FDC" OFF)
 option(IP_ENABLED "Enable IP" OFF)
-option(LOCAL_MIC "Local Microphone" OFF)
-option(LOCAL_MIC_DISABLE_VIA_PRIVACY "Use Privacy to disable microphone" OFF)
-option(MEM_DEBUG "Enable memory debugging" OFF)
-option(MEMORY_LOCK "Memory Lock" OFF)
-option(MIC_TAP "Enable MIC_TAP" OFF)
 option(RF4CE_ENABLED "Enable RF4CE" ON)
 option(TELEMETRY_SUPPORT "Enable TELEMETRY_SUPPORT" OFF)
 option(THUNDER "Enable THUNDER" ON)
 option(THUNDER_SECURITY "Enable THUNDER_SECURITY" OFF)
 option(USE_SAFEC "Use safec" OFF)
 option(USE_IARM_POWER_MANAGER "Use IARM Power Manager" OFF)
-option(VOICE_KEYWORD_BEEP "Enable VOICE_KEYWORD_BEEP" OFF)
 option(XRSR_HTTP "Enable XRSR_HTTP" OFF)
 option(XRSR_SDT "Enable XRSR_SDT" OFF)
 option(ENABLE_ASYNC_SRVR_MSG "Enable Asynchronous Server Messaging Feature" OFF)
@@ -178,22 +165,13 @@ target_link_libraries(
 
 install(TARGETS controlMgr RUNTIME DESTINATION bin)
 
-install(FILES ${CMAKE_BINARY_DIR}/ctrlm_config.json.template DESTINATION ${CMAKE_INSTALL_SYSCONFDIR} COMPONENT config )
+install(FILES ${CMAKE_BINARY_DIR}/ctrlm_config.json DESTINATION ${CMAKE_INSTALL_SYSCONFDIR} COMPONENT config )
 
 # DEFINES FROM OPTIONS
-if(A5000_ENABLE)
-   find_library( SE_HAL_PATH SE_HAL ${CMAKE_SYSROOT}/usr/lib/se051)
-   target_link_libraries(controlMgr ${SE_HAL_PATH})
-endif()
-
 if(ANSI_CODES_DISABLED)
    add_compile_definitions(ANSI_CODES_DISABLED)
 endif()
 
-if(ASSERT_ON_WRONG_THREAD)
-   add_compile_definitions(ASSERT_ON_WRONG_THREAD)
-endif()
-
 if(BLE_ENABLED)
    target_link_libraries(controlMgr BTMgr)
    if(BLE_SERVICES)
@@ -207,10 +185,6 @@ if(BREAKPAD)
    add_compile_definitions(BREAKPAD_SUPPORT)
 endif()
 
-if(DEEPSLEEP_CLOSE_DB)
-   add_compile_definitions(DEEPSLEEP_CLOSE_DB)
-endif()
-
 if(ENABLE_ASYNC_SRVR_MSG)
    add_compile_definitions(SUPPORT_ASYNC_SRVR_MSG)
 endif()
@@ -219,10 +193,6 @@ if(ENABLE_AVS_WITH_SDT)
     add_compile_definitions(SUPPORT_VOICE_DEST_ALSA SUPPORT_ASYNC_SRVR_MSG)
 endif()
 
-if(ENABLE_NETWORKED_STANDBY_MODE)
-   add_compile_definitions(NETWORKED_STANDBY_MODE_ENABLED)
-endif()
-
 if(FDC_ENABLED)
    add_compile_definitions(FDC_ENABLED)
 endif()
@@ -231,25 +201,6 @@ if(IP_ENABLED)
    add_compile_definitions(CTRLM_NETWORK_IP CTRLM_IP_HAL_LOG_ENABLED)
 endif()
 
-if(LOCAL_MIC)
-   add_compile_definitions(CTRLM_LOCAL_MIC)
-   if(MIC_TAP)
-      add_compile_definitions(CTRLM_LOCAL_MIC_TAP)
-   endif()
-   if(LOCAL_MIC_DISABLE_VIA_PRIVACY)
-      add_compile_definitions(CTRLM_LOCAL_MIC_DISABLE_VIA_PRIVACY)
-   endif()
-endif()
-
-if(MEM_DEBUG)
-   add_compile_definitions(MEM_DEBUG)
-endif()
-
-if(MEMORY_LOCK)
-   add_compile_definitions(MEMORY_LOCK)
-   target_link_libraries(controLMgr clnl)
-endif()
-
 # RF4CE options
 if(RF4CE_ENABLED)
    # All RF4CE platforms have HAL NVM
@@ -283,8 +234,6 @@ if(THUNDER)
       if(AUTH_ACTIVATION_STATUS)
          add_compile_definitions(AUTH_ACTIVATION_STATUS)
       endif()
-      #By default disabled but can be enabled
-      #add_compile_definitions(AUTH_EXPERIENCE)
       target_link_libraries(controlMgr RdkCertSelector)
    endif()
 endif()
@@ -303,19 +252,13 @@ else()
    add_compile_definitions(SAFEC_DUMMY_API)
 endif()
 
-if(VOICE_KEYWORD_BEEP)
-   add_compile_definitions(BEEP_ON_KWD_ENABLED)
-   add_definitions(-DBEEP_ON_KWD_FILE=\"${CMAKE_DATADIR}/${BEEP_ON_KWD_FILE}\")
-   install(FILES ${CMAKE_SOURCE_DIR}/../${BEEP_ON_KWD_FILE} DESTINATION share )
-endif()
-
 if(USE_DEPRECATED_HDMI_INPUT_PLUGIN)
    add_compile_definitions(USE_DEPRECATED_HDMI_INPUT_PLUGIN)
 endif()
 
 install(TARGETS  controlMgr RUNTIME DESTINATION bin)
 
-install(FILES ${CMAKE_BINARY_DIR}/ctrlm_config.json.template DESTINATION ${CMAKE_INSTALL_SYSCONFDIR} COMPONENT config )
+install(FILES ${CMAKE_BINARY_DIR}/ctrlm_config.json DESTINATION ${CMAKE_INSTALL_SYSCONFDIR} COMPONENT config )
 
 # GENERATED FILES
 add_custom_command( OUTPUT ctrlm_version_build.h
@@ -331,16 +274,16 @@ add_custom_command( OUTPUT ctrlm_version_build.h
 )
 
 add_custom_command(
-   OUTPUT ${CMAKE_BINARY_DIR}/ctrlm_config.json.template
-   COMMAND python3 ${CTRLM_UTILS_JSON_COMBINE} -i ${CMAKE_CURRENT_SOURCE_DIR}/src/ctrlm_config_default.json -a ${CTRLM_CONFIG_JSON_VSDK}:vsdk -a ${CTRLM_CONFIG_JSON_CPC} -s ${CTRLM_CONFIG_JSON_CPC_SUB} -a ${CTRLM_CONFIG_JSON_CPC_ADD} -s ${CTRLM_CONFIG_JSON_OEM_SUB} -a ${CTRLM_CONFIG_JSON_OEM_ADD} -s ${CTRLM_CONFIG_JSON_MAIN_SUB} -a ${CTRLM_CONFIG_JSON_MAIN_ADD} -o ${CMAKE_BINARY_DIR}/ctrlm_config.json.template
+   OUTPUT ${CMAKE_BINARY_DIR}/ctrlm_config.json
+   COMMAND python3 ${CTRLM_UTILS_JSON_COMBINE} -i ${CMAKE_CURRENT_SOURCE_DIR}/src/ctrlm_config_default.json -a ${CTRLM_CONFIG_JSON_CPC} -s ${CTRLM_CONFIG_JSON_CPC_SUB} -a ${CTRLM_CONFIG_JSON_CPC_ADD} -s ${CTRLM_CONFIG_JSON_MAIN_SUB} -a ${CTRLM_CONFIG_JSON_MAIN_ADD} -o ${CMAKE_BINARY_DIR}/ctrlm_config.json
    DEPENDS src/ctrlm_config_default.json
    VERBATIM
    )
 
 add_custom_command(
    OUTPUT ctrlm_config_default.h ${CMAKE_CURRENT_SOURCE_DIR}/src/ctrlm_config_default.c
-   COMMAND python3 ${CTRLM_UTILS_JSON_TO_HEADER} -i ${CMAKE_BINARY_DIR}/ctrlm_config.json.template -o ctrlm_config_default.h -c ${CMAKE_CURRENT_SOURCE_DIR}/src/ctrlm_config_default.c -v "ctrlm_global,network_rf4ce,network_ip,network_ble,ir,voice,device_update" -d "network_ble"
-   DEPENDS ${CMAKE_BINARY_DIR}/ctrlm_config.json.template
+   COMMAND python3 ${CTRLM_UTILS_JSON_TO_HEADER} -i ${CMAKE_BINARY_DIR}/ctrlm_config.json -o ctrlm_config_default.h -c ${CMAKE_CURRENT_SOURCE_DIR}/src/ctrlm_config_default.c -v "ctrlm_global,network_rf4ce,network_ip,network_ble,ir,voice,device_update" -d "network_ble"
+   DEPENDS ${CMAKE_BINARY_DIR}/ctrlm_config.json
    VERBATIM
    )
 
@@ -351,5 +294,5 @@ add_custom_command(
    )
 
 add_custom_target( ctrlm_config
-   DEPENDS ${CMAKE_BINARY_DIR}/ctrlm_config.json.template
+   DEPENDS ${CMAKE_BINARY_DIR}/ctrlm_config.json
    )

PRODUCT.md

@@ -0,0 +1,64 @@
+# rdkcentral/control Product Functionality
+
+This document summarizes the core product features, capabilities, and user-facing functionality provided by the `rdkcentral/control` project.
+
+## 1. Product Overview
+
+`rdkcentral/control` provides the central control and management solution for RDK-based devices, focusing on remote control integration, device state management, configuration handling, and hardware abstraction. It enables flexible, reliable control of device functions, typically in set-top boxes and smart TV platforms.
+
+## 2. Key Functional Areas
+
+### 2.1 Remote Control Manager
+
+- **Multi-protocol Support:** Integrates with RF4CE and BLE-based remote controls, supporting automatic pairing and discovery of devices.
+- **Key Mapping & Input:** Manages IR, RF, and BLE key events, including vendor-specific key mappings (e.g., for AMC App).
+- **Telemetry & Logging:** Captures and processes telemetry data from voice streams, key events, and audio sessions for diagnostics and monitoring.
+- **OTA & Firmware Management:** Handles remote control firmware updates and network discovery, with stability features when interrupted (e.g., OTA interrupted by reset).
+
+### 2.2 Device State & Power Management
+
+- **Deep Sleep & Wake Handling:** Responds to device state changes, ensuring proper initialization/timer handling during deep sleep or wake events.
+- **Power Plugin Integration:** Uses RDK's Power Manager Thunder plugin for system power state management and interaction.
+
+### 2.3 Configuration Management
+
+- **Dynamic Configuration:** Reads, updates, and applies runtime configuration changes from files, including support for vendor override files.
+- **Device Discovery:** Provides mechanisms to discover IR input devices, support for multiple device types and fallback/stub implementations if hardware is absent.
+- **HAL Abstraction:** Exposes interfaces to control hardware-specific features via C++ classes (see `ctrlm_hal.h`, `ctrlm_hal_rf4ce.h`, `ctrlm_hal_ble.h`).
+
+### 2.4 Audio & Voice Control
+
+- **Voice Session Management:** Supports BLE/RF voice streaming; logs sessions; manages session state, end times, and error reporting.
+- **Audio Stream Management:** Reports and optimizes audio pipe size; ensures reliable audio sample reporting for voice sessions.
+
+### 2.5 API & Service Integration
+
+- **Thunder & HDMI Plugins:** Integrates with plugin frameworks to extend support for HDMI input, AV input, MAC address fetch, and advanced service bridging.
+- **ASB Detection:** Offers runtime detection for Advanced Service Bridge capabilities.
+
+## 3. Product Extensibility
+
+- **Vendor Layer Integration:** Provides hooks for vendor-specific features, such as configuration overrides and device database stubs.
+- **Flexible Build & Runtime Flags:** Build flags allow enabling/disabling features (e.g., BLE audio, packet analysis, deepsleep, memory lock).
+- **Plugin & Target Customization:** Can build custom targets (e.g., just the control config file).
+
+## 4. Typical Use Cases
+
+- **User Experience:** Enables seamless remote pairing and input handling, responsive device wake/sleep, and dynamic feature provisioning.
+- **Monitoring/Diagnostics:** Logs device events and telemetry, aiding both advanced diagnostics and data-driven product improvement.
+- **Integration Point:** Forms the backbone for device control in RDK deployments where remote management and hardware abstraction are required.
+
+## 5. Recent Product Updates (Selected Highlights)
+
+- Multi-protocol remote integration (BLE and RF4CE support).
+- Overhaul of key mapping and vendor integration logic.
+- Telemetry improvements for voice stream analytics.
+- Refactoring to enhance HAL interface extensibility.
+- Crash and stability fixes for deep sleep, rapid input, and device discovery.
+- Improved runtime configuration and plugin extensibility.
+
+_For full release notes, please see the [CHANGELOG](https://github.com/rdkcentral/control/blob/develop/CHANGELOG.md)._
+
+## 6. Summary
+
+`rdkcentral/control` delivers a comprehensive control and management solution for RDK devices, emphasizing extensibility, reliability, and integration with modern remote protocols and power management frameworks. It remains the canonical product for remote control, device state, and configuration management within the RDK platform.