Speech 1.0 Encoder Codec Interface

Defines
#define	SPHENC1_EOK   ISPHENC1_EOK
#define	SPHENC1_EFAIL   ISPHENC1_EFAIL
#define	SPHENC1_EUNSUPPORTED   ISPHENC1_EUNSUPPORTED
#define	SPHENC1_ETIMEOUT   VISA_ETIMEOUT
#define	SPHENC1_FOREVER   VISA_FOREVER
Typedefs
typedef VISA_Handle	SPHENC1_Handle
	Opaque handle to a SPHENC1 codec.
typedef struct ISPHENC1_Params	SPHENC1_Params
	This structure defines the parameters necessary to create an instance of a speech encoder.
typedef ISPHENC1_InArgs	SPHENC1_InArgs
typedef ISPHENC1_OutArgs	SPHENC1_OutArgs
typedef ISPHENC1_Cmd	SPHENC1_Cmd
typedef ISPHENC1_Status	SPHENC1_Status
typedef ISPHENC1_DynamicParams	SPHENC1_DynamicParams
Functions
Int32	SPHENC1_control (SPHENC1_Handle handle, SPHENC1_Cmd id, SPHENC1_DynamicParams *params, SPHENC1_Status *status)
	Execute the control() method in this instance of a speech encoder algorithm.
SPHENC1_Handle	SPHENC1_create (Engine_Handle e, String name, SPHENC1_Params *params)
	Create an instance of a speech encoder algorithm.
Void	SPHENC1_delete (SPHENC1_Handle handle)
	Delete the instance of a speech encoder algorithm.
Int32	SPHENC1_process (SPHENC1_Handle handle, XDM1_SingleBufDesc *inBuf, XDM1_SingleBufDesc *outBuf, SPHENC1_InArgs *inArgs, SPHENC1_OutArgs *outArgs)
	Execute the process() method in this instance of a speech encoder algorithm.
XDAS_Int32	SPHENC1_processAsync (SPHENC1_Handle handle, XDM1_SingleBufDesc *inBuf, XDM1_SingleBufDesc *outBuf, SPHENC1_InArgs *inArgs, SPHENC1_OutArgs *outArgs)
	Perform asynchronous submission to this instance of a speech encoder algorithm.
