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.
Macro Definition Documentation
Special value for timeout parameter indicating never timeout.
#define SPHENC_VISATYPE "ti.sdo.ce.speech.ISPHENC" |
#define SPHENC_STUBSNAME "SPHENC_STUBS" |
Name of stub functions. Use this name when registering the SPHENC_STUBS functions with Engine_addStubFxns.
- See also:
- Engine_addStubFxns
Typedef Documentation
Defines instance status parameters (read-only).
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Opaque handle to a SPHENC codec.
This structure defines the parameters necessary to create an instance of a Speech/Voice Encoder object.
Defines the input arguments for all ISPHENC instance process function.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines the run time output arguments for all ISPHENC instance objects.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
This structure defines the codec parameters that can be modified after creation via control() calls.
@remarks It is not necessary that given implementation support all
dynamic parameters to be configurable at run time. If a
particular algorithm does not support run-time updates to
a parameter that the application is attempting to change
at runtime, it may indicate this as an error.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
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.
@param[in] e Handle to an opened engine.
@param[in] name String identifier of the type of speech encoder
to create.
@param[in] params Creation parameters.
@retval NULL An error has occurred.
@retval non-NULL The handle to the newly created speech encoder
instance.
@remark Depending on the configuration of the engine opened, this
call may create a local or remote instance of the speech
encoder.
@remarks In general, @c 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 <b>":priority"</b>, <b>":priority:flag"</b>, or <b>"::flag"</b>.
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()