PR: Feature/23 task far field voice hal #177

lucienkennedylamb · 2025-09-04T13:08:24Z

For review by HAL team

modified: ffv/current/hfp-ffv.yaml

Update FFV feature branch with latest from Develop

Develop

…DetectInfo.aidl

Ulrond

did an initial review with amba on the ffv hals

Ulrond · 2025-09-23T09:07:19Z

ffv/current/com/rdk/hal/farfieldvoice/IFarFieldVoice.aidl

+ * limitations under the License.
+ */
+package com.rdk.hal.farfieldvoice;
+import com.rdk.hal.State;


you don't need this, the new model is that each module will have it's own State, and you have that anyway.

This will be removed.

Ulrond · 2025-09-24T10:34:17Z

ffv/current/com/rdk/hal/farfieldvoice/IFarFieldVoiceController.aidl

+     * Keyword channel audio processing is initialized and keyword detection is started. Upon keyword
+     * detection, audio samples are written to the Keyword channel's pipe.
+     *
+     * Audio data is signed 16 bits per sample at 16kHz sampling rate. The endian order of each sample


this is hardcoded. would it be for the future? Would we not need to expand this into a getCaps and then we're flexible as the system expands?

The middleware and VREX only support 16 bit 16kHz audio and is not configurable. There is no use case for the HAL to support any other sample size or sampling rate.

Ulrond · 2025-09-24T10:46:43Z

ffv/current/com/rdk/hal/farfieldvoice/IFarFieldVoiceController.aidl

+     * number with respect to the audio samples written to the Keyword channel's pipe. A sample offset value
+     * of zero corresponds to the first sample written after opening the Keyword channel.
+     *
+     * The Keyword channel can be opened only in Standby or Full Power modes.


On documentation and cross-references

When we mention types from other files, let’s reference them explicitly so Doxygen can link them (e.g., PowerMode::FULL_POWER, PowerMode::STANDBY). This helps readers jump to the definitions.

On power modes and this module’s responsibility

The system is responsible for control of power, it's not clear why this module needs to know. What behaviour changes are expected in your power modes this it's clear from the documentation.

Will update types with explicit names.
Far Field Voice in Sky Glass uses an external DSP in order to support low power requirements while in Standby state. The external DSP is listening for a key word while the SOC is sleeping. Upon key word detect, the DSP signals the SOC to wake up. The FFV HAL needs to load DSP firmware and communicate key word language information every time the SOC transitions between Full Power and Standby states. Future products may not use an external DSP but may have a lower power state while in Standby. Thus, the FFV HAL needs to know in which state it should operate. For future products that don't need to operate differently based on power state, the FFV HAL can do nothing and respond with success.

Ulrond · 2025-09-24T10:48:33Z

ffv/current/com/rdk/hal/farfieldvoice/IFarFieldVoiceController.aidl

+     * If successful, creates and returns a pipe for passing raw microphone data to the client and
+     * the Microphones channel is in the open state.
+     *
+     * Audio data is signed 32 bits per sample at 16kHz sampling rate. The endian order of each sample


need to move this to caps, and this should be static, that's just what the current system does, this API is required to be future proof.

Ulrond · 2025-09-24T10:52:06Z

ffv/current/com/rdk/hal/farfieldvoice/IFarFieldVoiceController.aidl

