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 |
#define | IMGENC_VISATYPE "ti.sdo.ce.image.IIMGENC" |
The VISA type. | |
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. |
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 IMGENC_EOK IIMGENC_EOK |
Success.
#define IMGENC_EFAIL IIMGENC_EFAIL |
General failure.
#define IMGENC_ERUNTIME IIMGENC_ERUNTIME |
General runtime failure.
#define IMGENC_ETIMEOUT VISA_ETIMEOUT |
Timeout occurred.
#define IMGENC_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
#define IMGENC_VISATYPE "ti.sdo.ce.image.IIMGENC" |
The VISA type.
typedef IIMGENC_Status IMGENC_Status |
Defines instance status parameters (read-only).
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 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 |
Defines the input arguments for all IIMGENC 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 IIMGENC_OutArgs IMGENC_OutArgs |
Defines the run time output arguments for all IIMGENC 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 IIMGENC_Cmd IMGENC_Cmd |
Defines the control commands for the IIMGENC 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 struct IIMGENC_CodecClassConfig IIMGENC_CodecClassConfig |
Definition of IIMGENC codec class configurable parameters.
IMGENC_Handle IMGENC_create | ( | Engine_Handle | e, |
String | name, | ||
IMGENC_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 IMGENC_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. 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.
[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.IMGENC_EOK | Success. |
IMGENC_EFAIL | Failure. |
IMGENC_ERUNTIME | Internal Runtime Error. |
outArgs->extendedError
may indicate further details about the error. See IMGENC_OutArgs::extendedError for details.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.
[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.IMGENC_EOK | Success. |
IMGENC_EFAIL | Failure. |
IMGENC_ERUNTIME | Internal Runtime Error. |
status->extendedError
may indicate further details about the error. See IMGENC_Status::extendedError for details.Void IMGENC_delete | ( | IMGENC_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.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.
[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.IMGENC_EOK | Success. |
IMGENC_EFAIL | Failure. |
IMGENC_ERUNTIME | Internal Runtime Error. |
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.
[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) |
handle
is a valid (non-NULL) image encoder handle and the image encoder is in the created state.IMGENC_EOK | Success. |
IMGENC_EFAIL | Failure. |
IMGENC_ERUNTIME | Internal Runtime Error. |
IMGENC_ETIMEOUT | Operation timed out. |