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.
Macro Definition Documentation
Special value for timeout parameter indicating never timeout.
#define IMGENC_VISATYPE "ti.sdo.ce.image.IIMGENC" |
#define IMGENC_STUBSNAME "IMGENC_STUBS" |
Name of stub functions. Use this name when registering the IMGENC_STUBS functions with Engine_addStubFxns.
- See also:
- Engine_addStubFxns
Typedef Documentation
Defines instance status parameters (read-only).
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Opaque handle to a IMGENC codec.
This structure defines the parameters necessary to create an instance of a image encoder object.
Defines the input arguments for all IIMGENC instance process() function.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines the run time output arguments for all IIMGENC instance objects.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
This structure defines the algorithm parameters that can be modified after creation via control() calls.
@remarks It is not necessary that given implementation support all
dynamic parameters to be configurable at run time. If a
particular algorithm does not support run-time updates to
a parameter that the application is attempting to change
at runtime, it may indicate this as an error.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
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.
@param[in] e Handle to an opened engine.
@param[in] name String identifier of the type of image encoder
to create.
@param[in] params Creation parameters.
@retval NULL An error has occurred.
@retval non-NULL The handle to the newly created image encoder
instance.
@remarks @c params is optional. If it's not supplied, codec-specific
default params will be used.
@remark Depending on the configuration of the engine opened, this
call may create a local or remote instance of the image
encoder.
@remarks In general, @c 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 <b>":priority"</b>, <b>":priority:flag"</b>, or <b>"::flag"</b>.
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()