Speech 1.0 Encoder Codec Interface
Defines |
#define | SPHENC1_EOK ISPHENC1_EOK |
#define | SPHENC1_EFAIL ISPHENC1_EFAIL |
#define | SPHENC1_EUNSUPPORTED ISPHENC1_EUNSUPPORTED |
#define | SPHENC1_ETIMEOUT VISA_ETIMEOUT |
#define | SPHENC1_FOREVER VISA_FOREVER |
Typedefs |
typedef VISA_Handle | SPHENC1_Handle |
| Opaque handle to a SPHENC1 codec.
|
typedef struct ISPHENC1_Params | SPHENC1_Params |
| This structure defines the parameters necessary to create an instance of a speech encoder.
|
typedef ISPHENC1_InArgs | SPHENC1_InArgs |
typedef ISPHENC1_OutArgs | SPHENC1_OutArgs |
typedef ISPHENC1_Cmd | SPHENC1_Cmd |
typedef ISPHENC1_Status | SPHENC1_Status |
typedef ISPHENC1_DynamicParams | SPHENC1_DynamicParams |
Functions |
Int32 | SPHENC1_control (SPHENC1_Handle handle, SPHENC1_Cmd id, SPHENC1_DynamicParams *params, SPHENC1_Status *status) |
| Execute the control() method in this instance of a speech encoder algorithm.
|
SPHENC1_Handle | SPHENC1_create (Engine_Handle e, String name, SPHENC1_Params *params) |
| Create an instance of a speech encoder algorithm.
|
Void | SPHENC1_delete (SPHENC1_Handle handle) |
| Delete the instance of a speech encoder algorithm.
|
Int32 | SPHENC1_process (SPHENC1_Handle handle, XDM1_SingleBufDesc *inBuf, XDM1_SingleBufDesc *outBuf, SPHENC1_InArgs *inArgs, SPHENC1_OutArgs *outArgs) |
| Execute the process() method in this instance of a speech encoder algorithm.
|
XDAS_Int32 | SPHENC1_processAsync (SPHENC1_Handle handle, XDM1_SingleBufDesc *inBuf, XDM1_SingleBufDesc *outBuf, SPHENC1_InArgs *inArgs, SPHENC1_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a speech encoder algorithm.
|
XDAS_Int32 | SPHENC1_processWait (SPHENC1_Handle handle, XDM1_SingleBufDesc *inBuf, XDM1_SingleBufDesc *outBuf, SPHENC1_InArgs *inArgs, SPHENC1_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of SPHENC1_processAsync() in this instance of an speech encoder algorithm.
|
Detailed Description
This is the Speech 1.0 Encoder Codec Interface. Several of the data types in this API are specified by the XDM 1.0 interface; please see the XDM documentation for those details.
Define Documentation
#define SPHENC1_EOK ISPHENC1_EOK |
#define SPHENC1_EFAIL ISPHENC1_EFAIL |
#define SPHENC1_EUNSUPPORTED ISPHENC1_EUNSUPPORTED |
#define SPHENC1_ETIMEOUT VISA_ETIMEOUT |
#define SPHENC1_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a SPHENC1 codec.
This structure defines the parameters necessary to create an instance of a speech encoder.
Defines the input arguments for all ISPHENC1 instance process function.
Defines instance status parameters.
Function Documentation
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:
- SPHENC1_create()
-
SPHENC1_delete()
-
ISPHENC1_Fxns::control()
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 SPHENC1_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()
Delete the instance of a speech 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 SPHENC1_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- SPHENC1_create()
Execute the process() method in this instance of a speech encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech encoder instance. |
[in,out] | 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 encoder handle and the speech encoder is in the created state.
- Return values:
-
- See also:
- SPHENC1_create()
-
SPHENC1_delete()
-
SPHENC1_control()
-
SPHENC1_processAsync()
-
SPHENC1_processWait()
-
ISPHENC1_Fxns::process()
Perform asynchronous submission to this instance of a speech encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech encoder 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 encoder handle and the speech encoder is in the created state.
- Return values:
-
- See also:
- SPHENC1_create()
-
SPHENC1_delete()
-
SPHENC1_control()
-
SPHENC1_process()
-
SPHENC1_processWait()
-
ISPHENC1_Fxns::process()
Wait for a return message from a previous invocation of SPHENC1_processAsync() in this instance of an speech encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created speech encoder 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 -> SPHENC1_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) speech encoder handle and the speech encoder is in the created state.
- Return values:
-
- See also:
- SPHENC1_create()
-
SPHENC1_delete()
-
SPHENC1_control()
-
SPHENC1_process()
-
SPHENC1_processAsync()