Image decoder codec interface
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 |
Typedefs |
typedef VISA_Handle | IMGDEC1_Handle |
| Opaque handle to a IMGDEC1 codec.
|
typedef 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 |
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 a 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.
|
Detailed Description
This is the IMGDEC1 image decoder codec 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 Documentation
#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 |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a IMGDEC1 codec.
Defines the creation time parameters for all IIMGDEC1 instance objects.
This structure defines the codec parameters that can be modified after creation via control() calls.
- See also:
- IIMGDEC1_Fxns::control()
Function Documentation
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:
- IMGDEC1_create()
-
IMGDEC1_delete()
-
IIMGDEC1_Fxns()control()
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.
- 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()
-
IMGDEC1_delete()
Delete the instance of an 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 IMGDEC1_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- IMGDEC1_create()
Execute the process() method 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. |
- Precondition:
handle
is a valid (non-NULL) image decoder handle and the image decoder is in the created state.
- Return values:
-
- See also:
- IMGDEC1_create()
-
IMGDEC1_delete()
-
IMGDEC1_control()
-
IMGDEC1_processAsync()
-
IMGDEC1_processWait()
-
IIMGDEC1_Fxns()process()
Perform asynchronous submission to 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:
- IMGDEC1_create()
-
IMGDEC1_delete()
-
IMGDEC1_control()
-
IMGDEC1_process()
-
IMGDEC1_processWait()
-
IIMGDEC1_Fxns::process()
Wait for a return message from a previous invocation of IMGDEC1_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 -> IMGDEC1_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) image decoder handle and the image decoder is in the created state.
- Return values:
-
- See also:
- IMGDEC1_create()
-
IMGDEC1_delete()
-
IMGDEC1_control()
-
IMGDEC1_process()
-
IMGDEC1_processAsync()