Data Structures |
struct | IIMGENC_CodecClassConfig |
| Definition of IIMGENC codec class configurable parameters. More...
|
Defines |
#define | IMGENC_EOK IIMGENC_EOK |
#define | IMGENC_EFAIL IIMGENC_EFAIL |
#define | IMGENC_ERUNTIME IIMGENC_ERUNTIME |
#define | IMGENC_ETIMEOUT VISA_ETIMEOUT |
#define | IMGENC_FOREVER VISA_FOREVER |
Typedefs |
typedef IIMGENC_Status | IMGENC_Status |
typedef VISA_Handle | IMGENC_Handle |
| Opaque handle to a IMGENC codec.
|
typedef struct IIMGENC_Params | IMGENC_Params |
| This structure defines the parameters necessary to create an instance of a image encoder object.
|
typedef IIMGENC_InArgs | IMGENC_InArgs |
typedef IIMGENC_OutArgs | IMGENC_OutArgs |
typedef IIMGENC_Cmd | IMGENC_Cmd |
typedef IIMGENC_DynamicParams | IMGENC_DynamicParams |
typedef struct
IIMGENC_CodecClassConfig | IIMGENC_CodecClassConfig |
| Definition of IIMGENC codec class configurable parameters.
|
Functions |
IMGENC_Handle | IMGENC_create (Engine_Handle e, String name, IMGENC_Params *params) |
| Create an instance of an image encoder algorithm.
|
Int32 | IMGENC_process (IMGENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IMGENC_InArgs *inArgs, IMGENC_OutArgs *outArgs) |
| Execute the process() method in this instance of an image encoder algorithm.
|
Int32 | IMGENC_control (IMGENC_Handle handle, IMGENC_Cmd id, IMGENC_DynamicParams *params, IMGENC_Status *status) |
| Execute the control() method in this instance of an image encoder algorithm.
|
Void | IMGENC_delete (IMGENC_Handle handle) |
| Delete the instance of an image encoder algorithm.
|
XDAS_Int32 | IMGENC_processAsync (IMGENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IIMGENC_InArgs *inArgs, IIMGENC_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of an image encoder algorithm.
|
XDAS_Int32 | IMGENC_processWait (IMGENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IIMGENC_InArgs *inArgs, IIMGENC_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of IMGENC_processAsync() in this instance of an image encoder algorithm.
|
Detailed Description
This is the IMGENC image encoder 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 IMGENC_EOK IIMGENC_EOK |
#define IMGENC_EFAIL IIMGENC_EFAIL |
#define IMGENC_ERUNTIME IIMGENC_ERUNTIME |
#define IMGENC_ETIMEOUT VISA_ETIMEOUT |
#define IMGENC_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a IMGENC codec.
This structure defines the parameters necessary to create an instance of a image encoder object.
This structure defines the algorithm parameters that can be modified after creation via control() calls.
- See also:
- IIMGENC_Fxns::control()
Function Documentation
Create an instance of an image encoder algorithm.
Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via IMGENC_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 encoder to create. |
[in] | params | Creation parameters. |
- Return values:
-
NULL | An error has occurred. |
non-NULL | The handle to the newly created image encoder instance. |
- See also:
- Engine_open()
-
IMGENC_delete()
Execute the process() method in this instance of an image encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created image encoder 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 encoder handle and the image encoder is in the created state.
- Return values:
-
- See also:
- IMGENC_create()
-
IMGENC_delete()
-
IMGENC_control()
-
IMGENC_processAsync()
-
IMGENC_processWait()
-
IIMGENC_Fxns::process() - the reflected algorithm interface, which may contain further usage details.
Execute the control() method in this instance of an image encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created image encoder instance. |
[in] | id | Command id for XDM control operation. |
[in] | params | Runtime control parameters used for encoding. |
[out] | status | Status info upon completion of encode operation. |
- Precondition:
handle
is a valid (non-NULL) image encoder handle and the image encoder is in the created state.
- Return values:
-
- See also:
- IMGENC_create()
-
IMGENC_delete()
-
IIMGENC_Fxns::control() - the reflected algorithm interface, which may contain further usage details.
Delete the instance of an image encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created image encoder instance. |
- Precondition:
handle
is a valid (non-NULL) handle which is in the created state.
- Postcondition:
- All resources allocated as part of the IMGENC_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- IMGENC_create()
Perform asynchronous submission to this instance of an image encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created image encoder 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 encoder handle and the image encoder is in the created state.
- Return values:
-
- See also:
- IMGENC_create()
-
IMGENC_delete()
-
IMGENC_control()
-
IMGENC_process()
-
IMGENC_processWait()
-
IIMGENC_Fxns::process() - the reflected algorithm interface, which may contain further usage details.
Wait for a return message from a previous invocation of IMGENC_processAsync() in this instance of an image encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created image encoder 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 -> IMGENC_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) image encoder handle and the image encoder is in the created state.
- Return values:
-
- See also:
- IMGENC_create()
-
IMGENC_delete()
-
IMGENC_control()
-
IMGENC_process()
-
IMGENC_processAsync()