Kwave::PitchShiftDialog Class Reference

#include <PitchShiftDialog.h>

Inheritance diagram for Kwave::PitchShiftDialog:

Collaboration diagram for Kwave::PitchShiftDialog:

Signals
void	changed (double speed, double freq)
void	startPreListen ()
void	stopPreListen ()

Public Member Functions
	PitchShiftDialog (QWidget *parent)
virtual	~PitchShiftDialog () Q_DECL_OVERRIDE
virtual QStringList	params () Q_DECL_OVERRIDE
virtual void	setParams (QStringList &params) Q_DECL_OVERRIDE
virtual QDialog *	dialog () Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::PluginSetupDialog
virtual	~PluginSetupDialog ()

Protected Types
enum	Mode { MODE_FACTOR = 0, MODE_PERCENT = 1 }

Protected Slots
void	modeChanged (bool)
void	sliderChanged (int pos)
void	spinboxChanged (int pos)
void	frequencyChanged (int pos)
void	listenToggled (bool listen)
void	listenStopped ()

Protected Member Functions
void	setMode (Mode mode)
void	updateSpeed (double speed)

Private Slots
void	invokeHelp ()

Private Attributes
double	m_speed
double	m_frequency
Mode	m_mode
bool	m_enable_updates

Detailed Description

Definition at line 35 of file PitchShiftDialog.h.

Member Enumeration Documentation

Mode

enum Kwave::PitchShiftDialog::Mode

protected

Mode for amplification selection by factor (x1, x2, x5,...) or by percentage

Enumerator
MODE_FACTOR
MODE_PERCENT

Definition at line 108 of file PitchShiftDialog.h.

                     {
            MODE_FACTOR  = 0,
            MODE_PERCENT = 1
        } Mode;

Constructor & Destructor Documentation

PitchShiftDialog()

Kwave::PitchShiftDialog::PitchShiftDialog ( QWidget *  parent )

explicit

Constructor

Definition at line 37 of file PitchShiftDialog.cpp.

References Kwave::connect(), frequencyChanged(), invokeHelp(), listenToggled(), m_mode, modeChanged(), setMode(), sliderChanged(), and spinboxChanged().

    :QDialog(parent), Ui::PitchShiftDlg(), Kwave::PluginSetupDialog(),
     m_speed(1.0), m_frequency(5.0), m_mode(MODE_FACTOR),
     m_enable_updates(true)
{
    setupUi(this);
    setModal(true);

    setMode(m_mode);

    // process changed in mode selection
    connect(rbFactor, SIGNAL(toggled(bool)),
            this, SLOT(modeChanged(bool)));
    connect(rbPercentage, SIGNAL(toggled(bool)),
            this, SLOT(modeChanged(bool)));

    // changes in the speed slider or spinbox
    connect(slSpeed, SIGNAL(valueChanged(int)),
            this, SLOT(sliderChanged(int)));
    connect(sbSpeed, SIGNAL(valueChanged(int)),
            this, SLOT(spinboxChanged(int)));

    // changes in the frequency spinbox
    connect(sbFrequency, SIGNAL(valueChanged(int)),
            this, SLOT(frequencyChanged(int)));

    // click to the "Listen" button
    connect(btListen, SIGNAL(toggled(bool)),
            this, SLOT(listenToggled(bool)));

    // expand the "Listen" button to it's maximum width
    listenToggled(true);
    if (btListen->width() > btListen->minimumWidth())
        btListen->setMinimumWidth(btListen->width());
    listenToggled(false);
    if (btListen->width() > btListen->minimumWidth())
        btListen->setMinimumWidth(btListen->width());

    // set the initial size of the dialog
    setFixedHeight(sizeHint().height());
    int w = (height() * 3) / 5;
    if (width() < w) resize(w, height());

    connect(btHelp->button(QDialogButtonBox::Help), SIGNAL(clicked()),
            this,   SLOT(invokeHelp()));

    // set the focus onto the "OK" button
    buttonBox->button(QDialogButtonBox::Ok)->setFocus();
}

Here is the call graph for this function:

~PitchShiftDialog()

Kwave::PitchShiftDialog::~PitchShiftDialog ( )

virtual

Destructor

Definition at line 88 of file PitchShiftDialog.cpp.

References listenToggled().

