Kwave::AmplifyFreePlugin Class Reference

#include <AmplifyFreePlugin.h>

Inheritance diagram for Kwave::AmplifyFreePlugin:

Collaboration diagram for Kwave::AmplifyFreePlugin:

Public Member Functions
	AmplifyFreePlugin (QObject *parent, const QVariantList &args)
virtual	~AmplifyFreePlugin () Q_DECL_OVERRIDE
virtual QStringList *	setup (QStringList &previous_params) Q_DECL_OVERRIDE
virtual void	run (QStringList params) Q_DECL_OVERRIDE
virtual int	start (QStringList &params) Q_DECL_OVERRIDE
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	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
QString	m_action_name
QStringList	m_params
Kwave::Curve	m_curve
QMap< QString, QString >	m_cmd_map

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

Todo:

add support for logarithmic scale

Definition at line 34 of file AmplifyFreePlugin.h.

Constructor & Destructor Documentation

AmplifyFreePlugin()

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

Constructor

Parameters

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

Definition at line 40 of file AmplifyFreePlugin.cpp.

References _.

    :Kwave::Plugin(parent, args),
     m_action_name(), m_params(), m_curve(), m_cmd_map()
{
    m_cmd_map[_("fade in")]      = i18n("Fade In");
    m_cmd_map[_("fade out")]     = i18n("Fade Out");
    m_cmd_map[_("fade intro")]   = i18n("Fade Intro");
    m_cmd_map[_("fade leadout")] = i18n("Fade Leadout");
}

~AmplifyFreePlugin()

Kwave::AmplifyFreePlugin::~AmplifyFreePlugin ( )

virtual

Destructor

Definition at line 52 of file AmplifyFreePlugin.cpp.

{
}

Member Function Documentation

interpreteParameters()

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

protected

Reads values from the parameter list

Definition at line 57 of file AmplifyFreePlugin.cpp.

References _, Kwave::Curve::fromCommand(), m_action_name, m_cmd_map, m_curve, and m_params.

Referenced by run(), setup(), and start().

