ISPHENC - XDM Speech Encoder Interface

Data Structures
struct	ISPHENC_Obj
	This must be the first field of all ISPHENC instance objects. More...
struct	ISPHENC_Params
	Defines the creation time parameters for all ISPHENC instance objects. More...
struct	ISPHENC_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct	ISPHENC_InArgs
	Defines the input arguments for all ISPHENC instance process function. More...
struct	ISPHENC_Status
	Defines instance status parameters (read-only). More...
struct	ISPHENC_OutArgs
	Defines the run time output arguments for all ISPHENC instance objects. More...
struct	ISPHENC_Fxns
	Defines all of the operations on ISPHENC objects. More...

Macros
#define	ISPHENC_CID   "ti.xdais.dm.ISPHENC"
#define	ISPHENC_ERUNTIME   XDM_ERUNTIME
#define	ISPHENC_EOK   XDM_EOK
#define	ISPHENC_EFAIL   XDM_EFAIL

Typedefs
typedef struct ISPHENC_Obj	ISPHENC_Obj
	This must be the first field of all ISPHENC instance objects.
typedef struct ISPHENC_Obj *	ISPHENC_Handle
	Opaque handle to an ISPHENC objects.
typedef struct ISPHENC_Params	ISPHENC_Params
	Defines the creation time parameters for all ISPHENC instance objects.
typedef struct ISPHENC_DynamicParams	ISPHENC_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct ISPHENC_InArgs	ISPHENC_InArgs
	Defines the input arguments for all ISPHENC instance process function.
typedef struct ISPHENC_Status	ISPHENC_Status
	Defines instance status parameters (read-only).
typedef struct ISPHENC_OutArgs	ISPHENC_OutArgs
	Defines the run time output arguments for all ISPHENC instance objects.
typedef IALG_Cmd	ISPHENC_Cmd
	Defines the control commands for the ISPHENC module.
typedef struct ISPHENC_Fxns	ISPHENC_Fxns
	Defines all of the operations on ISPHENC objects.

---

Detailed Description

This is the XDM ISPHENC Speech/Voice Encoder Interface.

Deprecated:

This XDM speech encoder interface has been deprecated, and superceeded by newer ISPHENCx speech encoder interfaces.

---

Macro Definition Documentation

#define ISPHENC_CID   "ti.xdais.dm.ISPHENC"

ISPHENC Class ID

#define ISPHENC_ERUNTIME   XDM_ERUNTIME

General runtime failure.

#define ISPHENC_EOK   XDM_EOK

Success.

#define ISPHENC_EFAIL   XDM_EFAIL

General failure.

---

Typedef Documentation

typedef struct ISPHENC_Obj ISPHENC_Obj

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

typedef struct ISPHENC_Obj* ISPHENC_Handle

Opaque handle to an ISPHENC objects.

typedef struct ISPHENC_Params ISPHENC_Params

Defines the creation time parameters for all ISPHENC instance objects.

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

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

@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         ISPHENC_Fxns::control()

typedef struct ISPHENC_InArgs ISPHENC_InArgs

Defines the input arguments for all ISPHENC 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 @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         ISPHENC_Fxns::process()

typedef struct ISPHENC_Status ISPHENC_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 @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         ISPHENC_Fxns::control()

typedef struct ISPHENC_OutArgs ISPHENC_OutArgs

Defines the run time output arguments for all ISPHENC 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         ISPHENC_Fxns::process()

typedef IALG_Cmd ISPHENC_Cmd

Defines the control commands for the ISPHENC module.

Remarks:

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

See also:

XDM_CmdId

ISPHENC_Fxns::control()

typedef struct ISPHENC_Fxns ISPHENC_Fxns

Defines all of the operations on ISPHENC objects.