Split video decoder interface

Data Structures
struct	IVIDDEC2BACK_CodecClassConfig
	Definition of IVIDDEC2BACK codec class configurable parameters. More...
Typedefs
typedef IVIDDEC2FRONT_Status	VIDDEC2FRONT_Status
typedef VISA_Handle	VIDDEC2FRONT_Handle
	Opaque handle to a VIDDEC2FRONT codec.
typedef VISA_Handle	VIDDEC2BACK_Handle
	Opaque handle to a VIDDEC2BACK codec.
typedef IVIDDEC2FRONT_OutArgs	VIDDEC2FRONT_OutArgs
Functions
VIDDEC2BACK_Handle	VIDDEC2BACK_create (Engine_Handle e, String name, VIDDEC2_Params *params)
	Create an instance of the BACK end of a split video decoder algorithm.
Int32	VIDDEC2BACK_process (VIDDEC2BACK_Handle handle, XDM_Context *context, VIDDEC2_OutArgs *outArgs)
	Execute the process() method in this instance of a BACK side split video decoder algorithm.
Int32	VIDDEC2BACK_control (VIDDEC2BACK_Handle handle, XDM_Context *context, VIDDEC2_Status *status)
	Execute the control() method in this instance of a video decoder algorithm.
Void	VIDDEC2BACK_delete (VIDDEC2BACK_Handle handle)
	Delete the instance of a video decoder algorithm.
VIDDEC2FRONT_Handle	VIDDEC2FRONT_create (Engine_Handle e, String name, VIDDEC2_Params *params)
	Create an instance of the FRONT end of a split video decoder algorithm.
Int32	VIDDEC2FRONT_process (VIDDEC2FRONT_Handle handle, VIDDEC2_InArgs *inArgs, XDM_Context *context, VIDDEC2FRONT_OutArgs *outArgs)
	Execute the process() method in this instance of a FRONT side split video decoder algorithm.
Int32	VIDDEC2FRONT_control (VIDDEC2FRONT_Handle handle, VIDDEC2_Cmd id, VIDDEC2_DynamicParams *params, XDM_Context *context, VIDDEC2FRONT_Status *status)
	Execute the control() method in this instance of a video decoder algorithm.
Void	VIDDEC2FRONT_delete (VIDDEC2FRONT_Handle handle)
	Delete the instance of a video decoder algorithm.

---

Detailed Description

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

---

Typedef Documentation

typedef IVIDDEC2FRONT_Status VIDDEC2FRONT_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.

All fields correspond to latest IVIDDEC2_Fxns::process() call on the particular instance of the decoder.

See also:

IVIDDEC2_Fxns::control()

typedef VISA_Handle VIDDEC2FRONT_Handle

Opaque handle to a VIDDEC2FRONT codec.

typedef VISA_Handle VIDDEC2BACK_Handle

Opaque handle to a VIDDEC2BACK codec.

typedef IVIDDEC2FRONT_OutArgs VIDDEC2FRONT_OutArgs

Defines the run time output arguments for all IVIDDEC2FRONT 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.

See also:

IVIDDEC2FRONT_Fxns::process()

---

Function Documentation

VIDDEC2BACK_Handle VIDDEC2BACK_create	(	Engine_Handle	e,
		String	name,
		VIDDEC2_Params *	params
	)

Create an instance of the BACK end of a split video decoder algorithm.

Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via VIDDEC2BACK_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:

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 and/or the number of VISA messages to allocate, to be overridden. This optional argument string is of the form ":priority:flag:number-of-messages", and can be specified with an empty field for any element that you don't want to be overridden, e.g. "mp3:::3" to cause 3 messages to be allocated while using the default values for priority and the heap 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.

The number-of-messages overrides the default of 1 message, and is useful (or required, practically speaking) for when the "asynchronous" process method is used, i.e. "AUDENC1_processAsync()"

See also:

Engine_open()

Int32 VIDDEC2BACK_process	(	VIDDEC2BACK_Handle	handle,
		XDM_Context *	context,
		VIDDEC2_OutArgs *	outArgs
	)

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

Parameters:

[in]	handle	Handle to a created video decoder instance.
[in,out]	context	Context provided to, and managed by, the split codec.
[out]	outArgs	Output results. This is a required parameter

Precondition:

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

