BLE RDK Voice Service Specification
RDK-SP-BLE-RV-Service-D02-200120
Document Status: Draft
January 20, 2020
Document Status

Document Status Codes
Work in Progress (W)An incomplete document designed to guide discussion and generate feedback that may include several alternative requirements for consideration.
Draft (D)A document in specification format considered largely complete, but lacking review. Drafts are susceptible to substantial change during the review process.
Issued (I)A stable document that has undergone rigorous review and is suitable for product design and development. It will serve as a basis for testing requirements.

Table of Contents
1. Introduction
1.1 Overview
1.2 Purpose of Document
1.3 Typographical Conventions
1.4 Revision History
2 References
2.1 Normative References
3 Terms and Definitions
4 Abbreviations and Acronyms
5 Introduction
5.1 Conformance
5.2 Service Dependency
5.3 Bluetooth Specification Release Compatibility
5.4 GATT Sub-Procedure Requirements
5.5 Transport Dependencies
5.6 Error Codes
5.7 Byte Transmission Order
6 Service Requirements
6.1 Service Declaration
6.2 Service Roles
6.3 Service Sequence Examples
6.3.1 Push-to-talk Voice Session Sequence
6.3.2 Explicitly Rejected Push-to-talk Voice Session Sequence
6.3.3 Far-Field Voice Session Sequence
6.4 Characteristic Overview
6.5 Audio Codecs Characteristic
6.5.1 Audio Codecs Characteristic Value
6.6 Audio Gain Characteristic
6.6.1 Audio Gain Characteristic Value
6.7 Audio Control Characteristic
6.7.1 Audio Control Characteristic Value
6.7.2 Audio Control Encoding Value
6.7.3 Audio Control Enable Value
6.7.4 Audio Control Enable Behaviour
6.8 Audio Response Characteristic
6.8.1 Audio Response Characteristic Value
6.8.2 Audio Response Characteristic Behaviour
6.9 Keyword Detect Characteristic
6.9.1 Keyword Detect Characteristic Descriptors
6.9.1.1 Client Characteristic Configuration Descriptor
6.9.2 Keyword Detect Characteristic Value
6.9.3 Keyword Detect Characteristic Behaviour
6.10 Beamformer Data Characteristic
6.10.1 Beamformer Data Characteristic Value
6.10.1.1 Beam Data Field
6.10.1.2 Client Characteristic Configuration Descriptor
6.10.2 Beamformer Data Characteristic Behaviour
6.11 Audio Data Characteristic
6.11.1 Audio Data Characteristic Descriptors
6.11.1.1 Client Characteristic Configuration Descriptor
6.11.2 Audio Data Characteristic Value
6.11.2.1 G.726 and IMA/DVI ADPCM Frame Format
6.11.2.2 Audio Frame Buffering

Tables
Table 1 - Typographical Conventions
Table 2 - Terms and Definitions
Table 3 - Abbreviations and Acronyms
Table 4 - GATT Sub-Procedure Requirement
Table 5 - Voice Service Characteristics
Table 6 - Audio Codecs Supported Bit Mask
Table 7 - Audio Control Characteristic Value
Table 8 - Audio Control Characteristic Encoding Values
Table 9 - Audio Control Characteristic Enable Values
Table 10 - Audio Response Values
Table 11 - Audio Keyword Detect Characteristic
Table 12 - Audio Beamformer Characteristic
Table 13 - Beam Data Field
Table 14 - Beam Description Byte
Table 15 - Audio Frame Metadata Format

Figures
Figure 2 – Push-to-talk Voice Session
Figure 3 - Explicit Reject of Voice Session
Figure 4 - Far-Field Voice Session
Figure 5 - G.726 and IMA/DVI ADPCM Frame Format
Figure 6 - G.726 and IMA/DVI ADPCM Frame Metadata

Anchor
_Toc236461453 _Toc236461453

Anchor
_Toc352579429 _Toc352579429

Anchor
_Toc30497232 _Toc30497232

