Kwave::NoiseDialog Class Reference

#include <NoiseDialog.h>

Inheritance diagram for Kwave::NoiseDialog:

Collaboration diagram for Kwave::NoiseDialog:

Signals
void	levelChanged (double level)
void	startPreListen ()
void	stopPreListen ()

Public Member Functions
	NoiseDialog (QWidget *parent, Kwave::OverViewCache *overview_cache)
virtual	~NoiseDialog () 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_PERCENT = 0, MODE_DECIBEL = 1 }

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

Protected Member Functions
void	setMode (Mode mode)
void	updateDisplay (double value)

Private Slots
void	invokeHelp ()

Private Attributes
double	m_noise
Mode	m_mode
bool	m_enable_updates
Kwave::OverViewCache *	m_overview_cache

Detailed Description

Definition at line 37 of file NoiseDialog.h.

Member Enumeration Documentation

Mode

enum Kwave::NoiseDialog::Mode

protected

Mode for amplification selection by percentage or by decibel

Enumerator
MODE_PERCENT
MODE_DECIBEL

Definition at line 106 of file NoiseDialog.h.

                     {
            MODE_PERCENT = 0,
            MODE_DECIBEL = 1
        } Mode;

Constructor & Destructor Documentation

NoiseDialog()

Kwave::NoiseDialog::NoiseDialog	(	QWidget *	parent,
		Kwave::OverViewCache *	overview_cache
	)

Constructor

