Functions |
Int32 | UNIVERSAL_control (UNIVERSAL_Handle handle, UNIVERSAL_Cmd id, UNIVERSAL_DynamicParams *params, UNIVERSAL_Status *status) |
| Execute the control() method in this instance of a "universal" algorithm.
|
UNIVERSAL_Handle | UNIVERSAL_create (Engine_Handle e, String name, UNIVERSAL_Params *params) |
| Create an instance of a universal algorithm.
|
Void | UNIVERSAL_delete (UNIVERSAL_Handle handle) |
| Delete the instance of a universal algorithm.
|
Int32 | UNIVERSAL_process (UNIVERSAL_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, XDM1_BufDesc *inOutBufs, UNIVERSAL_InArgs *inArgs, UNIVERSAL_OutArgs *outArgs) |
| Execute the process() method in this instance of a universal algorithm.
|
XDAS_Int32 | UNIVERSAL_processAsync (UNIVERSAL_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, XDM1_BufDesc *inOutBufs, IUNIVERSAL_InArgs *inArgs, IUNIVERSAL_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a universal algorithm.
|
XDAS_Int32 | UNIVERSAL_processWait (UNIVERSAL_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, XDM1_BufDesc *inOutBufs, IUNIVERSAL_InArgs *inArgs, IUNIVERSAL_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of UNIVERSAL_processAsync() in this instance of a universal algorithm.
|
Detailed Description
This is the "universal" algorithm interface. Several of the data types in this API are specified by the XDM IUNIVERSAL interface; please see the XDM documentation for those details.
Macro Definition Documentation
Request is unsupported. Timeout occurred.
Special value for timeout parameter indicating never timeout.
#define UNIVERSAL_STUBSNAME "UNIVERSAL_STUBS" |
Name of stub functions. Use this name when registering the UNIVERSAL_STUBS functions with Engine_addStubFxns.
- See also:
- Engine_addStubFxns
#define UNIVERSAL_VISATYPE "ti.sdo.ce.universal.IUNIVERSAL" |
Typedef Documentation
Opaque handle to a UNIVERSAL codec.
This structure defines the parameters necessary to create an instance of a "universal" algorithm.
Defines the input arguments for all IUNIVERSAL 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 IUNIVERSAL 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.
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.
This structure defines the codec parameters that can be modified after creation via control() calls.
@remarks It is not necessary that a 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
Execute the control() method in this instance of a "universal" algorithm.
- Parameters:
-
[in] | handle | Handle to a created universal algorithm instance. |
[in] | id | Command id for XDM control operation. |
[in] | params | Runtime control parameters used for the universal algorithm instance. |
[out] | status | Status info returned by the algorithm instance. |
- Precondition:
handle
is a valid (non-NULL) universal algorithm handle and the universal algorithm instance is in the created state.
- Return values:
-
- See also:
- UNIVERSAL_create()
-
UNIVERSAL_delete()
-
IUNIVERSAL_Fxns::control()
Create an instance of a universal algorithm.
Instance handles must not be concurrently accessed by multiple threads;
each thread must either obtain its own handle (via UNIVERSAL_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 universal
algorithm to create.
@param[in] params Creation parameters.
@retval NULL An error has occurred.
@retval non-NULL The handle to the newly created universal
algorithm 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 universal
algorithm.
@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>.
Delete the instance of a universal algorithm.
- Parameters:
-
[in] | handle | Handle to a created universal algorithm instance. |
- Precondition:
handle
is a valid (non-NULL) handle which is in the created state.
- Postcondition:
- All resources allocated as part of the UNIVERSAL_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- UNIVERSAL_create()
Execute the process() method in this instance of a universal algorithm.
- Parameters:
-
[in] | handle | Handle to a created universal algorithm instance. |
[in] | inBufs | A buffer descriptor containing input buffers. |
[out] | outBufs | A buffer descriptor containing output buffers. |
[in,out] | inOutBufs | A buffer descriptor containing in/out buffers. |
[in] | inArgs | Input Arguments. |
[out] | outArgs | Output Arguments. |
- Precondition:
handle
is a valid (non-NULL) universal algorithm handle and the universal algorithm instance is in the created state.
- Return values:
-
- See also:
- UNIVERSAL_create()
-
UNIVERSAL_delete()
-
UNIVERSAL_control()
-
UNIVERSAL_processAsync()
-
UNIVERSAL_processWait()
-
IUNIVERSAL_Fxns::process()
Perform asynchronous submission to this instance of a universal algorithm.
- Parameters:
-
[in] | handle | Handle to a created universal algorithm instance. |
[in] | inBufs | A buffer descriptor containing input buffers. |
[out] | outBufs | A buffer descriptor containing output buffers. |
[in,out] | inOutBufs | A buffer descriptor containing in/out buffers. |
[in] | inArgs | Input Arguments. |
[out] | outArgs | Output Arguments. |
- Precondition:
handle
is a valid (non-NULL) universal algorithm handle and the universal algorithm instance is in the created state.
- Return values:
-
- See also:
- UNIVERSAL_create()
-
UNIVERSAL_delete()
-
UNIVERSAL_control()
-
UNIVERSAL_process()
-
UNIVERSAL_processWait()
-
IUNIVERSAL_Fxns::process()
Wait for a return message from a previous invocation of UNIVERSAL_processAsync() in this instance of a universal algorithm.
- Parameters:
-
[in] | handle | Handle to a created universal algorithm instance. |
[in] | inBufs | A buffer descriptor containing input buffers. |
[out] | outBufs | A buffer descriptor containing output buffers. |
[in,out] | inOutBufs | A buffer descriptor containing in/out buffers. |
[in] | inArgs | Input Arguments. |
[out] | outArgs | Output Arguments. |
[in] | timeout | Amount of "time" to wait (from 0 -> UNIVERSAL_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) universal algorithm handle and the universal algorithm instance is in the created state.
- Return values:
-
- See also:
- UNIVERSAL_create()
-
UNIVERSAL_delete()
-
UNIVERSAL_control()
-
UNIVERSAL_process()
-
UNIVERSAL_processAsync()