Defines |
#define | SPHDEC_EOK ISPHDEC_EOK |
#define | SPHDEC_EFAIL ISPHDEC_EFAIL |
#define | SPHDEC_ERUNTIME ISPHDEC_ERUNTIME |
#define | SPHDEC_ETIMEOUT VISA_ETIMEOUT |
#define | SPHDEC_FOREVER VISA_FOREVER |
#define | SPHDEC_VISATYPE "ti.sdo.ce.speech.ISPHDEC" |
| The VISA type.
|
Typedefs |
typedef ISPHDEC_Status | SPHDEC_Status |
typedef VISA_Handle | SPHDEC_Handle |
| Opaque handle to a SPHDEC codec.
|
typedef struct ISPHDEC_Params | SPHDEC_Params |
| This structure defines the parameters necessary to create an instance of a speech decoder object.
|
typedef ISPHDEC_InArgs | SPHDEC_InArgs |
typedef ISPHDEC_OutArgs | SPHDEC_OutArgs |
typedef ISPHDEC_Cmd | SPHDEC_Cmd |
typedef ISPHDEC_DynamicParams | SPHDEC_DynamicParams |
Functions |
SPHDEC_Handle | SPHDEC_create (Engine_Handle e, String name, SPHDEC_Params *params) |
| Create an instance of a speech decoder algorithm.
|
Int32 | SPHDEC_process (SPHDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, SPHDEC_InArgs *inArgs, SPHDEC_OutArgs *outArgs) |
| Execute the process() method in this instance of a speech decoder algorithm.
|
Int32 | SPHDEC_control (SPHDEC_Handle handle, SPHDEC_Cmd id, SPHDEC_DynamicParams *params, SPHDEC_Status *status) |
| Execute the control method in this instance of a speech decoder algorithm.
|
Void | SPHDEC_delete (SPHDEC_Handle handle) |
| Delete the instance of a speech/voice decoder algorithm.
|
XDAS_Int32 | SPHDEC_processAsync (SPHDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, SPHDEC_InArgs *inArgs, SPHDEC_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a speech decoder algorithm.
|
XDAS_Int32 | SPHDEC_processWait (SPHDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, SPHDEC_InArgs *inArgs, SPHDEC_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of SPHDEC_processAsync() in this instance of an speech decoder algorithm.
|
Detailed Description
This is the SPHDEC speech decoder interface. Several of the data types in this API are specified by the XDM interface; please see the XDM documentation for those details.
Define Documentation
#define SPHDEC_EOK ISPHDEC_EOK |
#define SPHDEC_EFAIL ISPHDEC_EFAIL |
#define SPHDEC_ERUNTIME ISPHDEC_ERUNTIME |
#define SPHDEC_ETIMEOUT VISA_ETIMEOUT |
#define SPHDEC_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
#define SPHDEC_VISATYPE "ti.sdo.ce.speech.ISPHDEC" |
Typedef Documentation
Opaque handle to a SPHDEC codec.
This structure defines the parameters necessary to create an instance of a speech decoder object.
This structure defines the codec parameters that can be modified after creation via control() calls.
- See also:
- ISPHDEC_Fxns::control()
Function Documentation
Create an instance of a speech decoder algorithm.
Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via SPHDEC_create()) or explicitly serialize access to a shared handle.
- Parameters:
-
[in] | e | Handle to an opened engine. |
[in] | name | String identifier of the type of speech decoder to create. |
[in] | params | Creation parameters. |
- Return values:
-
NULL | An error has occurred. |
non-NULL | The handle to the newly created speech decoder instance. |
- See also:
- Engine_open()
-
SPHDEC_delete()
Execute the process() method in this instance of a speech decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech decoder 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) speech decoder handle and the speech decoder is in the created state.
- Return values:
-
- See also:
- SPHDEC_create()
-
SPHDEC_delete()
-
SPHDEC_control()
-
SPHDEC_processAsync()
-
SPHDEC_processWait()
-
ISPHDEC_Fxns::process()
Execute the control method in this instance of a speech decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech decoder instance. |
[in] | id | Command id for XDM control operation. |
[in] | params | Runtime control parameters used for decoding. |
[out] | status | Status info upon completion of decode operation. |
- Precondition:
handle
is a valid (non-NULL) speech decoder handle and the speech decoder is in the created state.
- Return values:
-
- See also:
- SPHDEC_create()
-
SPHDEC_delete()
-
ISPHDEC_Fxns::control()
Delete the instance of a speech/voice decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech decoder instance. |
- Precondition:
handle
is a valid (non-NULL) handle which is in the created state.
- Postcondition:
- All resources allocated as part of the SPHDEC_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- SPHDEC_create()
Perform asynchronous submission to this instance of a speech decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech decoder 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) speech decoder handle and the speech decoder is in the created state.
- Return values:
-
- See also:
- SPHDEC_create()
-
SPHDEC_delete()
-
SPHDEC_control()
-
SPHDEC_process()
-
SPHDEC_processWait()
-
ISPHDEC_Fxns::process()
Wait for a return message from a previous invocation of SPHDEC_processAsync() in this instance of an speech decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech decoder 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 -> SPHDEC_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) speech decoder handle and the speech decoder is in the created state.
- Return values:
-
- See also:
- SPHDEC_create()
-
SPHDEC_delete()
-
SPHDEC_control()
-
SPHDEC_process()
-
SPHDEC_processAsync()