Video Driver API Functions

Video Driver API functions. More...

Typedefs
typedef void(*	VideoDrv_Event_t) (uint32_t channel, uint32_t event)
	Video Events callback function type.

Functions
int32_t	VideoDrv_Initialize (VideoDrv_Event_t cb_event)
	Initialize Video Interface.
int32_t	VideoDrv_Uninitialize (void)
	De-initialize Video Interface.
int32_t	VideoDrv_SetFile (uint32_t channel, const char *name)
	Set Video channel file.
int32_t	VideoDrv_Configure (uint32_t channel, uint32_t frame_width, uint32_t frame_height, uint32_t color_format, uint32_t frame_rate)
	Configure Video channel.
int32_t	VideoDrv_SetBuf (uint32_t channel, void *buf, uint32_t buf_size)
	Set Video channel buffer.
int32_t	VideoDrv_FlushBuf (uint32_t channel)
	Flush Video channel buffer.
int32_t	VideoDrv_StreamStart (uint32_t channel, uint32_t mode)
	Start Video channel stream.
int32_t	VideoDrv_StreamStop (uint32_t channel)
	Stop Video channel stream.
void *	VideoDrv_GetFrameBuf (uint32_t channel)
	Get Video channel Frame buffer.
int32_t	VideoDrv_ReleaseFrame (uint32_t channel)
	Release Video channel Frame.
VideoDrv_Status_t	VideoDrv_GetStatus (uint32_t channel)
	Get Video channel status.

Description

Video Driver API functions.

Typedef Documentation

VideoDrv_Event_t

VideoDrv_Event_t

Video Events callback function type.

Parameters

[in]	channel	channel number
[in]	event	events notification mask

Returns

none

Provides the typedef for the event callback function VideoDrv_Event (uint32_t event) to be registered with VideoDrv_Initialize.

The parameter event indicates the reported event(s) that occurred during driver operation. Each event is encoded in a separate bit so it is possible to signal multiple events within the same call. VIDEO_DRV_EVENT_... definitions list the events that can be reported.

Parameter for:

• VideoDrv_Initialize

Function Documentation

VideoDrv_Initialize()

int32_t VideoDrv_Initialize

(

VideoDrv_Event_t

cb_event

)

Initialize Video Interface.

Parameters

[in]

cb_event

pointer to VideoDrv_Event_t

Returns

return code

The function VideoDrv_Initialize initializes the Video interface over VSI peripheral. It is called when the middleware component starts operation.

The function performs the following operations:

• Initializes the required resources of the video interface.
• Registers the VideoDrv_Event_t callback function.

The parameter cb_event is a pointer to the VideoDrv_Event_t callback function; use a NULL pointer when no callback signals are required.

Possible return values:

• VIDEO_DRV_OK : video interface is successfully initialized.

VideoDrv_Uninitialize()

int32_t VideoDrv_Uninitialize

(

void

)

De-initialize Video Interface.

Returns

return code

The function VideoDrv_Uninitialize de-initializes the resources of Video interface.

It is called when the middleware component stops operation and releases the software resources used by the interface.

Possible return values:

• VIDEO_DRV_OK : video interface is successfully de-initialized.

VideoDrv_SetFile()

int32_t VideoDrv_SetFile	(	uint32_t	channel,
		const char *	name
	)

Set Video channel file.

Parameters

[in]	channel	channel number
[in]	name	video filename (pointer to NULL terminated string)

Returns

return code

The function VideoDrv_SetFile sets file for specified video channel.

channel specifies the video channel (VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1).

name specifies filename with extension of video or image.

Possible return values:

• VIDEO_DRV_OK : filename was set successfully (filename is valid).
• VIDEO_DRV_ERROR_PARAMETER : invalid argument values. Returned in the following cases:
  • channel is not VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1.
  • name is NULL.
• VIDEO_DRV_ERROR : returned in the following cases:
  • video interface is not initialized.
  • video channel stream is active.
  • name is not a valid or supported filename.

