ISPHDEC - XDM Speech Decoder Interface

Data Structures
struct	ISPHDEC_Obj
	This must be the first field of all ISPHDEC instance objects. More...
struct	ISPHDEC_Params
	Defines the creation time parameters for all ISPHDEC instance objects. More...
struct	ISPHDEC_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct	ISPHDEC_InArgs
	Defines the input arguments for all ISPHDEC instance process function. More...
struct	ISPHDEC_Status
	Defines instance status parameters (read-only). More...
struct	ISPHDEC_OutArgs
	Defines the run time output arguments for all ISPHDEC instance objects. More...
struct	ISPHDEC_Fxns
	Defines all of the operations on ISPHDEC objects. More...

Macros
#define	ISPHDEC_CID   "ti.xdais.dm.ISPHDEC"
#define	ISPHDEC_ERUNTIME   XDM_ERUNTIME
#define	ISPHDEC_EOK   XDM_EOK
#define	ISPHDEC_EFAIL   XDM_EFAIL

Typedefs
typedef struct ISPHDEC_Obj	ISPHDEC_Obj
	This must be the first field of all ISPHDEC instance objects.
typedef struct ISPHDEC_Obj *	ISPHDEC_Handle
	Opaque handle to an ISPHDEC objects.
typedef struct ISPHDEC_Params	ISPHDEC_Params
	Defines the creation time parameters for all ISPHDEC instance objects.
typedef struct ISPHDEC_DynamicParams	ISPHDEC_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct ISPHDEC_InArgs	ISPHDEC_InArgs
	Defines the input arguments for all ISPHDEC instance process function.
typedef struct ISPHDEC_Status	ISPHDEC_Status
	Defines instance status parameters (read-only).
typedef struct ISPHDEC_OutArgs	ISPHDEC_OutArgs
	Defines the run time output arguments for all ISPHDEC instance objects.
typedef IALG_Cmd	ISPHDEC_Cmd
	Defines the control commands for the ISPHDEC module.
typedef struct ISPHDEC_Fxns	ISPHDEC_Fxns
	Defines all of the operations on ISPHDEC objects.

---

Detailed Description

This is the XDM ISPHDEC Speech Decoder Interface.

Deprecated:

This XDM speech decoder interface has been deprecated, and superceeded by newer ISPHDECx speech decoder interfaces.

---

Macro Definition Documentation

#define ISPHDEC_CID   "ti.xdais.dm.ISPHDEC"

ISPHDEC Class ID

#define ISPHDEC_ERUNTIME   XDM_ERUNTIME

General runtime failure.

#define ISPHDEC_EOK   XDM_EOK

Success.

#define ISPHDEC_EFAIL   XDM_EFAIL

General failure.

---

Typedef Documentation

typedef struct ISPHDEC_Obj ISPHDEC_Obj

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

typedef struct ISPHDEC_Obj* ISPHDEC_Handle

Opaque handle to an ISPHDEC objects.

typedef struct ISPHDEC_Params ISPHDEC_Params

Defines the creation time parameters for all ISPHDEC instance objects.

Remarks:

The application should set the parameters to 0 to use the algorithm's default values.

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

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

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.

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

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.

See also:

ISPHDEC_Fxns::control()

typedef struct ISPHDEC_InArgs ISPHDEC_InArgs

Defines the input arguments for all ISPHDEC 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 size parameter.

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.

See also:

ISPHDEC_Fxns::process()

typedef struct ISPHDEC_Status ISPHDEC_Status

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

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.

See also:

ISPHDEC_Fxns::control()

typedef struct ISPHDEC_OutArgs ISPHDEC_OutArgs

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

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.

See also:

ISPHDEC_Fxns::process()

typedef IALG_Cmd ISPHDEC_Cmd

Defines the control commands for the ISPHDEC module.

Remarks:

This ID can be extended in IMOD interface for additional controls.

See also:

XDM_CmdId

ISPHDEC_Fxns::control()

typedef struct ISPHDEC_Fxns ISPHDEC_Fxns

Defines all of the operations on ISPHDEC objects.