RDK Documentation (Open Sourced RDK Components)

Description

DeviceSettings HAL types and public API definitions that are part of the Device Settings Audio subsystem.

Data Structures

struct  _dsAudioSADList_t
 
struct  _dsAudioARCStatus_t
 Structure that defines ARC status for the HDMI ARC/EARC port. More...
 
struct  _dsMS12AudioProfileList_t
 
struct  _dsVolumeLeveller_t
 
struct  _dsSurroundVirtualizer_t
 

Macros

#define dsAUDIOPORT_TYPE_NUM_MAX   4
 
#define dsAudioPORT_NUM_MAX   4
 
#define dsAudioType_isValid(t)   (((t) >= dsAUDIOPORT_TYPE_ID_LR ) && ((t) < dsAUDIOPORT_TYPE_MAX))
 
#define dsAudioEncoding_isValid(t)   (((t) >= dsAUDIO_ENC_NONE ) && ((t) < dsAUDIO_ENC_MAX))
 
#define MAX_SAD   15
 Structure that defines Short Audio Descriptors retrieved from connected ARC device.
 
#define MAX_PROFILE_LIST_BUFFER_LEN   1024
 Structure that captures MS12 Audio Profile list.
 
#define dsAudioCompression_isValid(t)   (((t) >= dsAUDIO_CMP_NONE ) && ((t) < dsAUDIO_CMP_MAX))
 
#define dsAudioStereoMode_isValid(t)   (((t) >= dsAUDIO_STEREO_UNKNOWN ) && ((t) < dsAUDIO_STEREO_MAX))
 

Typedefs

typedef enum _dsAudioPortType_t dsAudioPortType_t
 
typedef enum _dsAudioEncoding_t dsAudioEncoding_t
 
typedef enum _dsAudioCompression_t dsAudioCompression_t
 
typedef enum _dsAudioFormat_t dsAudioFormat_t
 
typedef enum _dsAudioDuckingAction_t dsAudioDuckingAction_t
 
typedef enum _dsAudioDuckingType_t dsAudioDuckingType_t
 
typedef int dsAudioCompressionValue_t
 
typedef int dsDialogEnhancer_t
 
typedef int dsIntelligentEqualizerMode_t
 
typedef enum _dsAudioCapabilities_t dsAudioCapabilities_t
 
typedef enum _dsAudioARCTypes_t dsAudioARCTypes_t
 
typedef struct _dsAudioSADList_t dsAudioSADList_t
 
typedef struct _dsAudioARCStatus_t dsAudioARCStatus_t
 Structure that defines ARC status for the HDMI ARC/EARC port.
 
typedef enum _dsMS12Capabilities_t dsMS12Capabilities_t
 
typedef struct _dsMS12AudioProfileList_t dsMS12AudioProfileList_t
 
typedef struct _dsVolumeLeveller_t dsVolumeLeveller_t
 
typedef struct _dsSurroundVirtualizer_t dsSurroundVirtualizer_t
 
typedef enum StereoMode dsAudioStereoMode_t
 
typedef enum _dsATMOSCapability_t dsATMOSCapability_t
 

Enumerations

enum  _dsAudioPortType_t
 
enum  _dsAudioEncoding_t
 
enum  _dsAudioCompression_t
 
enum  _dsAudioFormat_t
 
enum  _dsAudioDuckingAction_t
 
enum  _dsAudioDuckingType_t
 
enum  _dsAudioCapabilities_t
 
enum  _dsAudioARCTypes_t
 
enum  _dsMS12Capabilities_t
 
enum  StereoMode
 
enum  _dsATMOSCapability_t
 

Data Structure Documentation

◆ _dsAudioSADList_t

struct _dsAudioSADList_t

Definition at line 299 of file dsTypes.h.

Collaboration diagram for _dsAudioSADList_t:
Collaboration graph
Data Fields
int sad[15]
int count

◆ _dsAudioARCStatus_t

struct _dsAudioARCStatus_t

Structure that defines ARC status for the HDMI ARC/EARC port.

Definition at line 307 of file dsTypes.h.

Collaboration diagram for _dsAudioARCStatus_t:
Collaboration graph
Data Fields
dsAudioARCTypes_t type
bool status

◆ _dsMS12AudioProfileList_t

struct _dsMS12AudioProfileList_t

Definition at line 334 of file dsTypes.h.

Collaboration diagram for _dsMS12AudioProfileList_t:
Collaboration graph
Data Fields
char audioProfileList[1024]
int audioProfileCount