VideoDrv_Configure()

int32_t VideoDrv_Configure	(	uint32_t	channel,
		uint32_t	frame_width,
		uint32_t	frame_height,
		uint32_t	color_format,
		uint32_t	frame_rate
	)

Configure Video channel.

Parameters

[in]	channel	channel number
[in]	frame_width	frame width in pixels
[in]	frame_height	frame height in pixels
[in]	color_format	pixel color format
[in]	frame_rate	frame rate (frames per second)

Returns

return code

The function VideoDrv_Configure configures specified video channel.

channel specifies the video channel (VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1).

frame_width configures frame width in pixels.

frame_height configures frame height in pixels.

color_format configures frame pixel color format:

• VIDEO_DRV_COLOR_GRAYSCALE8,
• VIDEO_DRV_COLOR_RGB888,
• VIDEO_DRV_COLOR_BGR565,
• VIDEO_DRV_COLOR_YUV420,
• VIDEO_DRV_COLOR_NV12,
• VIDEO_DRV_COLOR_NV21.

frame_rate configures frame rate (frames per second).

Possible return values:

• VIDEO_DRV_OK : channel configured.
• VIDEO_DRV_ERROR_PARAMETER : invalid argument values. Returned in the following cases:
  • channel is not VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1.
  • frame_width is 0.
  • frame_height is 0.
  • frame_rate is 0.
  • color_format is ≤ VIDEO_DRV_COLOR_FORMAT_BEGIN or ≥ VIDEO_DRV_COLOR_FORMAT_END.
• VIDEO_DRV_ERROR : returned in the following cases:
  • video interface is not initialized.
  • video channel stream is active.

VideoDrv_SetBuf()

int32_t VideoDrv_SetBuf	(	uint32_t	channel,
		void *	buf,
		uint32_t	buf_size
	)

Set Video channel buffer.

Parameters

[in]	channel	channel number
[in]	buf	pointer to buffer for video stream
[in]	buf_size	video stream buffer size in bytes

Returns

return code

The function VideoDrv_SetBuf sets the buffer for specified video channel.

channel specifies the video channel (VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1).

buf points to the video memory buffer provided by the user.

buf_size defines the size of user provided video memory buffer.

User provided memory is used as a circular buffer for storing video frames.

Possible return values:

• VIDEO_DRV_OK : channel buffer set.
• VIDEO_DRV_ERROR_PARAMETER : invalid argument values. Returned in the following cases:
  • channel is not VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1.
  • buf is NULL.
  • buf_size is 0.
• VIDEO_DRV_ERROR : returned in the following cases:
  • video interface is not initialized.
  • video channel is not configured.
  • video channel stream is active.
  • buf_size is smaller than the size of one frame.

VideoDrv_FlushBuf()

int32_t VideoDrv_FlushBuf

(

uint32_t

channel

)

Flush Video channel buffer.

Parameters

[in]

channel

channel number

Returns

return code

The function VideoDrv_FlushBuf flushes buffer of specified video channel.

channel specifies the video channel (VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1).

Possible return values:

• VIDEO_DRV_OK : channel buffer flushed.
• VIDEO_DRV_ERROR_PARAMETER : invalid argument values. Returned in the following case:
  • channel is not VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1.
• VIDEO_DRV_ERROR : returned in the following cases:
  • video interface is not initialized.
  • video channel stream is active.

VideoDrv_StreamStart()

int32_t VideoDrv_StreamStart	(	uint32_t	channel,
		uint32_t	mode
	)

Start Video channel stream.

Parameters

[in]	channel	channel number
[in]	mode	stream mode

Returns

return code

The function VideoDrv_StreamStart starts streaming on specified video channel.

channel specifies the video channel (VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1).

mode specifies whether the stream will be continuous (VIDEO_DRV_MODE_CONTINUOS) or single frame (VIDEO_DRV_MODE_SINGLE) which will automatically stop after a single frame.

For video input channels, frames received from video input will be stored in the video buffer.

When a frame is received:

