Speech decoder codec interface
Defines |
#define | SPHDEC1_EOK ISPHDEC1_EOK |
#define | SPHDEC1_EFAIL ISPHDEC1_EFAIL |
#define | SPHDEC1_EUNSUPPORTED ISPHDEC1_EUNSUPPORTED |
#define | SPHDEC1_ETIMEOUT VISA_ETIMEOUT |
#define | SPHDEC1_FOREVER VISA_FOREVER |
Typedefs |
typedef VISA_Handle | SPHDEC1_Handle |
| Opaque handle to a SPHDEC1 codec.
|
typedef ISPHDEC1_Params | SPHDEC1_Params |
typedef ISPHDEC1_InArgs | SPHDEC1_InArgs |
typedef ISPHDEC1_OutArgs | SPHDEC1_OutArgs |
typedef ISPHDEC1_Cmd | SPHDEC1_Cmd |
typedef ISPHDEC1_DynamicParams | SPHDEC1_DynamicParams |
typedef ISPHDEC1_Status | SPHDEC1_Status |
Functions |
Int32 | SPHDEC1_control (SPHDEC1_Handle handle, SPHDEC1_Cmd id, SPHDEC1_DynamicParams *params, SPHDEC1_Status *status) |
| Execute the control() method in this instance of a speech decoder algorithm.
|
SPHDEC1_Handle | SPHDEC1_create (Engine_Handle e, String name, SPHDEC1_Params *params) |
| Create an instance of a speech decoder algorithm.
|
Void | SPHDEC1_delete (SPHDEC1_Handle handle) |
| Delete the instance of a speech decoder algorithm.
|
Int32 | SPHDEC1_process (SPHDEC1_Handle handle, XDM1_SingleBufDesc *inBuf, XDM1_SingleBufDesc *outBuf, SPHDEC1_InArgs *inArgs, SPHDEC1_OutArgs *outArgs) |
| Execute the process() method in this instance of a speech decoder algorithm.
|
XDAS_Int32 | SPHDEC1_processAsync (SPHDEC1_Handle handle, XDM1_SingleBufDesc *inBuf, XDM1_SingleBufDesc *outBuf, SPHDEC1_InArgs *inArgs, SPHDEC1_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a speech decoder algorithm.
|
XDAS_Int32 | SPHDEC1_processWait (SPHDEC1_Handle handle, XDM1_SingleBufDesc *inBuf, XDM1_SingleBufDesc *outBuf, SPHDEC1_InArgs *inArgs, SPHDEC1_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of SPHDEC1_processAsync() in this instance of an speech decoder algorithm.
|
Detailed Description
This is the SPHDEC1 speech decoder codec 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 SPHDEC1_EOK ISPHDEC1_EOK |
#define SPHDEC1_EFAIL ISPHDEC1_EFAIL |
#define SPHDEC1_EUNSUPPORTED ISPHDEC1_EUNSUPPORTED |
#define SPHDEC1_ETIMEOUT VISA_ETIMEOUT |
#define SPHDEC1_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a SPHDEC1 codec.
Defines the creation time parameters for all ISPHDEC1 instance objects.
Defines the input arguments for all ISPHDEC1 instance process function.
Function Documentation
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:
- SPHDEC1_create()
-
SPHDEC1_delete()
-
ISPHDEC1_Fxns()control()
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 SPHDEC1_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()
-
SPHDEC1_delete()
Delete the instance of a speech 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 SPHDEC1_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- SPHDEC1_create()
Execute the process() method in this instance of a speech decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech decoder instance. |
[in] | inBuf | A buffer descriptor containing an input buffer. |
[out] | outBuf | A buffer descriptor containing an output buffer. |
[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:
- SPHDEC1_create()
-
SPHDEC1_delete()
-
SPHDEC1_control()
-
SPHDEC1_processAsync()
-
SPHDEC1_processWait()
-
ISPHDEC1_Fxns()process()
Perform asynchronous submission to this instance of a speech decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech decoder instance. |
[in] | inBuf | A buffer descriptor containing the input buffer. |
[out] | outBuf | A buffer descriptor containing the output buffer. |
[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:
- SPHDEC1_create()
-
SPHDEC1_delete()
-
SPHDEC1_control()
-
SPHDEC1_process()
-
SPHDEC1_processWait()
-
ISPHDEC1_Fxns::process()
Wait for a return message from a previous invocation of SPHDEC1_processAsync() in this instance of an speech decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech decoder instance. |
[in] | inBuf | A buffer descriptor containing the input buffer. |
[out] | outBuf | A buffer descriptor containing the output buffer. |
[in] | inArgs | Input Arguments. |
[out] | outArgs | Output Arguments. |
[in] | timeout | Amount of "time" to wait (from 0 -> SPHDEC1_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) speech decoder handle and the speech decoder is in the created state.
- Return values:
-
- See also:
- SPHDEC1_create()
-
SPHDEC1_delete()
-
SPHDEC1_control()
-
SPHDEC1_process()
-
SPHDEC1_processAsync()