Data Structures
struct	IVIDDEC3_CodecClassConfig
	Definition of IVIDDEC3 codec class configurable parameters. More...
Defines
#define	VIDDEC3_EOK IVIDDEC3_EOK
#define	VIDDEC3_EFAIL IVIDDEC3_EFAIL
#define	VIDDEC3_EUNSUPPORTED IVIDDEC3_EUNSUPPORTED
#define	VIDDEC3_ETIMEOUT VISA_ETIMEOUT
#define	VIDDEC3_FOREVER VISA_FOREVER
#define	VIDDEC3_VISATYPE "ti.sdo.ce.video3.IVIDDEC3"
	The VISA type.
Typedefs
typedef VISA_Handle	VIDDEC3_Handle
	Opaque handle to a VIDDEC3 codec.
typedef struct IVIDDEC3_Params	VIDDEC3_Params
typedef IVIDDEC3_InArgs	VIDDEC3_InArgs
typedef IVIDDEC3_OutArgs	VIDDEC3_OutArgs
typedef IVIDDEC3_Cmd	VIDDEC3_Cmd
typedef IVIDDEC3_DynamicParams	VIDDEC3_DynamicParams
typedef IVIDDEC3_Status	VIDDEC3_Status
typedef struct IVIDDEC3_CodecClassConfig	IVIDDEC3_CodecClassConfig
	Definition of IVIDDEC3 codec class configurable parameters.
Functions
Int32	VIDDEC3_control (VIDDEC3_Handle handle, VIDDEC3_Cmd id, VIDDEC3_DynamicParams params, VIDDEC3_Status status)
	Execute the control() method in this instance of a video decoder algorithm.
VIDDEC3_Handle	VIDDEC3_create (Engine_Handle e, String name, VIDDEC3_Params *params)
	Create an instance of a video decoder algorithm.
Void	VIDDEC3_delete (VIDDEC3_Handle handle)
	Delete the instance of a video decoder algorithm.
Int32	VIDDEC3_process (VIDDEC3_Handle handle, XDM2_BufDesc inBufs, XDM2_BufDesc outBufs, VIDDEC3_InArgs inArgs, VIDDEC3_OutArgs outArgs)
	Execute the process() method in this instance of a video decoder algorithm.

Detailed Description

This is the VIDDEC3 video decoder interface. Several of the data types in this API are specified by the XDM IVIDDEC3 interface; please see the XDM documentation for those details.

Define Documentation

#define VIDDEC3_EOK IVIDDEC3_EOK

Success.

#define VIDDEC3_EFAIL IVIDDEC3_EFAIL

General failure.

Request is unsupported.

#define VIDDEC3_EUNSUPPORTED IVIDDEC3_EUNSUPPORTED

#define VIDDEC3_ETIMEOUT VISA_ETIMEOUT

Timeout occurred.

#define VIDDEC3_FOREVER VISA_FOREVER

Special value for timeout parameter indicating never timeout.

#define VIDDEC3_VISATYPE "ti.sdo.ce.video3.IVIDDEC3"

The VISA type.

Typedef Documentation

typedef VISA_Handle VIDDEC3_Handle

Opaque handle to a VIDDEC3 codec.

typedef struct IVIDDEC3_Params VIDDEC3_Params

Defines the creation time parameters for all IVIDDEC3 instance objects.

Remarks:: This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the size parameter.; The size field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

typedef IVIDDEC3_InArgs VIDDEC3_InArgs

Defines the input arguments for all IVIDDEC3 instance process function.

Remarks:: This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the size parameter.; The size field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:: IVIDDEC3_Fxns::process()

typedef IVIDDEC3_OutArgs VIDDEC3_OutArgs

Defines the run time output arguments for all IVIDDEC3 instance objects.

