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

Data Structures

struct  IIMGDEC_Obj
 This must be the first field of all IIMGDEC instance objects. More...
struct  IIMGDEC_Params
 Defines the creation time parameters for all IIMGDEC instance objects. More...
struct  IIMGDEC_DynamicParams
 This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct  IIMGDEC_InArgs
 Defines the input arguments for all IIMGDEC instance process() function. More...
struct  IIMGDEC_Status
 Defines instance status parameters (read-only). More...
struct  IIMGDEC_OutArgs
 Defines the run time output arguments for all IIMGDEC instance objects. More...
struct  IIMGDEC_Fxns
 Defines all of the operations on IIMGDEC objects. More...

Macros

#define IIMGDEC_CID   "ti.xdais.dm.IIMGDEC"
#define IIMGDEC_ERUNTIME   XDM_ERUNTIME
#define IIMGDEC_EOK   XDM_EOK
 
#define IIMGDEC_EFAIL   XDM_EFAIL
 

Typedefs

typedef struct IIMGDEC_Obj IIMGDEC_Obj
 This must be the first field of all IIMGDEC instance objects.
typedef struct IIMGDEC_ObjIIMGDEC_Handle
 Opaque handle to an IIMGDEC objects.
typedef struct IIMGDEC_Params IIMGDEC_Params
 Defines the creation time parameters for all IIMGDEC instance objects.
typedef struct
IIMGDEC_DynamicParams 
IIMGDEC_DynamicParams
 This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IIMGDEC_InArgs IIMGDEC_InArgs
 Defines the input arguments for all IIMGDEC instance process() function.
typedef struct IIMGDEC_Status IIMGDEC_Status
 Defines instance status parameters (read-only).
typedef struct IIMGDEC_OutArgs IIMGDEC_OutArgs
 Defines the run time output arguments for all IIMGDEC instance objects.
typedef IALG_Cmd IIMGDEC_Cmd
 Defines the control commands for the IIMGDEC module.
typedef struct IIMGDEC_Fxns IIMGDEC_Fxns
 Defines all of the operations on IIMGDEC objects.

Detailed Description

This is the XDM IIMGDEC Image Decoder Interface.

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

Macro Definition Documentation

#define IIMGDEC_CID   "ti.xdais.dm.IIMGDEC"

IIMGDEC Class ID

#define IIMGDEC_ERUNTIME   XDM_ERUNTIME

General runtime failure.

#define IIMGDEC_EOK   XDM_EOK

Success.

#define IIMGDEC_EFAIL   XDM_EFAIL

General failure.


Typedef Documentation

typedef struct IIMGDEC_Obj IIMGDEC_Obj

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

typedef struct IIMGDEC_Obj* IIMGDEC_Handle

Opaque handle to an IIMGDEC objects.

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

Defines the input arguments for all IIMGDEC 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:
IIMGDEC_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:
IIMGDEC_Fxns::control()

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

Defines the control commands for the IIMGDEC module.

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

Defines all of the operations on IIMGDEC objects.

Copyright 2013, Texas Instruments Incorporated