IVIDENC_Fxns Struct Reference
[XDM IVIDENC Video Encoder Interface]

#include <ividenc.h>

Collaboration diagram for IVIDENC_Fxns:

[legend]

---

Detailed Description

Defines all of the operations on IVIDENC objects.

Data Fields
IALG_Fxns	ialg
XDAS_Int32(*	process )(IVIDENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IVIDENC_InArgs *inArgs, IVIDENC_OutArgs *outArgs)
	Basic video encoding call.
XDAS_Int32(*	control )(IVIDENC_Handle handle, IVIDENC_Cmd id, IVIDENC_DynamicParams *params, IVIDENC_Status *status)
	Control behavior of an algorithm.

---

Field Documentation

IALG_Fxns IVIDENC_Fxns::ialg

XDAIS algorithm interface.

See also:

IALG_Fxns

XDAS_Int32(* IVIDENC_Fxns::process)(IVIDENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IVIDENC_InArgs *inArgs, IVIDENC_OutArgs *outArgs)

Basic video encoding 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 IVIDENC_InArgs structure.

outArgs must not be NULL, and must point to a valid IVIDENC_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 inArgs.

The buffers in inBufs are owned by the calling application.

Return values:

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

XDAS_Int32(* IVIDENC_Fxns::control)(IVIDENC_Handle handle, IVIDENC_Cmd id, IVIDENC_DynamicParams *params, IVIDENC_Status *status)

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 IVIDENC_DynamicParams structure.

status must not be NULL, and must point to a valid IVIDENC_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 IVIDENC_Status::extendedError for more detailed further error conditions.

---

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

• ividenc.h

---

Copyright 2009, Texas Instruments Incorporated