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...

Macros
#define	ISPHDEC1_EOK XDM_EOK

#define	ISPHDEC1_EFAIL XDM_EFAIL

#define	ISPHDEC1_EUNSUPPORTED XDM_EUNSUPPORTED

Typedefs
typedef struct ISPHDEC1_Obj	ISPHDEC1_Obj
	This must be the first field of all ISPHDEC1 instance objects.
typedef struct ISPHDEC1_Obj *	ISPHDEC1_Handle
	Opaque handle to an ISPHDEC1 objects.
typedef struct ISPHDEC1_Params	ISPHDEC1_Params
	Defines the creation time parameters for all ISPHDEC1 instance objects.
typedef struct ISPHDEC1_DynamicParams	ISPHDEC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via ISPHDEC1_Fxns.control().
typedef struct ISPHDEC1_InArgs	ISPHDEC1_InArgs
	Defines the input arguments for all ISPHDEC1 instance process function.
typedef struct ISPHDEC1_Status	ISPHDEC1_Status
	Defines instance status parameters.
typedef struct ISPHDEC1_OutArgs	ISPHDEC1_OutArgs
	Defines the run time output arguments for all ISPHDEC1 instance objects.
typedef IALG_Cmd	ISPHDEC1_Cmd
	Defines the control commands for the ISPHDEC1 module.
typedef struct ISPHDEC1_Fxns	ISPHDEC1_Fxns
	Defines all of the operations on ISPHDEC1 objects.

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 Decoder Interface.

Macro Definition 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_Obj

This must be the first field of all ISPHDEC1 instance objects.

typedef struct ISPHDEC1_Obj* ISPHDEC1_Handle

Opaque handle to an ISPHDEC1 objects.

typedef struct ISPHDEC1_Params ISPHDEC1_Params

Defines the creation time parameters for all ISPHDEC1 instance objects.

@remarks    Some of the fields in this structure are optional and depend
            on the class of speech decoder you're creating.

@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.

Remarks:: The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

typedef struct ISPHDEC1_DynamicParams ISPHDEC1_DynamicParams

This structure defines the codec parameters that can be modified after creation via ISPHDEC1_Fxns.control().

@remarks    It is not necessary that a 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.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         ISPHDEC1_Fxns::control()

typedef struct ISPHDEC1_InArgs ISPHDEC1_InArgs

Defines the input arguments for all ISPHDEC1 instance process function.

typedef struct ISPHDEC1_Status ISPHDEC1_Status

Defines instance status parameters.

@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.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         ISPHDEC1_Fxns::control()

typedef struct ISPHDEC1_OutArgs ISPHDEC1_OutArgs

Defines the run time output arguments for all ISPHDEC1 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.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         ISPHDEC1_Fxns::process()

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()

typedef struct ISPHDEC1_Fxns ISPHDEC1_Fxns

Defines all of the operations on ISPHDEC1 objects.

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.

Data Structures

Macros

Typedefs

Enumerations

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation