Defines |
#define | SPHENC_EOK ISPHENC_EOK |
#define | SPHENC_EFAIL ISPHENC_EFAIL |
#define | SPHENC_ERUNTIME ISPHENC_ERUNTIME |
#define | SPHENC_ETIMEOUT VISA_ETIMEOUT |
#define | SPHENC_FOREVER VISA_FOREVER |
Typedefs |
typedef ISPHENC_Status | SPHENC_Status |
typedef VISA_Handle | SPHENC_Handle |
| Opaque handle to a SPHENC codec.
|
typedef struct ISPHENC_Params | SPHENC_Params |
| This structure defines the parameters necessary to create an instance of a Speech/Voice Encoder object.
|
typedef ISPHENC_InArgs | SPHENC_InArgs |
typedef ISPHENC_OutArgs | SPHENC_OutArgs |
typedef ISPHENC_Cmd | SPHENC_Cmd |
typedef ISPHENC_DynamicParams | SPHENC_DynamicParams |
Functions |
SPHENC_Handle | SPHENC_create (Engine_Handle e, String name, SPHENC_Params *params) |
| Create an instance of a speech encoder algorithm.
|
Int32 | SPHENC_process (SPHENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, SPHENC_InArgs *inArgs, SPHENC_OutArgs *outArgs) |
| Execute the process() method in this instance of a speech encoder algorithm.
|
Int32 | SPHENC_control (SPHENC_Handle handle, SPHENC_Cmd id, SPHENC_DynamicParams *params, SPHENC_Status *status) |
| Execute the control method in this instance of a speech encoder algorithm.
|
Void | SPHENC_delete (SPHENC_Handle handle) |
| Delete the instance of a speech/voice encoder algorithm.
|
XDAS_Int32 | SPHENC_processAsync (SPHENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, ISPHENC_InArgs *inArgs, ISPHENC_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a speech decoder algorithm.
|
XDAS_Int32 | SPHENC_processWait (SPHENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, ISPHENC_InArgs *inArgs, ISPHENC_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of SPHENC_processAsync() in this instance of an speech decoder algorithm.
|
Detailed Description
This is the SPHENC speech encoder 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 SPHENC_EOK ISPHENC_EOK |
#define SPHENC_EFAIL ISPHENC_EFAIL |
#define SPHENC_ERUNTIME ISPHENC_ERUNTIME |
#define SPHENC_ETIMEOUT VISA_ETIMEOUT |
#define SPHENC_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a SPHENC codec.
This structure defines the parameters necessary to create an instance of a Speech/Voice Encoder object.
This structure defines the codec parameters that can be modified after creation via control() calls.
- See also:
- ISPHENC_Fxns::control()
Function Documentation
Create an instance of a speech encoder algorithm.
Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via SPHENC_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 encoder to create. |
[in] | params | Creation parameters. |
- Return values:
-
NULL | An error has occurred. |
non-NULL | The handle to the newly created speech encoder instance. |
- See also:
- Engine_open()
-
SPHENC_delete()
Execute the process() method in this instance of a speech encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech 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) speech encoder handle and the speech encoder is in the created state.
- Return values:
-
- See also:
- SPHENC_create()
-
SPHENC_delete()
-
SPHENC_control()
-
SPHENC_processAsync()
-
SPHENC_processWait()
-
ISPHENC_Fxns::process()
Execute the control method in this instance of a speech encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech 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) speech encoder handle and the speech encoder is in the created state.
- Return values:
-
- See also:
- SPHENC_create()
-
SPHENC_delete()
-
ISPHENC_Fxns::control()
Delete the instance of a speech/voice encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech encoder instance. |
- Precondition:
handle
is a valid (non-NULL) handle which is in the created state.
- Postcondition:
- All resources allocated as part of the SPHENC_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- SPHENC_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:
- SPHENC_create()
-
SPHENC_delete()
-
SPHENC_control()
-
SPHENC_process()
-
SPHENC_processWait()
-
ISPHENC_Fxns::process()
Wait for a return message from a previous invocation of SPHENC_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 -> SPHENC_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) speech decoder handle and the speech decoder is in the created state.
- Return values:
-
- See also:
- SPHENC_create()
-
SPHENC_delete()
-
SPHENC_control()
-
SPHENC_process()
-
SPHENC_processAsync()