Data Structures | |
struct | IVIDDEC2_CodecClassConfig |
Definition of IVIDDEC2 codec class configurable parameters. More... | |
Defines | |
#define | VIDDEC2_EOK IVIDDEC2_EOK |
#define | VIDDEC2_EFAIL IVIDDEC2_EFAIL |
#define | VIDDEC2_EUNSUPPORTED IVIDDEC2_EUNSUPPORTED |
#define | VIDDEC2_ETIMEOUT VISA_ETIMEOUT |
#define | VIDDEC2_FOREVER VISA_FOREVER |
#define | VIDDEC2_VISATYPE "ti.sdo.ce.video2.IVIDDEC2" |
The VISA type. | |
#define | VIDDEC2_STUBSNAME "VIDDEC2_STUBS" |
Name of stub functions. Use this name when registering the VIDDEC2_STUBS functions with Engine_addStubFxns. | |
Typedefs | |
typedef IVIDDEC2_Status | VIDDEC2_Status |
typedef VISA_Handle | VIDDEC2_Handle |
Opaque handle to a VIDDEC2 codec. | |
typedef struct IVIDDEC2_Params | VIDDEC2_Params |
This structure defines the parameters necessary to create an instance of a video decoder object. | |
typedef IVIDDEC2_InArgs | VIDDEC2_InArgs |
typedef IVIDDEC2_OutArgs | VIDDEC2_OutArgs |
typedef IVIDDEC2_Cmd | VIDDEC2_Cmd |
typedef IVIDDEC2_DynamicParams | VIDDEC2_DynamicParams |
typedef struct IVIDDEC2_CodecClassConfig | IVIDDEC2_CodecClassConfig |
Definition of IVIDDEC2 codec class configurable parameters. | |
Functions | |
VIDDEC2_Handle | VIDDEC2_create (Engine_Handle e, String name, VIDDEC2_Params *params) |
Create an instance of a video decoder algorithm. | |
Int32 | VIDDEC2_process (VIDDEC2_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC2_InArgs *inArgs, VIDDEC2_OutArgs *outArgs) |
Execute the process() method in this instance of a video decoder algorithm. | |
Int32 | VIDDEC2_control (VIDDEC2_Handle handle, VIDDEC2_Cmd id, VIDDEC2_DynamicParams *params, VIDDEC2_Status *status) |
Execute the control() method in this instance of a video decoder algorithm. | |
Void | VIDDEC2_delete (VIDDEC2_Handle handle) |
Delete the instance of a video decoder algorithm. | |
XDAS_Int32 | VIDDEC2_processAsync (VIDDEC2_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC2_InArgs *inArgs, VIDDEC2_OutArgs *outArgs) |
Perform asynchronous submission to this instance of a video decoder algorithm. | |
XDAS_Int32 | VIDDEC2_processWait (VIDDEC2_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC2_InArgs *inArgs, VIDDEC2_OutArgs *outArgs, UInt timeout) |
Wait for a return message from a previous invocation of VIDDEC2_processAsync() in this instance of an video decoder algorithm. |
This is the VIDDEC2 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 VIDDEC2_EOK IVIDDEC2_EOK |
Success.
#define VIDDEC2_EFAIL IVIDDEC2_EFAIL |
General failure.
Request is unsupported.
#define VIDDEC2_EUNSUPPORTED IVIDDEC2_EUNSUPPORTED |
#define VIDDEC2_ETIMEOUT VISA_ETIMEOUT |
Timeout occurred.
#define VIDDEC2_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
#define VIDDEC2_VISATYPE "ti.sdo.ce.video2.IVIDDEC2" |
The VISA type.
#define VIDDEC2_STUBSNAME "VIDDEC2_STUBS" |
Name of stub functions. Use this name when registering the VIDDEC2_STUBS functions with Engine_addStubFxns.
typedef IVIDDEC2_Status VIDDEC2_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 VIDDEC2_Handle |
Opaque handle to a VIDDEC2 codec.
typedef struct IVIDDEC2_Params VIDDEC2_Params |
This structure defines the parameters necessary to create an instance of a video decoder object.
typedef IVIDDEC2_InArgs VIDDEC2_InArgs |
Defines the input arguments for all IVIDDEC2 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 IVIDDEC2_OutArgs VIDDEC2_OutArgs |
Defines the run time output arguments for all IVIDDEC2 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 IVIDDEC2_Cmd VIDDEC2_Cmd |
Defines the control commands for the IVIDDEC2 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 IVIDDEC2_CodecClassConfig IVIDDEC2_CodecClassConfig |
Definition of IVIDDEC2 codec class configurable parameters.
VIDDEC2_Handle VIDDEC2_create | ( | Engine_Handle | e, |
String | name, | ||
VIDDEC2_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 VIDDEC2_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 VIDDEC2_process | ( | VIDDEC2_Handle | handle, |
XDM1_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
VIDDEC2_InArgs * | inArgs, | ||
VIDDEC2_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.VIDDEC2_EOK | Success. |
VIDDEC2_EFAIL | Failure. |
VIDDEC2_EUNSUPPORTED | Unsupported request. |
Int32 VIDDEC2_control | ( | VIDDEC2_Handle | handle, |
VIDDEC2_Cmd | id, | ||
VIDDEC2_DynamicParams * | params, | ||
VIDDEC2_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.VIDDEC2_EOK | Success. |
VIDDEC2_EFAIL | Failure. |
VIDDEC2_EUNSUPPORTED | Unsupported request. |
status->extendedError
may indicate further details about the error. See VIDDEC2_Status::extendedError for details.Void VIDDEC2_delete | ( | VIDDEC2_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 VIDDEC2_processAsync | ( | VIDDEC2_Handle | handle, |
XDM1_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
VIDDEC2_InArgs * | inArgs, | ||
VIDDEC2_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.VIDDEC2_EOK | Success. |
VIDDEC2_EFAIL | Failure. |
VIDDEC2_EUNSUPPORTED | Unsupported request. |
XDAS_Int32 VIDDEC2_processWait | ( | VIDDEC2_Handle | handle, |
XDM1_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
VIDDEC2_InArgs * | inArgs, | ||
VIDDEC2_OutArgs * | outArgs, | ||
UInt | timeout | ||
) |
Wait for a return message from a previous invocation of VIDDEC2_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 -> VIDDEC2_FOREVER) |
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.VIDDEC2_EOK | Success. |
VIDDEC2_EFAIL | Failure. |
VIDDEC2_EUNSUPPORTED | Unsupported request. |
VIDDEC2_ETIMEOUT | Operation timed out. |