Image encoder codec interface

Data Structures
struct	IIMGENC1_CodecClassConfig
	Definition of IIMGENC1 codec class configurable parameters. More...
Defines
#define	IMGENC1_EOK   IIMGENC1_EOK
#define	IMGENC1_EFAIL   IIMGENC1_EFAIL
#define	IMGENC1_EUNSUPPORTED   IIMGENC1_EUNSUPPORTED
#define	IMGENC1_ETIMEOUT   VISA_ETIMEOUT
#define	IMGENC1_FOREVER   VISA_FOREVER
Typedefs
typedef VISA_Handle	IMGENC1_Handle
	Opaque handle to a IMGENC1 codec.
typedef struct IIMGENC1_Params	IMGENC1_Params
typedef IIMGENC1_InArgs	IMGENC1_InArgs
typedef IIMGENC1_OutArgs	IMGENC1_OutArgs
typedef IIMGENC1_Cmd	IMGENC1_Cmd
typedef IIMGENC1_DynamicParams	IMGENC1_DynamicParams
typedef IIMGENC1_Status	IMGENC1_Status
Functions
Int32	IMGENC1_control (IMGENC1_Handle handle, IMGENC1_Cmd id, IMGENC1_DynamicParams *params, IMGENC1_Status *status)
	Execute the control() method in this instance of an image encoder algorithm.
IMGENC1_Handle	IMGENC1_create (Engine_Handle e, String name, IMGENC1_Params *params)
	Create an instance of an image encoder algorithm.
Void	IMGENC1_delete (IMGENC1_Handle handle)
	Delete the instance of a image encoder algorithm.
Int32	IMGENC1_process (IMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IMGENC1_InArgs *inArgs, IMGENC1_OutArgs *outArgs)
	Execute the process() method in this instance of an image encoder algorithm.
XDAS_Int32	IMGENC1_processAsync (IMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IIMGENC1_InArgs *inArgs, IIMGENC1_OutArgs *outArgs)
	Perform asynchronous submission to this instance of a image encoder algorithm.
XDAS_Int32	IMGENC1_processWait (IMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IIMGENC1_InArgs *inArgs, IIMGENC1_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of IMGENC1_processAsync() in this instance of an image encoder algorithm.

---

Detailed Description

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

---

Define Documentation

#define IMGENC1_EOK   IIMGENC1_EOK

Success.

#define IMGENC1_EFAIL   IIMGENC1_EFAIL

General failure.

#define IMGENC1_EUNSUPPORTED   IIMGENC1_EUNSUPPORTED

Request is unsupported.

#define IMGENC1_ETIMEOUT   VISA_ETIMEOUT

Timeout occurred.

#define IMGENC1_FOREVER   VISA_FOREVER

Special value for timeout parameter indicating never timeout.

---

Typedef Documentation

typedef VISA_Handle IMGENC1_Handle

Opaque handle to a IMGENC1 codec.

typedef struct IIMGENC1_Params IMGENC1_Params

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

typedef IIMGENC1_InArgs IMGENC1_InArgs

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

IIMGENC1_Fxns::process()

typedef IIMGENC1_OutArgs IMGENC1_OutArgs

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

IIMGENC1_Fxns::process()

typedef IIMGENC1_Cmd IMGENC1_Cmd

Defines the control commands for the IIMGENC1 module.

Remarks:

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

See also:

XDM_CmdId

IIMGENC1_Fxns::control()

typedef IIMGENC1_DynamicParams IMGENC1_DynamicParams

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

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:

IIMGENC1_Fxns::control()

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:

IIMGENC1_Fxns::control()

typedef IIMGENC1_Status IMGENC1_Status

---

Function Documentation

Int32 IMGENC1_control	(	IMGENC1_Handle	handle,
		IMGENC1_Cmd	id,
		IMGENC1_DynamicParams *	params,
		IMGENC1_Status *	status
	)

Execute the control() method in this instance of an image encoder algorithm.

Parameters:

[in]	handle	Handle to a created image 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) image encoder handle and the image encoder is in the created state.

Return values:

	IMGENC1_EOK	Success.
	IMGENC1_EFAIL	Failure.
	IMGENC1_EUNSUPPORTED	Unsupported request.

Remarks:

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

See also:

IMGENC1_create()

IMGENC1_delete()

IIMGENC1_Fxns::control()

IMGENC1_Handle IMGENC1_create	(	Engine_Handle	e,
		String	name,
		IMGENC1_Params *	params
	)

Create an instance of an image encoder algorithm.

Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via IMGENC1_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 image encoder to create.
[in]	params	Creation parameters.

Return values:

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

Remarks:

params is optional. If it's not supplied, codec-specific default params will be used.

Depending on the configuration of the engine opened, this call may create a local or remote instance of the image 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()

IMGENC1_delete()

Void IMGENC1_delete

(

IMGENC1_Handle

handle

)

Delete the instance of a image encoder algorithm.

Parameters:

[in]

handle

Handle to a created image encoder instance.

Remarks:

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

Precondition:

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

Postcondition:

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

See also:

IMGENC1_create()

Int32 IMGENC1_process	(	IMGENC1_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM1_BufDesc *	outBufs,
		IMGENC1_InArgs *	inArgs,
		IMGENC1_OutArgs *	outArgs
	)

Execute the process() method in this instance of an image encoder algorithm.

Parameters:

[in]	handle	Handle to a created image encoder 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) image encoder handle and the image encoder is in the created state.

Return values:

	IMGENC1_EOK	Success.
	IMGENC1_EFAIL	Failure.
	IMGENC1_EUNSUPPORTED	Unsupported request.

Remarks:

Since the IMGENC1 encoder 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 IMGENC1_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:

IMGENC1_create()

IMGENC1_delete()

IMGENC1_control()

IMGENC1_processAsync()

IMGENC1_processWait()

IIMGENC1_Fxns::process()

XDAS_Int32 IMGENC1_processAsync	(	IMGENC1_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM1_BufDesc *	outBufs,
		IIMGENC1_InArgs *	inArgs,
		IIMGENC1_OutArgs *	outArgs
	)

Perform asynchronous submission to this instance of a image encoder algorithm.

Parameters:

[in]	handle	Handle to a created image encoder 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) image encoder handle and the image encoder is in the created state.

Return values:

	IMGENC1_EOK	Success.
	IMGENC1_EFAIL	Failure.
	IMGENC1_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 IMGENC1_processWait() API.

The buffers supplied to IMGENC1_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:

IMGENC1_create()

IMGENC1_delete()

IMGENC1_control()

IMGENC1_process()

IMGENC1_processWait()

IIMGENC1_Fxns::process()

XDAS_Int32 IMGENC1_processWait	(	IMGENC1_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM1_BufDesc *	outBufs,
		IIMGENC1_InArgs *	inArgs,
		IIMGENC1_OutArgs *	outArgs,
		UInt	timeout
	)

Wait for a return message from a previous invocation of IMGENC1_processAsync() in this instance of an image encoder algorithm.

Parameters:

[in]	handle	Handle to a created image encoder 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 -> IMGENC1_FOREVER)

Precondition:

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

Return values:

	IMGENC1_EOK	Success.
	IMGENC1_EFAIL	Failure.
	IMGENC1_EUNSUPPORTED	Unsupported request.
	IMGENC1_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 IMGENC1_EFOREVER.

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

The buffers supplied to IMGENC1_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:

IMGENC1_create()

IMGENC1_delete()

IMGENC1_control()

IMGENC1_process()

IMGENC1_processAsync()