IVIDDEC2BACK_Fxns Struct Reference [XDM IVIDDEC2-based Video Decoder Split Interface]

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

#include <ividdec2.h>

Collaboration diagram for IVIDDEC2BACK_Fxns:

Data Fields
IALG_Fxns	ialg
XDAS_Int32(*	process )(IVIDDEC2BACK_Handle handle, XDM_Context *context, IVIDDEC2_OutArgs *outArgs)
	Basic video decoding call.
XDAS_Int32(*	control )(IVIDDEC2BACK_Handle handle, XDM_Context *context, IVIDDEC2_Status *status)
	Control behavior of an algorithm.

---

Detailed Description

Defines all of the operations on IVIDDEC2BACK objects.

---

Field Documentation

IALG_Fxns IVIDDEC2BACK_Fxns::ialg

XDAIS algorithm interface.

See also:

IALG_Fxns

XDAS_Int32(* IVIDDEC2BACK_Fxns::process)(IVIDDEC2BACK_Handle handle, XDM_Context *context, IVIDDEC2_OutArgs *outArgs)

Basic video decoding call.

Parameters:

[in]	handle	Handle to an algorithm instance.
[in,out]	context	Context provided to, and managed by the split codec.
[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:

context must not be NULL, and must point to a valid XDM_Context structure.

context->numInOutBufs must be zero (0).

outArgs must not be NULL, and must point to a valid IVIDDEC2_OutArgs structure.

Postcondition:

The buffers in context are owned by the calling application.

Return values:

IVIDDEC2_EOK	Success.
IVIDDEC2_EFAIL	General failure. See IVIDDEC2_Status::extendedError for more detailed further error conditions.
IVIDDEC2_EUNSUPPORTED	Request is unsupported.

XDAS_Int32(* IVIDDEC2BACK_Fxns::control)(IVIDDEC2BACK_Handle handle, XDM_Context *context, IVIDDEC2_Status *status)

Control behavior of an algorithm.

Parameters:

[in]	handle	Handle to an algorithm instance.
[in]	context	Codec context. This is a required parameter.
[out]	status	Output results. This is a required parameter.

Precondition:

handle must be a valid algorithm instance handle.

context must not be NULL, and must point to a valid XDM_Context structure.

status must not be NULL, and must point to a valid IVIDDEC2_Status structure.

If a buffer is provided in the status->data field, it must be physically contiguous and owned by the calling application.

Postcondition:

If a buffer was provided in the status->data field, it is owned by the calling application.

Return values:

IVIDDEC2_EOK	Success.
IVIDDEC2_EFAIL	General failure. See IVIDDEC2_Status::extendedError for more detailed further error conditions.
IVIDDEC2_EUNSUPPORTED	Request is unsupported.

---

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

• split/ividdec2.h