◆ _dsVolumeLeveller_t

struct _dsVolumeLeveller_t

This defines the type of volume leveller param that can be used.

Definition at line 352 of file dsTypes.h.

Collaboration diagram for _dsVolumeLeveller_t:
Collaboration graph
Data Fields
int mode
int level

◆ _dsSurroundVirtualizer_t

struct _dsSurroundVirtualizer_t

This defines the type of surround virtualizer param that can be used.

Definition at line 360 of file dsTypes.h.

Collaboration diagram for _dsSurroundVirtualizer_t:
Collaboration graph
Data Fields
int mode
int boost

Macro Definition Documentation

◆ dsAUDIOPORT_TYPE_NUM_MAX

#define dsAUDIOPORT_TYPE_NUM_MAX   4

Maximum number of audio output port types.

Definition at line 159 of file dsTypes.h.

◆ dsAudioPORT_NUM_MAX

#define dsAudioPORT_NUM_MAX   4

Maximum number of audio output ports.

Definition at line 160 of file dsTypes.h.

◆ dsAudioType_isValid

#define dsAudioType_isValid (   t)    (((t) >= dsAUDIOPORT_TYPE_ID_LR ) && ((t) < dsAUDIOPORT_TYPE_MAX))

Audio output port type validation check.

Definition at line 178 of file dsTypes.h.

◆ dsAudioEncoding_isValid

#define dsAudioEncoding_isValid (   t)    (((t) >= dsAUDIO_ENC_NONE ) && ((t) < dsAUDIO_ENC_MAX))

Audio encoding type validation check.

Definition at line 195 of file dsTypes.h.

◆ dsAudioCompression_isValid

#define dsAudioCompression_isValid (   t)    (((t) >= dsAUDIO_CMP_NONE ) && ((t) < dsAUDIO_CMP_MAX))

Audio compression type validation check.

Definition at line 368 of file dsTypes.h.

◆ dsAudioStereoMode_isValid

#define dsAudioStereoMode_isValid (   t)    (((t) >= dsAUDIO_STEREO_UNKNOWN ) && ((t) < dsAUDIO_STEREO_MAX))

Audio stereo mode type validation check.

Definition at line 395 of file dsTypes.h.

Typedef Documentation

◆ dsAudioPortType_t

This enumeration defines the type of output audio port that are avaiable.

◆ dsAudioEncoding_t

This enumeration defines the type of audio encoding that can be used.

◆ dsAudioCompression_t

This enumeration defines the type of audio compression that can be used.

◆ dsAudioFormat_t

This enumeration defines the type of audio format

◆ dsAudioDuckingAction_t

This enumeration defines the type of audio ducking action that can be used.

◆ dsAudioDuckingType_t

This enumeration defines the type of audio ducking type that can be used.

◆ dsAudioCompressionValue_t

This defines the type of audio compression that can be used.

Definition at line 251 of file dsTypes.h.

◆ dsDialogEnhancer_t

typedef int dsDialogEnhancer_t

This defines the type of dialog enhancer level that can be used.

Definition at line 256 of file dsTypes.h.

◆ dsIntelligentEqualizerMode_t

This defines the type of dialog enhancer level that can be used.

Definition at line 261 of file dsTypes.h.

◆ dsAudioCapabilities_t

Enumeration defines all of the supported Audio types. Each bit of uint32_t represent a standard. If a device supports multiple standards, the capability is the bitwise OR of the standards.

◆ dsAudioARCTypes_t

Enumeration defines all of the supported Arc types. Each bit of uint32_t represent an ARC support type. If a device multiple ARC types support, it's represented as bitwise OR of the types.

◆ dsMS12Capabilities_t

Enumeration defines all of the supported MS12 types. Each bit of uint32_t represent a standard. If a device supports multiple standards, the capability is the bitwise OR of the standards.

◆ dsVolumeLeveller_t

This defines the type of volume leveller param that can be used.

◆ dsSurroundVirtualizer_t

This defines the type of surround virtualizer param that can be used.

◆ dsAudioStereoMode_t

This enumeration defines the type of audio stereo mode that can be used.

Enumeration Type Documentation

◆ _dsAudioPortType_t

This enumeration defines the type of output audio port that are avaiable.

Enumerator
dsAUDIOPORT_TYPE_ID_LR 

RCA audio output.

dsAUDIOPORT_TYPE_HDMI 

