Kwave::VolumePlugin Class Reference

#include <VolumePlugin.h>

Inheritance diagram for Kwave::VolumePlugin:

Collaboration diagram for Kwave::VolumePlugin:

Public Member Functions
	VolumePlugin (QObject *parent, const QVariantList &args)
virtual	~VolumePlugin () Q_DECL_OVERRIDE
virtual QStringList *	setup (QStringList &previous_params) Q_DECL_OVERRIDE
virtual void	run (QStringList params) Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::Plugin
	Plugin (QObject *parent, const QVariantList &args)
virtual	~Plugin () Q_DECL_OVERRIDE
virtual QString	name () const
virtual QString	description () const
virtual QString	progressText ()
virtual bool	canClose () const
bool	isRunning () const
bool	shouldStop () const
virtual void	load (QStringList &params)
virtual void	unload ()
virtual int	start (QStringList &params)
virtual int	stop ()
Kwave::PluginManager &	manager () const
Kwave::SignalManager &	signalManager ()
QWidget *	parentWidget () const
QString	signalName ()
virtual sample_index_t	signalLength ()
virtual double	signalRate ()
virtual const QList< unsigned int >	selectedTracks ()
virtual sample_index_t	selection (QList< unsigned int > *tracks=Q_NULLPTR, sample_index_t *left=Q_NULLPTR, sample_index_t *right=Q_NULLPTR, bool expand_if_empty=false)
virtual void	selectRange (sample_index_t offset, sample_index_t length)
virtual void	migrateToActiveContext ()
Public Member Functions inherited from Kwave::Runnable
virtual	~Runnable ()

Protected Member Functions
int	interpreteParameters (QStringList &params)
Protected Member Functions inherited from Kwave::Plugin
int	execute (QStringList &params)
void	emitCommand (const QString &command)
void	use ()
void	setPluginManager (Kwave::PluginManager *new_plugin_manager)
virtual void	run_wrapper (const QVariant &params) Q_DECL_OVERRIDE

Private Attributes
QStringList	m_params
float	m_factor

Additional Inherited Members
Public Slots inherited from Kwave::Plugin
virtual void	setProgressDialogEnabled (bool enable)
virtual void	updateProgress (qreal progress)
virtual void	cancel ()
virtual void	close ()
void	release ()
Signals inherited from Kwave::Plugin
void	sigRunning (Kwave::Plugin *plugin)
void	sigDone (Kwave::Plugin *plugin)
void	sigClosed (Kwave::Plugin *p)
void	sigCommand (const QString &command)
void	setProgressText (const QString &text)

Detailed Description

Definition at line 31 of file VolumePlugin.h.

Constructor & Destructor Documentation

VolumePlugin()

Kwave::VolumePlugin::VolumePlugin	(	QObject *	parent,
		const QVariantList &	args
	)

Constructor

Parameters

parent	reference to our plugin manager
args	argument list [unused]

Definition at line 42 of file VolumePlugin.cpp.

    :Kwave::Plugin(parent, args), m_params(), m_factor(1.0)
{
}

~VolumePlugin()

Kwave::VolumePlugin::~VolumePlugin ( )

virtual

Destructor

Definition at line 48 of file VolumePlugin.cpp.

{
}

Member Function Documentation

interpreteParameters()

int Kwave::VolumePlugin::interpreteParameters ( QStringList &  params )

protected

Reads values from the parameter list

Definition at line 53 of file VolumePlugin.cpp.

References m_factor, and m_params.

Referenced by run(), and setup().

{
    bool ok;
    QString param;

    // evaluate the parameter list
    if (params.count() != 2) return -EINVAL;

    param = params[0];
    m_factor = param.toFloat(&ok);
    Q_ASSERT(ok);
    if (!ok) return -EINVAL;

    param = params[1];
    unsigned int mode = param.toUInt(&ok);
    Q_ASSERT(ok);
    if (!ok || (mode > 2)) return -EINVAL;

    // all parameters accepted
    m_params = params;

    return 0;
}

Here is the caller graph for this function:

run()

void Kwave::VolumePlugin::run ( QStringList  params )

virtual

Does the amplification operation

Parameters

params

list of strings with parameters

Reimplemented from Kwave::Plugin.

Definition at line 121 of file VolumePlugin.cpp.

