Prosody signal path processing: API: sm_path_pitchshift

Prototype Definition

int sm_path_pitchshift(struct sm_path_pitchshift_parms *pitchshiftp)

Parameters

*pitchshiftp
a structure of the following type:
typedef struct sm_path_pitchshift_parms {
	tSMPathId path;						/* in */
	float shift;						/* in */
} SM_PATH_PITCHSHIFT_PARMS;

Description

Configures pitch shifting on a signal path.

Requires the module pitchshift.

Fields

path
The signal path to be configured
shift
The number of octaves by which the signal is to be shifted. Values less than zero cause a downward shift (for example, the value -0.08333 configures a shift down one semitone), values greater than zero cause an upward shift, and the value zero disables pitch shifting.

Returns

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


This function is part of the Prosody signal path processing API.