XDAIS: XDM ISPHENC1 Speech/Voice Encoder Interface

Detailed Description


Data Structures
struct	ISPHENC1_Obj
	This must be the first field of all ISPHENC1 instance objects. More...
struct	ISPHENC1_Params
	Defines the creation time parameters for all ISPHENC1 instance objects. More...
struct	ISPHENC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via ISPHENC1_Fxns.control(). More...
struct	ISPHENC1_InArgs
	Defines the input arguments for all ISPHENC1 instance process function. More...
struct	ISPHENC1_Status
	Defines instance status parameters. More...
struct	ISPHENC1_OutArgs
	Defines the run time output arguments for all ISPHENC1 instance objects. More...
struct	ISPHENC1_Fxns
	Defines all of the operations on ISPHENC1 objects. More...
Defines
#define	ISPHENC1_EOK XDM_EOK
#define	ISPHENC1_EFAIL XDM_EFAIL
#define	ISPHENC1_EUNSUPPORTED XDM_EUNSUPPORTED
#define	ISPHENC1_ENOOUTPUT 1
	This value signifies no output being available at encoder, for example in the case of intermediate calls in 10msec frame size execution.
Typedefs
typedef ISPHENC1_Obj *	ISPHENC1_Handle
	Opaque handle to an ISPHENC1 objects.
typedef IALG_Cmd	ISPHENC1_Cmd
	Defines the control commands for the ISPHENC1 module.
Enumerations
enum	ISPHENC1_FrameType { ISPHENC1_FTYPE_SPEECH = 0, ISPHENC1_FTYPE_SIDFRAME = 1, ISPHENC1_FTYPE_NODATA = 2 }
	Encoder frame types. More...

Define Documentation

#define ISPHENC1_EOK XDM_EOK

Success.

#define ISPHENC1_EFAIL XDM_EFAIL

General failure.

#define ISPHENC1_EUNSUPPORTED XDM_EUNSUPPORTED

Request is unsupported.

#define ISPHENC1_ENOOUTPUT 1

This value signifies no output being available at encoder, for example in the case of intermediate calls in 10msec frame size execution.

Typedef Documentation

Opaque handle to an ISPHENC1 objects.

Defines the control commands for the ISPHENC1 module.

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

Enumeration Type Documentation

Encoder frame types.

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

Enumerator:

ISPHENC1_FTYPE_SPEECH	Speech frame
ISPHENC1_FTYPE_SIDFRAME	SID frames for codecs which support DTX.
ISPHENC1_FTYPE_NODATA	Untransmitted frame for codecs which support DTX.

XDM ISPHENC1 Speech/Voice Encoder Interface