Introduction

Anchor
_Toc236461454 _Toc236461454

Anchor
_Toc352579430 _Toc352579430

Anchor
_Toc30497233 _Toc30497233

Overview

The RDK Voice Service is a service for transmitting voice data over BLE in the RDK ecosystem. The RDK Voice Service is specifically designed to enable voice control of a BLE voice client.

Anchor
_Toc352579431 _Toc352579431

Anchor
_Toc30497234 _Toc30497234

Purpose of Document

This document defines detailed requirements for the RDK Voice Service. It is intended to specify transmission of voice data from an RVS server to an RVS client.

Anchor
_Toc352579434 _Toc352579434

Anchor
_Toc30497235 _Toc30497235

Anchor
_Toc107845694 _Toc107845694

Anchor
_Toc107846682 _Toc107846682

Anchor
_Toc132173416 _Toc132173416

Anchor
_Toc153605725 _Toc153605725

Anchor
_Toc208903908 _Toc208903908

Typographical Conventions

This specification uses different typefaces to differentiate and emphasize important information.

Anchor
_Toc30497236 _Toc30497236

Anchor
_Toc352579437 _Toc352579437

Revision History

Anchor
_Toc194472262 _Toc194472262

Anchor
_Toc194559202 _Toc194559202

Anchor
_Toc194559935 _Toc194559935

Anchor
_Toc216232400 _Toc216232400

Anchor
_Toc216236622 _Toc216236622

Anchor
_Toc220999718 _Toc220999718

Anchor
_Toc221949358 _Toc221949358

Anchor
_Toc352579438 _Toc352579438

Anchor
_Toc30497237 _Toc30497237

References

Reasonable effort is made to keep references up to date with respect to versions and release dates, however manufacturers are responsible for ensuring they have the most recent version of a reference specification (unless otherwise noted).
Where conflicts exist between requirements contained in this specification and normative references, the specification requirements govern.

Anchor
_Toc111007485 _Toc111007485

Anchor
_Toc111007732 _Toc111007732

Anchor
_Toc111007486 _Toc111007486

Anchor
_Toc111007733 _Toc111007733

Anchor
_Toc111007488 _Toc111007488

Anchor
_Toc111007735 _Toc111007735

Anchor
_Toc104019913 _Toc104019913

Anchor
_Ref95270381 _Ref95270381

Anchor
_Toc107845702 _Toc107845702

Anchor
_Toc107846690 _Toc107846690

Anchor
_Toc132173420 _Toc132173420

Anchor
_Toc153605729 _Toc153605729

Anchor
_Toc194472263 _Toc194472263

Anchor
_Toc194559203 _Toc194559203

Anchor
_Toc194559936 _Toc194559936

Anchor
_Toc216232401 _Toc216232401

Anchor
_Toc216236623 _Toc216236623

Anchor
_Toc220999719 _Toc220999719

Anchor
_Toc221949359 _Toc221949359

Anchor
_Toc352579439 _Toc352579439

Anchor
_Toc30497238 _Toc30497238

Normative References

<ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="d3a42f34-7f2c-47f2-82c4-ea1ed2c6335e"><ac:parameter ac:name="">ADPCM</ac:parameter></ac:structured-macro> \[ADPCM\] Recommended Practices for Enhancing Digital Audio Compatibility in Multimedia Systems, IMA Digital Audio Focus and Technical Working Groups; DATWG Recommendation, October 21, 1992. 
\[BLUETOOTH\] Bluetooth Core Specification version 4.0 or later 
\\

Anchor
_Toc352579442 _Toc352579442

Anchor
_Toc30497239 _Toc30497239

Terms and Definitions

This document uses the following terms and definitions.

Anchor
_Toc352579443 _Toc352579443

Anchor
_Toc30497240 _Toc30497240

Abbreviations and Acronyms

This document uses the following abbreviations and acronyms.

Anchor
_Toc30497241 _Toc30497241

Introduction

