Kwave::FilterPlugin Class Reference

#include <FilterPlugin.h>

Inheritance diagram for Kwave::FilterPlugin:

Collaboration diagram for Kwave::FilterPlugin:

Signals
void	sigCancelPressed ()
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)

Public Member Functions
	FilterPlugin (QObject *parent, const QVariantList &args)
virtual	~FilterPlugin () Q_DECL_OVERRIDE
virtual int	interpreteParameters (QStringList &)=0
virtual Kwave::PluginSetupDialog *	createDialog (QWidget *)=0
virtual Kwave::SampleSource *	createFilter (unsigned int tracks)=0
virtual QStringList *	setup (QStringList &previous_params) Q_DECL_OVERRIDE
virtual void	run (QStringList params) Q_DECL_OVERRIDE
virtual bool	paramsChanged ()
virtual void	updateFilter (Kwave::SampleSource *filter, bool force=false)
virtual QString	actionName ()=0
virtual QString	progressText () 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 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 Slots
void	startPreListen ()
void	stopPreListen ()

Private Attributes
QStringList	m_params
bool	m_listen
bool	m_pause
Kwave::SampleSink *	m_sink

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 ()
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

Detailed Description

Definition at line 39 of file FilterPlugin.h.

Constructor & Destructor Documentation

FilterPlugin()

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

Constructor

Parameters

parent	pointer to the corresponding plugin manager
args	argument list, containts internal meta data

Definition at line 41 of file FilterPlugin.cpp.

    :Kwave::Plugin(parent, args),
     m_params(), m_listen(false), m_pause(false), m_sink(Q_NULLPTR)
{
}

~FilterPlugin()

Kwave::FilterPlugin::~FilterPlugin ( )

virtual

Destructor

Definition at line 48 of file FilterPlugin.cpp.

{
}

Member Function Documentation

actionName()

virtual QString Kwave::FilterPlugin::actionName ( )

pure virtual

Returns a verbose name of the performed action. Used for giving the undo action a readable name. The name must already be localized !

Implemented in Kwave::LowPassPlugin, Kwave::NotchFilterPlugin, Kwave::PitchShiftPlugin, Kwave::BandPassPlugin, and Kwave::NoisePlugin.

Referenced by progressText(), and run().

Here is the caller graph for this function:

createDialog()

virtual Kwave::PluginSetupDialog* Kwave::FilterPlugin::createDialog ( QWidget *  )

pure virtual

Creates a setup dialog an returns a pointer to it.

Implemented in Kwave::LowPassPlugin, Kwave::NotchFilterPlugin, Kwave::PitchShiftPlugin, Kwave::BandPassPlugin, and Kwave::NoisePlugin.

Referenced by setup().

Here is the caller graph for this function:

createFilter()

virtual Kwave::SampleSource* Kwave::FilterPlugin::createFilter ( unsigned int  tracks )

pure virtual

Creates a multi-track filter with the given number of tracks

Parameters

tracks

number of tracks that the filter should have

Returns

pointer to the filter or null if failed

Implemented in Kwave::LowPassPlugin, Kwave::NotchFilterPlugin, Kwave::PitchShiftPlugin, Kwave::BandPassPlugin, and Kwave::NoisePlugin.

Referenced by run().

Here is the caller graph for this function:

interpreteParameters()

virtual int Kwave::FilterPlugin::interpreteParameters ( QStringList &  )

pure virtual

Reads values from the parameter list

Implemented in Kwave::LowPassPlugin, Kwave::NotchFilterPlugin, Kwave::PitchShiftPlugin, Kwave::BandPassPlugin, and Kwave::NoisePlugin.

Referenced by run(), and setup().

Here is the caller graph for this function:

paramsChanged()

bool Kwave::FilterPlugin::paramsChanged ( )

virtual

Returns true if the parameters have changed during pre-listen.

Note

this default implementation always returns false.

Reimplemented in Kwave::LowPassPlugin, Kwave::NotchFilterPlugin, Kwave::PitchShiftPlugin, Kwave::BandPassPlugin, and Kwave::NoisePlugin.

Definition at line 192 of file FilterPlugin.cpp.

Referenced by run().

{
    return false;
}

Here is the caller graph for this function:

progressText()

QString Kwave::FilterPlugin::progressText ( )

virtual

Returns a text for the progress dialog if enabled. (should already be localized)