References Kwave::connect(), Kwave::MultiTrackSource< SOURCE, INITIALIZE >::done(), Kwave::MultiTrackSource< SOURCE, INITIALIZE >::goOn(), interpreteParameters(), m_factor, Kwave::Overwrite, Kwave::Plugin::selectedTracks(), Kwave::Plugin::selection(), Kwave::Plugin::shouldStop(), Kwave::Plugin::signalManager(), Kwave::SinglePassForward, and Kwave::Plugin::updateProgress().

{
    QList<unsigned int> tracks;
    sample_index_t first, last;

    interpreteParameters(params);
    if (!selection(&tracks, &first, &last, true) || tracks.isEmpty())
        return;

    Kwave::UndoTransactionGuard undo_guard(*this, i18n("Volume"));

    // create all objects
    Kwave::MultiTrackReader source(Kwave::SinglePassForward,
        signalManager(), selectedTracks(), first, last);
    Kwave::MultiTrackWriter sink(signalManager(), tracks, Kwave::Overwrite,
        first, last);
    Kwave::MultiTrackSource<Kwave::Mul, true> mul(tracks.count());

    // connect the progress dialog
    connect(&source, SIGNAL(progress(qreal)),
            this,  SLOT(updateProgress(qreal)),
             Qt::BlockingQueuedConnection);

    // connect them
    Kwave::connect(
        source, SIGNAL(output(Kwave::SampleArray)),
        mul,    SLOT(input_a(Kwave::SampleArray)));

    mul.setAttribute(SLOT(set_b(QVariant)),
                     QVariant(m_factor));
    Kwave::connect(
        mul,    SIGNAL(output(Kwave::SampleArray)),
        sink,   SLOT(input(Kwave::SampleArray)));

    // transport the samples
    qDebug("VolumePlugin: filter started...");
    while (!shouldStop() && !source.done()) {
        source.goOn();
        mul.goOn();
    }
    qDebug("VolumePlugin: filter done.");
}

Here is the call graph for this function:

setup()

QStringList * Kwave::VolumePlugin::setup ( QStringList &  previous_params )

virtual

Shows a dialog for selecting a volume.

See also

Kwave::Plugin::setup

Reimplemented from Kwave::Plugin.

Definition at line 78 of file VolumePlugin.cpp.

References interpreteParameters(), Kwave::SignalManager::isEmpty(), m_params, Kwave::Plugin::manager(), Kwave::VolumeDialog::params(), Kwave::Plugin::parentWidget(), Kwave::Plugin::selection(), Kwave::VolumeDialog::setParams(), and Kwave::PluginManager::signalManager().

{
    // try to interprete the previous parameters
    interpreteParameters(previous_params);

    // initialize the overview cache
    Kwave::SignalManager &mgr = manager().signalManager();
    QList<unsigned int> tracks;
    sample_index_t first, last;
    sample_index_t length = selection(&tracks, &first, &last, true);
    Kwave::OverViewCache *overview_cache = new Kwave::OverViewCache(mgr,
        first, length, tracks.isEmpty() ? Q_NULLPTR : &tracks);
    Q_ASSERT(overview_cache);

    // create the setup dialog
    Kwave::VolumeDialog *dialog =
        new Kwave::VolumeDialog(parentWidget(), overview_cache);
    if (!dialog) {
        if (overview_cache) delete overview_cache;
        return Q_NULLPTR;
    }

    if (!m_params.isEmpty()) dialog->setParams(m_params);

    // execute the dialog
    QStringList *list = new QStringList();
    Q_ASSERT(list);
    if (list && dialog->exec()) {
        // user has pressed "OK"
        *list = dialog->params();
    } else {
        // user pressed "Cancel"
        if (list) delete list;
        list = Q_NULLPTR;
    }

    if (dialog)         delete dialog;
    if (overview_cache) delete overview_cache;

    return list;
}

Here is the call graph for this function:

Member Data Documentation

m_factor

float Kwave::VolumePlugin::m_factor

private

amplification factor

Definition at line 70 of file VolumePlugin.h.

Referenced by interpreteParameters(), and run().

m_params

QStringList Kwave::VolumePlugin::m_params

private

List of parameters

Definition at line 67 of file VolumePlugin.h.

Referenced by interpreteParameters(), and setup().

---

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

• plugins/volume/VolumePlugin.h
• plugins/volume/VolumePlugin.cpp