The RDK Voice Service exposes data and associated formatting for streaming voice audio from an RDK Remote Control Device to an RDK based STB.

Anchor
_Toc30497242 _Toc30497242

Conformance

All capabilities indicated as mandatory for this Service shall be supported in the specified manner (process-mandatory). This also applies for all optional and conditional capabilities for which support is indicated.

Anchor
_Toc30497243 _Toc30497243

Service Dependency

This service is not dependent upon any other services.

Anchor
_Toc30497244 _Toc30497244

Bluetooth Specification Release Compatibility

This specification is compatible with any Bluetooth core specification as defined in \[BLUETOOTH\] that includes the Generic Attribute Profile (GATT) specification and the Bluetooth Low Energy Controller specification. 

Anchor
_Toc30497245 _Toc30497245

GATT Sub-Procedure Requirements

Requirements in this section represent a minimum set of requirements for an RDK Remote Control Device (GATT Server). Other GATT sub-procedures may be used if supported by both Client and Server.
Table 4 below summarises additional GATT sub-procedure requirements beyond those required by all GATT Servers.

Anchor
_Toc30497246 _Toc30497246

Transport Dependencies

The service shall only operate over an LE transport.

Anchor
_Toc30497247 _Toc30497247

Error Codes

This service does not define any application error codes that are used in Attribute Protocol.

Anchor
_Toc30497248 _Toc30497248

Byte Transmission Order

All characteristics used with this service shall be transmitted with the least significant octet first (i.e., little endian).

Anchor
_Toc30497249 _Toc30497249

Service Requirements

Anchor
_Toc11917225 _Toc11917225

Anchor
_Toc30497250 _Toc30497250

Service Declaration

The service UUID shall be set to:

Service Roles

A remote control or similar low power device enabled with one or multiple microphones should function as an RVS Server.
A settop box or other host capable of processing transmitted voice data should function as an RVS Client.

Anchor
_Toc30497252 _Toc30497252

Service Sequence Examples

Anchor
_Toc30497253 _Toc30497253

Push-to-talk Voice Session Sequence

Figure 2 illustrates a sequence of a normal push-to-talk voice session.
The RVS Server should depend on the application defined HID keypress to enable audio streaming from an RVS Client.

Anchor
_Toc30497254 _Toc30497254

Explicitly Rejected Push-to-talk Voice Session Sequence

The RVS provides an optional characteristic for the RVS Client to explicitly inform the RVS Server a voice request was rejected and why. Figure 3 illustrates this sequence.

Anchor
_Toc30497255 _Toc30497255

Far-Field Voice Session Sequence

The RVS supports optional characteristics to support transferring keyword and beamformer data to an RVS Client for more optimal processing of the audio stream and metrics.
Figure 4 shows a voice session for a far-field device supporting a keyword detector and end-of-speech detection.

Anchor
_Toc30497256 _Toc30497256

Characteristic Overview

The RDK Voice Service is composed of the following characteristics used to provide access to the audio capabilities and data.
Only one instance of each characteristic shall be permitted within an RDK Voice Service unless otherwise specified.

Profiles utilising this Service may impose security requirements beyond those defined in Table 5 for all characteristics defined in Table 5.
Properties not listed as mandatory (M) or optional (O) shall be excluded.

Anchor
_Toc30497257 _Toc30497257

Audio Codecs Characteristic

The Audio Codecs characteristic is used to expose the codecs supported by an RVS Server.
This characteristic shall be read only.
The Audio Codecs characteristic shall be written by the RVS Server.
Only a single instance of this characteristic shall exist as part of the RDK Voice Service.
The characteristic UUID shall be set to:

Audio Codecs Characteristic Value

The Audio Codecs Characteristic value is a 32-bit little endian value that contains a bit mask of supported codecs.
Only the codecs shown in Table 6 shall be set.
An RVS Server shall support at least one codec shown in the table.

Anchor
_Toc30497259 _Toc30497259

Audio Gain Characteristic

