AUDDEC Audio Decoder Interface

Defines
#define	AUDDEC_EOK   IAUDDEC_EOK
#define	AUDDEC_EFAIL   IAUDDEC_EFAIL
#define	AUDDEC_ERUNTIME   IAUDDEC_ERUNTIME
#define	AUDDEC_ETIMEOUT   VISA_ETIMEOUT
#define	AUDDEC_FOREVER   VISA_FOREVER
Typedefs
typedef IAUDDEC_Status	AUDDEC_Status
typedef VISA_Handle	AUDDEC_Handle
	Opaque handle to a AUDDEC codec.
typedef struct IAUDDEC_Params	AUDDEC_Params
	This structure defines the parameters necessary to create an instance of a IAUDDEC-compliant audio decoder.
typedef IAUDDEC_InArgs	AUDDEC_InArgs
typedef IAUDDEC_OutArgs	AUDDEC_OutArgs
typedef IAUDDEC_Cmd	AUDDEC_Cmd
typedef IAUDDEC_DynamicParams	AUDDEC_DynamicParams
Functions
AUDDEC_Handle	AUDDEC_create (Engine_Handle e, String name, AUDDEC_Params *params)
	Create an instance of a audio decoder algorithm.
Int32	AUDDEC_process (AUDDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, AUDDEC_InArgs *inArgs, AUDDEC_OutArgs *outArgs)
	Execute the process() method in this instance of an audio decoder algorithm.
Int32	AUDDEC_control (AUDDEC_Handle handle, AUDDEC_Cmd id, AUDDEC_DynamicParams *params, AUDDEC_Status *status)
	Execute the control() method in this instance of an audio decoder algorithm.
Void	AUDDEC_delete (AUDDEC_Handle handle)
	Delete the instance of an audio decoder algorithm.
XDAS_Int32	AUDDEC_processAsync (AUDDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, AUDDEC_InArgs *inArgs, AUDDEC_OutArgs *outArgs)
	Perform asynchronous submission to this instance of a audio decoder algorithm.
XDAS_Int32	AUDDEC_processWait (AUDDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, AUDDEC_InArgs *inArgs, AUDDEC_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of AUDDEC_processAsync() in this instance of an audio decoder algorithm.

---

Detailed Description

This is the AUDDEC audio decoder interface. Several of the data types in this API are specified by the XDM interface; please see the XDM documentation for those details.

---

Define Documentation

#define AUDDEC_EOK   IAUDDEC_EOK

Success.

#define AUDDEC_EFAIL   IAUDDEC_EFAIL

General failure.

#define AUDDEC_ERUNTIME   IAUDDEC_ERUNTIME

General runtime failure.

#define AUDDEC_ETIMEOUT   VISA_ETIMEOUT

Timeout occurred.

#define AUDDEC_FOREVER   VISA_FOREVER

Special value for timeout parameter indicating never timeout.

---

Typedef Documentation

typedef IAUDDEC_Status AUDDEC_Status

Defines instance status parameters (read-only).

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:

IAUDDEC_Fxns::control()

typedef VISA_Handle AUDDEC_Handle

Opaque handle to a AUDDEC codec.

typedef struct IAUDDEC_Params AUDDEC_Params

This structure defines the parameters necessary to create an instance of a IAUDDEC-compliant audio decoder.

typedef IAUDDEC_InArgs AUDDEC_InArgs

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

IAUDDEC_Fxns::process()

typedef IAUDDEC_OutArgs AUDDEC_OutArgs

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

IAUDDEC_Fxns::process()

typedef IAUDDEC_Cmd AUDDEC_Cmd

Defines the control commands for the IAUDDEC module.

Remarks:

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

See also:

XDM_CmdId

IAUDDEC_Fxns::control()

typedef IAUDDEC_DynamicParams AUDDEC_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 http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:

IAUDDEC_Fxns::control()

---

Function Documentation

AUDDEC_Handle AUDDEC_create	(	Engine_Handle	e,
		String	name,
		AUDDEC_Params *	params
	)

Create an instance of a audio decoder algorithm.

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

Return values:

	NULL	An error has occurred.
	non-NULL	The handle to the newly created audio decoder 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 audio decoder.

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()

AUDDEC_delete()

Int32 AUDDEC_process	(	AUDDEC_Handle	handle,
		XDM_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		AUDDEC_InArgs *	inArgs,
		AUDDEC_OutArgs *	outArgs
	)

Execute the process() method in this instance of an audio decoder algorithm.

Parameters:

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

Return values:

	AUDDEC_EOK	Success.
	AUDDEC_EFAIL	Failure.
	AUDDEC_ERUNTIME	Internal Runtime Error.

Remarks:

Since the AUDDEC 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 decoded.

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

AUDDEC_create()

AUDDEC_delete()

AUDDEC_control()

AUDDEC_processAsync()

AUDDEC_processWait()

IAUDDEC_Fxns::process()

Int32 AUDDEC_control	(	AUDDEC_Handle	handle,
		AUDDEC_Cmd	id,
		AUDDEC_DynamicParams *	params,
		AUDDEC_Status *	status
	)

Execute the control() method in this instance of an audio decoder algorithm.

Parameters:

[in]	handle	Handle to a created audio decoder instance.
[in]	id	Command id for XDM control operation.
[in]	params	Runtime control parameters used for decoding.
[out]	status	Status info upon completion of decode operation.

Precondition:

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

Return values:

	AUDDEC_EOK	Success.
	AUDDEC_EFAIL	Failure.
	AUDDEC_ERUNTIME	Internal Runtime Error.

Remarks:

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

See also:

AUDDEC_create()

AUDDEC_delete()

IAUDDEC_Fxns::control()

Void AUDDEC_delete

(

AUDDEC_Handle

handle

)

Delete the instance of an audio decoder algorithm.

Parameters:

[in]

handle

Handle to a created audio decoder instance.

Remarks:

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

Precondition:

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

Postcondition:

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

See also:

AUDDEC_create()

XDAS_Int32 AUDDEC_processAsync	(	AUDDEC_Handle	handle,
		XDM_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		AUDDEC_InArgs *	inArgs,
		AUDDEC_OutArgs *	outArgs
	)

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

Parameters:

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

Return values:

	AUDDEC_EOK	Success.
	AUDDEC_EFAIL	Failure.
	AUDDEC_ERUNTIME	Internal Runtime Error.

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 AUDDEC_processWait() API.

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

AUDDEC_create()

AUDDEC_delete()

AUDDEC_control()

AUDDEC_process()

AUDDEC_processWait()

IAUDDEC_Fxns::process()

XDAS_Int32 AUDDEC_processWait	(	AUDDEC_Handle	handle,
		XDM_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		AUDDEC_InArgs *	inArgs,
		AUDDEC_OutArgs *	outArgs,
		UInt	timeout
	)

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

Parameters:

[in]	handle	Handle to a created audio 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 -> AUDDEC_FOREVER)

Precondition:

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

Return values:

	AUDDEC_EOK	Success.
	AUDDEC_EFAIL	Failure.
	AUDENC_ERUNTIME	Internal Runtime Error.
	AUDDEC_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 AUDDEC_EFOREVER.

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

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

AUDDEC_create()

AUDDEC_delete()

AUDDEC_control()

AUDDEC_process()

AUDDEC_processAsync()