HDMI audio output.

dsAUDIOPORT_TYPE_SPDIF 

S/PDIF audio output.

dsAUDIOPORT_TYPE_SPEAKER 

SPEAKER audio output.

dsAUDIOPORT_TYPE_HEADPHONE 

< HDMI ARC/EARC audio output.
3.5mm headphone jack.

dsAUDIOPORT_TYPE_MAX 

Maximum index for audio port type.

Definition at line 165 of file dsTypes.h.

◆ _dsAudioEncoding_t

This enumeration defines the type of audio encoding that can be used.

Enumerator
dsAUDIO_ENC_NONE 

No digital audio output.

dsAUDIO_ENC_DISPLAY 

Platform-selected digital audio encoding format.

dsAUDIO_ENC_PCM 

PCM digital audio encoding format.

dsAUDIO_ENC_AC3 

AC-3 digital audio encoding format.

dsAUDIO_ENC_EAC3 

DD+/E-AC-3 digital audio encoding format.

dsAUDIO_ENC_MAX 

Maximum index for audio encoding types.

Definition at line 183 of file dsTypes.h.

◆ _dsAudioCompression_t

This enumeration defines the type of audio compression that can be used.

Enumerator
dsAUDIO_CMP_NONE 

No audio compression.

dsAUDIO_CMP_LIGHT 

Light audio level compression.

dsAUDIO_CMP_MEDIUM 

Medium audio level compression.

dsAUDIO_CMP_HEAVY 

Heavy audio level compression.

dsAUDIO_CMP_MAX 

Maximum index for audio compression types.

Definition at line 200 of file dsTypes.h.

◆ _dsAudioFormat_t

This enumeration defines the type of audio format

Enumerator
dsAUDIO_FORMAT_MAX 

Maximum .

Definition at line 212 of file dsTypes.h.

◆ _dsAudioDuckingAction_t

This enumeration defines the type of audio ducking action that can be used.

Enumerator
dsAUDIO_DUCKINGACTION_START 

Audio ducking start.

dsAUDIO_DUCKINGACTION_STOP 

Audio ducking stop.

Definition at line 235 of file dsTypes.h.

◆ _dsAudioDuckingType_t

This enumeration defines the type of audio ducking type that can be used.

Enumerator
dsAUDIO_DUCKINGTYPE_ABSOLUTE 

Audio ducking absolute.

dsAUDIO_DUCKINGTYPE_RELATIVE 

Audio ducking relative.

Definition at line 243 of file dsTypes.h.

◆ _dsAudioCapabilities_t

Enumeration defines all of the supported Audio types. Each bit of uint32_t represent a standard. If a device supports multiple standards, the capability is the bitwise OR of the standards.

Definition at line 270 of file dsTypes.h.

◆ _dsAudioARCTypes_t

Enumeration defines all of the supported Arc types. Each bit of uint32_t represent an ARC support type. If a device multiple ARC types support, it's represented as bitwise OR of the types.

Definition at line 288 of file dsTypes.h.

◆ _dsMS12Capabilities_t

Enumeration defines all of the supported MS12 types. Each bit of uint32_t represent a standard. If a device supports multiple standards, the capability is the bitwise OR of the standards.

Definition at line 318 of file dsTypes.h.

◆ StereoMode

enum StereoMode

This enumeration defines the type of audio stereo mode that can be used.

Enumerator
dsAUDIO_STEREO_UNKNOWN 

Unknown mode.

dsAUDIO_STEREO_MONO 

Mono mode.

dsAUDIO_STEREO_STEREO 

Normal stereo mode (L+R).

dsAUDIO_STEREO_SURROUND 

Surround mode.

dsAUDIO_STEREO_PASSTHRU 

Passthrough mode.

dsAUDIO_STEREO_DD 

Dolby Digital.

dsAUDIO_STEREO_DDPLUS 

Dolby Digital Plus.

dsAUDIO_STEREO_MAX 

Maximum index for audio stereo types.

Definition at line 373 of file dsTypes.h.

◆ _dsATMOSCapability_t

Enumerator
dsAUDIO_ATMOS_NOTSUPPORTED 

ATMOS audio not supported

dsAUDIO_ATMOS_DDPLUSSTREAM 

can handle dd plus stream which is only way to pass ATMOS metadata

dsAUDIO_ATMOS_ATMOSMETADATA 

capable of parsing ATMOS metadata

Definition at line 386 of file dsTypes.h.