IIMGENC - XDM Image Encoder Interface

Data Structures
struct	IIMGENC_Obj
	This must be the first field of all IIMGENC instance objects. More...
struct	IIMGENC_Params
	Defines the creation time parameters for all IIMGENC instance objects. More...
struct	IIMGENC_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls. More...
struct	IIMGENC_InArgs
	Defines the input arguments for all IIMGENC instance process() function. More...
struct	IIMGENC_Status
	Defines instance status parameters (read-only). More...
struct	IIMGENC_OutArgs
	Defines the run time output arguments for all IIMGENC instance objects. More...
struct	IIMGENC_Fxns
	Defines all of the operations on IIMGENC objects. More...

Macros
#define	IIMGENC_CID   "ti.xdais.dm.IIMGENC"
#define	IIMGENC_ERUNTIME   XDM_ERUNTIME
#define	IIMGENC_EOK   XDM_EOK
#define	IIMGENC_EFAIL   XDM_EFAIL

Typedefs
typedef struct IIMGENC_Obj	IIMGENC_Obj
	This must be the first field of all IIMGENC instance objects.
typedef struct IIMGENC_Obj *	IIMGENC_Handle
	Opaque handle to an IIMGENC objects.
typedef struct IIMGENC_Params	IIMGENC_Params
	Defines the creation time parameters for all IIMGENC instance objects.
typedef struct IIMGENC_DynamicParams	IIMGENC_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls.
typedef struct IIMGENC_InArgs	IIMGENC_InArgs
	Defines the input arguments for all IIMGENC instance process() function.
typedef struct IIMGENC_Status	IIMGENC_Status
	Defines instance status parameters (read-only).
typedef struct IIMGENC_OutArgs	IIMGENC_OutArgs
	Defines the run time output arguments for all IIMGENC instance objects.
typedef IALG_Cmd	IIMGENC_Cmd
	Defines the control commands for the IIMGENC module.
typedef struct IIMGENC_Fxns	IIMGENC_Fxns
	Defines all of the operations on IIMGENC objects.

---

Detailed Description

This is the XDM IIMGENC Image Encoder Interface.

Deprecated:

This XDM image encoder interface has been deprecated, and superceeded by newer IIMGENCx image encoder interfaces.

---

Macro Definition Documentation

#define IIMGENC_CID   "ti.xdais.dm.IIMGENC"

IIMGENC Class ID

#define IIMGENC_ERUNTIME   XDM_ERUNTIME

General runtime failure.

#define IIMGENC_EOK   XDM_EOK

Success.

#define IIMGENC_EFAIL   XDM_EFAIL

General failure.

---

Typedef Documentation

typedef struct IIMGENC_Obj IIMGENC_Obj

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

typedef struct IIMGENC_Obj* IIMGENC_Handle

Opaque handle to an IIMGENC objects.

typedef struct IIMGENC_Params IIMGENC_Params

Defines the creation time parameters for all IIMGENC instance objects.

@remarks    The application should set the parameters to 0 to use
            the algorithm's default values.

@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 @c size parameter.

Remarks:

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.

typedef struct IIMGENC_DynamicParams IIMGENC_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.

@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 @c size parameter.

Remarks:

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.

@sa         IIMGENC_Fxns::control()

typedef struct IIMGENC_InArgs IIMGENC_InArgs

Defines the input arguments for all IIMGENC 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 @c size parameter.

Remarks:

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.

@sa         IIMGENC_Fxns::process()

typedef struct IIMGENC_Status IIMGENC_Status

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 @c size parameter.

Remarks:

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.

@sa         IIMGENC_Fxns::control()

typedef struct IIMGENC_OutArgs IIMGENC_OutArgs

Defines the run time output arguments for all IIMGENC 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 @c size parameter.

Remarks:

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.

@sa         IIMGENC_Fxns::process()

typedef IALG_Cmd IIMGENC_Cmd

Defines the control commands for the IIMGENC module.

Remarks:

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

See also:

XDM_CmdId

IIMGENC_Fxns::control()

typedef struct IIMGENC_Fxns IIMGENC_Fxns

Defines all of the operations on IIMGENC objects.