XDAS_Int32	SPHENC1_processWait (SPHENC1_Handle handle, XDM1_SingleBufDesc *inBuf, XDM1_SingleBufDesc *outBuf, SPHENC1_InArgs *inArgs, SPHENC1_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of SPHENC1_processAsync() in this instance of an speech encoder algorithm.

---

Detailed Description

This is the Speech 1.0 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.

---

Define Documentation

#define SPHENC1_EOK   ISPHENC1_EOK

Success.

#define SPHENC1_EFAIL   ISPHENC1_EFAIL

General failure.

#define SPHENC1_EUNSUPPORTED   ISPHENC1_EUNSUPPORTED

Request is unsupported.

#define SPHENC1_ETIMEOUT   VISA_ETIMEOUT

Timeout occurred.

#define SPHENC1_FOREVER   VISA_FOREVER

Special value for timeout parameter indicating never timeout.

---

Typedef Documentation

typedef VISA_Handle SPHENC1_Handle

Opaque handle to a SPHENC1 codec.

typedef struct ISPHENC1_Params SPHENC1_Params

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

typedef ISPHENC1_InArgs SPHENC1_InArgs

Defines the input arguments for all ISPHENC1 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.

typedef ISPHENC1_OutArgs SPHENC1_OutArgs

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

ISPHENC1_Fxns::process()

typedef ISPHENC1_Cmd SPHENC1_Cmd

Defines the control commands for the ISPHENC1 module.

Remarks:

This ID can be extended in IMOD interface for additional control commands.

See also:

XDM_CmdId

ISPHENC1_Fxns::control()

typedef ISPHENC1_Status SPHENC1_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.

typedef ISPHENC1_DynamicParams SPHENC1_DynamicParams

This structure defines the codec parameters that can be modified after creation via ISPHENC1_Fxns.control().

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.

---

Function Documentation

Int32 SPHENC1_control	(	SPHENC1_Handle	handle,
		SPHENC1_Cmd	id,
		SPHENC1_DynamicParams *	params,
		SPHENC1_Status *	status
	)

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

Parameters:

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

Return values:

	SPHENC1_EOK	Success.
	SPHENC1_EFAIL	Failure.
	SPHENC1_EUNSUPPORTED	Unsupported request.

Remarks:

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

See also:

SPHENC1_create()

SPHENC1_delete()

ISPHENC1_Fxns::control()

SPHENC1_Handle SPHENC1_create	(	Engine_Handle	e,
		String	name,
		SPHENC1_Params *	params
	)

Create an instance of a speech encoder algorithm.

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

Return values:

	NULL	An error has occurred.
	non-NULL	The handle to the newly created speech 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 speech1 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()

SPHENC_delete()

Void SPHENC1_delete

(

SPHENC1_Handle

handle

)

Delete the instance of a speech encoder algorithm.

Parameters:

[in]

handle

Handle to a created speech encoder instance.

Remarks:

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

Precondition:

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

Postcondition:

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

See also:

SPHENC1_create()

Int32 SPHENC1_process	(	SPHENC1_Handle	handle,
		XDM1_SingleBufDesc *	inBuf,
		XDM1_SingleBufDesc *	outBuf,
		SPHENC1_InArgs *	inArgs,
		SPHENC1_OutArgs *	outArgs
	)

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

Parameters:

[in]	handle	Handle to a created speech encoder instance.
[in,out]	inBuf	A buffer descriptor containing an input buffer.
[out]	outBuf	A buffer descriptor containing an output buffer.
[in]	inArgs	Input Arguments.
[out]	outArgs	Output Arguments.

Precondition:

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

Return values:

	SPHENC1_EOK	Success.
	SPHENC1_EFAIL	Failure.
	SPHENC1_EUNSUPPORTED	Unsupported request.

Remarks:

Since the SPHENC1 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 SPHENC1_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:

SPHENC1_create()

SPHENC1_delete()

SPHENC1_control()

SPHENC1_processAsync()

SPHENC1_processWait()

ISPHENC1_Fxns::process()

XDAS_Int32 SPHENC1_processAsync	(	SPHENC1_Handle	handle,
		XDM1_SingleBufDesc *	inBuf,
		XDM1_SingleBufDesc *	outBuf,
		SPHENC1_InArgs *	inArgs,
		SPHENC1_OutArgs *	outArgs
	)

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

Parameters:

[in]	handle	Handle to a created speech encoder instance.
[in]	inBuf	A buffer descriptor containing the input buffer.
[out]	outBuf	A buffer descriptor containing the output buffer.
[in]	inArgs	Input Arguments.
[out]	outArgs	Output Arguments.

Precondition:

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

Return values:

	SPHENC1_EOK	Success.
	SPHENC1_EFAIL	Failure.
	SPHENC1_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 SPHENC1_processWait() API.

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

SPHENC1_create()

SPHENC1_delete()

SPHENC1_control()

SPHENC1_process()

SPHENC1_processWait()

ISPHENC1_Fxns::process()

XDAS_Int32 SPHENC1_processWait	(	SPHENC1_Handle	handle,
		XDM1_SingleBufDesc *	inBuf,
		XDM1_SingleBufDesc *	outBuf,
		SPHENC1_InArgs *	inArgs,
		SPHENC1_OutArgs *	outArgs,
		UInt	timeout
	)

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

Parameters:

[in]	handle	Handle to a created speech encoder instance.
[in]	inBuf	A buffer descriptor containing the input buffer.
[out]	outBuf	A buffer descriptor containing the output buffer.
[in]	inArgs	Input Arguments.
[out]	outArgs	Output Arguments.
[in]	timeout	Amount of "time" to wait (from 0 -> SPHENC1_FOREVER)

Precondition:

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

Return values:

	SPHENC1_EOK	Success.
	SPHENC1_EFAIL	Failure.
	SPHENC1_EUNSUPPORTED	Unsupported request.
	SPHENC1_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 SPHENC1_EFOREVER.

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

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

SPHENC1_create()

SPHENC1_delete()

SPHENC1_control()

SPHENC1_process()

SPHENC1_processAsync()