Definition at line 44 of file NoiseDialog.cpp.

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

    :QDialog(parent), Kwave::PluginSetupDialog(), Ui::NoiseDlg(),
     m_noise(0.1), m_mode(MODE_DECIBEL),
     m_enable_updates(true), m_overview_cache(overview_cache)
{
    setupUi(this);
    setModal(true);

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

    // changes in the slider or spinbox
    connect(slider, SIGNAL(valueChanged(int)),
            this, SLOT(sliderChanged(int)));
    connect(spinbox, SIGNAL(valueChanged(int)),
            this, SLOT(spinboxChanged(int)));
    // click to the "Listen" button
    connect(btListen, SIGNAL(toggled(bool)),
            this, SLOT(listenToggled(bool)));

    // force activation of the layout
    layout()->activate();

    // give the preview image a odd height, for better symmetry
    int h = preview->height();
    if (~h & 1) h++;
    preview->setFixedHeight(h);

    // 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
    h     = (sizeHint().height() * 12) / 10;
    int w = (3 * h) / 4;
    if (sizeHint().width() > w) w = sizeHint().width();
    setFixedSize(w, h);

    // set default: 10%
    setMode(m_mode);
    updateDisplay(+0.1);

    connect(buttonBox_Help->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:

~NoiseDialog()

Kwave::NoiseDialog::~NoiseDialog ( )

virtual

Destructor

Definition at line 102 of file NoiseDialog.cpp.

References listenToggled(), and m_overview_cache.

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

    delete m_overview_cache;
    m_overview_cache = Q_NULLPTR;
}

Here is the call graph for this function:

Member Function Documentation

dialog()

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

inlinevirtual

retruns a pointer to this as a QDialog

Implements Kwave::PluginSetupDialog.

Definition at line 57 of file NoiseDialog.h.

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

{ return this; }

Here is the call graph for this function:

invokeHelp

void Kwave::NoiseDialog::invokeHelp ( )

privateslot

invoke the online help

Definition at line 376 of file NoiseDialog.cpp.

References _.

Referenced by dialog(), and NoiseDialog().

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

Here is the caller graph for this function:

levelChanged

void Kwave::NoiseDialog::levelChanged ( double  level )

signal

Emitted whenever the noise level changes

Parameters

level

the noise level [0 .. 1.0]

Referenced by dialog(), and updateDisplay().

Here is the caller graph for this function:

listenStopped

void Kwave::NoiseDialog::listenStopped ( )

protectedslot

called when the pre-listen mode stopped/aborted

Definition at line 370 of file NoiseDialog.cpp.

Referenced by dialog().

{
    if (btListen) btListen->setChecked(false);
}

Here is the caller graph for this function:

listenToggled

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

protectedslot

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

Definition at line 353 of file NoiseDialog.cpp.

References startPreListen(), and stopPreListen().

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

{
    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::NoiseDialog::modeChanged ( bool  )

protectedslot

called when the mode radio buttons changed

Definition at line 150 of file NoiseDialog.cpp.

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

Referenced by dialog(), and NoiseDialog().

{
    bool old_enable_updates = m_enable_updates;
    m_enable_updates = false;

    if (rbPercentage->isChecked())  setMode(MODE_PERCENT);
    if (rbLogarithmic->isChecked()) setMode(MODE_DECIBEL);

    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::NoiseDialog::params ( )

virtual

Returns the parameters as string list

Implements Kwave::PluginSetupDialog.

Definition at line 323 of file NoiseDialog.cpp.

References m_mode, and m_noise.

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

setMode()

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

protected

Sets a new volume selection mode

Definition at line 112 of file NoiseDialog.cpp.

References m_enable_updates, m_mode, m_noise, MODE_DECIBEL, MODE_PERCENT, and updateDisplay().

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

{
    double value = m_noise;
    m_mode = mode;
    bool old_enable_updates = m_enable_updates;
    m_enable_updates = false;

    switch (m_mode) {
        case MODE_PERCENT: {
            rbPercentage->setChecked(true);

            slider->setMinimum(1);
            slider->setMaximum(100);
            slider->setPageStep(100);
            slider->setTickInterval(10);
            spinbox->setMinimum(1);
            spinbox->setMaximum(100);
            break;
        }
        case MODE_DECIBEL: {
            rbLogarithmic->setChecked(true);

            slider->setMinimum(-21);
            slider->setMaximum(0);
            slider->setPageStep(6);
            slider->setTickInterval(3);
            spinbox->setMinimum(-21);
            spinbox->setMaximum(0);
            break;
        }
    }

    // update the value in the display
    updateDisplay(value);
    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::NoiseDialog::setParams ( QStringList &  params )

virtual

Sets the from a list of parameters

Implements Kwave::PluginSetupDialog.

Definition at line 332 of file NoiseDialog.cpp.

References m_mode, m_noise, MODE_DECIBEL, MODE_PERCENT, setMode(), and updateDisplay().

{
    // evaluate the parameter list
    double factor = params[0].toDouble();
    factor = qBound<double>(0.0, factor, 1.0);

    switch (params[1].toUInt()) {
        case 0:  m_mode = MODE_PERCENT; break;
        case 1:  m_mode = MODE_DECIBEL; break;
        default: m_mode = MODE_DECIBEL;
    }

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

    // update factor
    updateDisplay(factor);
}

Here is the call graph for this function:

sliderChanged

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

protectedslot

called when the slider's position has changed

Definition at line 293 of file NoiseDialog.cpp.

References m_enable_updates, and spinboxChanged().

Referenced by dialog(), and NoiseDialog().

{
    if (!m_enable_updates) return;

    int sv = slider->maximum() + slider->minimum() - pos;
    spinboxChanged(sv);
}

Here is the call graph for this function:

Here is the caller graph for this function:

spinboxChanged

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

protectedslot

called when the spinbox value has changed

Definition at line 302 of file NoiseDialog.cpp.

References m_enable_updates, m_mode, m_noise, MODE_DECIBEL, MODE_PERCENT, and updateDisplay().

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

{
    if (!m_enable_updates) return;

    double factor = m_noise;

    switch (m_mode) {
        case MODE_PERCENT:
            // percentage
            factor = static_cast<double>(pos) / 100.0;
            break;
        case MODE_DECIBEL:
            // decibel
            factor = pow(10.0, pos / 20.0);
            break;
    }

    updateDisplay(factor);
}

Here is the call graph for this function:

Here is the caller graph for this function:

startPreListen

void Kwave::NoiseDialog::startPreListen ( )

signal

Pre-listen mode has been started

Referenced by dialog(), and listenToggled().

Here is the caller graph for this function:

stopPreListen

void Kwave::NoiseDialog::stopPreListen ( )

signal

Pre-listen mode has been stopped

Referenced by dialog(), and listenToggled().

Here is the caller graph for this function:

updateDisplay()

void Kwave::NoiseDialog::updateDisplay ( double  value )

protected

Update the slider position and the spinbox value

Definition at line 162 of file NoiseDialog.cpp.

References _, Kwave::Colors::ColorSet::background, Kwave::OverViewCache::getMinMax(), Kwave::Colors::ColorSet::interpolated, levelChanged(), m_enable_updates, m_mode, m_noise, m_overview_cache, MODE_DECIBEL, MODE_PERCENT, Kwave::Colors::Normal, Kwave::Colors::ColorSet::sample, sample2double(), Kwave::toInt(), and zero().

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

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

    Kwave::OverViewCache::MinMaxArray m_minmax;

    if (!qFuzzyCompare(m_noise, value)) {

        // take over the new factor
        m_noise = value;

        // update the preview widget
        if (m_overview_cache && preview) {
            int width  = preview->width();
            int height = preview->height();
            QColor color_bg    = Kwave::Colors::Normal.background;
            QColor color_sig   = Kwave::Colors::Normal.interpolated;
            QColor color_noise = Kwave::Colors::Normal.sample;

            // get the min/max information
            int count = m_overview_cache->getMinMax(width, m_minmax);

            QImage image(width, height, QImage::Format_ARGB32_Premultiplied);
            QPainter p;
            p.begin(&image);
            p.fillRect(image.rect(), color_bg);

            // calculate scaling factor and (noise level / 2) in pixel
            const int middle = height >> 1;
            const int noise_2 = Kwave::toInt(middle * m_noise);

            /*
             * mixing of noise goes like this:
             *
             * y[t] = x[t] * (1 - n) + noise(t) * n;
             *
             * and has this effect on min/max:
             *
             * [---noise---]          [---noise---]
             *     [min -------------------max]
             * ^     ^    ^           ^     ^     ^
             * |     |    |           |     |     |
             * y1    y2   y3          y4    y5    y6
             */

            for (int x = 0; x < count; ++x) {
                int y2 = Kwave::toInt((sample2double(m_minmax[x].min) *
                    (1.0 - m_noise)) * middle);
                int y5 = Kwave::toInt((sample2double(m_minmax[x].max) *
                    (1.0 - m_noise)) * middle);
                int y1 = y2 - noise_2;
                int y3 = y2 + noise_2;
                int y4 = y5 - noise_2;
                int y6 = y5 + noise_2;

                if (y4 > y3) {
                    // noise around "min" [y1 ... y3]
                    p.setPen(color_noise);
                    p.drawLine(x, middle - y3, x, middle - y1);

                    // noise around "max" [y4 ... y6]
                    p.drawLine(x, middle - y6, x, middle - y4);

                    // original signal [y3 ... y4 ]
                    p.setPen(color_sig);
                    p.drawLine(x, middle - y4, x, middle - y3);
                } else {
                    // only noise [y1 ... y6]
                    p.setPen(color_noise);
                    p.drawLine(x, middle - y6, x, middle - y1);
                }
            }

            // zero line
            p.setCompositionMode(QPainter::CompositionMode_SourceOver);
            p.setPen(Kwave::Colors::Normal.zero);
            p.drawLine(0, middle, width - 1, middle);

            p.end();

            // update the image view
            preview->setImage(image);
        }

        // emit the noise level change to the plugin
        emit levelChanged(m_noise);
    }

    switch (m_mode) {
        case MODE_PERCENT: {
            // factor 1.0 means 100%
            new_spinbox_value = Kwave::toInt(rint(value * 100.0));
            new_slider_value = new_spinbox_value;
            spinbox->setPrefix(_(""));
            spinbox->setSuffix(_("%"));
            spinbox->setInverse(false);
            break;
        }
        case MODE_DECIBEL: {
            // factor 1.0 means 0dB
            if (!qFuzzyIsNull(value))
                new_slider_value = Kwave::toInt(rint(20.0 * log10(value)));
            else
                new_slider_value = 0;
            new_spinbox_value = new_slider_value;
            if (new_spinbox_value >= 0) {
                spinbox->setPrefix(new_spinbox_value ? _("+") : _("+/- "));
            } else {
                // negative value
                spinbox->setPrefix(_(""));
            }
            spinbox->setSuffix(_(" ") + i18n("dB"));
            spinbox->setInverse(false);
            break;
        }
    }

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

    // update the slider, it's inverse => top=maximum, bottom=minimum !
    int sv = slider->maximum() + slider->minimum() - new_slider_value;
    if (slider->value() != sv) slider->setValue(sv);

    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::NoiseDialog::m_enable_updates

private

if false, ignore the signals of slider and spinbox

Definition at line 128 of file NoiseDialog.h.

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

m_mode

Mode Kwave::NoiseDialog::m_mode

private

current mode for noise level selection

Definition at line 125 of file NoiseDialog.h.

Referenced by NoiseDialog(), params(), setMode(), setParams(), spinboxChanged(), and updateDisplay().

m_noise

double Kwave::NoiseDialog::m_noise

private

noise level, as a linear factor [0...1]

Definition at line 120 of file NoiseDialog.h.

Referenced by params(), setMode(), setParams(), spinboxChanged(), and updateDisplay().

m_overview_cache

Kwave::OverViewCache* Kwave::NoiseDialog::m_overview_cache

private

overview cache for calculating the preview image

Definition at line 131 of file NoiseDialog.h.

Referenced by updateDisplay(), and ~NoiseDialog().

---

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

• plugins/noise/NoiseDialog.h
• plugins/noise/NoiseDialog.cpp