Audio 1.0 Encoder Codec Interface

Detailed Description

This is the 1.0 audio encoder codec interface. Several of the data types in this API are specified by the xDM 1.0 interface; please see the xDM documentation for those details.

Defines

#define AUDENC1_EOK   IAUDENC1_EOK

#define AUDENC1_EFAIL   IAUDENC1_EFAIL

#define AUDENC1_EUNSUPPORTED   IAUDENC1_EUNSUPPORTED

#define AUDENC1_ETIMEOUT   VISA_ETIMEOUT

#define AUDENC1_FOREVER   VISA_FOREVER

Typedefs

typedef VISA_Handle AUDENC1_Handle

Opaque handle to a AUDENC1 codec.

typedef IAUDENC1_Params AUDENC1_Params

This structure defines the parameters necessary to create an instance of an audio encoder.

typedef IAUDENC1_InArgs AUDENC1_InArgs

typedef IAUDENC1_OutArgs AUDENC1_OutArgs

typedef IAUDENC1_Cmd AUDENC1_Cmd

typedef IAUDENC1_Status AUDENC1_Status

typedef IAUDENC1_DynamicParams AUDENC1_DynamicParams

Functions

Int32 AUDENC1_control (AUDENC1_Handle handle, AUDENC1_Cmd id, AUDENC1_DynamicParams *params, AUDENC1_Status *status)

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

AUDENC1_Handle AUDENC1_create (Engine_Handle e, String name, AUDENC1_Params *params)

Create an instance of an audio encoder algorithm.

Void AUDENC1_delete (AUDENC1_Handle handle)

Delete the instance of a audio encoder algorithm.

Int32 AUDENC1_process (AUDENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDENC1_InArgs *inArgs, AUDENC1_OutArgs *outArgs)

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

Int32 AUDENC1_processAsync (AUDENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDENC1_InArgs *inArgs, AUDENC1_OutArgs *outArgs)

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

Int32 AUDENC1_processWait (AUDENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDENC1_InArgs *inArgs, AUDENC1_OutArgs *outArgs, UInt timeout)

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

Define Documentation

#define AUDENC1_EOK IAUDENC1_EOK

Success.

#define AUDENC1_EFAIL IAUDENC1_EFAIL

General failure.

#define AUDENC1_EUNSUPPORTED IAUDENC1_EUNSUPPORTED

Request is unsupported.

#define AUDENC1_ETIMEOUT VISA_ETIMEOUT

Timeout occurred.

#define AUDENC1_FOREVER VISA_FOREVER

Special value for timeout parameter indicating never timeout.

Typedef Documentation

typedef VISA_Handle AUDENC1_Handle

Opaque handle to a AUDENC1 codec.

typedef struct IAUDENC1_Params AUDENC1_Params

This structure defines the parameters necessary to create an instance of an audio encoder.

typedef IAUDENC1_InArgs AUDENC1_InArgs

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

typedef IAUDENC1_OutArgs AUDENC1_OutArgs

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

typedef IAUDENC1_Cmd AUDENC1_Cmd

Defines the control commands for the IAUDENC1 module.

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

See also:: XDM_CmdId
IAUDENC1_Fxns::control()

typedef IAUDENC1_Status AUDENC1_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:: IAUDENC1_Fxns::control()

typedef IAUDENC1_DynamicParams AUDENC1_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:: IAUDENC1_Fxns::control()

Function Documentation

Int32 AUDENC1_control	(	AUDENC1_Handle	handle,
		AUDENC1_Cmd	id,
		AUDENC1_DynamicParams *	params,
		AUDENC1_Status *	status
	)

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

Parameters:

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

Return values:

	AUDENC1_EOK	Success.
	AUDENC1_EFAIL	Failure.
	AUDENC1_EUNSUPPORTED	Unsupported request.

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

See also:

AUDENC1_create()

AUDENC1_delete()

IAUDENC1_Fxns::control()

AUDENC1_Handle AUDENC1_create	(	Engine_Handle	e,
		String	name,
		AUDENC1_Params *	params
	)

Create an instance of an audio encoder algorithm.

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

Return values:

	NULL	An error has occurred.
	non-NULL	The handle to the newly created audio 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 audio 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, to be overridden. This optional argument string is of the form ":priority", ":priority:flag", or "::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.

See also:: Engine_open()
AUDENC1_delete()

