Video encoder codec interface

Defines
#define	VIDENC1_EOK   IVIDENC1_EOK
#define	VIDENC1_EFAIL   IVIDENC1_EFAIL
#define	VIDENC1_EUNSUPPORTED   IVIDENC1_EUNSUPPORTED
#define	VIDENC1_ETIMEOUT   VISA_ETIMEOUT
#define	VIDENC1_FOREVER   VISA_FOREVER
Typedefs
typedef IVIDENC1_Status	VIDENC1_Status
typedef VISA_Handle	VIDENC1_Handle
	Opaque handle to a VIDENC1 codec.
typedef struct IVIDENC1_Params	VIDENC1_Params
	This structure defines the parameters necessary to create an instance of a VIDENC1-based video encoder.
typedef IVIDENC1_InArgs	VIDENC1_InArgs
typedef IVIDENC1_OutArgs	VIDENC1_OutArgs
typedef IVIDENC1_Cmd	VIDENC1_Cmd
typedef IVIDENC1_DynamicParams	VIDENC1_DynamicParams
Functions
VIDENC1_Handle	VIDENC1_create (Engine_Handle e, String name, VIDENC1_Params *params)
	Create an instance of a video encoder algorithm.
Int32	VIDENC1_process (VIDENC1_Handle handle, IVIDEO1_BufDescIn *inBufs, XDM_BufDesc *outBufs, VIDENC1_InArgs *inArgs, VIDENC1_OutArgs *outArgs)
	Execute the process() method in this instance of a video encoder algorithm.
Int32	VIDENC1_control (VIDENC1_Handle handle, VIDENC1_Cmd id, VIDENC1_DynamicParams *params, VIDENC1_Status *status)
	Execute the control() method in this instance of a video encoder algorithm.
Void	VIDENC1_delete (VIDENC1_Handle handle)
	Delete the instance of a video encoder algorithm.
XDAS_Int32	VIDENC1_processAsync (VIDENC1_Handle handle, IVIDEO1_BufDescIn *inBufs, XDM_BufDesc *outBufs, IVIDENC1_InArgs *inArgs, IVIDENC1_OutArgs *outArgs)
	Perform asynchronous submission to this instance of a video decoder algorithm.
XDAS_Int32	VIDENC1_processWait (VIDENC1_Handle handle, IVIDEO1_BufDescIn *inBufs, XDM_BufDesc *outBufs, IVIDENC1_InArgs *inArgs, IVIDENC1_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of VIDENC1_processAsync() in this instance of an video decoder algorithm.

---

Detailed Description

This is the VIDENC1 video encoder codec interface. Several of the data types in this API are specified by the XDM IVIDENC1 interface; please see the XDM documentation for those details.

---

Define Documentation

#define VIDENC1_EOK   IVIDENC1_EOK

Success.

#define VIDENC1_EFAIL   IVIDENC1_EFAIL

General failure. Request is unsupported.

#define VIDENC1_EUNSUPPORTED   IVIDENC1_EUNSUPPORTED

#define VIDENC1_ETIMEOUT   VISA_ETIMEOUT

Timeout occurred.

#define VIDENC1_FOREVER   VISA_FOREVER

Special value for timeout parameter indicating never timeout.

---

Typedef Documentation

typedef IVIDENC1_Status VIDENC1_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:

IVIDENC1_Fxns::control()

typedef VISA_Handle VIDENC1_Handle

Opaque handle to a VIDENC1 codec.

typedef struct IVIDENC1_Params VIDENC1_Params

This structure defines the parameters necessary to create an instance of a VIDENC1-based video encoder.

typedef IVIDENC1_InArgs VIDENC1_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 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:

IVIDENC1_Fxns::process()

typedef IVIDENC1_OutArgs VIDENC1_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 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:

IVIDENC1_Fxns::process()

typedef IVIDENC1_Cmd VIDENC1_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 IVIDENC1_DynamicParams VIDENC1_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.

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:

IVIDENC1_Fxns::control()

---

Function Documentation

VIDENC1_Handle VIDENC1_create	(	Engine_Handle	e,
		String	name,
		VIDENC1_Params *	params
	)

Create an instance of a video encoder algorithm.

Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via VIDENC1_create) or explicitly serialize access to a shared handle.

