IIMGENC1 - XDM Image Encoder Interface

Data Structures
struct	IIMGENC1_Obj
	This must be the first field of all IIMGENC1 instance objects. More...
struct	IIMGENC1_Params
	Defines the creation time parameters for all IIMGENC1 instance objects. More...
struct	IIMGENC1_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls. More...
struct	IIMGENC1_InArgs
	Defines the input arguments for all IIMGENC1 instance process() function. More...
struct	IIMGENC1_Status
	Defines instance status parameters. More...
struct	IIMGENC1_OutArgs
	Defines the run time output arguments for all IIMGENC1 instance objects. More...
struct	IIMGENC1_Fxns
	Defines all of the operations on IIMGENC1 objects. More...
Defines
#define	IIMGENC1_EOK   XDM_EOK
#define	IIMGENC1_EFAIL   XDM_EFAIL
#define	IIMGENC1_EUNSUPPORTED   XDM_EUNSUPPORTED
Typedefs
typedef struct IIMGENC1_Obj	IIMGENC1_Obj
	This must be the first field of all IIMGENC1 instance objects.
typedef struct IIMGENC1_Obj *	IIMGENC1_Handle
	Opaque handle to an IIMGENC1 objects.
typedef struct IIMGENC1_Params	IIMGENC1_Params
	Defines the creation time parameters for all IIMGENC1 instance objects.
typedef struct IIMGENC1_DynamicParams	IIMGENC1_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls.
typedef struct IIMGENC1_InArgs	IIMGENC1_InArgs
	Defines the input arguments for all IIMGENC1 instance process() function.
typedef struct IIMGENC1_Status	IIMGENC1_Status
	Defines instance status parameters.
typedef struct IIMGENC1_OutArgs	IIMGENC1_OutArgs
	Defines the run time output arguments for all IIMGENC1 instance objects.
typedef IALG_Cmd	IIMGENC1_Cmd
	Defines the control commands for the IIMGENC1 module.
typedef struct IIMGENC1_Fxns	IIMGENC1_Fxns
	Defines all of the operations on IIMGENC1 objects.

---

Detailed Description

This is the XDM IIMGENC1 Image Encoder Interface.

---

Define Documentation

#define IIMGENC1_EOK   XDM_EOK

Success.

#define IIMGENC1_EFAIL   XDM_EFAIL

General failure.

#define IIMGENC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Request is unsupported.

---

Typedef Documentation

typedef struct IIMGENC1_Obj IIMGENC1_Obj

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

typedef struct IIMGENC1_Obj* IIMGENC1_Handle

Opaque handle to an IIMGENC1 objects.

typedef struct IIMGENC1_Params IIMGENC1_Params

Defines the creation time parameters for all IIMGENC1 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 IIMGENC1_DynamicParams IIMGENC1_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:

IIMGENC1_Fxns::control()

typedef struct IIMGENC1_InArgs IIMGENC1_InArgs

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

IIMGENC1_Fxns::process()

typedef struct IIMGENC1_Status IIMGENC1_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:

IIMGENC1_Fxns::control()

typedef struct IIMGENC1_OutArgs IIMGENC1_OutArgs

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

IIMGENC1_Fxns::process()

typedef IALG_Cmd IIMGENC1_Cmd

Defines the control commands for the IIMGENC1 module.

Remarks:

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

See also:

XDM_CmdId

IIMGENC1_Fxns::control()

typedef struct IIMGENC1_Fxns IIMGENC1_Fxns

Defines all of the operations on IIMGENC1 objects.