Kwave::ZeroPlugin Class Reference

#include <ZeroPlugin.h>

Inheritance diagram for Kwave::ZeroPlugin:

Collaboration diagram for Kwave::ZeroPlugin:

Public Member Functions
	ZeroPlugin (QObject *parent, const QVariantList &args)
virtual	~ZeroPlugin () 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 QStringList *	setup (QStringList &previous_params)
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 ()

Private Attributes
Kwave::SampleArray	m_zeroes

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

This is a very simple plugin that blanks the currently selected range of samples with zeroes.

Definition at line 37 of file ZeroPlugin.h.

Constructor & Destructor Documentation

ZeroPlugin()

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

Constructor

Parameters

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

Definition at line 43 of file ZeroPlugin.cpp.

    :Kwave::Plugin(parent, args), m_zeroes()
{
}

~ZeroPlugin()

Kwave::ZeroPlugin::~ZeroPlugin ( )

virtual

Destructor

Definition at line 49 of file ZeroPlugin.cpp.

{
}

Member Function Documentation

run()

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

virtual

Fills the selected area with zeroes

Parameters

params

list of strings with parameters

Reimplemented from Kwave::Plugin.

Definition at line 54 of file ZeroPlugin.cpp.

References Kwave::SelectTimeWidget::byPercents, Kwave::SelectTimeWidget::bySamples, Kwave::SelectTimeWidget::byTime, Kwave::connect(), Kwave::SampleArray::fill(), Kwave::Insert, m_zeroes, Kwave::Overwrite, Kwave::SampleArray::resize(), Kwave::Plugin::selection(), Kwave::Plugin::shouldStop(), Kwave::Plugin::signalLength(), Kwave::Plugin::signalManager(), Kwave::Plugin::signalRate(), Kwave::SampleArray::size(), Kwave::SelectTimeWidget::timeToSamples(), Kwave::toUint(), Kwave::MultiTrackSink< SINK, INITIALIZE >::tracks(), Kwave::Plugin::updateProgress(), and ZERO_COUNT.

{
    QList<unsigned int> tracks;
    sample_index_t first = 0;
    sample_index_t last  = 0;
    bool succeeded = true;

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

    Kwave::MultiTrackWriter *writers = Q_NULLPTR;

    /*
     * new mode: insert a range filled with silence:
     * -> usage: zero(<mode>, <range>)
     */
    if (params.count() == 2) {
        // get the current selection
        selection(&tracks, &first, &last, false);

        // mode for the time (like in selectrange plugin)
        bool ok = true;
        int mode = params[0].toInt(&ok);
        Q_ASSERT(ok);
        if (!ok) return;
        Q_ASSERT(
            (mode == static_cast<int>(Kwave::SelectTimeWidget::byTime)) ||
            (mode == static_cast<int>(Kwave::SelectTimeWidget::bySamples)) ||
            (mode == static_cast<int>(Kwave::SelectTimeWidget::byPercents))
        );
        if ((mode != static_cast<int>(Kwave::SelectTimeWidget::byTime)) &&
            (mode != static_cast<int>(Kwave::SelectTimeWidget::bySamples)) &&
            (mode != static_cast<int>(Kwave::SelectTimeWidget::byPercents)))
        {
            return;
        }

        // length of the range of zeroes to insert
        unsigned int time = params[1].toUInt(&ok);
        Q_ASSERT(ok);
        if (!ok) return;

        // convert from time to samples
        sample_index_t length = Kwave::SelectTimeWidget::timeToSamples(
            static_cast<Kwave::SelectTimeWidget::Mode>(mode),
            time, signalRate(), signalLength());

        // some sanity check
        Q_ASSERT(length);
        Q_ASSERT(!tracks.isEmpty());
        if (!length || tracks.isEmpty()) return; // nothing to do

        last  = first + length - 1;
        writers = new(std::nothrow) Kwave::MultiTrackWriter(signalManager(),
            tracks, Kwave::Insert, first, last);
    } else {
        writers = new(std::nothrow) Kwave::MultiTrackWriter(signalManager(),
            Kwave::Overwrite);
    }

    if (!writers) return; // out-of-memory

    // break if aborted
    if (!writers->tracks()) return;

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

    first = (*writers)[0]->first();
    last  = (*writers)[0]->last();
    unsigned int count = writers->tracks();

    // get the buffer with zeroes for faster filling
    if (m_zeroes.size() != ZERO_COUNT) {
        succeeded &= m_zeroes.resize(ZERO_COUNT);
        Q_ASSERT(succeeded);
        m_zeroes.fill(0);
    }
    Q_ASSERT(m_zeroes.size() == ZERO_COUNT);

    // loop over the sample range
    while ((first <= last) && !shouldStop() && succeeded) {
        sample_index_t rest = last - first + 1;
        if (rest < m_zeroes.size()) {
            succeeded &= m_zeroes.resize(Kwave::toUint(rest));
            Q_ASSERT(succeeded);
            if (!succeeded) break;
        }

        // loop over all writers
        unsigned int w;
        for (w = 0; w < count; w++) {
            *((*writers)[w]) << m_zeroes;
        }

        first += m_zeroes.size();
    }

    delete writers;
}

Here is the call graph for this function:

Member Data Documentation

m_zeroes

Kwave::SampleArray Kwave::ZeroPlugin::m_zeroes

private

use an array with zeroes for faster filling

Definition at line 62 of file ZeroPlugin.h.

Referenced by run().

---

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

• plugins/zero/ZeroPlugin.h
• plugins/zero/ZeroPlugin.cpp