Data Structures | |
struct | IVIDDEC3_CodecClassConfig |
Definition of IVIDDEC3 codec class configurable parameters. More... | |
Defines | |
#define | VIDDEC3_EOK IVIDDEC3_EOK |
#define | VIDDEC3_EFAIL IVIDDEC3_EFAIL |
#define | VIDDEC3_EUNSUPPORTED IVIDDEC3_EUNSUPPORTED |
#define | VIDDEC3_ETIMEOUT VISA_ETIMEOUT |
#define | VIDDEC3_FOREVER VISA_FOREVER |
#define | VIDDEC3_VISATYPE "ti.sdo.ce.video3.IVIDDEC3" |
The VISA type. | |
#define | VIDDEC3_STUBSNAME "VIDDEC3_STUBS" |
Name of stub functions. Use this name when registering the VIDDEC3_STUBS functions with Engine_addStubFxns. | |
Typedefs | |
typedef VISA_Handle | VIDDEC3_Handle |
Opaque handle to a VIDDEC3 codec. | |
typedef struct IVIDDEC3_Params | VIDDEC3_Params |
typedef IVIDDEC3_InArgs | VIDDEC3_InArgs |
typedef IVIDDEC3_OutArgs | VIDDEC3_OutArgs |
typedef IVIDDEC3_Cmd | VIDDEC3_Cmd |
typedef IVIDDEC3_DynamicParams | VIDDEC3_DynamicParams |
typedef IVIDDEC3_Status | VIDDEC3_Status |
typedef struct IVIDDEC3_CodecClassConfig | IVIDDEC3_CodecClassConfig |
Definition of IVIDDEC3 codec class configurable parameters. | |
Functions | |
Int32 | VIDDEC3_control (VIDDEC3_Handle handle, VIDDEC3_Cmd id, VIDDEC3_DynamicParams *params, VIDDEC3_Status *status) |
Execute the control() method in this instance of a video decoder algorithm. | |
VIDDEC3_Handle | VIDDEC3_create (Engine_Handle e, String name, VIDDEC3_Params *params) |
Create an instance of a video decoder algorithm. | |
Void | VIDDEC3_delete (VIDDEC3_Handle handle) |
Delete the instance of a video decoder algorithm. | |
Int32 | VIDDEC3_process (VIDDEC3_Handle handle, XDM2_BufDesc *inBufs, XDM2_BufDesc *outBufs, VIDDEC3_InArgs *inArgs, VIDDEC3_OutArgs *outArgs) |
Execute the process() method in this instance of a video decoder algorithm. |
This is the VIDDEC3 video decoder interface. Several of the data types in this API are specified by the XDM IVIDDEC3 interface; please see the XDM documentation for those details.
#define VIDDEC3_EOK IVIDDEC3_EOK |
Success.
#define VIDDEC3_EFAIL IVIDDEC3_EFAIL |
General failure.
Request is unsupported.
#define VIDDEC3_EUNSUPPORTED IVIDDEC3_EUNSUPPORTED |
#define VIDDEC3_ETIMEOUT VISA_ETIMEOUT |
Timeout occurred.
#define VIDDEC3_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
#define VIDDEC3_VISATYPE "ti.sdo.ce.video3.IVIDDEC3" |
The VISA type.
#define VIDDEC3_STUBSNAME "VIDDEC3_STUBS" |
Name of stub functions. Use this name when registering the VIDDEC3_STUBS functions with Engine_addStubFxns.
typedef VISA_Handle VIDDEC3_Handle |
Opaque handle to a VIDDEC3 codec.
typedef struct IVIDDEC3_Params VIDDEC3_Params |
Defines the creation time parameters for all IVIDDEC3 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 IVIDDEC3_InArgs VIDDEC3_InArgs |
Defines the input arguments for all IVIDDEC3 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 IVIDDEC3_OutArgs VIDDEC3_OutArgs |
Defines the run time output arguments for all IVIDDEC3 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 IVIDDEC3_Cmd VIDDEC3_Cmd |
Defines the control commands for the IVIDDEC3 module.
This structure defines the algorithm parameters that can be modified after creation via IVIDDEC3_Fxns.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 IVIDDEC3_Status VIDDEC3_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 struct IVIDDEC3_CodecClassConfig IVIDDEC3_CodecClassConfig |
Definition of IVIDDEC3 codec class configurable parameters.
Int32 VIDDEC3_control | ( | VIDDEC3_Handle | handle, |
VIDDEC3_Cmd | id, | ||
VIDDEC3_DynamicParams * | params, | ||
VIDDEC3_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.VIDDEC3_EOK | Success. |
VIDDEC3_EFAIL | Failure. |
VIDDEC3_EUNSUPPORTED | Unsupported request. |
status->extendedError
may indicate further details about the error. See XDM_ErrorBit for details.VIDDEC3_Handle VIDDEC3_create | ( | Engine_Handle | e, |
String | name, | ||
VIDDEC3_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 VIDDEC3_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. Void VIDDEC3_delete | ( | VIDDEC3_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.Int32 VIDDEC3_process | ( | VIDDEC3_Handle | handle, |
XDM2_BufDesc * | inBufs, | ||
XDM2_BufDesc * | outBufs, | ||
VIDDEC3_InArgs * | inArgs, | ||
VIDDEC3_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.VIDDEC3_EOK | Success. |
VIDDEC3_EFAIL | Failure. |
VIDDEC3_EUNSUPPORTED | Unsupported request. |
outArgs->extendedError
may indicate further details about the error. See XDM_ErrorBit for details.