Data Structures | |
struct | IIMGDEC_CodecClassConfig |
Definition of IIMGDEC codec class configurable parameters. More... | |
Defines | |
#define | IMGDEC_EOK IIMGDEC_EOK |
#define | IMGDEC_EFAIL IIMGDEC_EFAIL |
#define | IMGDEC_ERUNTIME IIMGDEC_ERUNTIME |
#define | IMGDEC_ETIMEOUT VISA_ETIMEOUT |
#define | IMGDEC_FOREVER VISA_FOREVER |
#define | IMGDEC_VISATYPE "ti.sdo.ce.image.IIMGDEC" |
The VISA type. | |
Typedefs | |
typedef IIMGDEC_Status | IMGDEC_Status |
typedef VISA_Handle | IMGDEC_Handle |
Opaque handle to a IMGDEC codec. | |
typedef struct IIMGDEC_Params | IMGDEC_Params |
This structure defines the parameters necessary to create an instance of a image decoder object. | |
typedef IIMGDEC_InArgs | IMGDEC_InArgs |
typedef IIMGDEC_OutArgs | IMGDEC_OutArgs |
typedef IIMGDEC_Cmd | IMGDEC_Cmd |
typedef IIMGDEC_DynamicParams | IMGDEC_DynamicParams |
typedef struct IIMGDEC_CodecClassConfig | IIMGDEC_CodecClassConfig |
Definition of IIMGDEC codec class configurable parameters. | |
Functions | |
IMGDEC_Handle | IMGDEC_create (Engine_Handle e, String name, IMGDEC_Params *params) |
Create an instance of an image decoder algorithm. | |
Int32 | IMGDEC_process (IMGDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IMGDEC_InArgs *inArgs, IMGDEC_OutArgs *outArgs) |
Execute the process() method in this instance of a image decoder algorithm. | |
Int32 | IMGDEC_control (IMGDEC_Handle handle, IMGDEC_Cmd id, IMGDEC_DynamicParams *params, IMGDEC_Status *status) |
Execute the control() method in this instance of an image decoder algorithm. | |
Void | IMGDEC_delete (IMGDEC_Handle handle) |
Delete the instance of a image decoder algorithm. | |
XDAS_Int32 | IMGDEC_processAsync (IMGDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IMGDEC_InArgs *inArgs, IMGDEC_OutArgs *outArgs) |
Perform asynchronous submission to this instance of an image decoder algorithm. | |
XDAS_Int32 | IMGDEC_processWait (IMGDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IMGDEC_InArgs *inArgs, IMGDEC_OutArgs *outArgs, UInt timeout) |
Wait for a return message from a previous invocation of IMGDEC_processAsync() in this instance of an image decoder algorithm. |
This is the IMGDEC image 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 IMGDEC_EOK IIMGDEC_EOK |
Success.
#define IMGDEC_EFAIL IIMGDEC_EFAIL |
General failure.
#define IMGDEC_ERUNTIME IIMGDEC_ERUNTIME |
General runtime failure.
#define IMGDEC_ETIMEOUT VISA_ETIMEOUT |
Timeout occurred.
#define IMGDEC_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
#define IMGDEC_VISATYPE "ti.sdo.ce.image.IIMGDEC" |
The VISA type.
typedef IIMGDEC_Status IMGDEC_Status |
Defines instance status parameters (read-only).
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 IMGDEC_Handle |
Opaque handle to a IMGDEC codec.
typedef struct IIMGDEC_Params IMGDEC_Params |
This structure defines the parameters necessary to create an instance of a image decoder object.
typedef IIMGDEC_InArgs IMGDEC_InArgs |
Defines the input arguments for all IIMGDEC 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 IIMGDEC_OutArgs IMGDEC_OutArgs |
Defines the run time output arguments for all IIMGDEC 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 IIMGDEC_Cmd IMGDEC_Cmd |
Defines the control commands for the IIMGDEC 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 IIMGDEC_CodecClassConfig IIMGDEC_CodecClassConfig |
Definition of IIMGDEC codec class configurable parameters.
IMGDEC_Handle IMGDEC_create | ( | Engine_Handle | e, |
String | name, | ||
IMGDEC_Params * | params | ||
) |
Create an instance of an image decoder algorithm.
Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via IMGDEC_create()) or explicitly serialize access to a shared handle.
[in] | e | Handle to an opened engine. |
[in] | name | String identifier of the type of image decoder. to create. |
[in] | params | Creation parameters. |
NULL | An error has occurred. |
non-NULL | The handle to the newly created image 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 IMGDEC_process | ( | IMGDEC_Handle | handle, |
XDM_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
IMGDEC_InArgs * | inArgs, | ||
IMGDEC_OutArgs * | outArgs | ||
) |
Execute the process() method in this instance of a image decoder algorithm.
[in] | handle | Handle to a created image 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) image decoder handle and the image decoder is in the created state.IMGDEC_EOK | Success. |
IMGDEC_EFAIL | Failure. |
IMGDEC_ERUNTIME | Internal Runtime Error. |
outArgs->extendedError
may indicate further details about the error. See IMGDEC_OutArgs::extendedError for details.Int32 IMGDEC_control | ( | IMGDEC_Handle | handle, |
IMGDEC_Cmd | id, | ||
IMGDEC_DynamicParams * | params, | ||
IMGDEC_Status * | status | ||
) |
Execute the control() method in this instance of an image decoder algorithm.
[in] | handle | Handle to a created image 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) image decoder handle and the image decoder is in the created state.IMGDEC_EOK | Success. |
IMGDEC_EFAIL | Failure. |
IMGDEC_ERUNTIME | Internal Runtime Error. |
status->extendedError
may indicate further details about the error. See IMGDEC_Status::extendedError for details.Void IMGDEC_delete | ( | IMGDEC_Handle | handle ) |
Delete the instance of a image decoder algorithm.
[in] | handle | Handle to a created image decoder instance. |
handle
is a valid (non-NULL) handle which is in the created state.XDAS_Int32 IMGDEC_processAsync | ( | IMGDEC_Handle | handle, |
XDM_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
IMGDEC_InArgs * | inArgs, | ||
IMGDEC_OutArgs * | outArgs | ||
) |
Perform asynchronous submission to this instance of an image decoder algorithm.
[in] | handle | Handle to a created image 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) image decoder handle and the image decoder is in the created state.IMGDEC_EOK | Success. |
IMGDEC_EFAIL | Failure. |
IMGDEC_ERUNTIME | Internal Runtime Error. |
XDAS_Int32 IMGDEC_processWait | ( | IMGDEC_Handle | handle, |
XDM_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
IMGDEC_InArgs * | inArgs, | ||
IMGDEC_OutArgs * | outArgs, | ||
UInt | timeout | ||
) |
Wait for a return message from a previous invocation of IMGDEC_processAsync() in this instance of an image decoder algorithm.
[in] | handle | Handle to a created image 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 -> IMGDEC_FOREVER) |
handle
is a valid (non-NULL) image decoder handle and the image decoder is in the created state.IMGDEC_EOK | Success. |
IMGDEC_EFAIL | Failure. |
IMGDEC_ERUNTIME | Internal Runtime Error. |
IMGDEC_ETIMEOUT | Operation timed out. |