{
    // better stop pre-listen now
    listenToggled(false);
}

Here is the call graph for this function:

Member Function Documentation

changed

void Kwave::PitchShiftDialog::changed ( double  speed, double  freq  )

signal

Emitted whenever the speed or the frequency changes

Parameters

speed	the speed factor, floating point
freq	the frequency parameter in Hz

Referenced by dialog(), frequencyChanged(), sliderChanged(), and spinboxChanged().

Here is the caller graph for this function:

dialog()

virtual QDialog* Kwave::PitchShiftDialog::dialog ( )

inlinevirtual

retruns a pointer to this as a QDialog

Implements Kwave::PluginSetupDialog.

Definition at line 55 of file PitchShiftDialog.h.

References changed(), frequencyChanged(), invokeHelp(), listenStopped(), listenToggled(), modeChanged(), sliderChanged(), spinboxChanged(), startPreListen(), and stopPreListen().

{ return this; }

Here is the call graph for this function:

frequencyChanged

void Kwave::PitchShiftDialog::frequencyChanged ( int  pos )

protectedslot

called if the frequency sbinbox value has changed

Definition at line 276 of file PitchShiftDialog.cpp.

References changed(), m_frequency, and m_speed.

Referenced by dialog(), and PitchShiftDialog().

{
    // emit changes
    if (!qFuzzyCompare(m_frequency, pos)) {
        m_frequency = pos;
        emit changed(m_speed, m_frequency);
    }
}

Here is the caller graph for this function:

invokeHelp

void Kwave::PitchShiftDialog::invokeHelp ( )

privateslot

invoke the online help

Definition at line 344 of file PitchShiftDialog.cpp.

References _.

Referenced by dialog(), and PitchShiftDialog().

{
    KHelpClient::invokeHelp(_("plugin_sect_pitch_shift"));
}

Here is the caller graph for this function:

listenStopped

void Kwave::PitchShiftDialog::listenStopped ( )

protectedslot

called when the pre-listen mode stopped/aborted

Definition at line 334 of file PitchShiftDialog.cpp.

Referenced by dialog().

{
    Q_ASSERT(btListen);
    if (!btListen) return;

    btListen->setChecked(false);
}

Here is the caller graph for this function:

listenToggled

void Kwave::PitchShiftDialog::listenToggled ( bool  listen )

protectedslot

called when the "Listen" button has been toggled, to start or stop the pre-listen mode

Definition at line 317 of file PitchShiftDialog.cpp.

References startPreListen(), and stopPreListen().

Referenced by dialog(), PitchShiftDialog(), and ~PitchShiftDialog().

{
    Q_ASSERT(btListen);
    if (!btListen) return;

    if (listen) {
        // start pre-listen mode
        emit startPreListen();
        btListen->setText(i18n("&Stop"));
    } else {
        // stop pre-listen mode
        emit stopPreListen();
        btListen->setText(i18n("&Listen"));
    }
}

Here is the caller graph for this function:

modeChanged

void Kwave::PitchShiftDialog::modeChanged ( bool  )

protectedslot

called when the mode radio buttons changed

Definition at line 138 of file PitchShiftDialog.cpp.

References m_enable_updates, MODE_FACTOR, MODE_PERCENT, and setMode().

Referenced by dialog(), and PitchShiftDialog().

{
    bool old_enable_updates = m_enable_updates;
    m_enable_updates = false;

    if (rbFactor->isChecked())      setMode(MODE_FACTOR);
    if (rbPercentage->isChecked())  setMode(MODE_PERCENT);

    m_enable_updates = old_enable_updates;
}

Here is the call graph for this function:

Here is the caller graph for this function:

params()

QStringList Kwave::PitchShiftDialog::params ( )

virtual

Returns the parameters as string list

Implements Kwave::PluginSetupDialog.

Definition at line 286 of file PitchShiftDialog.cpp.

References m_frequency, m_mode, and m_speed.

{
    QStringList list;
    list << QString::number(m_speed);
    list << QString::number(m_frequency);
    list << QString::number(static_cast<int>(m_mode));
    return list;
}

setMode()

void Kwave::PitchShiftDialog::setMode ( Mode  mode )

protected

Sets a new volume selection mode

Definition at line 95 of file PitchShiftDialog.cpp.

