Data Structures | |
struct | IIMGDEC1_CodecClassConfig |
Definition of IIMGDEC1 codec class configurable parameters. More... | |
Defines | |
#define | IMGDEC1_EOK IIMGDEC1_EOK |
#define | IMGDEC1_EFAIL IIMGDEC1_EFAIL |
#define | IMGDEC1_EUNSUPPORTED IIMGDEC1_EUNSUPPORTED |
#define | IMGDEC1_ETIMEOUT VISA_ETIMEOUT |
#define | IMGDEC1_FOREVER VISA_FOREVER |
#define | IMGDEC1_VISATYPE "ti.sdo.ce.image1.IIMGDEC1" |
The VISA type. | |
Typedefs | |
typedef VISA_Handle | IMGDEC1_Handle |
Opaque handle to a IMGDEC1 codec. | |
typedef struct IIMGDEC1_Params | IMGDEC1_Params |
typedef IIMGDEC1_InArgs | IMGDEC1_InArgs |
typedef IIMGDEC1_OutArgs | IMGDEC1_OutArgs |
typedef IIMGDEC1_Cmd | IMGDEC1_Cmd |
typedef IIMGDEC1_DynamicParams | IMGDEC1_DynamicParams |
typedef IIMGDEC1_Status | IMGDEC1_Status |
typedef struct IIMGDEC1_CodecClassConfig | IIMGDEC1_CodecClassConfig |
Definition of IIMGDEC1 codec class configurable parameters. | |
Functions | |
Int32 | IMGDEC1_control (IMGDEC1_Handle handle, IMGDEC1_Cmd id, IMGDEC1_DynamicParams *params, IMGDEC1_Status *status) |
Execute the control() method in this instance of an image decoder algorithm. | |
IMGDEC1_Handle | IMGDEC1_create (Engine_Handle e, String name, IMGDEC1_Params *params) |
Create an instance of an image decoder algorithm. | |
Void | IMGDEC1_delete (IMGDEC1_Handle handle) |
Delete the instance of an image decoder algorithm. | |
Int32 | IMGDEC1_process (IMGDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IMGDEC1_InArgs *inArgs, IMGDEC1_OutArgs *outArgs) |
Execute the process() method in this instance of an image decoder algorithm. | |
XDAS_Int32 | IMGDEC1_processAsync (IMGDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IMGDEC1_InArgs *inArgs, IMGDEC1_OutArgs *outArgs) |
Perform asynchronous submission to this instance of an image decoder algorithm. | |
XDAS_Int32 | IMGDEC1_processWait (IMGDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IMGDEC1_InArgs *inArgs, IMGDEC1_OutArgs *outArgs, UInt timeout) |
Wait for a return message from a previous invocation of IMGDEC1_processAsync() in this instance of an image decoder algorithm. |
This is the IMGDEC1 image decoder interface. Several of the data types in this API are specified by the XDM IIMGDEC1 interface; please see the XDM documentation for those details.
#define IMGDEC1_EOK IIMGDEC1_EOK |
Success.
#define IMGDEC1_EFAIL IIMGDEC1_EFAIL |
General failure.
#define IMGDEC1_EUNSUPPORTED IIMGDEC1_EUNSUPPORTED |
Request is unsupported.
#define IMGDEC1_ETIMEOUT VISA_ETIMEOUT |
Timeout occurred.
#define IMGDEC1_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
#define IMGDEC1_VISATYPE "ti.sdo.ce.image1.IIMGDEC1" |
The VISA type.
typedef VISA_Handle IMGDEC1_Handle |
Opaque handle to a IMGDEC1 codec.
typedef struct IIMGDEC1_Params IMGDEC1_Params |
Defines the creation time parameters for all IIMGDEC1 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 IIMGDEC1_InArgs IMGDEC1_InArgs |
Defines the input arguments for all IIMGDEC1 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 IIMGDEC1_OutArgs IMGDEC1_OutArgs |
Defines the run time output arguments for all IIMGDEC1 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 IIMGDEC1_Cmd IMGDEC1_Cmd |
Defines the control commands for the IIMGDEC1 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 IIMGDEC1_Status IMGDEC1_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 struct IIMGDEC1_CodecClassConfig IIMGDEC1_CodecClassConfig |
Definition of IIMGDEC1 codec class configurable parameters.
Int32 IMGDEC1_control | ( | IMGDEC1_Handle | handle, |
IMGDEC1_Cmd | id, | ||
IMGDEC1_DynamicParams * | params, | ||
IMGDEC1_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.IMGDEC1_EOK | Success. |
IMGDEC1_EFAIL | Failure. |
IMGDEC1_EUNSUPPORTED | Unsupported request. |
IMGDEC1_Handle IMGDEC1_create | ( | Engine_Handle | e, |
String | name, | ||
IMGDEC1_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 IMGDEC1_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. Void IMGDEC1_delete | ( | IMGDEC1_Handle | handle ) |
Delete the instance of an 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.Int32 IMGDEC1_process | ( | IMGDEC1_Handle | handle, |
XDM1_BufDesc * | inBufs, | ||
XDM1_BufDesc * | outBufs, | ||
IMGDEC1_InArgs * | inArgs, | ||
IMGDEC1_OutArgs * | outArgs | ||
) |
Execute the process() method 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. |
handle
is a valid (non-NULL) image decoder handle and the image decoder is in the created state.IMGDEC1_EOK | Success. |
IMGDEC1_EFAIL | Failure. |
IMGDEC1_EUNSUPPORTED | Unsupported request. |
XDAS_Int32 IMGDEC1_processAsync | ( | IMGDEC1_Handle | handle, |
XDM1_BufDesc * | inBufs, | ||
XDM1_BufDesc * | outBufs, | ||
IMGDEC1_InArgs * | inArgs, | ||
IMGDEC1_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.IMGDEC1_EOK | Success. |
IMGDEC1_EFAIL | Failure. |
IMGDEC1_EUNSUPPORTED | Unsupported request. |
XDAS_Int32 IMGDEC1_processWait | ( | IMGDEC1_Handle | handle, |
XDM1_BufDesc * | inBufs, | ||
XDM1_BufDesc * | outBufs, | ||
IMGDEC1_InArgs * | inArgs, | ||
IMGDEC1_OutArgs * | outArgs, | ||
UInt | timeout | ||
) |
Wait for a return message from a previous invocation of IMGDEC1_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 -> IMGDEC1_FOREVER) |
handle
is a valid (non-NULL) image decoder handle and the image decoder is in the created state.IMGDEC1_EOK | Success. |
IMGDEC1_EFAIL | Failure. |
IMGDEC1_EUNSUPPORTED | Unsupported request. |
IMGDEC1_ETIMEOUT | Operation timed out. |