sphenc.h File Reference

---

Detailed Description

The SPHENC speech encoder codec interface. Provides the user an interface to create and interact with XDAIS algorithms that are compliant with the XDM ISPHENC speech encoder interface.

#include <ti/xdais/dm/xdm.h>
#include <ti/xdais/dm/isphenc.h>
#include <ti/sdo/ce/Engine.h>
#include <ti/sdo/ce/visa.h>
#include <ti/sdo/ce/skel.h>

Include dependency graph for sphenc.h:

Go to the source code of this file.

Macros
#define	SPHENC_EOK   ISPHENC_EOK
#define	SPHENC_EFAIL   ISPHENC_EFAIL
#define	SPHENC_ERUNTIME   ISPHENC_ERUNTIME
#define	SPHENC_ETIMEOUT   VISA_ETIMEOUT
	Timeout occurred.
#define	SPHENC_FOREVER   VISA_FOREVER
	Special value for timeout parameter indicating never timeout.
#define	SPHENC_VISATYPE   "ti.sdo.ce.speech.ISPHENC"
	The VISA type.
#define	SPHENC_STUBSNAME   "SPHENC_STUBS"
	Name of stub functions. Use this name when registering the SPHENC_STUBS functions with Engine_addStubFxns.

Typedefs
typedef ISPHENC_Status	SPHENC_Status
	Defines instance status parameters (read-only).
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
	Defines the input arguments for all ISPHENC instance process function.
typedef ISPHENC_OutArgs	SPHENC_OutArgs
	Defines the run time output arguments for all ISPHENC instance objects.
typedef ISPHENC_Cmd	SPHENC_Cmd
	Defines the control commands for the ISPHENC module.
typedef ISPHENC_DynamicParams	SPHENC_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.

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.