Data Structures | |
struct | IIMGENC1_CodecClassConfig |
Definition of IIMGENC1 codec class configurable parameters. More... | |
Defines | |
#define | IMGENC1_EOK IIMGENC1_EOK |
#define | IMGENC1_EFAIL IIMGENC1_EFAIL |
#define | IMGENC1_EUNSUPPORTED IIMGENC1_EUNSUPPORTED |
#define | IMGENC1_ETIMEOUT VISA_ETIMEOUT |
#define | IMGENC1_FOREVER VISA_FOREVER |
#define | IMGENC1_VISATYPE "ti.sdo.ce.image1.IIMGENC1" |
The VISA type. | |
Typedefs | |
typedef VISA_Handle | IMGENC1_Handle |
Opaque handle to a IMGENC1 codec. | |
typedef struct IIMGENC1_Params | IMGENC1_Params |
typedef IIMGENC1_InArgs | IMGENC1_InArgs |
typedef IIMGENC1_OutArgs | IMGENC1_OutArgs |
typedef IIMGENC1_Cmd | IMGENC1_Cmd |
typedef IIMGENC1_DynamicParams | IMGENC1_DynamicParams |
typedef IIMGENC1_Status | IMGENC1_Status |
typedef struct IIMGENC1_CodecClassConfig | IIMGENC1_CodecClassConfig |
Definition of IIMGENC1 codec class configurable parameters. | |
Functions | |
Int32 | IMGENC1_control (IMGENC1_Handle handle, IMGENC1_Cmd id, IMGENC1_DynamicParams *params, IMGENC1_Status *status) |
Execute the control() method in this instance of an image encoder algorithm. | |
IMGENC1_Handle | IMGENC1_create (Engine_Handle e, String name, IMGENC1_Params *params) |
Create an instance of an image encoder algorithm. | |
Void | IMGENC1_delete (IMGENC1_Handle handle) |
Delete the instance of an image encoder algorithm. | |
Int32 | IMGENC1_process (IMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IMGENC1_InArgs *inArgs, IMGENC1_OutArgs *outArgs) |
Execute the process() method in this instance of an image encoder algorithm. | |
XDAS_Int32 | IMGENC1_processAsync (IMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IIMGENC1_InArgs *inArgs, IIMGENC1_OutArgs *outArgs) |
Perform asynchronous submission to this instance of an image encoder algorithm. | |
XDAS_Int32 | IMGENC1_processWait (IMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IIMGENC1_InArgs *inArgs, IIMGENC1_OutArgs *outArgs, UInt timeout) |
Wait for a return message from a previous invocation of IMGENC1_processAsync() in this instance of an image encoder algorithm. |
This is the IMGENC1 image encoder interface. Several of the data types in this API are specified by the XDM IIMGENC1 interface; please see the XDM documentation for those details.
#define IMGENC1_EOK IIMGENC1_EOK |
Success.
#define IMGENC1_EFAIL IIMGENC1_EFAIL |
General failure.
#define IMGENC1_EUNSUPPORTED IIMGENC1_EUNSUPPORTED |
Request is unsupported.
#define IMGENC1_ETIMEOUT VISA_ETIMEOUT |
Timeout occurred.
#define IMGENC1_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
#define IMGENC1_VISATYPE "ti.sdo.ce.image1.IIMGENC1" |
The VISA type.
typedef VISA_Handle IMGENC1_Handle |
Opaque handle to a IMGENC1 codec.
typedef struct IIMGENC1_Params IMGENC1_Params |
Defines the creation time parameters for all IIMGENC1 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 IIMGENC1_InArgs IMGENC1_InArgs |
Defines the input arguments for all IIMGENC1 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 IIMGENC1_OutArgs IMGENC1_OutArgs |
Defines the run time output arguments for all IIMGENC1 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 IIMGENC1_Cmd IMGENC1_Cmd |
Defines the control commands for the IIMGENC1 module.
This structure defines the algorithm 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 IIMGENC1_Status IMGENC1_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 IIMGENC1_CodecClassConfig IIMGENC1_CodecClassConfig |
Definition of IIMGENC1 codec class configurable parameters.
Int32 IMGENC1_control | ( | IMGENC1_Handle | handle, |
IMGENC1_Cmd | id, | ||
IMGENC1_DynamicParams * | params, | ||
IMGENC1_Status * | status | ||
) |
Execute the control() method in this instance of an image encoder algorithm.
[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. |
handle
is a valid (non-NULL) image encoder handle and the image encoder is in the created state.IMGENC1_EOK | Success. |
IMGENC1_EFAIL | Failure. |
IMGENC1_EUNSUPPORTED | Unsupported request. |
IMGENC1_Handle IMGENC1_create | ( | Engine_Handle | e, |
String | name, | ||
IMGENC1_Params * | params | ||
) |
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 IMGENC1_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 encoder to create. |
[in] | params | Creation parameters. |
NULL | An error has occurred. |
non-NULL | The handle to the newly created image encoder 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 IMGENC1_delete | ( | IMGENC1_Handle | handle ) |
Delete the instance of an image encoder algorithm.
[in] | handle | Handle to a created image encoder instance. |
handle
is a valid (non-NULL) handle which is in the created state.Int32 IMGENC1_process | ( | IMGENC1_Handle | handle, |
XDM1_BufDesc * | inBufs, | ||
XDM1_BufDesc * | outBufs, | ||
IMGENC1_InArgs * | inArgs, | ||
IMGENC1_OutArgs * | outArgs | ||
) |
Execute the process() method in this instance of an image encoder algorithm.
[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. |
handle
is a valid (non-NULL) image encoder handle and the image encoder is in the created state.IMGENC1_EOK | Success. |
IMGENC1_EFAIL | Failure. |
IMGENC1_EUNSUPPORTED | Unsupported request. |
XDAS_Int32 IMGENC1_processAsync | ( | IMGENC1_Handle | handle, |
XDM1_BufDesc * | inBufs, | ||
XDM1_BufDesc * | outBufs, | ||
IIMGENC1_InArgs * | inArgs, | ||
IIMGENC1_OutArgs * | outArgs | ||
) |
Perform asynchronous submission to this instance of an image encoder algorithm.
[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. |
handle
is a valid (non-NULL) image encoder handle and the image encoder is in the created state.IMGENC1_EOK | Success. |
IMGENC1_EFAIL | Failure. |
IMGENC1_EUNSUPPORTED | Unsupported request. |
XDAS_Int32 IMGENC1_processWait | ( | IMGENC1_Handle | handle, |
XDM1_BufDesc * | inBufs, | ||
XDM1_BufDesc * | outBufs, | ||
IIMGENC1_InArgs * | inArgs, | ||
IIMGENC1_OutArgs * | outArgs, | ||
UInt | timeout | ||
) |
Wait for a return message from a previous invocation of IMGENC1_processAsync() in this instance of an image encoder algorithm.
[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 -> IMGENC1_FOREVER) |
handle
is a valid (non-NULL) image encoder handle and the image encoder is in the created state.IMGENC1_EOK | Success. |
IMGENC1_EFAIL | Failure. |
IMGENC1_EUNSUPPORTED | Unsupported request. |
IMGENC1_ETIMEOUT | Operation timed out. |