SPHDEC Speech Decoder Interface

Defines
#define	SPHDEC_EOK   ISPHDEC_EOK
#define	SPHDEC_EFAIL   ISPHDEC_EFAIL
#define	SPHDEC_ERUNTIME   ISPHDEC_ERUNTIME
#define	SPHDEC_ETIMEOUT   VISA_ETIMEOUT
#define	SPHDEC_FOREVER   VISA_FOREVER
Typedefs
typedef ISPHDEC_Status	SPHDEC_Status
typedef VISA_Handle	SPHDEC_Handle
	Opaque handle to a SPHDEC codec.
typedef struct ISPHDEC_Params	SPHDEC_Params
	This structure defines the parameters necessary to create an instance of a speech decoder object.
typedef ISPHDEC_InArgs	SPHDEC_InArgs
typedef ISPHDEC_OutArgs	SPHDEC_OutArgs
typedef ISPHDEC_Cmd	SPHDEC_Cmd
typedef ISPHDEC_DynamicParams	SPHDEC_DynamicParams
Functions
SPHDEC_Handle	SPHDEC_create (Engine_Handle e, String name, SPHDEC_Params *params)
	Create an instance of a speech decoder algorithm.
Int32	SPHDEC_process (SPHDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, SPHDEC_InArgs *inArgs, SPHDEC_OutArgs *outArgs)
	Execute the process() method in this instance of a speech decoder algorithm.
Int32	SPHDEC_control (SPHDEC_Handle handle, SPHDEC_Cmd id, SPHDEC_DynamicParams *params, SPHDEC_Status *status)
	Execute the control method in this instance of a speech decoder algorithm.
Void	SPHDEC_delete (SPHDEC_Handle handle)
	Delete the instance of a speech/voice decoder algorithm.
XDAS_Int32	SPHDEC_processAsync (SPHDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, SPHDEC_InArgs *inArgs, SPHDEC_OutArgs *outArgs)
	Perform asynchronous submission to this instance of a speech decoder algorithm.
XDAS_Int32	SPHDEC_processWait (SPHDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, SPHDEC_InArgs *inArgs, SPHDEC_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of SPHDEC_processAsync() in this instance of an speech decoder algorithm.

---

Detailed Description

This is the SPHDEC speech decoder codec 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 SPHDEC_EOK   ISPHDEC_EOK

Success.

#define SPHDEC_EFAIL   ISPHDEC_EFAIL

General failure.

#define SPHDEC_ERUNTIME   ISPHDEC_ERUNTIME

General runtime failure.

#define SPHDEC_ETIMEOUT   VISA_ETIMEOUT

Timeout occurred.

#define SPHDEC_FOREVER   VISA_FOREVER

Special value for timeout parameter indicating never timeout.

---

Typedef Documentation

typedef ISPHDEC_Status SPHDEC_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:

ISPHDEC_Fxns::control()

typedef VISA_Handle SPHDEC_Handle

Opaque handle to a SPHDEC codec.

typedef struct ISPHDEC_Params SPHDEC_Params

This structure defines the parameters necessary to create an instance of a speech decoder object.

typedef ISPHDEC_InArgs SPHDEC_InArgs

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

ISPHDEC_Fxns::process()

typedef ISPHDEC_OutArgs SPHDEC_OutArgs

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

ISPHDEC_Fxns::process()

typedef ISPHDEC_Cmd SPHDEC_Cmd

Defines the control commands for the ISPHDEC module.

Remarks:

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

See also:

XDM_CmdId

ISPHDEC_Fxns::control()

typedef ISPHDEC_DynamicParams SPHDEC_DynamicParams

This structure defines the codec 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:

ISPHDEC_Fxns::control()

---

Function Documentation

SPHDEC_Handle SPHDEC_create	(	Engine_Handle	e,
		String	name,
		SPHDEC_Params *	params
	)

Create an instance of a speech decoder algorithm.

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

Return values:

	NULL	An error has occurred.
	non-NULL	The handle to the newly created speech decoder instance.

Remarks:

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

SPHDEC_delete()

Int32 SPHDEC_process	(	SPHDEC_Handle	handle,
		XDM_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		SPHDEC_InArgs *	inArgs,
		SPHDEC_OutArgs *	outArgs
	)

Execute the process() method in this instance of a speech decoder algorithm.

Parameters:

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

Return values:

	SPHDEC_EOK	Success.
	SPHDEC_EFAIL	Failure.
	SPHDEC_ERUNTIME	Internal Runtime Error.

Remarks:

Since the SPHDEC 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 SPHDEC_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:

SPHDEC_create()

SPHDEC_delete()

SPHDEC_control()

SPHDEC_processAsync()

SPHDEC_processWait()

ISPHDEC_Fxns::process()

Int32 SPHDEC_control	(	SPHDEC_Handle	handle,
		SPHDEC_Cmd	id,
		SPHDEC_DynamicParams *	params,
		SPHDEC_Status *	status
	)

Execute the control method in this instance of a speech decoder algorithm.

Parameters:

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

Return values:

	SPHDEC_EOK	Success.
	SPHDEC_EFAIL	Failure.
	SPHDEC_ERUNTIME	Internal Runtime Error.

Remarks:

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

See also:

SPHDEC_create()

SPHDEC_delete()

ISPHDEC_Fxns::control()

Void SPHDEC_delete

(

SPHDEC_Handle

handle

)

Delete the instance of a speech/voice decoder algorithm.

Parameters:

[in]

handle

Handle to a created speech decoder instance.

Remarks:

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

Precondition:

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

Postcondition:

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

See also:

SPHDEC_create()

XDAS_Int32 SPHDEC_processAsync	(	SPHDEC_Handle	handle,
		XDM_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		SPHDEC_InArgs *	inArgs,
		SPHDEC_OutArgs *	outArgs
	)

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

Parameters:

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

Return values:

	SPHDEC_EOK	Success.
	SPHDEC_EFAIL	Failure.
	SPHDEC_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 SPHDEC_processWait() API.

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

SPHDEC_create()

SPHDEC_delete()

SPHDEC_control()

SPHDEC_process()

SPHDEC_processWait()

ISPHDEC_Fxns::process()

XDAS_Int32 SPHDEC_processWait	(	SPHDEC_Handle	handle,
		XDM_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		SPHDEC_InArgs *	inArgs,
		SPHDEC_OutArgs *	outArgs,
		UInt	timeout
	)

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

Parameters:

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

Precondition:

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

Return values:

	SPHDEC_EOK	Success.
	SPHDEC_EFAIL	Failure.
	SPHDEC_ERUNTIME	Internal Runtime Error.
	SPHDEC_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 SPHDEC_EFOREVER.

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

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

SPHDEC_create()

SPHDEC_delete()

SPHDEC_control()

SPHDEC_process()

SPHDEC_processAsync()