{
    // store last parameters
    m_params = params;

    m_action_name = _("");
    if (params.count() < 2) return -1;
    if (params.count() & 1) return -1; // no. of params must be even

    // first list entry == name of operation
    m_action_name = (params[0].length() && m_cmd_map.contains(params[0])) ?
         m_cmd_map[params[0]] : i18n("Amplify Free");

    // convert string list into command again...
    QString cmd = _("curve(");
    for (int i = 1; i < params.count(); ++i) {
        cmd += params[i];
        if ((i + 1) < params.count()) cmd += _(",");
    }
    cmd += _(")");

    // and initialize our curve with it
    m_curve.fromCommand(cmd);

    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

progressText()

QString Kwave::AmplifyFreePlugin::progressText ( )

virtual

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

Reimplemented from Kwave::Plugin.

Definition at line 125 of file AmplifyFreePlugin.cpp.

References m_action_name.

{
    return m_action_name;
}

run()

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

virtual

Does the fade operation

Parameters

params

list of strings with parameters

Reimplemented from Kwave::Plugin.

Definition at line 138 of file AmplifyFreePlugin.cpp.

References Kwave::connect(), Kwave::MultiTrackSource< SOURCE, INITIALIZE >::done(), Kwave::CurveStreamAdapter::goOn(), Kwave::MultiTrackSource< SOURCE, INITIALIZE >::goOn(), interpreteParameters(), m_action_name, m_curve, Kwave::Overwrite, Kwave::Plugin::selectedTracks(), Kwave::Plugin::selection(), Kwave::Plugin::shouldStop(), Kwave::Plugin::signalManager(), Kwave::SinglePassForward, Kwave::MultiTrackSink< SINK, INITIALIZE >::tracks(), and Kwave::Plugin::updateProgress().

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

    interpreteParameters(params);

    Kwave::UndoTransactionGuard undo_guard(*this, m_action_name);

    sample_index_t input_length = selection(&track_list, &first, &last, true);
    unsigned int   tracks       = track_list.count();

    // create all objects
    Kwave::MultiTrackReader source(Kwave::SinglePassForward,
        signalManager(), selectedTracks(), first, last);
    Kwave::CurveStreamAdapter curve(m_curve, input_length);
    Kwave::MultiTrackWriter sink(signalManager(), track_list, Kwave::Overwrite,
        first, last);
    Kwave::MultiTrackSource<Kwave::Mul, true> mul(tracks, this);

    // break if aborted
    if (!sink.tracks()) return;

    // connect them
    bool ok = true;
    if (ok) ok = Kwave::connect(
        source, SIGNAL(output(Kwave::SampleArray)),
        mul,    SLOT(input_a(Kwave::SampleArray)));
    if (ok) ok = Kwave::connect(
        curve,  SIGNAL(output(Kwave::SampleArray)),
        mul,    SLOT(input_b(Kwave::SampleArray)));
    if (ok) ok = Kwave::connect(
        mul,    SIGNAL(output(Kwave::SampleArray)),
        sink,   SLOT(input(Kwave::SampleArray)));
    if (!ok) {
        return;
    }

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

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

Here is the call graph for this function:

setup()

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

virtual

Shows a dialog for editing the amplification curve and emits a command for applying the curve if OK has been pressed.

See also

Kwave::Plugin::setup

Reimplemented from Kwave::Plugin.

Definition at line 85 of file AmplifyFreePlugin.cpp.

References _, DBG, Kwave::Plugin::emitCommand(), Kwave::AmplifyFreeDialog::getCommand(), interpreteParameters(), Kwave::Parser::isDone(), m_params, Kwave::Parser::nextParam(), Kwave::Plugin::parentWidget(), and Kwave::AmplifyFreeDialog::setParams().

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

    // create the setup dialog
    Kwave::AmplifyFreeDialog *dialog =
        new Kwave::AmplifyFreeDialog(parentWidget());
    Q_ASSERT(dialog);
    if (!dialog) return Q_NULLPTR;

    // remove the first list entry (action name), the rest is for the dialog
    if ((m_params.count() > 2) && !(m_params.count() & 1)) {
        QStringList curve_params = m_params;
        curve_params.takeFirst(); // ignore action name
        dialog->setParams(curve_params);
    }

    QStringList *list = new QStringList();
    Q_ASSERT(list);
    if (list && dialog->exec()) {
        // user has pressed "OK"
        *list << _("amplify free");
        QString cmd = dialog->getCommand();
        Kwave::Parser p(cmd);
        while (!p.isDone()) *list << p.nextParam();

        qDebug("setup -> emitCommand('%s')", DBG(cmd));
        emitCommand(cmd);
    } else {
        // user pressed "Cancel"
        if (list) delete list;
        list = Q_NULLPTR;
    }

    if (dialog) delete dialog;
    return list;
}

Here is the call graph for this function:

start()

int Kwave::AmplifyFreePlugin::start ( QStringList &  params )

virtual

See also

Kwave::Plugin::start(), overloaded to get the action name from the parameters

Reimplemented from Kwave::Plugin.

Definition at line 131 of file AmplifyFreePlugin.cpp.

References interpreteParameters(), and Kwave::Plugin::start().

{
    interpreteParameters(params);
    return Kwave::Plugin::start(params);
}

Here is the call graph for this function:

Member Data Documentation

m_action_name

QString Kwave::AmplifyFreePlugin::m_action_name

private

name of the action (untranslated)

Definition at line 83 of file AmplifyFreePlugin.h.

Referenced by interpreteParameters(), progressText(), and run().

m_cmd_map

QMap<QString, QString> Kwave::AmplifyFreePlugin::m_cmd_map

private

map for command name <-> description

Definition at line 92 of file AmplifyFreePlugin.h.

Referenced by interpreteParameters().

m_curve

Kwave::Curve Kwave::AmplifyFreePlugin::m_curve

private

curve used for interpolation

Definition at line 89 of file AmplifyFreePlugin.h.

Referenced by interpreteParameters(), and run().

m_params

QStringList Kwave::AmplifyFreePlugin::m_params

private

List of parameters

Definition at line 86 of file AmplifyFreePlugin.h.

Referenced by interpreteParameters(), and setup().

---

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

• plugins/amplifyfree/AmplifyFreePlugin.h
• plugins/amplifyfree/AmplifyFreePlugin.cpp