sphdec1.h File Reference

---

Detailed Description

The SPHDEC1 speech decoder interface. Provides the user an interface to create and interact with XDAIS algorithms that are compliant with the XDM-defined ISPHDEC1 speech decoder interface.

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

Include dependency graph for sphdec1.h:

Go to the source code of this file.

Macros
#define	SPHDEC1_EOK   ISPHDEC1_EOK
#define	SPHDEC1_EFAIL   ISPHDEC1_EFAIL
#define	SPHDEC1_EUNSUPPORTED   ISPHDEC1_EUNSUPPORTED
#define	SPHDEC1_ETIMEOUT   VISA_ETIMEOUT
	Timeout occurred.
#define	SPHDEC1_FOREVER   VISA_FOREVER
	Special value for timeout parameter indicating never timeout.
#define	SPHDEC1_VISATYPE   "ti.sdo.ce.speech1.ISPHDEC1"
	The VISA type.
#define	SPHDEC1_STUBSNAME   "SPHDEC1_STUBS"
	Name of stub functions. Use this name when registering the SPHDEC1_STUBS functions with Engine_addStubFxns.

Typedefs
typedef VISA_Handle	SPHDEC1_Handle
	Opaque handle to a SPHDEC1 codec.
typedef ISPHDEC1_Params	SPHDEC1_Params
	Defines the creation time parameters for all ISPHDEC1 instance objects.
typedef ISPHDEC1_InArgs	SPHDEC1_InArgs
	Defines the input arguments for all ISPHDEC1 instance process function.
typedef ISPHDEC1_OutArgs	SPHDEC1_OutArgs
	Defines the run time output arguments for all ISPHDEC1 instance objects.
typedef ISPHDEC1_Cmd	SPHDEC1_Cmd
	Defines the control commands for the ISPHDEC1 module.
typedef ISPHDEC1_DynamicParams	SPHDEC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via ISPHDEC1_Fxns.control().
typedef ISPHDEC1_Status	SPHDEC1_Status
	Defines instance status parameters.

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.