RDK Documentation (Open Sourced RDK Components)

Description

Data Structures

struct  _dsVideoPortResolution_t
 Structure that defines video port resolution settings of output video device. More...
 
struct  _dsVideoPortPortId_t
 Structure that defines port id associated with video port. More...
 
struct  _dsVideoPortTypeConfig_t
 Structure that defines the video output port configuration. More...
 
struct  _dsVideoPortPortConfig_t
 Structure that defines video port configuration settings. More...
 

Macros

#define dsVideoPortType_isValid(t)   (((t) >= dsVIDEOPORT_TYPE_RF ) && ((t) < dsVIDEOPORT_TYPE_MAX))
 
#define dsVideoPortPixelResolution_isValid(t)   (((t) >= dsVIDEO_PIXELRES_720x480 ) && ((t) < dsVIDEO_PIXELRES_MAX))
 
#define dsVideoPortFrameRate_isValid(t)   (((t) >= dsVIDEO_FRAMERATE_UNKNOWN ) && ((t) < dsVIDEO_FRAMERATE_MAX))
 
#define dsVideoPortScanMode_isValid(t)   (((t) >= dsVIDEO_SCANMODE_INTERLACED ) && ((t) < dsVIDEO_SCANMODE_MAX))
 
#define dsVideoPortAspectRatio_isValid(t)   (((t) >= dsVIDEO_ASPECT_RATIO_4x3 ) && ((t) < dsVIDEO_ASPECT_RATIO_MAX))
 
#define dsVideoPortStereoScopicMode_isValid(t)   (((t) >= dsVIDEO_SSMODE_UNKNOWN ) && ((t) < dsVIDEO_SSMODE_MAX))
 
#define dsVideoPortDFC_isValid(t)   (((t) >= dsVIDEO_ZOOM_NONE ) && ((t) < dsVIDEO_ZOOM_MAX))
 

Typedefs

typedef enum _dsVideoPortType_t dsVideoPortType_t
 
typedef enum _dsVideoResolution_t dsVideoResolution_t
 
typedef enum _dsTVResolution_t dsTVResolution_t
 
typedef enum _dsVideoFrameRate_t dsVideoFrameRate_t
 
typedef enum _dsVideoScanMode_t dsVideoScanMode_t
 
typedef enum _dsVideoBackgroundColor_t dsVideoBackgroundColor_t
 
typedef enum _dsVideoAspectRatio_t dsVideoAspectRatio_t
 
typedef enum _dsVideoStereoScopicMode_t dsVideoStereoScopicMode_t
 
typedef enum _dsVideoZoom_t dsVideoZoom_t
 
typedef struct _dsVideoPortResolution_t dsVideoPortResolution_t
 Structure that defines video port resolution settings of output video device.
 
typedef struct _dsVideoPortPortId_t dsVideoPortPortId_t
 Structure that defines port id associated with video port.
 
typedef struct _dsVideoPortTypeConfig_t dsVideoPortTypeConfig_t
 Structure that defines the video output port configuration.
 
typedef struct _dsVideoPortPortConfig_t dsVideoPortPortConfig_t
 Structure that defines video port configuration settings.
 

Enumerations

enum  _dsVideoPortType_t
 
enum  _dsVideoResolution_t
 
enum  _dsTVResolution_t
 
enum  _dsVideoFrameRate_t
 
enum  _dsVideoScanMode_t
 
enum  _dsVideoBackgroundColor_t
 
enum  _dsVideoAspectRatio_t
 
enum  _dsVideoStereoScopicMode_t
 
enum  _dsVideoZoom_t
 

Data Structure Documentation

◆ _dsVideoPortResolution_t

struct _dsVideoPortResolution_t

Structure that defines video port resolution settings of output video device.

Definition at line 642 of file dsTypes.h.

Collaboration diagram for _dsVideoPortResolution_t:
Collaboration graph
Data Fields
char name[32]

Name the resolution (e.g. 480i, 480p, 1080p24).

dsVideoResolution_t pixelResolution

The resolution associated with the name.

dsVideoAspectRatio_t aspectRatio

The associated aspect ratio.

dsVideoStereoScopicMode_t stereoScopicMode

The associated stereoscopic mode.

dsVideoFrameRate_t frameRate

The associated frame rate.

bool interlaced

The associated scan mode(true if interlaced, false if progressive).