Void AUDENC1_delete ( AUDENC1_Handle handle )

Delete the instance of a audio encoder algorithm.

Parameters:

[in] handle Handle to a created audio encoder instance.

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

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

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

See also:: AUDENC1_create()

Int32 AUDENC1_process	(	AUDENC1_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM1_BufDesc *	outBufs,
		AUDENC1_InArgs *	inArgs,
		AUDENC1_OutArgs *	outArgs
	)

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

Parameters:

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

Return values:

	AUDENC1_EOK	Success.
	AUDENC1_EFAIL	Failure.
	AUDENC1_EUNSUPPORTED	Unsupported request.

Remarks:

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

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

AUDENC1_create()

AUDENC1_delete()

AUDENC1_control()

AUDENC1_processWait()

IAUDENC1_Fxns::process()

VISA_setAsync()

VISA_setSync()

Int32 AUDENC1_processAsync	(	AUDENC1_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM1_BufDesc *	outBufs,
		AUDENC1_InArgs *	inArgs,
		AUDENC1_OutArgs *	outArgs
	)

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

Parameters:

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

Return values:

	AUDENC1_EOK	Success.
	AUDENC1_EFAIL	Failure.
	AUDENC1_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 AUDENC1_processWait() API.
The buffers supplied to AUDENC1_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:

AUDENC1_processWait()

IAUDENC1_Fxns::process()

Int32 AUDENC1_processWait	(	AUDENC1_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM1_BufDesc *	outBufs,
		AUDENC1_InArgs *	inArgs,
		AUDENC1_OutArgs *	outArgs,
		UInt	timeout
	)

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

Parameters:

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

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

Return values:

	AUDENC1_EOK	Success.
	AUDENC1_EFAIL	Failure.
	AUDENC1_EUNSUPPORTED	Unsupported request.
	AUDENC1_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 AUDENC1_EFOREVER.

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

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

AUDENC1_processAsync()


Defines
#define	AUDENC1_EOK IAUDENC1_EOK
#define	AUDENC1_EFAIL IAUDENC1_EFAIL
#define	AUDENC1_EUNSUPPORTED IAUDENC1_EUNSUPPORTED
#define	AUDENC1_ETIMEOUT VISA_ETIMEOUT
#define	AUDENC1_FOREVER VISA_FOREVER
Typedefs
typedef VISA_Handle	AUDENC1_Handle
	Opaque handle to a AUDENC1 codec.
typedef IAUDENC1_Params	AUDENC1_Params
	This structure defines the parameters necessary to create an instance of an audio encoder.
typedef IAUDENC1_InArgs	AUDENC1_InArgs
typedef IAUDENC1_OutArgs	AUDENC1_OutArgs
typedef IAUDENC1_Cmd	AUDENC1_Cmd
typedef IAUDENC1_Status	AUDENC1_Status
typedef IAUDENC1_DynamicParams	AUDENC1_DynamicParams
Functions
Int32	AUDENC1_control (AUDENC1_Handle handle, AUDENC1_Cmd id, AUDENC1_DynamicParams params, AUDENC1_Status status)
	Execute the control() method in this instance of an audio encoder algorithm.
AUDENC1_Handle	AUDENC1_create (Engine_Handle e, String name, AUDENC1_Params *params)
	Create an instance of an audio encoder algorithm.
Void	AUDENC1_delete (AUDENC1_Handle handle)
	Delete the instance of a audio encoder algorithm.
Int32	AUDENC1_process (AUDENC1_Handle handle, XDM1_BufDesc inBufs, XDM1_BufDesc outBufs, AUDENC1_InArgs inArgs, AUDENC1_OutArgs outArgs)
	Execute the process() method in this instance of a audio encoder algorithm.
Int32	AUDENC1_processAsync (AUDENC1_Handle handle, XDM1_BufDesc inBufs, XDM1_BufDesc outBufs, AUDENC1_InArgs inArgs, AUDENC1_OutArgs outArgs)
	Perform asynchronous submission to this instance of a audio encoder algorithm.
Int32	AUDENC1_processWait (AUDENC1_Handle handle, XDM1_BufDesc inBufs, XDM1_BufDesc outBufs, AUDENC1_InArgs inArgs, AUDENC1_OutArgs outArgs, UInt timeout)
	Wait for a return message from a previous invocation of AUDENC1_processAsync() in this instance of an audio encoder algorithm.