+interface IFarFieldVoiceController {
+
+    /**
+     * Open the Keyword channel.


it is not clear from the documentation (maybe because we don't have a higher level description doc), on what a keyword channel is and what it does.

Ulrond · 2025-09-24T11:53:08Z

ffv/current/com/rdk/hal/farfieldvoice/PowerMode.aidl

+@VintfStability
+@Backing(type="int")
+
+enum PowerMode


Need to use words that don't get mixed up with the system power states, that means real things for the module..

Your describing Wakefullness / alert status with these ones enum VoiceModuleState

FULLPOWER -> ACTIVE_LISTEN
STANDBY -> KEYWORD_ALERT
DEEP_SLEEP -> POWERED_OFF

Should we be listing enum WakeFullnessMode

FULLPOWER -> LIVE_STREAMING
STANDBY -> WAKE_DETECT
DEEP_SLEEP -> INACTIVE

Alternative enum ListeningCapability

FULLPOWER -> VOICE_READY
STANDBY -> SILENT_GUARD
DEEP_SLEP -> DORMANT

You would need to list supported modes in the HFP, so that each platform could support some if not all.

so the HFP would look like

iFarFieldVoice: # far_field_voice component HFP content microphone_channel_count: 1 # channels # Defines the static operational modes supported by the hardware. # Values are non-system power state names: ACTIVE_LISTEN, KEYWORD_ALERT, POWERED_OFF supported_states: - ACTIVE_LISTEN - KEYWORD_ALERT - POWERED_OFF # Detailed configuration and types channel_types: ["KEYWORD", "VOICE_COMMAND"] # Array of supported channel types

Ulrond · 2025-09-24T11:53:43Z

ffv/current/com/rdk/hal/farfieldvoice/Status.aidl

+     * This is for information only and useful to log when the Far Field
+     * Voice service is opened.
+     */
+    @utf8InCpp String codeBuildVersion;


why is this here? and where is it expected to be used?

This is informational to the FFV HAL team to know which FFV HAL build was used when doing debug and analysis.

so the lower SubSystemVersion, since it may not be a code build but a firmware or software binary, why does the MW need to know this?

Ulrond · 2025-09-24T11:56:10Z

ffv/current/com/rdk/hal/farfieldvoice/Status.aidl

+     * Total number of keyword channel samples lost due to buffer overflow.
+     *
+     * This is for information only and useful to log at the end of a session.
+     * Non zero values may indicate inadequate CPU time or buffer space and


indicate inadequate CPU time > how would you know this?

The FFV HAL will detect that audio data buffers are overflowing indicating the middleware is unable to keep up with real time audio.

Ulrond · 2025-09-24T11:57:13Z

ffv/current/com/rdk/hal/farfieldvoice/Status.aidl

+     *
+     * This is for information only and useful to log if an error condition occurs.
+     */
+    long vendorErrorCode;


where are you expecting to log this?

It would make sense for the middleware to write this to a log for debug and analysis when failures occur in the field.

Ulrond · 2025-09-24T11:59:33Z

ffv/current/com/rdk/hal/farfieldvoice/Capabilities.aidl

+	/**
+     * Indicates if the Continual channel is supported.
+	 */
+    bool continualChannelSupported;


are there caps missing? You've got more in your hfp

hal: components: far_field_voice: caps: microphone_channel_count: 1 # channels privacy_mode: false -> supports_privacy_mode? hardware_failure: false -> Not required for the hfp noise_reduction: true # Indicates noise reduction support -> Caps? beamforming: true # Indicates beamforming support beamforming_type: "fixed" # Optional: fixed, adaptive, etc. noise_reduction_type: "spectral" # Optional: spectral, etc.

Will investigate. Noise reduction settings should not be visible to the middleware.

CLAassistant · 2025-10-09T18:01:20Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
3 out of 4 committers have signed the CLA.

✅ Ulrond
✅ dwolaver
✅ garys2511
❌ pstick999
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

Ulrond

comments added

Ulrond · 2025-10-15T09:40:44Z

ffv/current/com/rdk/hal/farfieldvoice/IFarFieldVoiceEventListener.aidl

+     *
+     * @param[in] failureCode	The reason for the failure.
+     */
+    void onHardwareFailed(in FailureCode failureCode);


Need to understand the usecase for this and what actions if any do the upper layers take, does it need to pull the interfaces and bring it back up or something like that?

The appropriate response may be vendor or product dependent. The intent is to provide a way for the FFV HAL to inform the middleware that it is non functional because of a hardware related fault (e.g. failure to communicate with an external DSP or microphone input failure). At least one retry to restart the HAL may be appropriate. At the very least, the middleware should log the occurrence for later analysis.

…el type comments

Ulrond and others added 7 commits March 24, 2025 09:31

baseline #23 ffv

9c1a31c

upgraded #23 hfp

dc376b1

modified: ffv/current/hfp-ffv.yaml

Merge pull request #87 from rdkcentral/develop

b592963

Update FFV feature branch with latest from Develop

Fixed missing parenthesis in CMakeList.txt

1c22e49

Merge pull request #163 from rdkcentral/develop

e5aedb3

Develop

Updated FFV HAL AIDLs. Changed name KeywordDetectData.aidl to Keyword…

0ce1880

…DetectInfo.aidl

Oops. Removed KeywordDetectData.aidl due to name change.

7ee2e59

lucienkennedylamb requested a review from Ulrond September 4, 2025 13:08

lucienkennedylamb assigned Ulrond Sep 4, 2025

lucienkennedylamb added this to halif_aidl Sep 4, 2025

lucienkennedylamb added the enhancement New feature or request label Sep 4, 2025

github-project-automation bot moved this to Todo in halif_aidl Sep 4, 2025

Merge branch 'develop' into feature/23-task-far-field-voice-hal

c28c015

Ulrond assigned dwolaver and unassigned Ulrond Sep 23, 2025

Ulrond moved this from Todo to Review Requested in halif_aidl Sep 23, 2025

Ulrond linked an issue Sep 24, 2025 that may be closed by this pull request

Task: Far Field Voice HAL #23

Open

Ulrond requested a review from a team September 24, 2025 10:27

Ulrond requested changes Sep 24, 2025

View reviewed changes

github-project-automation bot moved this from Review Requested to Changes Requested in halif_aidl Sep 24, 2025

Ulrond changed the title ~~Feature/23 task far field voice hal~~ PR: Feature/23 task far field voice hal Sep 24, 2025

dwolaver assigned garys2511 and unassigned dwolaver Oct 8, 2025

Updates based on review feedback

8d71bb4

Ulrond requested changes Oct 15, 2025

View reviewed changes

pstick999 added 4 commits November 5, 2025 14:45

Updates for explicit types

e02c52b

Removed Continual channel type and added vendor defined channel types

1f52290

Updated folder name and file list

1a368b7

Fixed folder name

ceb66d6

pstick999 added 2 commits November 20, 2025 09:30

Removed nullabale and fixed bool

91c479c

Added getKeywordMetaData and setConfiguration APIs and modified chann…

9c8fa82

…el type comments

PR: Feature/23 task far field voice hal #177

Are you sure you want to change the base?

PR: Feature/23 task far field voice hal #177

Uh oh!

Conversation

lucienkennedylamb commented Sep 4, 2025

Uh oh!

Ulrond left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

On documentation and cross-references

On power modes and this module’s responsibility

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ulrond Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ulrond Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CLAassistant commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ulrond left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Ulrond Sep 24, 2025 •

edited

Loading

Ulrond Nov 27, 2025 •

edited

Loading

CLAassistant commented Oct 9, 2025 •

edited

Loading