IAUDENC - XDM Audio Encoder Interface

Data Structures
struct	IAUDENC_Obj
	This must be the first field of all IAUDENC instance objects. More...
struct	IAUDENC_Params
	Defines the creation time parameters for all IAUDENC instance objects. More...
struct	IAUDENC_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls. More...
struct	IAUDENC_InArgs
	Defines the input arguments for all IAUDENC instance process function. More...
struct	IAUDENC_Status
	Defines instance status parameters (read-only). More...
struct	IAUDENC_OutArgs
	Defines the run time output arguments for all IAUDENC instance objects. More...
struct	IAUDENC_Fxns
	Defines all of the operations on IAUDENC objects. More...
Defines
#define	IAUDENC_CID   "ti.xdais.dm.IAUDENC"
#define	IAUDENC_ERUNTIME   XDM_ERUNTIME
#define	IAUDENC_EOK   XDM_EOK
#define	IAUDENC_EFAIL   XDM_EFAIL
Typedefs
typedef struct IAUDENC_Obj	IAUDENC_Obj
	This must be the first field of all IAUDENC instance objects.
typedef struct IAUDENC_Obj *	IAUDENC_Handle
	Opaque handle to an IAUDENC objects.
typedef struct IAUDENC_Params	IAUDENC_Params
	Defines the creation time parameters for all IAUDENC instance objects.
typedef struct IAUDENC_DynamicParams	IAUDENC_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls.
typedef struct IAUDENC_InArgs	IAUDENC_InArgs
	Defines the input arguments for all IAUDENC instance process function.
typedef struct IAUDENC_Status	IAUDENC_Status
	Defines instance status parameters (read-only).
typedef struct IAUDENC_OutArgs	IAUDENC_OutArgs
	Defines the run time output arguments for all IAUDENC instance objects.
typedef IALG_Cmd	IAUDENC_Cmd
	Defines the control commands for the IAUDENC module.
typedef struct IAUDENC_Fxns	IAUDENC_Fxns
	Defines all of the operations on IAUDENC objects.

---

Detailed Description

This is the XDM IAUDENC Audio Encoder Interface.

Deprecated:

This XDM audio encoder interface has been deprecated, and superceeded by newer IAUDENCx audio encoder interfaces.

---

Define Documentation

#define IAUDENC_CID   "ti.xdais.dm.IAUDENC"

IAUDENC Class ID

#define IAUDENC_ERUNTIME   XDM_ERUNTIME

General runtime failure.

#define IAUDENC_EOK   XDM_EOK

Success.

#define IAUDENC_EFAIL   XDM_EFAIL

General failure.

---

Typedef Documentation

typedef struct IAUDENC_Obj IAUDENC_Obj

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

typedef struct IAUDENC_Obj* IAUDENC_Handle

Opaque handle to an IAUDENC objects.

typedef struct IAUDENC_Params IAUDENC_Params

Defines the creation time parameters for all IAUDENC 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 http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

typedef struct IAUDENC_DynamicParams IAUDENC_DynamicParams

This structure defines the algorithm 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 http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:

IAUDENC_Fxns::control()

typedef struct IAUDENC_InArgs IAUDENC_InArgs

Defines the input arguments for all IAUDENC 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 http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:

IAUDENC_Fxns::process()

typedef struct IAUDENC_Status IAUDENC_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 http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:

IAUDENC_Fxns::control()

typedef struct IAUDENC_OutArgs IAUDENC_OutArgs

Defines the run time output arguments for all IAUDENC 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 http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:

IAUDENC_Fxns::process()

typedef IALG_Cmd IAUDENC_Cmd

Defines the control commands for the IAUDENC module.

Remarks:

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

See also:

XDM_CmdId

IAUDENC_Fxns::control()

typedef struct IAUDENC_Fxns IAUDENC_Fxns

Defines all of the operations on IAUDENC objects.