Video mode management. More...

#include <ppu-types.h>

Data Structures
struct	_videoresolution
	Video resolution. More...

struct	_videodisplaymode
	Video display mode. More...

struct	_videostate
	Video state stucture. More...

struct	_videoconfig
	Video configuration structure. More...

struct	_videoColorInfo

struct	_videoKSVList

struct	_videoDeviceInfo

Macros
#define	VIDEO_STATE_DISABLED 0

#define	VIDEO_STATE_ENABLED 1

#define	VIDEO_STATE_BUSY 3

#define	VIDEO_PRIMARY 0

#define	VIDEO_SECONDARY 1

#define	VIDEO_SCANMODE_INTERLACE 0

#define	VIDEO_SCANMODE_PROGRESSIVE 1

#define	VIDEO_SCANMODE2_AUTO 0

#define	VIDEO_SCANMODE2_INTERLACE 1

#define	VIDEO_SCANMODE2_PROGRESSIVE 2

#define	VIDEO_BUFFER_FORMAT_XRGB 0

#define	VIDEO_BUFFER_FORMAT_XBGR 1

#define	VIDEO_BUFFER_FORMAT_FLOAT 2

#define	VIDEO_ASPECT_AUTO 0

#define	VIDEO_ASPECT_4_3 1

#define	VIDEO_ASPECT_16_9 2

#define	VIDEO_RESOLUTION_UNDEFINED 0

#define	VIDEO_RESOLUTION_1080 1

#define	VIDEO_RESOLUTION_720 2

#define	VIDEO_RESOLUTION_480 4

#define	VIDEO_RESOLUTION_576 5

#define	VIDEO_RESOLUTION_1600x1080 10

#define	VIDEO_RESOLUTION_1440x1080 11

#define	VIDEO_RESOLUTION_1280x1080 12

#define	VIDEO_RESOLUTION_960x1080 13

#define	VIDEO_COLOR_RGB 0x01

#define	VIDEO_COLOR_YUV 0x02

#define	VIDEO_COLOR_XVYCC 0x04

#define	VIDEO_RESOLUTION_720_3D_FRAME_PACKING 0x81

#define	VIDEO_RESOLUTION_1024x720_3D_FRAME_PACKING 0x88

#define	VIDEO_RESOLUTION_960x720_3D_FRAME_PACKING 0x89

#define	VIDEO_RESOLUTION_800x720_3D_FRAME_PACKING 0x8a

#define	VIDEO_RESOLUTION_640x720_3D_FRAME_PACKING 0x8b

#define	VIDEO_REFRESH_AUTO 0x00

#define	VIDEO_REFRESH_59_94HZ 0x01

#define	VIDEO_REFRESH_50HZ 0x02

#define	VIDEO_REFRESH_60HZ 0x04

#define	VIDEO_REFRESH_30HZ 0x08

#define	VIDEO_PORT_NONE 0x00

#define	VIDEO_PORT_HDMI 0x01

#define	VIDEO_PORT_NETWORK 0x41

#define	VIDEO_PORT_COMPOSITE 0x81

#define	VIDEO_PORT_D 0x82

#define	VIDEO_PORT_COMPONENT 0x83

#define	VIDEO_PORT_RGB 0x84

#define	VIDEO_PORT_SCART 0x85

#define	VIDEO_PORT_DSUB 0x86

Typedefs
typedef struct _videoresolution	videoResolution
	Video resolution.

typedef struct _videodisplaymode	videoDisplayMode
	Video display mode.

typedef struct _videostate	videoState
	Video state stucture.

typedef struct _videoconfig	videoConfiguration
	Video configuration structure.

typedef struct _videoColorInfo	videoColorInfo

typedef struct _videoKSVList	videoKSVList

typedef struct _videoDeviceInfo	videoDeviceInfo

typedef s32(*	videoCallback) (u32 slot, u32 videoOut, u32 deviceIndex, u32 event, videoDeviceInfo info, void userData)

Functions
s32	videoGetState (s32 videoOut, s32 deviceIndex, videoState *state)
	Get video state.

s32	videoGetResolution (s32 resolutionId, videoResolution *resolution)
	Get video resolution from resolution id.

s32	videoConfigure (s32 videoOut, videoConfiguration config, void option, s32 blocking)
	Configure the video output.

s32	videoGetNumberOfDevice (u32 videoOut)

s32	videoGetDeviceInfo (u32 videoOut, u32 deviceIndex, videoDeviceInfo *info)

s32	videoGetConfiguration (u32 videoOut, videoConfiguration config, void option)

s32	videoGetResolutionAvailability (u32 videoOut, u32 resolutionId, u32 aspect, u32 option)

s32	videoDebugSetMonitorType (u32 videoOut, u32 monitorType)

