IVIDDEC - XDM Video Decoder Interface

Data Structures
struct	IVIDDEC_Obj
	This must be the first field of all IVIDDEC instance objects. More...
struct	IVIDDEC_Params
	Defines the creation time parameters for all IVIDDEC instance objects. More...
struct	IVIDDEC_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct	IVIDDEC_InArgs
	Defines the input arguments for all IVIDDEC instance process function. More...
struct	IVIDDEC_Status
	Defines instance status parameters. More...
struct	IVIDDEC_OutArgs
	Defines the run time output arguments for all IVIDDEC instance objects. More...
struct	IVIDDEC_Fxns
	Defines all of the operations on IVIDDEC objects. More...
Defines
#define	IVIDDEC_CID   "ti.xdais.dm.IVIDDEC"
#define	IVIDDEC_ERUNTIME   XDM_ERUNTIME
#define	IVIDDEC_EOK   XDM_EOK
#define	IVIDDEC_EFAIL   XDM_EFAIL
Typedefs
typedef struct IVIDDEC_Obj	IVIDDEC_Obj
	This must be the first field of all IVIDDEC instance objects.
typedef struct IVIDDEC_Obj *	IVIDDEC_Handle
	Opaque handle to an IVIDDEC objects.
typedef struct IVIDDEC_Params	IVIDDEC_Params
	Defines the creation time parameters for all IVIDDEC instance objects.
typedef struct IVIDDEC_DynamicParams	IVIDDEC_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IVIDDEC_InArgs	IVIDDEC_InArgs
	Defines the input arguments for all IVIDDEC instance process function.
typedef struct IVIDDEC_Status	IVIDDEC_Status
	Defines instance status parameters.
typedef struct IVIDDEC_OutArgs	IVIDDEC_OutArgs
	Defines the run time output arguments for all IVIDDEC instance objects.
typedef IALG_Cmd	IVIDDEC_Cmd
	Defines the control commands for the IVIDDEC module.
typedef struct IVIDDEC_Fxns	IVIDDEC_Fxns
	Defines all of the operations on IVIDDEC objects.

---

Detailed Description

This is the XDM IVIDDEC Video Decoder Interface.

Deprecated:

This XDM video decoder interface has been deprecated, and superceeded by newer IVIDDECx video decoder interfaces.

---

Define Documentation

#define IVIDDEC_CID   "ti.xdais.dm.IVIDDEC"

IVIDDEC Class ID

#define IVIDDEC_ERUNTIME   XDM_ERUNTIME

General runtime failure.

#define IVIDDEC_EOK   XDM_EOK

Success.

#define IVIDDEC_EFAIL   XDM_EFAIL

General failure.

---

Typedef Documentation

typedef struct IVIDDEC_Obj IVIDDEC_Obj

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

typedef struct IVIDDEC_Obj* IVIDDEC_Handle

Opaque handle to an IVIDDEC objects.

typedef struct IVIDDEC_Params IVIDDEC_Params

Defines the creation time parameters for all IVIDDEC 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 implementation allowing customization with vendor specific parameters.

The size field must be correctly set by the caller.

typedef struct IVIDDEC_DynamicParams IVIDDEC_DynamicParams

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

See also:

IVIDDEC_Fxns::control()

typedef struct IVIDDEC_InArgs IVIDDEC_InArgs

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

IVIDDEC_Fxns::process()

typedef struct IVIDDEC_Status IVIDDEC_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:

IVIDDEC_Fxns::control()

typedef struct IVIDDEC_OutArgs IVIDDEC_OutArgs

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

IVIDDEC_Fxns::process()

typedef IALG_Cmd IVIDDEC_Cmd

Defines the control commands for the IVIDDEC module.

Remarks:

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

See also:

XDM_CmdId

IVIDDEC_Fxns::control()

typedef struct IVIDDEC_Fxns IVIDDEC_Fxns

Defines all of the operations on IVIDDEC objects.