◆ _dsVideoPortPortId_t

struct _dsVideoPortPortId_t

Structure that defines port id associated with video port.

Definition at line 664 of file dsTypes.h.

Collaboration diagram for _dsVideoPortPortId_t:
Collaboration graph
Data Fields
dsVideoPortType_t type

Video port type.

int32_t index

Port ID/number.

◆ _dsVideoPortTypeConfig_t

struct _dsVideoPortTypeConfig_t

Structure that defines the video output port configuration.

Definition at line 673 of file dsTypes.h.

Collaboration diagram for _dsVideoPortTypeConfig_t:
Collaboration graph
Data Fields
dsVideoPortType_t typeId

The video output type.

const char * name

Name of the video output port.

bool dtcpSupported

Is DTCP supported?

bool hdcpSupported

Is HDCP supported?

int32_t restrictedResollution

Any restricted resolution; -1 if no.

size_t numSupportedResolutions

Number of supported resolutions.

dsVideoPortResolution_t * supportedResolutions

List of supported resolutions.

◆ _dsVideoPortPortConfig_t

struct _dsVideoPortPortConfig_t

Structure that defines video port configuration settings.

Definition at line 737 of file dsTypes.h.

Collaboration diagram for _dsVideoPortPortConfig_t:
Collaboration graph
Data Fields
dsVideoPortPortId_t id

Port ID.

dsAudioPortId_t connectedAOP

Connected audio port.

const char * defaultResolution

Default resolution's name.

Macro Definition Documentation

◆ dsVideoPortType_isValid

#define dsVideoPortType_isValid (   t)    (((t) >= dsVIDEOPORT_TYPE_RF ) && ((t) < dsVIDEOPORT_TYPE_MAX))

Video ouptut port type validation check.

Definition at line 451 of file dsTypes.h.

◆ dsVideoPortPixelResolution_isValid

#define dsVideoPortPixelResolution_isValid (   t)    (((t) >= dsVIDEO_PIXELRES_720x480 ) && ((t) < dsVIDEO_PIXELRES_MAX))

Video ouptut resolutions type validation check.

Definition at line 497 of file dsTypes.h.

◆ dsVideoPortFrameRate_isValid

#define dsVideoPortFrameRate_isValid (   t)    (((t) >= dsVIDEO_FRAMERATE_UNKNOWN ) && ((t) < dsVIDEO_FRAMERATE_MAX))

Video output framerate validation check.

Definition at line 518 of file dsTypes.h.

◆ dsVideoPortScanMode_isValid

#define dsVideoPortScanMode_isValid (   t)    (((t) >= dsVIDEO_SCANMODE_INTERLACED ) && ((t) < dsVIDEO_SCANMODE_MAX))

Video scan mode type validation check.

Definition at line 542 of file dsTypes.h.

◆ dsVideoPortAspectRatio_isValid

#define dsVideoPortAspectRatio_isValid (   t)    (((t) >= dsVIDEO_ASPECT_RATIO_4x3 ) && ((t) < dsVIDEO_ASPECT_RATIO_MAX))

Video aspect ratio type validation check.

Definition at line 556 of file dsTypes.h.

◆ dsVideoPortStereoScopicMode_isValid

#define dsVideoPortStereoScopicMode_isValid (   t)    (((t) >= dsVIDEO_SSMODE_UNKNOWN ) && ((t) < dsVIDEO_SSMODE_MAX))

Video Stereo Scopic modes type validation check.

Definition at line 572 of file dsTypes.h.

◆ dsVideoPortDFC_isValid

#define dsVideoPortDFC_isValid (   t)    (((t) >= dsVIDEO_ZOOM_NONE ) && ((t) < dsVIDEO_ZOOM_MAX))

Video screen zoom validation check.

Definition at line 597 of file dsTypes.h.

Typedef Documentation

◆ dsVideoPortType_t

This enumeration defines all of the standard type of Video ports that are available.

◆ dsVideoResolution_t

This enumeration defines all of the standard video port resolutions that can be used.

◆ dsTVResolution_t

This enumeration defines all of the standard TV supported resolution with interlace information.

◆ dsVideoFrameRate_t

This enumeration defines all of the standard frame rates at which video may be played out of the video port.

◆ dsVideoScanMode_t

This enumeration defines all of the standard video port scan modes.

◆ dsVideoBackgroundColor_t