s32	videoGetConvertCursorColorInfo (u8 *rgbOutputRange)

s32	videoRegisterCallback (u32 slot, videoCallback cbVideo, void *userData)

s32	videoUnregisterCallback (u32 slot)

Detailed Description

Video mode management.

Definition in file video.h.

Macro Definition Documentation

◆ VIDEO_ASPECT_16_9

#define VIDEO_ASPECT_16_9 2

Definition at line 30 of file video.h.

◆ VIDEO_ASPECT_4_3

#define VIDEO_ASPECT_4_3 1

Definition at line 29 of file video.h.

◆ VIDEO_ASPECT_AUTO

#define VIDEO_ASPECT_AUTO 0

Definition at line 28 of file video.h.

◆ VIDEO_BUFFER_FORMAT_FLOAT

#define VIDEO_BUFFER_FORMAT_FLOAT 2

Definition at line 26 of file video.h.

◆ VIDEO_BUFFER_FORMAT_XBGR

#define VIDEO_BUFFER_FORMAT_XBGR 1

Definition at line 25 of file video.h.

◆ VIDEO_BUFFER_FORMAT_XRGB

#define VIDEO_BUFFER_FORMAT_XRGB 0

Definition at line 24 of file video.h.

◆ VIDEO_COLOR_RGB

#define VIDEO_COLOR_RGB 0x01

Definition at line 42 of file video.h.

◆ VIDEO_COLOR_XVYCC

#define VIDEO_COLOR_XVYCC 0x04

Definition at line 44 of file video.h.

◆ VIDEO_COLOR_YUV

#define VIDEO_COLOR_YUV 0x02

Definition at line 43 of file video.h.

◆ VIDEO_PORT_COMPONENT

#define VIDEO_PORT_COMPONENT 0x83

Definition at line 63 of file video.h.

◆ VIDEO_PORT_COMPOSITE

#define VIDEO_PORT_COMPOSITE 0x81

Definition at line 61 of file video.h.

◆ VIDEO_PORT_D

#define VIDEO_PORT_D 0x82

Definition at line 62 of file video.h.

◆ VIDEO_PORT_DSUB

#define VIDEO_PORT_DSUB 0x86

Definition at line 66 of file video.h.

◆ VIDEO_PORT_HDMI

#define VIDEO_PORT_HDMI 0x01

Definition at line 59 of file video.h.

◆ VIDEO_PORT_NETWORK

#define VIDEO_PORT_NETWORK 0x41

Definition at line 60 of file video.h.

◆ VIDEO_PORT_NONE

#define VIDEO_PORT_NONE 0x00

Definition at line 58 of file video.h.

◆ VIDEO_PORT_RGB

#define VIDEO_PORT_RGB 0x84

Definition at line 64 of file video.h.

◆ VIDEO_PORT_SCART

#define VIDEO_PORT_SCART 0x85

Definition at line 65 of file video.h.

◆ VIDEO_PRIMARY

#define VIDEO_PRIMARY 0

Definition at line 14 of file video.h.

◆ VIDEO_REFRESH_30HZ

#define VIDEO_REFRESH_30HZ 0x08

Definition at line 56 of file video.h.

◆ VIDEO_REFRESH_50HZ

#define VIDEO_REFRESH_50HZ 0x02

Definition at line 54 of file video.h.

◆ VIDEO_REFRESH_59_94HZ

#define VIDEO_REFRESH_59_94HZ 0x01

Definition at line 53 of file video.h.

◆ VIDEO_REFRESH_60HZ

#define VIDEO_REFRESH_60HZ 0x04

Definition at line 55 of file video.h.

◆ VIDEO_REFRESH_AUTO

#define VIDEO_REFRESH_AUTO 0x00

Definition at line 52 of file video.h.

◆ VIDEO_RESOLUTION_1024x720_3D_FRAME_PACKING

#define VIDEO_RESOLUTION_1024x720_3D_FRAME_PACKING 0x88

Definition at line 47 of file video.h.

◆ VIDEO_RESOLUTION_1080

#define VIDEO_RESOLUTION_1080 1

Definition at line 33 of file video.h.

◆ VIDEO_RESOLUTION_1280x1080

#define VIDEO_RESOLUTION_1280x1080 12

Definition at line 39 of file video.h.

◆ VIDEO_RESOLUTION_1440x1080

#define VIDEO_RESOLUTION_1440x1080 11

Definition at line 38 of file video.h.

◆ VIDEO_RESOLUTION_1600x1080

#define VIDEO_RESOLUTION_1600x1080 10

Definition at line 37 of file video.h.

◆ VIDEO_RESOLUTION_480

#define VIDEO_RESOLUTION_480 4