The Audio Gain characteristic is used to expose the gain level of the microphone used for voice capture.
Only a single instance of this characteristic shall exist as part of the RDK Voice Service.
The characteristic UUID of the Audio Gain shall be set to:
0000EA01-BDF0-407C-AAFF-D09967F31ACD

Anchor
_Toc30497260 _Toc30497260

Audio Gain Characteristic Value

The Audio Gain Characteristic value is an unsigned 8-bit value that contains the current audio gain value. The minimum value is 0 and the maximum value is 64.
The Audio Gain characteristic value shall be persistent across connections for bonded devices. The default value for the Audio Gain Characteristic value is vendor specific. Upon connection of non-bonded clients, this characteristic value is set to the default value.

Anchor
_Toc30497261 _Toc30497261

Audio Control Characteristic

The Audio Control Characteristic value contains two fields; the first signals the audio codec to be used for the encoding and the second is for enablement / disablement of the audio recording.
The Audio Control Characteristic value can be read using either the GATT Read Characteristic Value and is written using the GATT Write Characteristic Value or optional GATT Write Without Response sub-procedure.
Only a single instance of this characteristic shall exist as part of the RDK Voice Service.
The characteristic UUID shall be set to:

Audio Control Characteristic Value

The Audio Control Characteristic value shall be reset to the default value following connection establishment.
Table 7 shows the data format of the characteristic value.

Anchor
_Toc30497263 _Toc30497263

Audio Control Encoding Value

The Audio Encoding setting of the Audio Control Characteristic shall only take effect the next time audio recording is started.
Changing the Audio Encoding value shall be ignored by the remote device if audio streaming is currently enabled, however reading this value shall always contain the last value written.
Table 8 shows the possible values for the Audio Encoding value.

The RVS Client shall ensure that only codecs reported in the Audio Control Characteristic as available will be set in the Audio Control Encoding Value.

Anchor
_Toc30497264 _Toc30497264

Audio Control Enable Value

The Audio Enable setting of the Audio Control Characteristic shall have only the values shown in Table 9.

Anchor
_Toc30497265 _Toc30497265

Audio Control Enable Behaviour

When the Audio Enable Setting is toggled to 0x01 then audio data shall start to be sent via the Audio Data Characteristic provided notifications are enabled for the characteristic.

Anchor
_Toc30497266 _Toc30497266

Audio Response Characteristic

The Audio Response characteristic is used to allow the RVS Client to provide a reason to the RVS Server for not initiating a voice session.
The Audio Response characteristic is optional.
The characteristic UUID shall be set to **.

Anchor
_Toc30497267 _Toc30497267

Audio Response Characteristic Value

The Audio Response can have the values shown in Table 9.

Anchor
_Toc30497268 _Toc30497268

Audio Response Characteristic Behaviour

If the RVS Server supports the Audio Response characteristic, the RVS Client MAY write the Audio Response Characteristic if it is unable to accept notifies on the Audio Data characteristic.

Anchor
_Toc30497269 _Toc30497269

Keyword Detect Characteristic

The Keyword Detect characteristic is used to allow the RVS Client to provide information to the RVS Server about a keyword detect that initiated the voice session.
The Audio Keyword Detect characteristic is optional.
The characteristic UUID shall be set to:
TBD

Anchor
_Toc30497270 _Toc30497270

Keyword Detect Characteristic Descriptors

Anchor
_Toc30497271 _Toc30497271

Client Characteristic Configuration Descriptor

A Client Characteristic Configuration descriptor shall be included in the Keyword Detect characteristic.

Anchor
_Toc30497272 _Toc30497272

Keyword Detect Characteristic Value

The Keyword Detect Characteristic contains 6 fields specifying information about a keyword detection that initiated the voice session as described in Table 11.

Anchor
_Toc30497273 _Toc30497273

Keyword Detect Characteristic Behaviour

If the RVS Server supports the Audio Keyword Detect characteristic, the RVS Server MAY notify on the Audio Keyword Detect Characteristic if the audio session was initiated by a keyword before the Audio Data characteristic is notified on.