This enumeration defines background color for video port.

◆ dsVideoAspectRatio_t

This enumeration defines all of the standard video aspect ratios.

◆ dsVideoStereoScopicMode_t

This enumeration defines all of the standard video Stereo Scopic modes.

◆ dsVideoZoom_t

This enumeration defines all of the standard screen zoom (format conversion) modes.

Enumeration Type Documentation

◆ _dsVideoPortType_t

This enumeration defines all of the standard type of Video ports that are available.

Enumerator
dsVIDEOPORT_TYPE_RF 

RF modulator (channel 3/4) video output.

dsVIDEOPORT_TYPE_BB 

Baseband (composite, RCA) video output.

dsVIDEOPORT_TYPE_SVIDEO 

S-Video video output.

dsVIDEOPORT_TYPE_1394 

IEEE 1394 (Firewire) video output.

dsVIDEOPORT_TYPE_DVI 

DVI (Panel-Link, HDCP) video output.

dsVIDEOPORT_TYPE_COMPONENT 

Component video output.

dsVIDEOPORT_TYPE_HDMI 

HDMI video output.

dsVIDEOPORT_TYPE_HDMI_INPUT 

HDMI video input.

dsVIDEOPORT_TYPE_INTERNAL 

Internal (integrated/internal display) video output.

dsVIDEOPORT_TYPE_SCART 

SCART video output.

dsVIDEOPORT_TYPE_MAX 

Maximum index for video port types.

Definition at line 434 of file dsTypes.h.

◆ _dsVideoResolution_t

This enumeration defines all of the standard video port resolutions that can be used.

Enumerator
dsVIDEO_PIXELRES_720x480 

720x480 Resolution.

dsVIDEO_PIXELRES_720x576 

720x576 Resolution.

dsVIDEO_PIXELRES_1280x720 

1280x720 Resolution.

dsVIDEO_PIXELRES_1920x1080 

1920x1080 Resolution.

dsVIDEO_PIXELRES_3840x2160 

3840x2160 Resolution.

dsVIDEO_PIXELRES_4096x2160 

3840x2160 Resolution.

dsVIDEO_PIXELRES_MAX 

Maximum index for Video ouptut resolutions.

Definition at line 458 of file dsTypes.h.

◆ _dsTVResolution_t

This enumeration defines all of the standard TV supported resolution with interlace information.

Enumerator
dsTV_RESOLUTION_480i 

480i Resolution.

dsTV_RESOLUTION_480p 

480p Resolution.

dsTV_RESOLUTION_576i 

576p Resolution.

dsTV_RESOLUTION_576p 

576p Resolution.

dsTV_RESOLUTION_576p50 

576p50 Resolution.

dsTV_RESOLUTION_720p 

720p Resolution.

dsTV_RESOLUTION_720p50 

720p50 Resolution.

dsTV_RESOLUTION_1080i 

1080i Resolution.

dsTV_RESOLUTION_1080p 

1080p Resolution.

dsTV_RESOLUTION_1080p24 

1080p24 Resolution.

dsTV_RESOLUTION_1080i25 

1080i25 Resolution.

dsTV_RESOLUTION_1080p30 

1080p30 Resolution.

dsTV_RESOLUTION_1080i50 

1080i50 Resolution.

dsTV_RESOLUTION_1080p50 

1080p50 Resolution.

dsTV_RESOLUTION_1080p60 

1080p60 Resolution.

dsTV_RESOLUTION_2160p30 

2160p30 Resolution.

dsTV_RESOLUTION_2160p50 

2160p30 Resolution.

dsTV_RESOLUTION_2160p60 

2160p60 Resolution.

Definition at line 473 of file dsTypes.h.

◆ _dsVideoFrameRate_t

This enumeration defines all of the standard frame rates at which video may be played out of the video port.

Enumerator
dsVIDEO_FRAMERATE_UNKNOWN 

Unknown frame rate.

dsVIDEO_FRAMERATE_24 

Played at 24 frames per second.

dsVIDEO_FRAMERATE_25 

Played at 25 frames per second.

dsVIDEO_FRAMERATE_30 

Played at 30 frames per second.

dsVIDEO_FRAMERATE_60 

Played at 60 frames per second.

dsVIDEO_FRAMERATE_23dot98 

Played at 23.98 frames per second.

dsVIDEO_FRAMERATE_29dot97 