Definition at line 35 of file video.h.

◆ VIDEO_RESOLUTION_576

#define VIDEO_RESOLUTION_576 5

Definition at line 36 of file video.h.

◆ VIDEO_RESOLUTION_640x720_3D_FRAME_PACKING

#define VIDEO_RESOLUTION_640x720_3D_FRAME_PACKING 0x8b

Definition at line 50 of file video.h.

◆ VIDEO_RESOLUTION_720

#define VIDEO_RESOLUTION_720 2

Definition at line 34 of file video.h.

◆ VIDEO_RESOLUTION_720_3D_FRAME_PACKING

#define VIDEO_RESOLUTION_720_3D_FRAME_PACKING 0x81

Definition at line 46 of file video.h.

◆ VIDEO_RESOLUTION_800x720_3D_FRAME_PACKING

#define VIDEO_RESOLUTION_800x720_3D_FRAME_PACKING 0x8a

Definition at line 49 of file video.h.

◆ VIDEO_RESOLUTION_960x1080

#define VIDEO_RESOLUTION_960x1080 13

Definition at line 40 of file video.h.

◆ VIDEO_RESOLUTION_960x720_3D_FRAME_PACKING

#define VIDEO_RESOLUTION_960x720_3D_FRAME_PACKING 0x89

Definition at line 48 of file video.h.

◆ VIDEO_RESOLUTION_UNDEFINED

#define VIDEO_RESOLUTION_UNDEFINED 0

Definition at line 32 of file video.h.

◆ VIDEO_SCANMODE2_AUTO

#define VIDEO_SCANMODE2_AUTO 0

Definition at line 20 of file video.h.

◆ VIDEO_SCANMODE2_INTERLACE

#define VIDEO_SCANMODE2_INTERLACE 1

Definition at line 21 of file video.h.

◆ VIDEO_SCANMODE2_PROGRESSIVE

#define VIDEO_SCANMODE2_PROGRESSIVE 2

Definition at line 22 of file video.h.

◆ VIDEO_SCANMODE_INTERLACE

#define VIDEO_SCANMODE_INTERLACE 0

Definition at line 17 of file video.h.

◆ VIDEO_SCANMODE_PROGRESSIVE

#define VIDEO_SCANMODE_PROGRESSIVE 1

Definition at line 18 of file video.h.

◆ VIDEO_SECONDARY

#define VIDEO_SECONDARY 1

Definition at line 15 of file video.h.

◆ VIDEO_STATE_BUSY

#define VIDEO_STATE_BUSY 3

Definition at line 12 of file video.h.

◆ VIDEO_STATE_DISABLED

#define VIDEO_STATE_DISABLED 0

Definition at line 10 of file video.h.

◆ VIDEO_STATE_ENABLED

#define VIDEO_STATE_ENABLED 1

Definition at line 11 of file video.h.

Typedef Documentation

◆ videoCallback

typedef s32(* videoCallback) (u32 slot, u32 videoOut, u32 deviceIndex, u32 event, videoDeviceInfo *info, void *userData)

Definition at line 214 of file video.h.

◆ videoColorInfo

typedef struct _videoColorInfo videoColorInfo

◆ videoConfiguration

typedef struct _videoconfig videoConfiguration

Video configuration structure.

◆ videoDeviceInfo

typedef struct _videoDeviceInfo videoDeviceInfo

◆ videoDisplayMode

typedef struct _videodisplaymode videoDisplayMode

Video display mode.

◆ videoKSVList

typedef struct _videoKSVList videoKSVList

◆ videoResolution

typedef struct _videoresolution videoResolution

Video resolution.

◆ videoState

typedef struct _videostate videoState

Video state stucture.

Function Documentation

◆ videoConfigure()

s32 videoConfigure	(	s32	videoOut,
		videoConfiguration *	config,
		void *	option,
		s32	blocking
	)

Configure the video output.

Parameters

videoOut	Video output id.
config	Pointer to a video configuration structure.
option	Pointer to additional video configuration data.
blocking	Nonzero indicates if the call is blocking or not.

Returns: zero if no error, nonzero otherwise.

Todo:: verify the parameters signification.

◆ videoDebugSetMonitorType()

s32 videoDebugSetMonitorType	(	u32	videoOut,
		u32	monitorType
	)

◆ videoGetConfiguration()

s32 videoGetConfiguration	(	u32	videoOut,
		videoConfiguration *	config,
		void *	option
	)

◆ videoGetConvertCursorColorInfo()

s32 videoGetConvertCursorColorInfo ( u8 * rgbOutputRange )

◆ videoGetDeviceInfo()

s32 videoGetDeviceInfo	(	u32	videoOut,
		u32	deviceIndex,
		videoDeviceInfo *	info
	)

