IIMGDEC1 - XDM Image Decoder Interface

Data Structures
struct	IIMGDEC1_Obj
	This must be the first field of all IIMGDEC1 instance objects. More...
struct	IIMGDEC1_Params
	Defines the creation time parameters for all IIMGDEC1 instance objects. More...
struct	IIMGDEC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct	IIMGDEC1_InArgs
	Defines the input arguments for all IIMGDEC1 instance process() function. More...
struct	IIMGDEC1_Status
	Defines instance status parameters. More...
struct	IIMGDEC1_OutArgs
	Defines the run time output arguments for all IIMGDEC1 instance objects. More...
struct	IIMGDEC1_Fxns
	Defines all of the operations on IIMGDEC1 objects. More...
Defines
#define	IIMGDEC1_EOK   XDM_EOK
#define	IIMGDEC1_EFAIL   XDM_EFAIL
#define	IIMGDEC1_EUNSUPPORTED   XDM_EUNSUPPORTED
Typedefs
typedef struct IIMGDEC1_Obj	IIMGDEC1_Obj
	This must be the first field of all IIMGDEC1 instance objects.
typedef struct IIMGDEC1_Obj *	IIMGDEC1_Handle
	Opaque handle to an IIMGDEC1 objects.
typedef struct IIMGDEC1_Params	IIMGDEC1_Params
	Defines the creation time parameters for all IIMGDEC1 instance objects.
typedef struct IIMGDEC1_DynamicParams	IIMGDEC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IIMGDEC1_InArgs	IIMGDEC1_InArgs
	Defines the input arguments for all IIMGDEC1 instance process() function.
typedef struct IIMGDEC1_Status	IIMGDEC1_Status
	Defines instance status parameters.
typedef struct IIMGDEC1_OutArgs	IIMGDEC1_OutArgs
	Defines the run time output arguments for all IIMGDEC1 instance objects.
typedef IALG_Cmd	IIMGDEC1_Cmd
	Defines the control commands for the IIMGDEC1 module.
typedef struct IIMGDEC1_Fxns	IIMGDEC1_Fxns
	Defines all of the operations on IIMGDEC1 objects.

---

Detailed Description

This is the XDM IIMGDEC1 Image Decoder Interface.

---

Define Documentation

#define IIMGDEC1_EOK   XDM_EOK

Success.

#define IIMGDEC1_EFAIL   XDM_EFAIL

General failure.

#define IIMGDEC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Request is unsupported.

---

Typedef Documentation

typedef struct IIMGDEC1_Obj IIMGDEC1_Obj

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

typedef struct IIMGDEC1_Obj* IIMGDEC1_Handle

Opaque handle to an IIMGDEC1 objects.

typedef struct IIMGDEC1_Params IIMGDEC1_Params

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

typedef struct IIMGDEC1_DynamicParams IIMGDEC1_DynamicParams

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

See also:

IIMGDEC1_Fxns::control()

typedef struct IIMGDEC1_InArgs IIMGDEC1_InArgs

Defines the input arguments for all IIMGDEC1 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:

IIMGDEC1_Fxns::process()

typedef struct IIMGDEC1_Status IIMGDEC1_Status

Defines instance status parameters.

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:

IIMGDEC1_Fxns::control()

typedef struct IIMGDEC1_OutArgs IIMGDEC1_OutArgs

Defines the run time output arguments for all IIMGDEC1 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:

IIMGDEC1_Fxns::process()

typedef IALG_Cmd IIMGDEC1_Cmd

Defines the control commands for the IIMGDEC1 module.

Remarks:

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

See also:

XDM_CmdId

IIMGDEC1_Fxns::control()

typedef struct IIMGDEC1_Fxns IIMGDEC1_Fxns

Defines all of the operations on IIMGDEC1 objects.