Data Structures
struct	IVIDDEC1_CodecClassConfig
	Definition of IVIDDEC1 codec class configurable parameters. More...

Macros
#define	VIDDEC1_EOK IVIDDEC1_EOK

#define	VIDDEC1_EFAIL IVIDDEC1_EFAIL

#define	VIDDEC1_EUNSUPPORTED IVIDDEC1_EUNSUPPORTED
#define	VIDDEC1_ETIMEOUT VISA_ETIMEOUT
	Timeout occurred.
#define	VIDDEC1_FOREVER VISA_FOREVER
	Special value for timeout parameter indicating never timeout.
#define	VIDDEC1_VISATYPE "ti.sdo.ce.video1.IVIDDEC1"
	The VISA type.
#define	VIDDEC1_STUBSNAME "VIDDEC1_STUBS"
	Name of stub functions. Use this name when registering the VIDDEC1_STUBS functions with Engine_addStubFxns.

Typedefs
typedef IVIDDEC1_Status	VIDDEC1_Status
	Defines instance status parameters.
typedef VISA_Handle	VIDDEC1_Handle
	Opaque handle to a VIDDEC1 codec.
typedef struct IVIDDEC1_Params	VIDDEC1_Params
	This structure defines the parameters necessary to create an instance of a Video Decoder object.
typedef IVIDDEC1_InArgs	VIDDEC1_InArgs
	Defines the input arguments for all IVIDDEC1 instance process function.
typedef IVIDDEC1_OutArgs	VIDDEC1_OutArgs
	Defines the run time output arguments for all IVIDDEC1 instance objects.
typedef IVIDDEC1_Cmd	VIDDEC1_Cmd
	Defines the control commands for the IVIDDEC1 module.
typedef IVIDDEC1_DynamicParams	VIDDEC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IVIDDEC1_CodecClassConfig	IVIDDEC1_CodecClassConfig
	Definition of IVIDDEC1 codec class configurable parameters.

Functions
VIDDEC1_Handle	VIDDEC1_create (Engine_Handle e, String name, VIDDEC1_Params *params)
	Create an instance of a video decoder algorithm.
Int32	VIDDEC1_process (VIDDEC1_Handle handle, XDM1_BufDesc inBufs, XDM_BufDesc outBufs, VIDDEC1_InArgs inArgs, VIDDEC1_OutArgs outArgs)
	Execute the process() method in this instance of a video decoder algorithm.
Int32	VIDDEC1_control (VIDDEC1_Handle handle, VIDDEC1_Cmd id, VIDDEC1_DynamicParams params, VIDDEC1_Status status)
	Execute the control() method in this instance of a video decoder algorithm.
Void	VIDDEC1_delete (VIDDEC1_Handle handle)
	Delete the instance of a video decoder algorithm.
XDAS_Int32	VIDDEC1_processAsync (VIDDEC1_Handle handle, XDM1_BufDesc inBufs, XDM_BufDesc outBufs, VIDDEC1_InArgs inArgs, VIDDEC1_OutArgs outArgs)
	Perform asynchronous submission to this instance of a video decoder algorithm.
XDAS_Int32	VIDDEC1_processWait (VIDDEC1_Handle handle, XDM1_BufDesc inBufs, XDM_BufDesc outBufs, VIDDEC1_InArgs inArgs, VIDDEC1_OutArgs outArgs, UInt timeout)
	Wait for a return message from a previous invocation of VIDDEC1_processAsync() in this instance of an video decoder algorithm.

Detailed Description

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

Macro Definition Documentation

#define VIDDEC1_EOK IVIDDEC1_EOK

Success.

#define VIDDEC1_EFAIL IVIDDEC1_EFAIL

General failure. Request is unsupported.

#define VIDDEC1_EUNSUPPORTED IVIDDEC1_EUNSUPPORTED

#define VIDDEC1_ETIMEOUT VISA_ETIMEOUT

Timeout occurred.

#define VIDDEC1_FOREVER VISA_FOREVER

Special value for timeout parameter indicating never timeout.

#define VIDDEC1_VISATYPE "ti.sdo.ce.video1.IVIDDEC1"

The VISA type.

#define VIDDEC1_STUBSNAME "VIDDEC1_STUBS"

Name of stub functions. Use this name when registering the VIDDEC1_STUBS functions with Engine_addStubFxns.

See also:: Engine_addStubFxns

Typedef Documentation

typedef IVIDDEC1_Status VIDDEC1_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 @c size parameter.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

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

@sa         IVIDDEC1_Fxns::control()

typedef VISA_Handle VIDDEC1_Handle

Opaque handle to a VIDDEC1 codec.

typedef struct IVIDDEC1_Params VIDDEC1_Params

This structure defines the parameters necessary to create an instance of a Video Decoder object.

typedef IVIDDEC1_InArgs VIDDEC1_InArgs

Defines the input arguments for all IVIDDEC1 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 @c size parameter.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         IVIDDEC1_Fxns::process()

typedef IVIDDEC1_OutArgs VIDDEC1_OutArgs

Defines the run time output arguments for all IVIDDEC1 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 @c size parameter.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         IVIDDEC1_Fxns::process()

typedef IVIDDEC1_Cmd VIDDEC1_Cmd

Defines the control commands for the IVIDDEC1 module.

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

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

typedef IVIDDEC1_DynamicParams VIDDEC1_DynamicParams

This structure defines the codec parameters that can be modified after creation via 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.

@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 @c size parameter.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         IVIDDEC1_Fxns::control()

typedef struct IVIDDEC1_CodecClassConfig IVIDDEC1_CodecClassConfig

Definition of IVIDDEC1 codec class configurable parameters.

See also:: VISA_getCodecClassConfig()

Function Documentation

VIDDEC1_Handle VIDDEC1_create	(	Engine_Handle	e,
		String	name,
		VIDDEC1_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 VIDDEC1_create) or
explicitly serialize access to a shared handle.

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

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

@remarks    @c params is optional.  If it's not supplied, codec-specific
            default params will be used.

@remark     Depending on the configuration of the engine opened, this
            call may create a local or remote instance of the video
            decoder.

@remarks In general, @c 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 <b>":priority"</b>, <b>":priority:flag"</b>, or <b>"::flag"</b>.

Remarks:

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.

@sa         Engine_open()
@sa         VIDDEC1_delete()

Int32 VIDDEC1_process	(	VIDDEC1_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		VIDDEC1_InArgs *	inArgs,
		VIDDEC1_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:

VIDDEC1_EOK	Success.
VIDDEC1_EFAIL	Failure.
VIDDEC1_EUNSUPPORTED	Unsupported request.

Remarks:: Since the VIDDEC1 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 VIDDEC1_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:: VIDDEC1_create(); VIDDEC1_delete(); VIDDEC1_control(); VIDDEC1_processAsync(); VIDDEC1_processWait(); IVIDDEC1_Fxns::process() - the reflected algorithm interface, which may contain further usage details.

Int32 VIDDEC1_control	(	VIDDEC1_Handle	handle,
		VIDDEC1_Cmd	id,
		VIDDEC1_DynamicParams *	params,
		VIDDEC1_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:

VIDDEC1_EOK	Success.
VIDDEC1_EFAIL	Failure.
VIDDEC1_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 VIDDEC1_Status::extendedError for details.

See also:: VIDDEC1_create(); VIDDEC1_delete(); IVIDDEC1_Fxns::process()

Void VIDDEC1_delete ( VIDDEC1_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 VIDDEC1_create() operation (memory, DMA channels, etc.) are freed.

See also:: VIDDEC1_create()

XDAS_Int32 VIDDEC1_processAsync	(	VIDDEC1_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		VIDDEC1_InArgs *	inArgs,
		VIDDEC1_OutArgs *	outArgs
	)

Perform asynchronous submission to 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:

VIDDEC1_EOK	Success.
VIDDEC1_EFAIL	Failure.
VIDDEC1_EUNSUPPORTED	Unsupported request.

Remarks:: This API is the asynchronous counterpart to the process() method. It allows for buffer and argument submission without waiting for retrieval. A response is retrieved using the VIDDEC1_processWait() API.; The buffers supplied to VIDDEC1_processAsync() 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:: VIDDEC1_create(); VIDDEC1_delete(); VIDDEC1_control(); VIDDEC1_process(); VIDDEC1_processWait(); IVIDDEC1_Fxns::process()

XDAS_Int32 VIDDEC1_processWait	(	VIDDEC1_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		VIDDEC1_InArgs *	inArgs,
		VIDDEC1_OutArgs *	outArgs,
		UInt	timeout
	)

Wait for a return message from a previous invocation of VIDDEC1_processAsync() in this instance of an 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.
[in]	timeout	Amount of "time" to wait (from 0 -> VIDDEC1_FOREVER)

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

Return values:

VIDDEC1_EOK	Success.
VIDDEC1_EFAIL	Failure.
VIDDEC1_EUNSUPPORTED	Unsupported request.
VIDDEC1_ETIMEOUT	Operation timed out.

Remarks:: This is a blocking call, and will return after the data has been decoded.; "Polling" is supported by using a timeout of 0. Waiting forever is supported by using a timeout of VIDDEC1_FOREVER.; There must have previously been an invocation of the VIDDEC1_processAsync() API.; The buffers supplied to VIDDEC1_processAsync() 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:: VIDDEC1_create(); VIDDEC1_delete(); VIDDEC1_control(); VIDDEC1_process(); VIDDEC1_processAsync()

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation