Class fx_pitch_shift

Inheritance Relationships

Base Type

Class Documentation

class fx_pitch_shift : public fx_effect

Effect: Pitch shifter - shifts audio up or down in pitch.

This is a de-glitching, time-domain based implmentation. Also see the fx_pitch_shift_fd pitch shifter which provides a frequency-domain based approach (phase vocoder).

Public Functions

fx_pitch_shift(float pitch_shift_freq)
void enable()

Enable the pitch shifter (it is enabled by default)

void bypass()

Bypass the pitch shifter (will just pass clean audio through)

void set_freq_shift(float freq_shift)

Update the pitch shifter value. A freq_shift of 0.5 will drop down one octave. A value of 2.0 will go up one octave. A value of 1.0 will play at current pitch (no shift).

Parameters

  • [in] freq_shift: The frequency shift

void print_params(void)

Print the parameters for this effect.

Public Members

fx_audio_node *input

Audio routing node: primary audio input

fx_audio_node *output

Audio routing node: primary audio output

fx_control_node *freq_shift