Parameters:

[in]	e	Handle to an opened engine.
[in]	name	String identifier of the type of video encoder to create.
[in]	params	Creation parameters.

Return values:

	NULL	An error has occurred.
	non-NULL	The handle to the newly created video encoder instance.

Remarks:

Depending on the configuration of the engine opened, this call may create a local or remote instance of the video encoder.

In general, name is the name of the codec configured by the system integrator. However, an optional "argument string" may be appended to the codec name, to allow the codec's configured priority and/or the heaps where its memory will be allocated and/or the number of VISA messages to allocate, to be overridden. This optional argument string is of the form ":priority:flag:number-of-messages", and can be specified with an empty field for any element that you don't want to be overridden, e.g. "mp3:::3" to cause 3 messages to be allocated while using the default values for priority and the heap flag.

priority is the new priority to create the codec with.

The flag must be either 0 or 1, and if 1, all memory allocated for the codec will be in the heap that corresponds to IALG_EXTERNAL. If flag is 0, the memory for the codec will be allocated from the heaps it has requested. For example, if a codec named "mp3" has been configured into the system, setting name to "mp3:4" would cause the codec to be created at priority 4, instead of whatever priority was configured. This feature is useful if more than one instance of the codec are to be created at different priorities.

The flag can be used to prevent the codec from using any internal memory, for example, if it is to be run at the same time as another codec that must use internal memory, and there is insufficient internal memory for both.

The number-of-messages overrides the default of 1 message, and is useful (or required, practically speaking) for when the "asynchronous" process method is used, i.e. "AUDENC1_processAsync()"

See also:

Engine_open()

Int32 VIDENC1_process	(	VIDENC1_Handle	handle,
		IVIDEO1_BufDescIn *	inBufs,
		XDM_BufDesc *	outBufs,
		VIDENC1_InArgs *	inArgs,
		VIDENC1_OutArgs *	outArgs
	)

Execute the process() method in this instance of a video encoder algorithm.

Parameters:

[in]	handle	Handle to a created video encoder instance.
[in]	inBufs	A buffer describer containing input buffers.
[out]	outBufs	A buffer describer containing output buffers.
[in]	inArgs	Input Arguments.
[out]	outArgs	Output Arguments.

Precondition:

handle is a valid (non-NULL) video encoder handle and the video encoder is in the created state.

Return values:

	VIDENC1_EOK	Success.
	VIDENC1_EFAIL	Failure.

Remarks:

Since the VIDENC1 decoder contains support for asynchronous buffer submission and retrieval, this API becomes known as synchronous in nature.

This is a blocking call, and will return after the data has been encoded.

The buffers supplied to VIDENC1_process() may have constraints put on them. For example, in dual-processor, shared memory architectures, where the codec is running on a remote processor, the buffers may need to be physically contiguous. Additionally, the remote processor may place restrictions on buffer alignment.

See also:

VIDENC1_create()

VIDENC1_delete()

VIDENC1_control()

VIDENC1_processAsync()

VIDENC1_processWait()

IVIDENC1_Fxns::process()

Int32 VIDENC1_control	(	VIDENC1_Handle	handle,
		VIDENC1_Cmd	id,
		VIDENC1_DynamicParams *	params,
		VIDENC1_Status *	status
	)

Execute the control() method in this instance of a video encoder algorithm.

Parameters:

[in]	handle	Handle to a created video encoder instance.
[in]	id	Command id for XDM control operation.
[in]	params	Runtime control parameters used for encoding.
[out]	status	Status info upon completion of encode operation.

Precondition:

handle is a valid (non-NULL) video encoder handle and the video encoder is in the created state.

Return values:

	VIDENC1_EOK	Success.
	VIDENC1_EFAIL	Failure.

Remarks:

This is a blocking call, and will return after the control command has been executed.

