IVIDDEC_Fxns Struct Reference
[XDM IVIDDEC Video Decoder Interface]

Defines all of the operations on IVIDDEC objects. More...

#include <ividdec.h>

Collaboration diagram for IVIDDEC_Fxns:

Data Fields
IALG_Fxns	ialg
XDAS_Int32(*	process )(IVIDDEC_Handle handle, XDM_BufDesc inBufs, XDM_BufDesc outBufs, IVIDDEC_InArgs inArgs, IVIDDEC_OutArgs outArgs)
	Basic video decoding call.
XDAS_Int32(*	control )(IVIDDEC_Handle handle, IVIDDEC_Cmd id, IVIDDEC_DynamicParams params, IVIDDEC_Status status)
	Control behavior of an algorithm.

Detailed Description

Defines all of the operations on IVIDDEC objects.

XDAIS algorithm interface.

Basic video decoding call.

Parameters:

`[in]`	handle	Handle to an algorithm instance.
`[in]`	inBufs	Input buffer descriptors.
`[in,out]`	outBufs	Output buffer descriptors. The algorithm may modify the output buffer pointers.
`[in]`	inArgs	Input arguments. This is a required parameter.
`[out]`	outArgs	Ouput results. This is a required parameter.

Remarks:: process() is a blocking call. When process() returns, the algorithm's processing is complete.

Precondition:: inArgs must not be NULL, and must point to a valid IVIDDEC_InArgs structure.; outArgs must not be NULL, and must point to a valid IVIDDEC_OutArgs structure.; The buffers in inBufs and outBufs are physically contiguous and owned by the calling application.

Postcondition:: The algorithm must not modify the contents of inBufs or inArgs. That is, the data and buffers pointed to by these parameters must be treated as read-only.; The buffers in inBufs are owned by the calling application.

Return values:

	IALG_EOK	Success.
	IALG_EFAIL	Failure. See IVIDDEC_OutArgs::extendedError for more detailed further error conditions.

Control behavior of an algorithm.

Parameters:

`[in]`	handle	Handle to an algorithm instance.
`[in]`	id	Command id. See XDM_CmdId.
`[in]`	params	Dynamic parameters. This is a required parameter.
`[out]`	status	Output results. This is a required parameter.

Precondition:: handle must be a valid algorithm instance handle.; params must not be NULL, and must point to a valid IVIDDEC_DynamicParams structure.; status must not be NULL, and must point to a valid IVIDDEC_Status structure.

Postcondition:: The algorithm must not modify the contents of params. That is, the data pointed to by this parameter must be treated as read-only.

Return values:

	IALG_EOK	Success.
	IALG_EFAIL	Failure. See IVIDDEC_Status::extendedError for more detailed further error conditions.

The documentation for this struct was generated from the following file: