Data Structures | |
struct | IVIDDEC1_CodecClassConfig |
Definition of IVIDDEC1 codec class configurable parameters. More... | |
Defines | |
#define | VIDDEC1_EOK IVIDDEC1_EOK |
#define | VIDDEC1_EFAIL IVIDDEC1_EFAIL |
#define | VIDDEC1_EUNSUPPORTED IVIDDEC1_EUNSUPPORTED |
#define | VIDDEC1_ETIMEOUT VISA_ETIMEOUT |
#define | VIDDEC1_FOREVER VISA_FOREVER |
#define | VIDDEC1_VISATYPE "ti.sdo.ce.video1.IVIDDEC1" |
The VISA type. | |
Typedefs | |
typedef IVIDDEC1_Status | VIDDEC1_Status |
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 |
typedef IVIDDEC1_OutArgs | VIDDEC1_OutArgs |
typedef IVIDDEC1_Cmd | VIDDEC1_Cmd |
typedef IVIDDEC1_DynamicParams | VIDDEC1_DynamicParams |
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. |
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.
#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.
typedef IVIDDEC1_Status VIDDEC1_Status |
Defines instance status parameters.
size
parameter. 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 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.
size
parameter. 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 IVIDDEC1_OutArgs VIDDEC1_OutArgs |
Defines the run time output arguments for all IVIDDEC1 instance objects.
size
parameter. 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 IVIDDEC1_Cmd VIDDEC1_Cmd |
Defines the control commands for the IVIDDEC1 module.
This structure defines the codec parameters that can be modified after creation via control() calls.
size
parameter. 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 struct IVIDDEC1_CodecClassConfig IVIDDEC1_CodecClassConfig |
Definition of IVIDDEC1 codec class configurable parameters.
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.
[in] | e | Handle to an opened engine. |
[in] | name | String identifier of the type of video decoder to create. |
[in] | params | Creation parameters. |
NULL | An error has occurred. |
non-NULL | The handle to the newly created video decoder instance. |
params
is optional. If it's not supplied, codec-specific default params will be used.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". 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. 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.
[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. |
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.VIDDEC1_EOK | Success. |
VIDDEC1_EFAIL | Failure. |
VIDDEC1_EUNSUPPORTED | Unsupported request. |
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.
[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. |
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.VIDDEC1_EOK | Success. |
VIDDEC1_EFAIL | Failure. |
VIDDEC1_EUNSUPPORTED | Unsupported request. |
status->extendedError
may indicate further details about the error. See VIDDEC1_Status::extendedError for details.Void VIDDEC1_delete | ( | VIDDEC1_Handle | handle ) |
Delete the instance of a video decoder algorithm.
[in] | handle | Handle to a created video decoder instance. |
handle
is a valid (non-NULL) handle which is in the created state.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.
[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. |
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.VIDDEC1_EOK | Success. |
VIDDEC1_EFAIL | Failure. |
VIDDEC1_EUNSUPPORTED | Unsupported request. |
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.
[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) |
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.VIDDEC1_EOK | Success. |
VIDDEC1_EFAIL | Failure. |
VIDDEC1_EUNSUPPORTED | Unsupported request. |
VIDDEC1_ETIMEOUT | Operation timed out. |