XDAIS  dais-x04
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Structures | Macros | Typedefs
IUNIVERSAL - XDM Beta Universal Algorithm Interface

Data Structures

struct  IUNIVERSAL_Obj
 This must be the first field of all IUNIVERSAL instance objects. More...
struct  IUNIVERSAL_Params
 Defines the creation time parameters for all IUNIVERSAL instance objects. More...
struct  IUNIVERSAL_DynamicParams
 This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct  IUNIVERSAL_InArgs
 Defines the input arguments for all IUNIVERSAL instance process function. More...
struct  IUNIVERSAL_Status
 Defines instance status parameters (read-only). More...
struct  IUNIVERSAL_OutArgs
 Defines the run time output arguments for all IUNIVERSAL instance objects. More...
struct  IUNIVERSAL_Fxns
 Defines all of the operations on IUNIVERSAL objects. More...

Macros

#define IUNIVERSAL_EOK   XDM_EOK
 
#define IUNIVERSAL_EFAIL   XDM_EFAIL
 
#define IUNIVERSAL_EUNSUPPORTED   XDM_EUNSUPPORTED
 

Typedefs

typedef struct IUNIVERSAL_Obj IUNIVERSAL_Obj
 This must be the first field of all IUNIVERSAL instance objects.
typedef struct IUNIVERSAL_ObjIUNIVERSAL_Handle
 Opaque handle to an IUNIVERSAL objects.
typedef struct IUNIVERSAL_Params IUNIVERSAL_Params
 Defines the creation time parameters for all IUNIVERSAL instance objects.
typedef struct
IUNIVERSAL_DynamicParams 
IUNIVERSAL_DynamicParams
 This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IUNIVERSAL_InArgs IUNIVERSAL_InArgs
 Defines the input arguments for all IUNIVERSAL instance process function.
typedef struct IUNIVERSAL_Status IUNIVERSAL_Status
 Defines instance status parameters (read-only).
typedef struct IUNIVERSAL_OutArgs IUNIVERSAL_OutArgs
 Defines the run time output arguments for all IUNIVERSAL instance objects.
typedef IALG_Cmd IUNIVERSAL_Cmd
 Defines the control commands for the IUNIVERSAL module.
typedef struct IUNIVERSAL_Fxns IUNIVERSAL_Fxns
 Defines all of the operations on IUNIVERSAL objects.

Detailed Description

This is the XDM Beta Universal Algorithm Interface.


Macro Definition Documentation

#define IUNIVERSAL_EOK   XDM_EOK

Success.

#define IUNIVERSAL_EFAIL   XDM_EFAIL

General failure.

#define IUNIVERSAL_EUNSUPPORTED   XDM_EUNSUPPORTED

Request is unsupported.


Typedef Documentation

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

Opaque handle to an IUNIVERSAL objects.

Defines the creation time parameters for all IUNIVERSAL 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:
IUNIVERSAL_Fxns::control()

Defines the input arguments for all IUNIVERSAL 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:
IUNIVERSAL_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:
IUNIVERSAL_Fxns::control()

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

Defines the control commands for the IUNIVERSAL module.

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

Defines all of the operations on IUNIVERSAL objects.

Copyright 2013, Texas Instruments Incorporated