Reimplemented from Kwave::Plugin.

Definition at line 228 of file FilterPlugin.cpp.

References actionName().

{
    return i18n("Applying '%1'...", actionName());
}

Here is the call graph for this function:

run()

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

virtual

Does the filter operation and/or pre-listen

Parameters

params

list of strings with parameters

Reimplemented from Kwave::Plugin.

Definition at line 91 of file FilterPlugin.cpp.

References actionName(), Kwave::connect(), createFilter(), Kwave::SampleSink::done(), Kwave::MultiTrackSource< SOURCE, INITIALIZE >::done(), Kwave::FullSnapshot, Kwave::SampleSource::goOn(), Kwave::MultiTrackSource< SOURCE, INITIALIZE >::goOn(), interpreteParameters(), m_listen, m_params, m_pause, m_sink, Kwave::Overwrite, paramsChanged(), Kwave::MultiTrackReader::reset(), Kwave::Plugin::selection(), Kwave::StreamObject::setInteractive(), Kwave::Plugin::shouldStop(), Kwave::Plugin::signalManager(), Kwave::SinglePassForward, updateFilter(), and Kwave::Plugin::updateProgress().

{
    Kwave::UndoTransactionGuard *undo_guard = Q_NULLPTR;
    m_pause = false;

    if (!interpreteParameters(params)) m_params = params;

    sample_index_t first, last;
    QList<unsigned int> tracks;
    selection(&tracks, &first, &last, true);

    // switch to interactive mode in pre-listen mode
    Kwave::StreamObject::setInteractive(m_listen);

    // create all objects
    Kwave::MultiTrackReader source(
        (m_listen) ? Kwave::FullSnapshot : Kwave::SinglePassForward,
        signalManager(), tracks, first, last);

    Kwave::SampleSource *filter = createFilter(tracks.count());
    Q_ASSERT(filter);

    if (m_listen) {
        // pre-listen mode
        Q_ASSERT(m_sink);
    } else {
        // normal mode, with undo
        undo_guard = new(std::nothrow)
            Kwave::UndoTransactionGuard(*this, actionName());
        Q_ASSERT(undo_guard);
        if (!undo_guard) {
            if (filter) delete filter;
            Kwave::StreamObject::setInteractive(false);
            return;
        }
        m_sink = new(std::nothrow) MultiTrackWriter(signalManager(), tracks,
            Kwave::Overwrite, first, last);
        Q_ASSERT(m_sink);
    }
    if (!filter || !m_sink || m_sink->done()) {
        if (filter)     delete filter;
        if (undo_guard) delete undo_guard;
        if (m_sink)     delete m_sink;
        m_sink = Q_NULLPTR;
        Kwave::StreamObject::setInteractive(false);
        return;
    }

    // set up the progress dialog when in processing (not pre-listen) mode
    if (!m_listen) {
        connect(&source, SIGNAL(progress(qreal)),
                this,    SLOT(updateProgress(qreal)),
                Qt::BlockingQueuedConnection);
    }

    // force initial update of the filter settings
    updateFilter(filter, true);

    // connect them
    Kwave::connect(source,  SIGNAL(output(Kwave::SampleArray)),
                   *filter, SLOT(input(Kwave::SampleArray)));
    Kwave::connect(*filter, SIGNAL(output(Kwave::SampleArray)),
                   *m_sink, SLOT(input(Kwave::SampleArray)));

    // transport the samples
    while (!shouldStop() && (!source.done() || m_listen)) {
        // process one step
        source.goOn();
        filter->goOn();

        // watch out for changed parameters when in
        // pre-listen mode
        if (m_listen && paramsChanged()) {
            updateFilter(filter);
        }

        if (m_listen && source.done()) {
            // start the next loop
            source.reset();
            continue;
        }

        // this lets the process wait if the user pressed cancel
        // and the confirm_cancel dialog is active
        while (m_pause && !shouldStop())
            sleep(1);
    }

    // cleanup
    if (filter)     delete filter;
    if (m_sink)     delete m_sink;
    m_sink = Q_NULLPTR;
    if (undo_guard) delete undo_guard;

    m_pause  = false;
    m_listen = false;

    Kwave::StreamObject::setInteractive(false);
}

Here is the call graph for this function:

setup()

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

virtual

Shows a dialog for setting up the filter plugin