References m_enable_updates, m_mode, m_speed, MODE_FACTOR, MODE_PERCENT, and updateSpeed().

Referenced by modeChanged(), PitchShiftDialog(), and setParams().

{
    double speed = m_speed;
    m_mode = mode;
    bool old_enable_updates = m_enable_updates;
    m_enable_updates = false;

    switch (m_mode) {
        case MODE_FACTOR: {
            rbFactor->setChecked(true);

            slSpeed->setMinimum(-9);
            slSpeed->setMaximum(+4);
            slSpeed->setPageStep(1);
            slSpeed->setTickInterval(1);

            sbSpeed->setMinimum(-10);
            sbSpeed->setMaximum(+10);
            sbSpeed->setSingleStep(1);
            break;
        }
        case MODE_PERCENT: {
            rbPercentage->setChecked(true);

            slSpeed->setMinimum(1);
            slSpeed->setMaximum(400);
            slSpeed->setPageStep(10);
            slSpeed->setTickInterval(50);

            sbSpeed->setMinimum(1);
            sbSpeed->setMaximum(400);
            sbSpeed->setSingleStep(1);
            break;
        }
    }

    // update the spped value in the display
    m_speed = speed;
    updateSpeed(m_speed);
    m_enable_updates = old_enable_updates;
}

Here is the call graph for this function:

Here is the caller graph for this function:

setParams()

void Kwave::PitchShiftDialog::setParams ( QStringList &  params )

virtual

Sets the from a list of parameters

Implements Kwave::PluginSetupDialog.

Definition at line 296 of file PitchShiftDialog.cpp.

References m_frequency, m_mode, m_speed, MODE_FACTOR, MODE_PERCENT, setMode(), and updateSpeed().

{
    // evaluate the parameter list
    double speed = params[0].toDouble();
    m_frequency  = params[1].toDouble();
    switch (params[2].toUInt()) {
        case 0: m_mode = MODE_FACTOR;  break;
        case 1: m_mode = MODE_PERCENT; break;
        default: m_mode = MODE_PERCENT;
    }

    // update mode, using default factor 1.0
    m_speed = 1.0; // works with every mode
    setMode(m_mode);

    // update speed factor
    m_speed = speed;
    updateSpeed(speed);
}

Here is the call graph for this function:

sliderChanged

void Kwave::PitchShiftDialog::sliderChanged ( int  pos )

protectedslot

called when the speed slider's position has changed

Definition at line 209 of file PitchShiftDialog.cpp.

References changed(), m_enable_updates, m_frequency, m_mode, m_speed, MODE_FACTOR, MODE_PERCENT, spinboxChanged(), and updateSpeed().

Referenced by dialog(), and PitchShiftDialog().

