IVIDENC - XDM Video Encoder Interface

Data Structures
struct	IVIDENC_Obj
	This must be the first field of all IVIDENC instance objects. More...
struct	IVIDENC_Params
	Defines the creation time parameters for all IVIDENC instance objects. More...
struct	IVIDENC_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct	IVIDENC_InArgs
	Defines the input arguments for all IVIDENC instance process function. More...
struct	IVIDENC_Status
	Defines instance status parameters. More...
struct	IVIDENC_OutArgs
	Defines the run time output arguments for all IVIDENC instance objects. More...
struct	IVIDENC_Fxns
	Defines all of the operations on IVIDENC objects. More...

Macros
#define	IVIDENC_CID   "ti.xdais.dm.IVIDENC"
#define	IVIDENC_ERUNTIME   XDM_ERUNTIME
#define	IVIDENC_EOK   XDM_EOK
#define	IVIDENC_EFAIL   XDM_EFAIL

Typedefs
typedef struct IVIDENC_Obj	IVIDENC_Obj
	This must be the first field of all IVIDENC instance objects.
typedef struct IVIDENC_Obj *	IVIDENC_Handle
	Opaque handle to an IVIDENC objects.
typedef struct IVIDENC_Params	IVIDENC_Params
	Defines the creation time parameters for all IVIDENC instance objects.
typedef struct IVIDENC_DynamicParams	IVIDENC_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IVIDENC_InArgs	IVIDENC_InArgs
	Defines the input arguments for all IVIDENC instance process function.
typedef struct IVIDENC_Status	IVIDENC_Status
	Defines instance status parameters.
typedef struct IVIDENC_OutArgs	IVIDENC_OutArgs
	Defines the run time output arguments for all IVIDENC instance objects.
typedef IALG_Cmd	IVIDENC_Cmd
	Defines the control commands for the IVIDENC module.
typedef struct IVIDENC_Fxns	IVIDENC_Fxns
	Defines all of the operations on IVIDENC objects.

---

Detailed Description

This is the XDM IVIDENC Video Encoder Interface.

Deprecated:

This XDM video encoder interface has been deprecated, and superceeded by newer IVIDENCx video encoder interfaces.

---

Macro Definition Documentation

#define IVIDENC_CID   "ti.xdais.dm.IVIDENC"

IVIDENC Class ID

#define IVIDENC_ERUNTIME   XDM_ERUNTIME

General runtime failure.

#define IVIDENC_EOK   XDM_EOK

Success.

#define IVIDENC_EFAIL   XDM_EFAIL

General failure.

---

Typedef Documentation

typedef struct IVIDENC_Obj IVIDENC_Obj

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

typedef struct IVIDENC_Obj* IVIDENC_Handle

Opaque handle to an IVIDENC objects.

typedef struct IVIDENC_Params IVIDENC_Params

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

@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         IVIDENC_Fxns::control()

typedef struct IVIDENC_InArgs IVIDENC_InArgs

Defines the input arguments for all IVIDENC 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         IVIDENC_Fxns::process()

typedef struct IVIDENC_Status IVIDENC_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 @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         IVIDENC_Fxns::control()

typedef struct IVIDENC_OutArgs IVIDENC_OutArgs

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

typedef IALG_Cmd IVIDENC_Cmd

Defines the control commands for the IVIDENC module.

Remarks:

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

See also:

XDM_CmdId

IVIDENC_Fxns::control()

typedef struct IVIDENC_Fxns IVIDENC_Fxns

Defines all of the operations on IVIDENC objects.