See also

Kwave::Plugin::setup

Reimplemented from Kwave::Plugin.

Definition at line 53 of file FilterPlugin.cpp.

References Kwave::connect(), createDialog(), Kwave::PluginSetupDialog::dialog(), interpreteParameters(), m_params, Kwave::PluginSetupDialog::params(), Kwave::Plugin::parentWidget(), Kwave::PluginSetupDialog::setParams(), Kwave::Plugin::sigDone(), startPreListen(), and stopPreListen().

{
    // try to interpret and use the previous parameters
    if (!interpreteParameters(previous_params))
        m_params = previous_params;

    // create the setup dialog
    Kwave::PluginSetupDialog *setup_dialog = createDialog(parentWidget());
    Q_ASSERT(setup_dialog);
    if (!setup_dialog) return Q_NULLPTR;

    // connect the signals for the pre-listen handling
    QDialog *dlg = setup_dialog->dialog();
    connect(dlg, SIGNAL(startPreListen()),
            this, SLOT(startPreListen()));
    connect(dlg, SIGNAL(stopPreListen()),
            this, SLOT(stopPreListen()));
    connect(this, SIGNAL(sigDone(Kwave::Plugin*)),
            dlg, SLOT(listenStopped()));

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

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

    if (setup_dialog) delete setup_dialog;
    return list;
}

Here is the call graph for this function:

sigCancelPressed

void Kwave::FilterPlugin::sigCancelPressed ( )

signal

emitted when the user pressed the cancel button of the progress dialog

startPreListen

void Kwave::FilterPlugin::startPreListen ( )

protectedslot

Start the pre-listening

Definition at line 205 of file FilterPlugin.cpp.

References Kwave::Plugin::execute(), m_listen, m_sink, Kwave::Plugin::manager(), Kwave::PluginManager::openMultiTrackPlayback(), Kwave::Plugin::selectedTracks(), and Kwave::Plugin::setProgressDialogEnabled().

Referenced by setup().

{
    Q_ASSERT(!m_sink);
    if (m_sink) delete m_sink;
    m_sink = manager().openMultiTrackPlayback(selectedTracks().count());

    if (m_sink) {
        m_listen = true;
        setProgressDialogEnabled(false);
        static QStringList empty_list;
        execute(empty_list);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

stopPreListen

void Kwave::FilterPlugin::stopPreListen ( )

protectedslot

Stop the pre-listening

Definition at line 220 of file FilterPlugin.cpp.

References m_listen, Kwave::Plugin::setProgressDialogEnabled(), and Kwave::Plugin::stop().

Referenced by setup().

{
    stop();
    m_listen = false;
    setProgressDialogEnabled(true);
}

Here is the call graph for this function:

Here is the caller graph for this function:

updateFilter()

void Kwave::FilterPlugin::updateFilter ( Kwave::SampleSource *  filter, bool  force = false  )

virtual

Update the filter with new parameters if it has changed changed during the pre-listen.

Parameters

filter	the Kwave::SampleSource to be updated, should be the same one as created with createFilter()
force	if true, even update if no settings have changed

Reimplemented in Kwave::LowPassPlugin, Kwave::NotchFilterPlugin, Kwave::PitchShiftPlugin, Kwave::BandPassPlugin, and Kwave::NoisePlugin.

Definition at line 198 of file FilterPlugin.cpp.

Referenced by run().

{
    /* default implementation, does nothing */
}

Here is the caller graph for this function:

Member Data Documentation

m_listen

bool Kwave::FilterPlugin::m_listen

private

flag for indicating pre-listen mode

Definition at line 132 of file FilterPlugin.h.

Referenced by run(), startPreListen(), and stopPreListen().

m_params

QStringList Kwave::FilterPlugin::m_params

private

List of parameters

Definition at line 129 of file FilterPlugin.h.

Referenced by run(), and setup().

m_pause

bool Kwave::FilterPlugin::m_pause

private

flag for pausing the process

Definition at line 135 of file FilterPlugin.h.

Referenced by run().

m_sink

Kwave::SampleSink* Kwave::FilterPlugin::m_sink

private

a sample sink, used either for pre-listen or for normal processing

Definition at line 141 of file FilterPlugin.h.

Referenced by run(), and startPreListen().

---

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

• libgui/FilterPlugin.h
• libgui/FilterPlugin.cpp