XDM ISPHDEC1 Speech/Voice Decoder Interface

Data Structures
struct	ISPHDEC1_Obj
	This must be the first field of all ISPHDEC1 instance objects. More...
struct	ISPHDEC1_Params
	Defines the creation time parameters for all ISPHDEC1 instance objects. More...
struct	ISPHDEC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via ISPHDEC1_Fxns.control(). More...
struct	ISPHDEC1_InArgs
	Defines the input arguments for all ISPHDEC1 instance process function. More...
struct	ISPHDEC1_Status
	Defines instance status parameters. More...
struct	ISPHDEC1_OutArgs
	Defines the run time output arguments for all ISPHDEC1 instance objects. More...
struct	ISPHDEC1_Fxns
	Defines all of the operations on ISPHDEC1 objects. More...
Defines
#define	ISPHDEC1_EOK   XDM_EOK
#define	ISPHDEC1_EFAIL   XDM_EFAIL
#define	ISPHDEC1_EUNSUPPORTED   XDM_EUNSUPPORTED
Typedefs
typedef struct ISPHDEC1_Obj *	ISPHDEC1_Handle
	Opaque handle to an ISPHDEC1 objects.
typedef IALG_Cmd	ISPHDEC1_Cmd
	Defines the control commands for the ISPHDEC1 module.
Enumerations
enum	ISPHDEC1_FrameType {   ISPHDEC1_FTYPE_SPEECHGOOD = 0,   ISPHDEC1_FTYPE_SIDUPDATE = 1,   ISPHDEC1_FTYPE_NODATA = 2,   ISPHDEC1_FTYPE_SPEECHLOST = 3,   ISPHDEC1_FTYPE_DEGRADED = 4,   ISPHDEC1_FTYPE_BAD = 5,   ISPHDEC1_FTYPE_SIDFIRST = 6,   ISPHDEC1_FTYPE_SIDBAD = 7,   ISPHDEC1_FTYPE_ONSET = 8 }
	Decoder frame types. More...

---

Detailed Description

This is the XDM ISPHDEC1 Speech/Voice Decoder Interface.

---

Define Documentation

#define ISPHDEC1_EOK   XDM_EOK

Success.

#define ISPHDEC1_EFAIL   XDM_EFAIL

General failure.

#define ISPHDEC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Request is unsupported.

---

Typedef Documentation

typedef struct ISPHDEC1_Obj* ISPHDEC1_Handle

Opaque handle to an ISPHDEC1 objects.

typedef IALG_Cmd ISPHDEC1_Cmd

Defines the control commands for the ISPHDEC1 module.

Remarks:

This ID can be extended in IMOD interface for additional control commands.

See also:

XDM_CmdId

ISPHDEC1_Fxns::control()

---

Enumeration Type Documentation

enum ISPHDEC1_FrameType

Decoder frame types.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

See also:

ISPHDEC1_InArgs.frameType

Enumerator:

ISPHDEC1_FTYPE_SPEECHGOOD	Regular speech frame received without errors/loss.
ISPHDEC1_FTYPE_SIDUPDATE	SID update frames.
ISPHDEC1_FTYPE_NODATA	Untransmitted frame for codecs which support internal DTX.
ISPHDEC1_FTYPE_SPEECHLOST	Complete loss of speech frame.
ISPHDEC1_FTYPE_DEGRADED	Speech frame with a correct CRC, some invalid data.
ISPHDEC1_FTYPE_BAD	Speech frame (likely), but invalid.
ISPHDEC1_FTYPE_SIDFIRST	The first frame of comfort noise.
ISPHDEC1_FTYPE_SIDBAD	Corrupt SID update frame.
ISPHDEC1_FTYPE_ONSET	Frames which precede the first speech frame of a speech burst.