If VIDENC1_EFAIL is returned, status->extendedError may indicate further details about the error. See XDM_ErrorBit for details.

See also:

VIDENC1_create()

VIDENC1_delete()

IVIDENC1_Fxns::process()

XDM_ErrorBit

Void VIDENC1_delete

(

VIDENC1_Handle

handle

)

Delete the instance of a video encoder algorithm.

Parameters:

[in]

handle

Handle to a created video encoder instance.

Remarks:

Depending on the configuration of the engine opened, this call may delete a local or remote instance of the video encoder.

Precondition:

handle is a valid (non-NULL) handle which is in the created state.

Postcondition:

All resources allocated as part of the VIDENC1_create() operation (memory, DMA channels, etc.) are freed.

See also:

VIDENC1_create()

XDAS_Int32 VIDENC1_processAsync	(	VIDENC1_Handle	handle,
		IVIDEO1_BufDescIn *	inBufs,
		XDM_BufDesc *	outBufs,
		IVIDENC1_InArgs *	inArgs,
		IVIDENC1_OutArgs *	outArgs
	)

Perform asynchronous submission to this instance of a video decoder algorithm.

Parameters:

[in]	handle	Handle to a created video decoder instance.
[in]	inBufs	A buffer descriptor containing input buffers.
[out]	outBufs	A buffer descriptor containing output buffers.
[in]	inArgs	Input Arguments.
[out]	outArgs	Output Arguments.

Precondition:

handle is a valid (non-NULL) video decoder handle and the video decoder is in the created state.

Return values:

	VIDENC1_EOK	Success.
	VIDENC1_EFAIL	Failure.
	VIDENC1_EUNSUPPORTED	Unsupported request.

Remarks:

This API is the asynchronous counterpart to the process() method. It allows for buffer and argument submission without waiting for retrieval. A response is retrieved using the VIDENC1_processWait() API.

The buffers supplied to VIDENC1_processAsync() may have constraints put on them. For example, in dual-processor, shared memory architectures, where the codec is running on a remote processor, the buffers may need to be physically contiguous. Additionally, the remote processor may place restrictions on buffer alignment.

See also:

VIDENC1_create()

VIDENC1_delete()

VIDENC1_control()

VIDENC1_process()

VIDENC1_processWait()

IVIDENC1_Fxns::process()

XDAS_Int32 VIDENC1_processWait	(	VIDENC1_Handle	handle,
		IVIDEO1_BufDescIn *	inBufs,
		XDM_BufDesc *	outBufs,
		IVIDENC1_InArgs *	inArgs,
		IVIDENC1_OutArgs *	outArgs,
		UInt	timeout
	)

Wait for a return message from a previous invocation of VIDENC1_processAsync() in this instance of an video decoder algorithm.

Parameters:

[in]	handle	Handle to a created video decoder instance.
[in]	inBufs	A buffer descriptor containing input buffers.
[out]	outBufs	A buffer descriptor containing output buffers.
[in]	inArgs	Input Arguments.
[out]	outArgs	Output Arguments.
[in]	timeout	Amount of "time" to wait (from 0 -> VIDENC1_FOREVER)

Precondition:

handle is a valid (non-NULL) video decoder handle and the video decoder is in the created state.

Return values:

	VIDENC1_EOK	Success.
	VIDENC1_EFAIL	Failure.
	VIDENC1_EUNSUPPORTED	Unsupported request.
	VIDENC1_ETIMEOUT	Operation timed out.

Remarks:

This is a blocking call, and will return after the data has been decoded.

"Polling" is supported by using a timeout of 0. Waiting forever is supported by using a timeout of VIDENC1_EFOREVER.

There must have previously been an invocation of the VIDENC1_processAsync() API.

The buffers supplied to VIDENC1_processAsync() may have constraints put on them. For example, in dual-processor, shared memory architectures, where the codec is running on a remote processor, the buffers may need to be physically contiguous. Additionally, the remote processor may place restrictions on buffer alignment.

See also:

VIDENC1_create()

VIDENC1_delete()

VIDENC1_control()

VIDENC1_process()

VIDENC1_processAsync()