Played at 29.97 frames per second.

dsVIDEO_FRAMERATE_50 

Played at 50 frames per second.

dsVIDEO_FRAMERATE_59dot94 

Played at 59.94 frames per second.

dsVIDEO_FRAMERATE_MAX 

Maximum index for video frame rates.

Definition at line 502 of file dsTypes.h.

◆ _dsVideoScanMode_t

This enumeration defines all of the standard video port scan modes.

Enumerator
dsVIDEO_SCANMODE_INTERLACED 

Interlaced video.

dsVIDEO_SCANMODE_PROGRESSIVE 

Progressive video.

dsVIDEO_SCANMODE_MAX 

Maximum index for video scan modes.

Definition at line 523 of file dsTypes.h.

◆ _dsVideoBackgroundColor_t

This enumeration defines background color for video port.

Enumerator
dsVIDEO_BGCOLOR_BLUE 

Background color BLUE.

dsVIDEO_BGCOLOR_BLACK 

Background color BLACK

dsVIDEO_BGCOLOR_NONE 

Background color NONE

dsVIDEO_BGCOLOR_MAX 

Maximum index for background color.

Definition at line 532 of file dsTypes.h.

◆ _dsVideoAspectRatio_t

This enumeration defines all of the standard video aspect ratios.

Enumerator
dsVIDEO_ASPECT_RATIO_4x3 

4:3 aspect ratio.

dsVIDEO_ASPECT_RATIO_16x9 

16:9 aspect ratio.

dsVIDEO_ASPECT_RATIO_MAX 

Maximum index for video aspect ratios.

Definition at line 547 of file dsTypes.h.

◆ _dsVideoStereoScopicMode_t

This enumeration defines all of the standard video Stereo Scopic modes.

Enumerator
dsVIDEO_SSMODE_UNKNOWN 

Unknown mode.

dsVIDEO_SSMODE_2D 

2D mode.

dsVIDEO_SSMODE_3D_SIDE_BY_SIDE 

3D side by side (L/R) stereo mode.

dsVIDEO_SSMODE_3D_TOP_AND_BOTTOM 

3D top & bottom stereo mode.

dsVIDEO_SSMODE_MAX 

Maximum index for video stereoscopic modes.

Definition at line 561 of file dsTypes.h.

◆ _dsVideoZoom_t

This enumeration defines all of the standard screen zoom (format conversion) modes.

Enumerator
dsVIDEO_ZOOM_UNKNOWN 

Unknown mode.

dsVIDEO_ZOOM_NONE 

Decoder format conversion is inactive.

dsVIDEO_ZOOM_FULL 

Full screen (16:9 video is streched to fit 4:3 frame).

dsVIDEO_ZOOM_LB_16_9 

16:9 Letterbox (16:9 video is placed in a 4:3 frame with a full letterbox effect).

dsVIDEO_ZOOM_LB_14_9 

14:9 Letterbox (16:9 video is transferred into a 4:3 frame with 14:9 letterbox effect).

dsVIDEO_ZOOM_CCO 

Center Cut-out (16:9 video is cut to fill 4:3 frame with its center part).

dsVIDEO_ZOOM_PAN_SCAN 

Pan & Scan (16:9 is cut and panned to fille 4:3 frame, following MPEG pan & scan vectors).

dsVIDEO_ZOOM_LB_2_21_1_ON_4_3 

2.21:1 Letterbox on 4:3 (video is transferred into 4:3 frame with a 2.21:1 letterbox effect).

dsVIDEO_ZOOM_LB_2_21_1_ON_16_9 

2.21:1 Letterbox on 16:9 (video is transferred into 16:9 frame with a 2.21:1 letterbox effect).

dsVIDEO_ZOOM_PLATFORM 

Control over the decoder format conversions is managed by the platform.

dsVIDEO_ZOOM_16_9_ZOOM 

16:9 Zoom (4:3 video is zoomed to fill 16:9 frame).

dsVIDEO_ZOOM_PILLARBOX_4_3 

Pillarbox 4:3 (4:3 video is placed in a 16:9 frame with a pillarbox effect)

dsVIDEO_ZOOM_WIDE_4_3 

Wide 4:3 (4:3 video is stretched to fill 16:9 frame).

dsVIDEO_ZOOM_MAX 

Maximum index for screen zoom modes.

Definition at line 577 of file dsTypes.h.