Prosody speech processing: API: sm_add_input_freq_coeffs

Prototype Definition

int sm_add_input_freq_coeffs(struct sm_input_freq_coeffs_parms *freqcoeffp)

Parameters

*freqcoeffp

a structure of the following type:

typedef struct sm_input_freq_coeffs_parms {
	tSMModuleId module;					/* in */
	double upper_limit;					/* in */
	double lower_limit;					/* in */
	tSM_INT id;						/* out */
} SM_INPUT_FREQ_COEFFS_PARMS;

Description

This call may be used to add a pair of input frequency coefficients (upper_limit, lower_limit specified in Hz) to the repertoire of those supported by the given module. These coefficients are used to specify upper and lower rejection frequencies for tone recognition. On return id will be set to an identifier for the new input frequency coefficient pair.

See Prosody speech processing: pre-loaded input tones for list of predefined frequency coefficients.

See Prosody speech processing: Details of tone detection algorithm for more details on choosing upper and lower rejection limits for a given input frequency.

Fields

module

The module whose tone set if to be modified.

upper_limit

The upper frequency boundary (in Hz).

lower_limit

The lower frequency boundary (in Hz).

id

The identifier of the tone added.

Returns

0 if call completed successfully, otherwise a standard error such as:

• ERR_SM_DEVERR - device error
• ERR_SM_NO_SUCH_MODULE - if no such module exists
• ERR_SM_NO_RESOURCES - if no resources to store new coefficients
• ERR_SM_BAD_PARAMETER - if frequency or amplitude parameter out of range
• ERR_SM_CHANNEL_ALLOCATED - channel still allocated

This function is part of the Prosody speech processing API.