XDAIS  dais-x04
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Structures | Macros | Typedefs
IAUDDEC - XDM Audio Decoder Interface

Data Structures

struct  IAUDDEC_Obj
 This must be the first field of all IAUDDEC instance objects. More...
struct  IAUDDEC_Params
 Defines the creation time parameters for all IAUDDEC instance objects. More...
struct  IAUDDEC_DynamicParams
 This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct  IAUDDEC_InArgs
 Defines the input arguments for all IAUDDEC instance process function. More...
struct  IAUDDEC_Status
 Defines instance status parameters (read-only). More...
struct  IAUDDEC_OutArgs
 Defines the run time output arguments for all IAUDDEC instance objects. More...
struct  IAUDDEC_Fxns
 Defines all of the operations on IAUDDEC objects. More...

Macros

#define IAUDDEC_CID   "ti.xdais.dm.IAUDDEC"
#define IAUDDEC_ERUNTIME   XDM_ERUNTIME
#define IAUDDEC_EOK   XDM_EOK
 
#define IAUDDEC_EFAIL   XDM_EFAIL
 

Typedefs

typedef struct IAUDDEC_Obj IAUDDEC_Obj
 This must be the first field of all IAUDDEC instance objects.
typedef struct IAUDDEC_ObjIAUDDEC_Handle
 Opaque handle to an IAUDDEC objects.
typedef struct IAUDDEC_Params IAUDDEC_Params
 Defines the creation time parameters for all IAUDDEC instance objects.
typedef struct
IAUDDEC_DynamicParams 
IAUDDEC_DynamicParams
 This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IAUDDEC_InArgs IAUDDEC_InArgs
 Defines the input arguments for all IAUDDEC instance process function.
typedef struct IAUDDEC_Status IAUDDEC_Status
 Defines instance status parameters (read-only).
typedef struct IAUDDEC_OutArgs IAUDDEC_OutArgs
 Defines the run time output arguments for all IAUDDEC instance objects.
typedef IALG_Cmd IAUDDEC_Cmd
 Defines the control commands for the IAUDDEC module.
typedef struct IAUDDEC_Fxns IAUDDEC_Fxns
 Defines all of the operations on IAUDDEC objects.

Detailed Description

This is the XDM IAUDDEC Audio Decoder Interface.

Deprecated:
This XDM audio decoder interface has been deprecated, and superceeded by newer IAUDDECx audio decoder interfaces.

Macro Definition Documentation

#define IAUDDEC_CID   "ti.xdais.dm.IAUDDEC"

IAUDDEC Class ID

#define IAUDDEC_ERUNTIME   XDM_ERUNTIME

General runtime failure.

#define IAUDDEC_EOK   XDM_EOK

Success.

#define IAUDDEC_EFAIL   XDM_EFAIL

General failure.


Typedef Documentation

typedef struct IAUDDEC_Obj IAUDDEC_Obj

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

typedef struct IAUDDEC_Obj* IAUDDEC_Handle

Opaque handle to an IAUDDEC objects.

Defines the creation time parameters for all IAUDDEC 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.

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

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.
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:
IAUDDEC_Fxns::control()

Defines the input arguments for all IAUDDEC 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:
IAUDDEC_Fxns::process()

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

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

Defines the control commands for the IAUDDEC module.

Remarks:
This ID can be extended in IMOD interface for additional controls.
See also:
XDM_CmdId
IAUDDEC_Fxns::control()
typedef struct IAUDDEC_Fxns IAUDDEC_Fxns

Defines all of the operations on IAUDDEC objects.

Copyright 2013, Texas Instruments Incorporated