IVIDENC1 - XDM Video Encoder Interface

Data Structures
struct	IVIDENC1_Obj
	This must be the first field of all IVIDENC1 instance objects. More...
struct	IVIDENC1_Params
	Defines the creation time parameters for all IVIDENC1 instance objects. More...
struct	IVIDENC1_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls. More...
struct	IVIDENC1_InArgs
	Defines the input arguments for all IVIDENC1 instance process function. More...
struct	IVIDENC1_Status
	Defines instance status parameters. More...
struct	IVIDENC1_OutArgs
	Defines the run time output arguments for all IVIDENC1 instance objects. More...
struct	IVIDENC1_MbData
	Defines the structure that contains macroblock related encoding parameter estimates. More...
struct	IVIDENC1_Fxns
	Defines all of the operations on IVIDENC1 objects. More...

Macros
#define	IVIDENC1_EOK   XDM_EOK
#define	IVIDENC1_EFAIL   XDM_EFAIL
#define	IVIDENC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Typedefs
typedef struct IVIDENC1_Obj	IVIDENC1_Obj
	This must be the first field of all IVIDENC1 instance objects.
typedef struct IVIDENC1_Obj *	IVIDENC1_Handle
	Opaque handle to an IVIDENC1 objects.
typedef struct IVIDENC1_Params	IVIDENC1_Params
	Defines the creation time parameters for all IVIDENC1 instance objects.
typedef struct IVIDENC1_DynamicParams	IVIDENC1_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls.
typedef struct IVIDENC1_InArgs	IVIDENC1_InArgs
	Defines the input arguments for all IVIDENC1 instance process function.
typedef struct IVIDENC1_Status	IVIDENC1_Status
	Defines instance status parameters.
typedef struct IVIDENC1_OutArgs	IVIDENC1_OutArgs
	Defines the run time output arguments for all IVIDENC1 instance objects.
typedef IALG_Cmd	IVIDENC1_Cmd
	Defines the control commands for the IVIDENC1 module.
typedef struct IVIDENC1_MbData	IVIDENC1_MbData
	Defines the structure that contains macroblock related encoding parameter estimates.
typedef struct IVIDENC1_Fxns	IVIDENC1_Fxns
	Defines all of the operations on IVIDENC1 objects.

---

Detailed Description

This is the XDM IVIDENC1 Video Encoder Interface.

---

Macro Definition Documentation

#define IVIDENC1_EOK   XDM_EOK

Success.

#define IVIDENC1_EFAIL   XDM_EFAIL

General failure.

#define IVIDENC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Request is unsupported.

---

Typedef Documentation

typedef struct IVIDENC1_Obj IVIDENC1_Obj

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

typedef struct IVIDENC1_Obj* IVIDENC1_Handle

Opaque handle to an IVIDENC1 objects.

typedef struct IVIDENC1_Params IVIDENC1_Params

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

typedef struct IVIDENC1_DynamicParams IVIDENC1_DynamicParams

This structure defines the algorithm 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.

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

typedef struct IVIDENC1_InArgs IVIDENC1_InArgs

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

typedef struct IVIDENC1_Status IVIDENC1_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         IVIDENC1_Fxns::control()

typedef struct IVIDENC1_OutArgs IVIDENC1_OutArgs

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

typedef IALG_Cmd IVIDENC1_Cmd

Defines the control commands for the IVIDENC1 module.

Remarks:

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

See also:

XDM_CmdId

IVIDENC1_Fxns::control()

typedef struct IVIDENC1_MbData IVIDENC1_MbData

Defines the structure that contains macroblock related encoding parameter estimates.

Remarks:

An array of IVIDENC1_MbData is provided within the inBufs parameter to IVIDENC1_Fxns::process() when IVIDENC1_DynamicParams::mbDataFlag is set.

See also:

IVIDENC1_DynamicParams::mbDataFlag

IVIDENC1_Fxns::process()

IVIDENC1_Fxns::control()

typedef struct IVIDENC1_Fxns IVIDENC1_Fxns

Defines all of the operations on IVIDENC1 objects.