◆ videoGetNumberOfDevice()

s32 videoGetNumberOfDevice ( u32 videoOut )

◆ videoGetResolution()

s32 videoGetResolution	(	s32	resolutionId,
		videoResolution *	resolution
	)

Get video resolution from resolution id.

Parameters

resolutionId	The input resolution id. The possible values are: `VIDEO_RESOLUTION_1080` `VIDEO_RESOLUTION_720` `VIDEO_RESOLUTION_480` `VIDEO_RESOLUTION_576`
resolution	Pointer to the video resolution structure to be updated.

Returns: zero if no error, nonzero otherwise.

◆ videoGetResolutionAvailability()

s32 videoGetResolutionAvailability	(	u32	videoOut,
		u32	resolutionId,
		u32	aspect,
		u32	option
	)

◆ videoGetState()

s32 videoGetState	(	s32	videoOut,
		s32	deviceIndex,
		videoState *	state
	)

Get video state.

For the default display, just use 0 for videoOut and deviceIndex.

Parameters

videoOut	Video output id.
deviceIndex	Devide index.
state	Pointer to a video state structure to be updated.

Returns: zero if no error, nonzero otherwise.

Todo:: verify the parameters signification.

◆ videoRegisterCallback()

s32 videoRegisterCallback	(	u32	slot,
		videoCallback	cbVideo,
		void *	userData
	)

◆ videoUnregisterCallback()

s32 videoUnregisterCallback ( u32 slot )

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ VIDEO_ASPECT_16_9

◆ VIDEO_ASPECT_4_3

◆ VIDEO_ASPECT_AUTO

◆ VIDEO_BUFFER_FORMAT_FLOAT

◆ VIDEO_BUFFER_FORMAT_XBGR

◆ VIDEO_BUFFER_FORMAT_XRGB

◆ VIDEO_COLOR_RGB

◆ VIDEO_COLOR_XVYCC

◆ VIDEO_COLOR_YUV

◆ VIDEO_PORT_COMPONENT

◆ VIDEO_PORT_COMPOSITE

◆ VIDEO_PORT_D

◆ VIDEO_PORT_DSUB

◆ VIDEO_PORT_HDMI

◆ VIDEO_PORT_NETWORK

◆ VIDEO_PORT_NONE

◆ VIDEO_PORT_RGB

◆ VIDEO_PORT_SCART

◆ VIDEO_PRIMARY

◆ VIDEO_REFRESH_30HZ

◆ VIDEO_REFRESH_50HZ

◆ VIDEO_REFRESH_59_94HZ

◆ VIDEO_REFRESH_60HZ

◆ VIDEO_REFRESH_AUTO

◆ VIDEO_RESOLUTION_1024x720_3D_FRAME_PACKING

◆ VIDEO_RESOLUTION_1080

◆ VIDEO_RESOLUTION_1280x1080

◆ VIDEO_RESOLUTION_1440x1080

◆ VIDEO_RESOLUTION_1600x1080

◆ VIDEO_RESOLUTION_480

◆ VIDEO_RESOLUTION_576

◆ VIDEO_RESOLUTION_640x720_3D_FRAME_PACKING

◆ VIDEO_RESOLUTION_720

◆ VIDEO_RESOLUTION_720_3D_FRAME_PACKING

◆ VIDEO_RESOLUTION_800x720_3D_FRAME_PACKING

◆ VIDEO_RESOLUTION_960x1080

◆ VIDEO_RESOLUTION_960x720_3D_FRAME_PACKING

◆ VIDEO_RESOLUTION_UNDEFINED

◆ VIDEO_SCANMODE2_AUTO

◆ VIDEO_SCANMODE2_INTERLACE

◆ VIDEO_SCANMODE2_PROGRESSIVE

◆ VIDEO_SCANMODE_INTERLACE

◆ VIDEO_SCANMODE_PROGRESSIVE

◆ VIDEO_SECONDARY

◆ VIDEO_STATE_BUSY

◆ VIDEO_STATE_DISABLED

◆ VIDEO_STATE_ENABLED

Typedef Documentation

◆ videoCallback

◆ videoColorInfo

◆ videoConfiguration

◆ videoDeviceInfo

◆ videoDisplayMode

◆ videoKSVList

◆ videoResolution

◆ videoState

Function Documentation

◆ videoConfigure()

◆ videoDebugSetMonitorType()

◆ videoGetConfiguration()

◆ videoGetConvertCursorColorInfo()

◆ videoGetDeviceInfo()

◆ videoGetNumberOfDevice()

◆ videoGetResolution()

◆ videoGetResolutionAvailability()

◆ videoGetState()

◆ videoRegisterCallback()

◆ videoUnregisterCallback()