{
    if (!m_enable_updates) return;

    double last_speed = m_speed;

    switch (m_mode) {
        case MODE_FACTOR: {
            // -1 <=> /2
            //  0 <=> x1
            // +1 <=> x2
            if (pos >= 0) {
                m_speed = (pos + 1);
            } else {
                m_speed = -1.0 / static_cast<double>(pos - 1);
            }
            updateSpeed(m_speed);
            break;
        }
        case MODE_PERCENT:
            spinboxChanged(pos);
            break;
    }

    // emit changes
    if (!qFuzzyCompare(m_speed, last_speed)) {
        emit changed(m_speed, m_frequency);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

spinboxChanged

void Kwave::PitchShiftDialog::spinboxChanged ( int  pos )

protectedslot

called when the spped spinbox value has changed

Definition at line 240 of file PitchShiftDialog.cpp.

References changed(), m_enable_updates, m_frequency, m_mode, m_speed, MODE_FACTOR, MODE_PERCENT, and updateSpeed().

Referenced by dialog(), PitchShiftDialog(), and sliderChanged().

{
    if (!m_enable_updates) return;

    double last_speed = m_speed;
    int sv = sbSpeed->value();
    switch (m_mode) {
        case MODE_FACTOR: {
            // multiply or divide by factor
            // -1 <=> /2
            //  0 <=> x1
            // +1 <=> x2
            if (m_speed >= 1) {
                m_speed = sv ? sv : 0.5;
            } else {
                if (!sv) sv = 1;
                m_speed = 1.0 / static_cast<double>(sv);
            }
            break;
        }
        case MODE_PERCENT: {
            // percentage
            m_speed = static_cast<double>(pos) / 100.0;
            break;
        }
    }

    // emit changes
    if (!qFuzzyCompare(m_speed, last_speed)) {
        emit changed(m_speed, m_frequency);
    }

    updateSpeed(m_speed);
}

Here is the call graph for this function:

Here is the caller graph for this function:

startPreListen

void Kwave::PitchShiftDialog::startPreListen ( )

signal

Pre-listen mode has been started

Referenced by dialog(), and listenToggled().

Here is the caller graph for this function:

stopPreListen

void Kwave::PitchShiftDialog::stopPreListen ( )

signal

Pre-listen mode has been stopped

Referenced by dialog(), and listenToggled().

Here is the caller graph for this function:

updateSpeed()

void Kwave::PitchShiftDialog::updateSpeed ( double  speed )

protected

Update the speed slider position and the speed spinbox value

Definition at line 150 of file PitchShiftDialog.cpp.

References _, m_enable_updates, m_mode, m_speed, MODE_FACTOR, MODE_PERCENT, and Kwave::toInt().

Referenced by setMode(), setParams(), sliderChanged(), and spinboxChanged().

{
    int new_spinbox_value = 0;
    int new_slider_value  = 0;
    bool old_enable_updates = m_enable_updates;
    m_enable_updates = false;

    switch (m_mode) {
        case MODE_FACTOR: {
            // -1 => /2
            //  0 => x1
            // +1 => x2
            if (Kwave::toInt(m_speed) >= 1) {
                // greater or equal to one -> multiply
                int new_value = Kwave::toInt(speed);
                sbSpeed->setPrefix(_("x "));
                sbSpeed->setSuffix(_(""));
                sbSpeed->setInverse(false);

                new_spinbox_value = new_value;
                new_slider_value = new_value-1;
            } else {
                // less than one -> divide
                int new_value = Kwave::toInt(-1.0 / speed);

                sbSpeed->setPrefix(_("1/"));
                sbSpeed->setSuffix(_(""));
                sbSpeed->setInverse(true);

                new_spinbox_value = -1*new_value;
                new_slider_value  = (new_value+1);
            }

            m_enable_updates = old_enable_updates;
            break;
        }
        case MODE_PERCENT: {
            // factor 1.0 means 100%
            new_spinbox_value = Kwave::toInt(rint(speed * 100.0));
            new_slider_value = new_spinbox_value;
            sbSpeed->setPrefix(_(""));
            sbSpeed->setSuffix(_("%"));
            sbSpeed->setInverse(false);
            break;
        }
    }

    // update the spinbox
    if (sbSpeed->value() != new_spinbox_value)
        sbSpeed->setValue(new_spinbox_value);

    // update the slider
    if (slSpeed->value() != new_slider_value)
        slSpeed->setValue(new_slider_value);

    m_enable_updates = old_enable_updates;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_enable_updates

bool Kwave::PitchShiftDialog::m_enable_updates

private

if false, ignore the signals of slider and spinbox

Definition at line 131 of file PitchShiftDialog.h.

Referenced by modeChanged(), setMode(), sliderChanged(), spinboxChanged(), and updateSpeed().

m_frequency

double Kwave::PitchShiftDialog::m_frequency

private

base frequency,

See also

aRts documentation

Definition at line 125 of file PitchShiftDialog.h.

Referenced by frequencyChanged(), params(), setParams(), sliderChanged(), and spinboxChanged().

m_mode

Mode Kwave::PitchShiftDialog::m_mode

private

mode for selecting speed (factor or percentage)

Definition at line 128 of file PitchShiftDialog.h.

Referenced by params(), PitchShiftDialog(), setMode(), setParams(), sliderChanged(), spinboxChanged(), and updateSpeed().

m_speed

double Kwave::PitchShiftDialog::m_speed

private

speed factor

Definition at line 122 of file PitchShiftDialog.h.

Referenced by frequencyChanged(), params(), setMode(), setParams(), sliderChanged(), spinboxChanged(), and updateSpeed().

---

The documentation for this class was generated from the following files:

• plugins/pitch_shift/PitchShiftDialog.h
• plugins/pitch_shift/PitchShiftDialog.cpp