IVIDTRANSCODE - XDM Video Transcoder Interface

Data Structures
struct	IVIDTRANSCODE_Obj
	This must be the first field of all IVIDTRANSCODE instance objects. More...
struct	IVIDTRANSCODE_Params
	Defines the creation time parameters for all IVIDTRANSCODE instance objects. More...
struct	IVIDTRANSCODE_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct	IVIDTRANSCODE_InArgs
	Defines the input arguments for all IVIDTRANSCODE instance process function. More...
struct	IVIDTRANSCODE_Status
	Defines instance status parameters. More...
struct	IVIDTRANSCODE_OutArgs
	Defines the run time output arguments for all IVIDTRANSCODE instance objects. More...
struct	IVIDTRANSCODE_Fxns
	Defines all of the operations on IVIDTRANSCODE objects. More...

Macros
#define	IVIDTRANSCODE_EOK   XDM_EOK
#define	IVIDTRANSCODE_EFAIL   XDM_EFAIL
#define	IVIDTRANSCODE_EUNSUPPORTED   XDM_EUNSUPPORTED
#define	IVIDTRANSCODE_MAXOUTSTREAMS   2

Typedefs
typedef struct IVIDTRANSCODE_Obj	IVIDTRANSCODE_Obj
	This must be the first field of all IVIDTRANSCODE instance objects.
typedef struct IVIDTRANSCODE_Obj *	IVIDTRANSCODE_Handle
	Opaque handle to an IVIDTRANSCODE objects.
typedef struct IVIDTRANSCODE_Params	IVIDTRANSCODE_Params
	Defines the creation time parameters for all IVIDTRANSCODE instance objects.
typedef struct IVIDTRANSCODE_DynamicParams	IVIDTRANSCODE_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IVIDTRANSCODE_InArgs	IVIDTRANSCODE_InArgs
	Defines the input arguments for all IVIDTRANSCODE instance process function.
typedef struct IVIDTRANSCODE_Status	IVIDTRANSCODE_Status
	Defines instance status parameters.
typedef struct IVIDTRANSCODE_OutArgs	IVIDTRANSCODE_OutArgs
	Defines the run time output arguments for all IVIDTRANSCODE instance objects.
typedef IALG_Cmd	IVIDTRANSCODE_Cmd
	Defines the control commands for the IVIDTRANSCODE module.
typedef struct IVIDTRANSCODE_Fxns	IVIDTRANSCODE_Fxns
	Defines all of the operations on IVIDTRANSCODE objects.

---

Detailed Description

This is the XDM IVIDENC2 Video Transcoder Interface.

---

Macro Definition Documentation

#define IVIDTRANSCODE_EOK   XDM_EOK

Success.

#define IVIDTRANSCODE_EFAIL   XDM_EFAIL

General failure.

#define IVIDTRANSCODE_EUNSUPPORTED   XDM_EUNSUPPORTED

Request is unsupported.

#define IVIDTRANSCODE_MAXOUTSTREAMS   2

Todo:

Document this.

---

Typedef Documentation

typedef struct IVIDTRANSCODE_Obj IVIDTRANSCODE_Obj

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

typedef struct IVIDTRANSCODE_Obj* IVIDTRANSCODE_Handle

Opaque handle to an IVIDTRANSCODE objects.

typedef struct IVIDTRANSCODE_Params IVIDTRANSCODE_Params

Defines the creation time parameters for all IVIDTRANSCODE 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 https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

typedef struct IVIDTRANSCODE_DynamicParams IVIDTRANSCODE_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 https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

See also:

IVIDTRANSCODE_Fxns::control()

typedef struct IVIDTRANSCODE_InArgs IVIDTRANSCODE_InArgs

Defines the input arguments for all IVIDTRANSCODE 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 https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

See also:

IVIDTRANSCODE_Fxns::process()

typedef struct IVIDTRANSCODE_Status IVIDTRANSCODE_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 https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

See also:

IVIDTRANSCODE_Fxns::control()

typedef struct IVIDTRANSCODE_OutArgs IVIDTRANSCODE_OutArgs

Defines the run time output arguments for all IVIDTRANSCODE 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 https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

See also:

IVIDTRANSCODE_Fxns::process()

typedef IALG_Cmd IVIDTRANSCODE_Cmd

Defines the control commands for the IVIDTRANSCODE module.

Remarks:

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

See also:

XDM_CmdId

IVIDTRANSCODE_Fxns::control()

typedef struct IVIDTRANSCODE_Fxns IVIDTRANSCODE_Fxns

Defines all of the operations on IVIDTRANSCODE objects.