ISPHDEC_Fxns Struct Reference
[XDM ISPHDEC Speech/Voice Decoder Interface]

Defines all of the operations on ISPHDEC objects. More...

#include <isphdec.h>

Collaboration diagram for ISPHDEC_Fxns:

[legend]

Data Fields
IALG_Fxns	ialg
XDAS_Int32(*	process )(ISPHDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, ISPHDEC_InArgs *inArgs, ISPHDEC_OutArgs *outArgs)
	Basic speech/voice decoding call.
XDAS_Int32(*	control )(ISPHDEC_Handle handle, ISPHDEC_Cmd id, ISPHDEC_DynamicParams *params, ISPHDEC_Status *status)
	Control behaviour of an algorithm.

---

Detailed Description

Defines all of the operations on ISPHDEC objects.

---

Field Documentation

IALG_Fxns ISPHDEC_Fxns::ialg

XDAIS algorithm interface.

See also:

IALG_Fxns

XDAS_Int32(* ISPHDEC_Fxns::process)(ISPHDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, ISPHDEC_InArgs *inArgs, ISPHDEC_OutArgs *outArgs)

Basic speech/voice decoding call.

Parameters:

[in]	handle	Handle to an algorithm instance.
[in]	inBufs	Input buffer descriptors.
[in,out]	outBufs	Output buffer descriptors. The algorithm may modify the output buffer pointers.
[in]	inArgs	Input arguments. This is a required parameter.
[out]	outArgs	Ouput results. This is a required parameter.

Remarks:

process() is a blocking call. When process() returns, the algorithm's processing is complete.

Precondition:

handle must be a valid algorithm instance handle.

inArgs must not be NULL, and must point to a valid ISPHDEC_InArgs structure.

outArgs must not be NULL, and must point to a valid ISPHDEC_OutArgs structure.

inBufs must not be NULL, and must point to a valid XDM_BufDesc structure.

inBufs.buf[0] must not be NULL, and must point to a valid buffer of data that is at least inBufs.bufSizes[0] bytes in length.

outBufs must not be NULL, and must point to a valid XDM_BufDesc structure.

outBufs.buf[0] must not be NULL, and must point to a valid buffer of data that is at least outBufs.bufSizes[0] bytes in length.

The buffers in inBufs and outBufs are physically contiguous and owned by the calling application.

Postcondition:

The algorithm must not modify the contents of inBufs. That is, the data and buffers pointed to by these parameters must be treated as read-only.

The buffers in inBufs and outBufs are owned by the calling application.

Return values:

	IALG_EOK	Success.
	IALG_EFAIL	Failure. See ISPHDEC_OutArgs::extendedError for more detailed further error conditions.

XDAS_Int32(* ISPHDEC_Fxns::control)(ISPHDEC_Handle handle, ISPHDEC_Cmd id, ISPHDEC_DynamicParams *params, ISPHDEC_Status *status)

Control behaviour of an algorithm.

Parameters:

[in]	handle	Handle to an algorithm instance.
[in]	id	Command id. See XDM_CmdId.
[in]	params	Dynamic parameters. This is a required parameter.
[out]	status	Output results. This is a required parameter.

Precondition:

handle must be a valid algorithm instance handle.

params must not be NULL, and must point to a valid ISPHDEC_DynamicParams structure.

status must not be NULL, and must point to a valid ISPHDEC_Status structure.

Postcondition:

The algorithm must not modify the contents of params. That is, the data pointed to by this parameter must be treated as read-only.

Return values:

	IALG_EOK	Success.
	IALG_EFAIL	Failure. See ISPHDEC_Status::extendedError for more detailed further error conditions.

---

The documentation for this struct was generated from the following file:

• isphdec.h