Return values:

	VIDDEC2_EOK	Success.
	VIDDEC2_EFAIL	Failure.

Remarks:

Since the VIDDEC2BACK 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 VIDDEC2BACK_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.

See also:

VIDDEC2BACK_create()

VIDDEC2BACK_delete()

VIDDEC2BACK_control()

VIDDEC2BACK_processAsync()

VIDDEC2BACK_processWait()

IVIDDEC2BACK_Fxns::process()

VIDDEC2FRONT_create()

VIDDEC2FRONT_delete()

VIDDEC2FRONT_control()

IVIDDEC2FRONT_Fxns::process()

Int32 VIDDEC2BACK_control	(	VIDDEC2BACK_Handle	handle,
		XDM_Context *	context,
		VIDDEC2_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,out]	context	Context provided to, and managed by, the split codec.
[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:

	VIDDEC2_EOK	Success.
	VIDDEC2_EFAIL	Failure.

Remarks:

This is a blocking call, and will return after the control command has been executed.

See also:

VIDDEC2FRONT_create()

VIDDEC2FRONT_delete()

IVIDDEC2FRONT_Fxns::process()

VIDDEC2BACK_create()

VIDDEC2BACK_delete()

IVIDDEC2BACK_Fxns::process()

Void VIDDEC2BACK_delete

(

VIDDEC2BACK_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 VIDDEC2BACK_create() operation (memory, DMA channels, etc.) are freed.

See also:

VIDDEC2BACK_create()

VIDDEC2FRONT_Handle VIDDEC2FRONT_create	(	Engine_Handle	e,
		String	name,
		VIDDEC2_Params *	params
	)

Create an instance of the FRONT end of a split video decoder algorithm.

Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via VIDDEC2FRONT_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:

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 and/or the number of VISA messages to allocate, to be overridden. This optional argument string is of the form ":priority:flag:number-of-messages", and can be specified with an empty field for any element that you don't want to be overridden, e.g. "mp3:::3" to cause 3 messages to be allocated while using the default values for priority and the heap 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.

The number-of-messages overrides the default of 1 message, and is useful (or required, practically speaking) for when the "asynchronous" process method is used, i.e. "AUDENC1_processAsync()"

See also:

Engine_open()

Int32 VIDDEC2FRONT_process	(	VIDDEC2FRONT_Handle	handle,
		VIDDEC2_InArgs *	inArgs,
		XDM_Context *	context,
		VIDDEC2FRONT_OutArgs *	outArgs
	)

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

Parameters:

[in]	handle	Handle to a created video decoder instance.
[in]	inArgs	Input Arguments.
[in,out]	context	Context provided to, and managed by, the split codec.
[out]	outArgs	Output results. This is a required parameter

Precondition:

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

Return values:

	VIDDEC2_EOK	Success.
	VIDDEC2_EFAIL	Failure.

Remarks:

Since the VIDDEC2FRONT 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 VIDDEC2FRONT_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.

See also:

VIDDEC2FRONT_create()

VIDDEC2FRONT_delete()

VIDDEC2FRONT_control()

IVIDDEC2FRONT_Fxns::process()

VIDDEC2BACK_create()

VIDDEC2BACK_delete()

VIDDEC2BACK_control()

VIDDEC2BACK_processAsync()

VIDDEC2BACK_processWait()

IVIDDEC2BACK_Fxns::process()

Int32 VIDDEC2FRONT_control	(	VIDDEC2FRONT_Handle	handle,
		VIDDEC2_Cmd	id,
		VIDDEC2_DynamicParams *	params,
		XDM_Context *	context,
		VIDDEC2FRONT_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.
[in,out]	context	Context provided to, and managed by, the split codec.
[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:

	VIDDEC2_EOK	Success.
	VIDDEC2_EFAIL	Failure.

Remarks:

This is a blocking call, and will return after the control command has been executed.

See also:

VIDDEC2FRONT_create()

VIDDEC2FRONT_delete()

IVIDDEC2FRONT_Fxns::process()

VIDDEC2BACK_create()

VIDDEC2BACK_delete()

IVIDDEC2BACK_Fxns::process()

Void VIDDEC2FRONT_delete

(

VIDDEC2FRONT_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 VIDDEC2FRONT_create() operation (memory, DMA channels, etc.) are freed.

See also:

VIDDEC2FRONT_create()