Data Structures | |
struct | IVIDDEC_CodecClassConfig |
Definition of VIDDEC codec class configurable parameters. More... | |
Defines | |
#define | VIDDEC_EOK IVIDDEC_EOK |
#define | VIDDEC_EFAIL IVIDDEC_EFAIL |
#define | VIDDEC_ERUNTIME IVIDDEC_ERUNTIME |
#define | VIDDEC_ETIMEOUT VISA_ETIMEOUT |
#define | VIDDEC_FOREVER VISA_FOREVER |
#define | VIDDEC_VISATYPE "ti.sdo.ce.video.IVIDDEC" |
The VISA type. | |
#define | VIDDEC_STUBSNAME "VIDDEC_STUBS" |
Name of stub functions. Use this name when registering the VIDDEC_STUBS functions with Engine_addStubFxns. | |
Typedefs | |
typedef IVIDDEC_Status | VIDDEC_Status |
typedef VISA_Handle | VIDDEC_Handle |
Opaque handle to a VIDDEC codec. | |
typedef struct IVIDDEC_Params | VIDDEC_Params |
This structure defines the parameters necessary to create an instance of a video decoder object. | |
typedef IVIDDEC_InArgs | VIDDEC_InArgs |
typedef IVIDDEC_OutArgs | VIDDEC_OutArgs |
typedef IVIDDEC_Cmd | VIDDEC_Cmd |
typedef IVIDDEC_DynamicParams | VIDDEC_DynamicParams |
typedef struct IVIDDEC_CodecClassConfig | IVIDDEC_CodecClassConfig |
Definition of VIDDEC codec class configurable parameters. | |
Functions | |
VIDDEC_Handle | VIDDEC_create (Engine_Handle e, String name, VIDDEC_Params *params) |
Create an instance of a video decoder algorithm. | |
Int32 | VIDDEC_process (VIDDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC_InArgs *inArgs, VIDDEC_OutArgs *outArgs) |
Execute the process() method in this instance of a video decoder algorithm. | |
Int32 | VIDDEC_control (VIDDEC_Handle handle, VIDDEC_Cmd id, VIDDEC_DynamicParams *params, VIDDEC_Status *status) |
Execute the "control" method in this instance of a video decoder algorithm. | |
Void | VIDDEC_delete (VIDDEC_Handle handle) |
Delete the instance of a video decoder algorithm. | |
XDAS_Int32 | VIDDEC_processAsync (VIDDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC_InArgs *inArgs, VIDDEC_OutArgs *outArgs) |
Perform asynchronous submission to this instance of a video decoder algorithm. | |
XDAS_Int32 | VIDDEC_processWait (VIDDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC_InArgs *inArgs, VIDDEC_OutArgs *outArgs, UInt timeout) |
Wait for a return message from a previous invocation of VIDDEC_processAsync() in this instance of an video decoder algorithm. |
This is the VIDDEC 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 VIDDEC_EOK IVIDDEC_EOK |
Success.
#define VIDDEC_EFAIL IVIDDEC_EFAIL |
General failure.
#define VIDDEC_ERUNTIME IVIDDEC_ERUNTIME |
General runtime failure.
#define VIDDEC_ETIMEOUT VISA_ETIMEOUT |
Timeout occurred.
#define VIDDEC_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
#define VIDDEC_VISATYPE "ti.sdo.ce.video.IVIDDEC" |
The VISA type.
#define VIDDEC_STUBSNAME "VIDDEC_STUBS" |
Name of stub functions. Use this name when registering the VIDDEC_STUBS functions with Engine_addStubFxns.
typedef IVIDDEC_Status VIDDEC_Status |
Defines instance status parameters.
size
parameter. 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.typedef VISA_Handle VIDDEC_Handle |
Opaque handle to a VIDDEC codec.
typedef struct IVIDDEC_Params VIDDEC_Params |
This structure defines the parameters necessary to create an instance of a video decoder object.
typedef IVIDDEC_InArgs VIDDEC_InArgs |
Defines the input arguments for all IVIDDEC instance process function.
size
parameter. 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.typedef IVIDDEC_OutArgs VIDDEC_OutArgs |
Defines the run time output arguments for all IVIDDEC instance objects.
size
parameter. 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.typedef IVIDDEC_Cmd VIDDEC_Cmd |
Defines the control commands for the IVIDDEC 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 https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.typedef struct IVIDDEC_CodecClassConfig IVIDDEC_CodecClassConfig |
Definition of VIDDEC codec class configurable parameters.
VIDDEC_Handle VIDDEC_create | ( | Engine_Handle | e, |
String | name, | ||
VIDDEC_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 VIDDEC_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 VIDDEC_process | ( | VIDDEC_Handle | handle, |
XDM_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
VIDDEC_InArgs * | inArgs, | ||
VIDDEC_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.VIDDEC_EOK | Success. |
VIDDEC_EFAIL | Failure. |
VIDDEC_ERUNTIME | Internal Runtime Error. |
Int32 VIDDEC_control | ( | VIDDEC_Handle | handle, |
VIDDEC_Cmd | id, | ||
VIDDEC_DynamicParams * | params, | ||
VIDDEC_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.VIDDEC_EOK | Success. |
VIDDEC_EFAIL | Failure. |
VIDDEC_ERUNTIME | Internal Runtime Error. |
Void VIDDEC_delete | ( | VIDDEC_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 VIDDEC_processAsync | ( | VIDDEC_Handle | handle, |
XDM_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
VIDDEC_InArgs * | inArgs, | ||
VIDDEC_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.VIDDEC_EOK | Success. |
VIDDEC_EFAIL | Failure. |
VIDDEC_ERUNTIME | Internal Runtime Error. |
XDAS_Int32 VIDDEC_processWait | ( | VIDDEC_Handle | handle, |
XDM_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
VIDDEC_InArgs * | inArgs, | ||
VIDDEC_OutArgs * | outArgs, | ||
UInt | timeout | ||
) |
Wait for a return message from a previous invocation of VIDDEC_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 -> VIDDEC_FOREVER) |
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.VIDDEC_EOK | Success. |
VIDDEC_EFAIL | Failure. |
VIDDEC_ERUNTIME | Internal Runtime Error. |
VIDDEC_ETIMEOUT | Operation timed out. |