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 |
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.
|
Detailed Description
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 Documentation
#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 |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a IMGDEC codec.
This structure defines the parameters necessary to create an instance of a image decoder object.
This structure defines the codec parameters that can be modified after creation via control() calls.
- See also:
- IIMGDEC_Fxns::control()
Function Documentation
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.
- Parameters:
-
[in] | e | Handle to an opened engine. |
[in] | name | String identifier of the type of image decoder. to create. |
[in] | params | Creation parameters. |
- Return values:
-
NULL | An error has occurred. |
non-NULL | The handle to the newly created image decoder instance. |
- See also:
- Engine_open()
-
IMGDEC_delete()
Execute the process() method in this instance of a image decoder algorithm.
- Parameters:
-
[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. |
- Precondition:
handle
is a valid (non-NULL) image decoder handle and the image decoder is in the created state.
- Return values:
-
- See also:
- IMGDEC_create()
-
IMGDEC_delete()
-
IMGDEC_control()
-
IMGDEC_processAsync()
-
IMGDEC_processWait()
-
IIMGDEC_Fxns::process() - the reflected algorithm interface, which may contain further usage details.
Execute the control() method in this instance of an image decoder algorithm.
- Parameters:
-
[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. |
- Precondition:
handle
is a valid (non-NULL) image decoder handle and the image decoder is in the created state.
- Return values:
-
- See also:
- IMGDEC_create()
-
IMGDEC_delete()
-
IIMGDEC_Fxns::control()
Delete the instance of a image decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created image decoder instance. |
- Precondition:
handle
is a valid (non-NULL) handle which is in the created state.
- Postcondition:
- All resources allocated as part of the IMGDEC_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- IMGDEC_create()
Perform asynchronous submission to this instance of an image decoder algorithm.
- Parameters:
-
[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. |
- Precondition:
handle
is a valid (non-NULL) image decoder handle and the image decoder is in the created state.
- Return values:
-
- See also:
- IMGDEC_create()
-
IMGDEC_delete()
-
IMGDEC_control()
-
IMGDEC_process()
-
IMGDEC_processWait()
-
IIMGDEC_Fxns::process()
Wait for a return message from a previous invocation of IMGDEC_processAsync() in this instance of an image decoder algorithm.
- Parameters:
-
[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) |
- Precondition:
handle
is a valid (non-NULL) image decoder handle and the image decoder is in the created state.
- Return values:
-
- See also:
- IMGDEC_create()
-
IMGDEC_delete()
-
IMGDEC_control()
-
IMGDEC_process()
-
IMGDEC_processAsync()