Anchor
_Toc30497274 _Toc30497274

Beamformer Data Characteristic

The Audio Beamformer Data characteristic is used to allow the RVS Server to provide information about beamformers used in the voice session.
The Audio Beamformer Data characteristic is optional.
The characteristic UUID shall be set to:
TBD

Anchor
_Toc30497275 _Toc30497275

Beamformer Data Characteristic Value

The Beamformer Data Characteristic contains up to 4 fields describing beam data from a beamformer running on the RVS Client as described in Table 12.

Anchor
_Ref11050228 _Ref11050228

Anchor
_Toc14171054 _Toc14171054

Anchor
_Toc30497276 _Toc30497276

Beam Data Field

The format used for each Beam Data field in the Beamformer Data Characteristic is describes in Table 13.

The Beam Description byte uses the format described in Table 14.

The Confidence value is float between 0-1 that has been converted to an unsigned 16-bit integer. This value represents the confidence level of the keyword detector.
The Signal Noise Ratio is a signed 16-bit integer where 1 unit is equal to .01 SNR.

Anchor
_Toc30497277 _Toc30497277

Client Characteristic Configuration Descriptor

A Client Characteristic Configuration descriptor shall be included in the Beamformer Data characteristic.

Anchor
_Toc30497278 _Toc30497278

Beamformer Data Characteristic Behaviour

If the RVS Server supports the Beamformer Data characteristic, the RVS Server MAY notify on the Beamformer Data Characteristic if the audio session was initiated by a keyword before the Data characteristic is notified on.

Anchor
_Toc30497279 _Toc30497279

Audio Data Characteristic

The Audio Data characteristic is used to send data from an RVS Server to an RVS Client.
Only a single instance of this characteristic shall exist as part of the RDK Voice Service. The characteristic UUID shall be set to:
0000EA03-BDF0-407C-AAFF-D09967F31ACD

Anchor
_Toc30497280 _Toc30497280

Audio Data Characteristic Descriptors

Anchor
_Toc30497281 _Toc30497281

Client Characteristic Configuration Descriptor

A Client Characteristic Configuration descriptor shall be included in the Audio Data characteristic.

Anchor
_Toc30497282 _Toc30497282

Audio Data Characteristic Value

The Audio Data Characteristic value consists of 20 octets of encoded audio data.
When the audio data streaming is enabled via the Audio Control Characteristic and notifications are enabled in the Client Characteristic Configuration descriptor then 20 octets of Audio Data shall be sent as a GATT notification.
Audio data shall be stored in frames, each frame is a multiple of 20 octets and will be segmented and sent in order within a GATT notification. The format and size of the frame depends on the codec used for encoding the audio data. Only complete frames shall be sent in fixed sized batches of GATT notifications. If the Remote Control Device has to discard data (i.e. in noisy environments) it shall discard a complete audio frame.

Anchor
_Toc30497283 _Toc30497283

G.726 and IMA/DVI ADPCM Frame Format

Both G.726 and IMA/DVI ADPCM Frames shall be 100 octets in length; consisting of 96 octets of encoded audio sample data and 4 octets of metadata.
Figure 5 shows the layout of an audio frame and the how it is sent in 20 octet GATT notifications.

Figure 6 shows the layout of the start of an ADPCM audio frame.

Anchor
_Toc30497284 _Toc30497284

Audio Frame Buffering

Audio data is always buffered in 100 octet frames, and the device shall ensure that only complete frames are sent (as 5 x 20 octet GATT notifications). No partial frames shall ever be transferred. This ensures that the STB host can always determine where an audio frame starts and ends.
The RVS Server shall be able to buffer a minimum of 2 audio frames.
If frame buffers are exhausted then the complete frame shall be discarded, however the frame sequence number should still be incremented for the next encoded frame.
All buffered content shall be purged when either a disconnection event occurs, audio streaming is disabled via the Audio Control Characteristic or notifications are disabled for the characteristic.