• VIDEO_DRV_EVENT_FRAME event is generated.
• In case the video buffer overflowed an additional VIDEO_DRV_EVENT_OVERFLOW event is generated.
• In case end of stream is reached an additional VIDEO_DRV_EVENT_EOS event is generated.

Frame buffer is retrieved by calling VideoDrv_GetFrameBuf. Once the frame data is consumed it needs to be released by calling VideoDrv_ReleaseFrame.

For video output channels, frames stored in the video buffer will be sent to the video output.

Frame buffer is retrieved by calling VideoDrv_GetFrameBuf. Once the frame data is produced it needs to be released by calling VideoDrv_ReleaseFrame.

When a frame is sent:

• VIDEO_DRV_EVENT_FRAME event is generated.
• In case the video buffer underflowed an additional VIDEO_DRV_EVENT_UNDERFLOW event is generated.

Possible return values:

• VIDEO_DRV_OK : channel streaming started.
• VIDEO_DRV_ERROR_PARAMETER : invalid argument values. Returned in the following cases:
  • channel is not VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1.
  • mode is not VIDEO_DRV_MODE_CONTINUOS or VIDEO_DRV_MODE_SINGLE.
• VIDEO_DRV_ERROR : returned in the following cases:
  • video interface is not initialized.
  • video channel is not configured.
  • video channel stream failed to activate.

VideoDrv_StreamStop()

int32_t VideoDrv_StreamStop

(

uint32_t

channel

)

Stop Video channel stream.

Parameters

[in]

channel

channel number

Returns

return code

The function VideoDrv_StreamStop stops streaming on specified video channel.

channel specifies the video channel (VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1).

Possible return values:

• VIDEO_DRV_OK : channel streaming stopped.
• VIDEO_DRV_ERROR_PARAMETER : invalid argument values. Returned in the following case:
  • channel is not VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1.
• VIDEO_DRV_ERROR : returned in the following cases:
  • video interface is not initialized.
  • video channel is not configured.

VideoDrv_GetFrameBuf()

void * VideoDrv_GetFrameBuf

(

uint32_t

channel

)

Get Video channel Frame buffer.

Parameters

[in]

channel

channel number

Returns

pointer to frame buffer

The function VideoDrv_GetFrameBuf gets frame buffer from specified video channel.

channel specifies the video channel (VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1).

For video input channels, the application gets the pointer to the frame buffer, consumes frame data and releases the frame by calling VideoDrv_ReleaseFrame.

For video output channels, the application gets the pointer to the frame buffer, produces frame data and releases the frame by calling VideoDrv_ReleaseFrame.

Possible return values:

• pointer to frame buffer,
• NULL : invalid argument values. Returned in the following case:
  • channel is not VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1.
  • video interface is not initialized.
  • video channel is not configured.
  • buffer is empty (input channel)
  • buffer is full (output channel)

VideoDrv_ReleaseFrame()

int32_t VideoDrv_ReleaseFrame

(

uint32_t

channel

)

Release Video channel Frame.

Parameters

[in]

channel

channel number

Returns

return code

The function VideoDrv_ReleaseFrame releases a frame from specified video channel.

channel specifies the video channel (VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1).

Possible return values:

• VIDEO_DRV_OK : channel frame released.
• VIDEO_DRV_ERROR_PARAMETER : invalid argument values. Returned in the following case:
  • channel is not VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1.
• VIDEO_DRV_ERROR : returned in the following cases:
  • video interface is not initialized.
  • video channel is not configured.
  • buffer is empty (input channel)
  • buffer is full (output channel)

VideoDrv_GetStatus()

VideoDrv_Status_t VideoDrv_GetStatus

(

uint32_t

channel

)

Get Video channel status.

Parameters

[in]

channel

channel number

Returns

VideoDrv_Status_t

The function VideoDrv_GetStatus retrieves the current status of specified video channel.

channel specifies the video channel (VIDEO_DRV_IN0..1 or VIDEO_DRV_OUT0..1).