Remarks:: This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the size parameter.; The size field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.; The size of this struct may vary when IVIDDEC3_OutArgs.displayBufsMode is set to IVIDDEC3_DISPLAYBUFS_EMBEDDED (see details in IVIDDEC3_OutArgs.displayBufs.bufDesc).; When IVIDDEC3_OutArgs.displayBufsMode is set to IVIDDEC3_DISPLAYBUFS_EMBEDDED, the number of elements in the IVIDDEC3_OutArgs.displayBufs.bufDesc array is a constant (and can be acquired by calling IVIDDEC3_Fxns.control() and looking in the IVIDDEC3_Status.maxOutArgsDisplayBufs field. Note that any extended fields follow the IVIDDEC3_OutArgs.displayBufs.bufDesc array.

See also:: IVIDDEC3_Fxns.process()

typedef IVIDDEC3_Cmd VIDDEC3_Cmd

Defines the control commands for the IVIDDEC3 module.

Remarks:: This ID can be extended in IMOD interface for additional controls.

See also:: XDM_CmdId; IVIDDEC3_Fxns::control()

typedef IVIDDEC3_DynamicParams VIDDEC3_DynamicParams

This structure defines the algorithm parameters that can be modified after creation via IVIDDEC3_Fxns.control() calls.

Remarks:: It is not necessary that a given implementation support all dynamic parameters to be configurable at run time. If a particular algorithm does not support run-time updates to a parameter that the application is attempting to change at runtime, it may indicate this as an error.; This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the size parameter.; The size field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:: IVIDDEC3_Fxns::control()

typedef IVIDDEC3_Status VIDDEC3_Status

Defines instance status parameters.

Remarks:: This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the size parameter.; The size field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:: IVIDDEC3_Fxns::control()

typedef struct IVIDDEC3_CodecClassConfig IVIDDEC3_CodecClassConfig

Definition of IVIDDEC3 codec class configurable parameters.

See also:: VISA_getCodecClassConfig()

Function Documentation

Int32 VIDDEC3_control	(	VIDDEC3_Handle	handle,
		VIDDEC3_Cmd	id,
		VIDDEC3_DynamicParams *	params,
		VIDDEC3_Status *	status
	)

Execute the control() method in this instance of a video decoder algorithm.

Parameters:

[in]	handle	Handle to a created video decoder instance.
[in]	id	Command id for XDM control operation.
[in]	params	Runtime control parameters used for decoding.
[out]	status	Status info upon completion of decode operation.

Precondition:: handle is a valid (non-NULL) video decoder handle and the video decoder is in the created state.

Return values:

VIDDEC3_EOK	Success.
VIDDEC3_EFAIL	Failure.
VIDDEC3_EUNSUPPORTED	Unsupported request.

Remarks:: This is a blocking call, and will return after the control command has been executed.; If an error is returned, status->extendedError may indicate further details about the error. See XDM_ErrorBit for details.

See also:: VIDDEC3_create(); VIDDEC3_delete(); IVIDDEC3_Fxns::process()

VIDDEC3_Handle VIDDEC3_create	(	Engine_Handle	e,
		String	name,
		VIDDEC3_Params *	params
	)

Create an instance of a video decoder algorithm.

Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via VIDDEC3_create) or explicitly serialize access to a shared handle.

Parameters:

[in]	e	Handle to an opened engine.
[in]	name	String identifier of the type of video decoder to create.
[in]	params	Creation parameters.

Return values:

NULL	An error has occurred.
non-NULL	The handle to the newly created video decoder instance.

Remarks:: params is optional. If it's not supplied, codec-specific default params will be used.; Depending on the configuration of the engine opened, this call may create a local or remote instance of the video decoder.; In general, name is the name of the codec configured by the system integrator. However, an optional "argument string" may be appended to the codec name, to allow the codec's configured priority and/or the heaps where its memory will be allocated, to be overridden. This optional argument string is of the form ":priority", ":priority:flag", or "::flag".; priority is the new priority to create the codec with.; The flag must be either 0 or 1, and if 1, all memory allocated for the codec will be in the heap that corresponds to IALG_EXTERNAL. If flag is 0, the memory for the codec will be allocated from the heaps it has requested. For example, if a codec named "mp3" has been configured into the system, setting name to "mp3:4" would cause the codec to be created at priority 4, instead of whatever priority was configured. This feature is useful if more than one instance of the codec are to be created at different priorities.; The flag can be used to prevent the codec from using any internal memory, for example, if it is to be run at the same time as another codec that must use internal memory, and there is insufficient internal memory for both.

See also:: Engine_open(); VIDENC3_delete()

Void VIDDEC3_delete ( VIDDEC3_Handle handle )

Delete the instance of a video decoder algorithm.

Parameters:

[in] handle Handle to a created video decoder instance.

Remarks:: Depending on the configuration of the engine opened, this call may delete a local or remote instance of the video decoder.

Precondition:: handle is a valid (non-NULL) handle which is in the created state.

Postcondition:: All resources allocated as part of the VIDDEC3_create() operation (memory, DMA channels, etc.) are freed.

See also:: VIDDEC3_create()

Int32 VIDDEC3_process	(	VIDDEC3_Handle	handle,
		XDM2_BufDesc *	inBufs,
		XDM2_BufDesc *	outBufs,
		VIDDEC3_InArgs *	inArgs,
		VIDDEC3_OutArgs *	outArgs
	)

Execute the process() method in this instance of a video decoder algorithm.

Parameters:

[in]	handle	Handle to a created video decoder instance.
[in]	inBufs	A buffer descriptor containing input buffers.
[out]	outBufs	A buffer descriptor containing output buffers.
[in]	inArgs	Input Arguments.
[out]	outArgs	Output Arguments.

Precondition:: handle is a valid (non-NULL) video decoder handle and the video decoder is in the created state.

Return values:

VIDDEC3_EOK	Success.
VIDDEC3_EFAIL	Failure.
VIDDEC3_EUNSUPPORTED	Unsupported request.

Remarks:: Since the VIDDEC3 decoder contains support for asynchronous buffer submission and retrieval, this API becomes known as synchronous in nature.; This is a blocking call, and will return after the data has been decoded.; The buffers supplied to VIDDEC3_process() may have constraints put on them. For example, in dual-processor, shared memory architectures, where the codec is running on a remote processor, the buffers may need to be physically contiguous. Additionally, the remote processor may place restrictions on buffer alignment.; If an error is returned, outArgs->extendedError may indicate further details about the error. See XDM_ErrorBit for details.

See also:: VIDDEC3_create(); VIDDEC3_delete(); VIDDEC3_control(); VIDDEC3_processAsync(); VIDDEC3_processWait(); IVIDDEC3_Fxns::process()

VIDDEC3 - Video Decoder Interface

Data Structures

Defines

Typedefs

Functions

Detailed Description

Define Documentation

Typedef Documentation

Function Documentation