Data Structures | |
struct | IUNIVERSAL_CodecClassConfig |
Definition of IUNIVERSAL codec class configurable parameters. More... | |
Defines | |
#define | UNIVERSAL_EOK IUNIVERSAL_EOK |
#define | UNIVERSAL_EFAIL IUNIVERSAL_EFAIL |
#define | UNIVERSAL_EUNSUPPORTED IUNIVERSAL_EUNSUPPORTED |
#define | UNIVERSAL_ETIMEOUT VISA_ETIMEOUT |
#define | UNIVERSAL_FOREVER VISA_FOREVER |
#define | UNIVERSAL_STUBSNAME "UNIVERSAL_STUBS" |
Name of stub functions. Use this name when registering the UNIVERSAL_STUBS functions with Engine_addStubFxns. | |
#define | UNIVERSAL_VISATYPE "ti.sdo.ce.universal.IUNIVERSAL" |
The VISA type. | |
Typedefs | |
typedef VISA_Handle | UNIVERSAL_Handle |
Opaque handle to a UNIVERSAL codec. | |
typedef struct IUNIVERSAL_Params | UNIVERSAL_Params |
This structure defines the parameters necessary to create an instance of a "universal" algorithm. | |
typedef IUNIVERSAL_InArgs | UNIVERSAL_InArgs |
typedef IUNIVERSAL_OutArgs | UNIVERSAL_OutArgs |
typedef IUNIVERSAL_Cmd | UNIVERSAL_Cmd |
typedef IUNIVERSAL_Status | UNIVERSAL_Status |
typedef IUNIVERSAL_DynamicParams | UNIVERSAL_DynamicParams |
typedef struct IUNIVERSAL_CodecClassConfig | IUNIVERSAL_CodecClassConfig |
Definition of IUNIVERSAL codec class configurable parameters. | |
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. |
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.
#define UNIVERSAL_EOK IUNIVERSAL_EOK |
Success.
#define UNIVERSAL_EFAIL IUNIVERSAL_EFAIL |
General failure.
#define UNIVERSAL_EUNSUPPORTED IUNIVERSAL_EUNSUPPORTED |
Request is unsupported.
Timeout occurred.
#define UNIVERSAL_ETIMEOUT VISA_ETIMEOUT |
Special value for timeout parameter indicating never timeout.
#define UNIVERSAL_FOREVER VISA_FOREVER |
#define UNIVERSAL_STUBSNAME "UNIVERSAL_STUBS" |
Name of stub functions. Use this name when registering the UNIVERSAL_STUBS functions with Engine_addStubFxns.
#define UNIVERSAL_VISATYPE "ti.sdo.ce.universal.IUNIVERSAL" |
The VISA type.
typedef VISA_Handle UNIVERSAL_Handle |
Opaque handle to a UNIVERSAL codec.
typedef struct IUNIVERSAL_Params UNIVERSAL_Params |
This structure defines the parameters necessary to create an instance of a "universal" algorithm.
typedef IUNIVERSAL_InArgs UNIVERSAL_InArgs |
Defines the input arguments for all IUNIVERSAL instance process function.
size
parameter. size
field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.typedef IUNIVERSAL_OutArgs UNIVERSAL_OutArgs |
Defines the run time output arguments for all IUNIVERSAL instance objects.
size
parameter. size
field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.typedef IUNIVERSAL_Cmd UNIVERSAL_Cmd |
Defines the control commands for the IUNIVERSAL module.
typedef IUNIVERSAL_Status UNIVERSAL_Status |
Defines instance status parameters (read-only).
size
parameter. size
field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.This structure defines the codec parameters that can be modified after creation via control() calls.
size
parameter. size
field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.typedef struct IUNIVERSAL_CodecClassConfig IUNIVERSAL_CodecClassConfig |
Definition of IUNIVERSAL codec class configurable parameters.
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.
[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. |
handle
is a valid (non-NULL) universal algorithm handle and the universal algorithm instance is in the created state.UNIVERSAL_EOK | Success. |
UNIVERSAL_EFAIL | Failure. |
UNIVERSAL_EUNSUPPORTED | Unsupported request. |
UNIVERSAL_Handle UNIVERSAL_create | ( | Engine_Handle | e, |
String | name, | ||
UNIVERSAL_Params * | params | ||
) |
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.
[in] | e | Handle to an opened engine. |
[in] | name | String identifier of the type of universal algorithm to create. |
[in] | params | Creation parameters. |
NULL | An error has occurred. |
non-NULL | The handle to the newly created universal algorithm 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 UNIVERSAL_delete | ( | UNIVERSAL_Handle | handle ) |
Delete the instance of a universal algorithm.
[in] | handle | Handle to a created universal algorithm instance. |
handle
is a valid (non-NULL) handle which is in the created state.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.
[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. |
handle
is a valid (non-NULL) universal algorithm handle and the universal algorithm instance is in the created state.UNIVERSAL_EOK | Success. |
UNIVERSAL_EFAIL | Failure. |
UNIVERSAL_EUNSUPPORTED | Unsupported request. |
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.
[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. |
handle
is a valid (non-NULL) universal algorithm handle and the universal algorithm instance is in the created state.UNIVERSAL_EOK | Success. |
UNIVERSAL_EFAIL | Failure. |
UNIVERSAL_EUNSUPPORTED | Unsupported request. |
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.
[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) |
handle
is a valid (non-NULL) universal algorithm handle and the universal algorithm instance is in the created state.UNIVERSAL_EOK | Success. |
UNIVERSAL_EFAIL | Failure. |
UNIVERSAL_EUNSUPPORTED | Unsupported request. |
UNIVERSAL_ETIMEOUT | Operation timed out. |