#include <NoisePlugin.h>

Inheritance diagram for Kwave::NoisePlugin:

Collaboration diagram for Kwave::NoisePlugin:

Public Member Functions
	NoisePlugin (QObject *parent, const QVariantList &args)

virtual	~NoisePlugin () Q_DECL_OVERRIDE

virtual Kwave::PluginSetupDialog *	createDialog (QWidget *parent) Q_DECL_OVERRIDE

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

virtual bool	paramsChanged () Q_DECL_OVERRIDE

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

virtual QString	actionName () Q_DECL_OVERRIDE

Public Member Functions inherited from Kwave::FilterPlugin
	FilterPlugin (QObject *parent, const QVariantList &args)

virtual	~FilterPlugin () Q_DECL_OVERRIDE

virtual QStringList *	setup (QStringList &previous_params) Q_DECL_OVERRIDE

virtual void	run (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	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	setNoiseLevel (double level)

Protected Slots inherited from Kwave::FilterPlugin
void	startPreListen ()

void	stopPreListen ()

Protected Member Functions
virtual int	interpreteParameters (QStringList &params) Q_DECL_OVERRIDE

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
double	m_level

double	m_last_level

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

Detailed Description

Definition at line 30 of file NoisePlugin.h.

Constructor & Destructor Documentation

◆ NoisePlugin()

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

Constructor

Parameters

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

Definition at line 43 of file NoisePlugin.cpp.

     :Kwave::FilterPlugin(parent, args), m_level(1.0), m_last_level(0.0)
 {
 }

◆ ~NoisePlugin()

Kwave::NoisePlugin::~NoisePlugin ( )

virtual

Destructor

Definition at line 49 of file NoisePlugin.cpp.

50 {

51 }

Member Function Documentation

◆ actionName()

QString Kwave::NoisePlugin::actionName ( )

virtual

Returns a verbose name of the performed action. Used for giving the undo action a readable name.

Implements Kwave::FilterPlugin.

Definition at line 132 of file NoisePlugin.cpp.

 {
     return i18n("Add Noise");
 }

◆ createDialog()

Kwave::PluginSetupDialog * Kwave::NoisePlugin::createDialog ( QWidget * parent )

virtual

Creates the setup dialog and connects it's signals

Implements Kwave::FilterPlugin.

Definition at line 77 of file NoisePlugin.cpp.

References Kwave::connect(), Kwave::SignalManager::isEmpty(), Kwave::Plugin::manager(), Kwave::Plugin::parentWidget(), Kwave::Plugin::selection(), setNoiseLevel(), and Kwave::PluginManager::signalManager().

 {
     Q_UNUSED(parent);
 
     // 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(std::nothrow) Kwave::OverViewCache(mgr, first, length,
             tracks.isEmpty() ? Q_NULLPTR : &tracks);
     Q_ASSERT(overview_cache);
 
     // create the setup dialog
     Kwave::NoiseDialog *dialog =
         new Kwave::NoiseDialog(parentWidget(), overview_cache);
     if (!dialog) {
         if (overview_cache) delete overview_cache;
         return Q_NULLPTR;
     }
 
     // connect the signals for detecting value changes in pre-listen mode
     connect(dialog, SIGNAL(levelChanged(double)),
             this,   SLOT(setNoiseLevel(double)));
 
     return dialog;
 }

Here is the call graph for this function:

◆ createFilter()

Kwave::SampleSource * Kwave::NoisePlugin::createFilter ( unsigned int tracks )

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

Implements Kwave::FilterPlugin.

Definition at line 107 of file NoisePlugin.cpp.

 {
     return new Kwave::MultiTrackSource<Kwave::NoiseGenerator, true>(tracks);
 }

◆ interpreteParameters()

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

protectedvirtual

Reads values from the parameter list

Implements Kwave::FilterPlugin.

Definition at line 54 of file NoisePlugin.cpp.

References m_level.

 {
     bool ok;
     QString param;
 
     // evaluate the parameter list
     if (params.count() != 2) return -EINVAL;
 
     param = params[0];
     m_level = param.toDouble(&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
     return 0;
 }

◆ paramsChanged()

bool Kwave::NoisePlugin::paramsChanged ( )

virtual

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

Reimplemented from Kwave::FilterPlugin.

Definition at line 113 of file NoisePlugin.cpp.

References m_last_level, and m_level.

 {
     return (!qFuzzyCompare(m_level, m_last_level));
 }

◆ setNoiseLevel

void Kwave::NoisePlugin::setNoiseLevel ( double level )

protectedslot

called when the noise level setting changed during pre-listen

Parameters

level noise level, as a factor between 0 and 1

Definition at line 138 of file NoisePlugin.cpp.

References m_level.

Referenced by createDialog(), and updateFilter().

 {
     m_level = level;
 }

Here is the caller graph for this function:

◆ updateFilter()

void Kwave::NoisePlugin::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 from Kwave::FilterPlugin.

Definition at line 119 of file NoisePlugin.cpp.

References m_last_level, m_level, Kwave::StreamObject::setAttribute(), and setNoiseLevel().

 {
     if (!filter) return;
 
     if (!qFuzzyCompare(m_level, m_last_level) || force)
         filter->setAttribute(SLOT(setNoiseLevel(QVariant)),
                              QVariant(m_level));
 
     m_last_level = m_level;
 }

Here is the call graph for this function:

Member Data Documentation

◆ m_last_level

double Kwave::NoisePlugin::m_last_level

private

last value of m_level

Definition at line 97 of file NoisePlugin.h.

Referenced by paramsChanged(), and updateFilter().

◆ m_level

double Kwave::NoisePlugin::m_level

private

noise level, as linear factor ]0 ... 1.0]

Definition at line 94 of file NoisePlugin.h.

Referenced by interpreteParameters(), paramsChanged(), setNoiseLevel(), and updateFilter().

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

plugins/noise/NoisePlugin.h
plugins/noise/NoisePlugin.cpp

Public Member Functions

Protected Slots

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NoisePlugin()

◆ ~NoisePlugin()

Member Function Documentation

◆ actionName()

◆ createDialog()

◆ createFilter()

◆ interpreteParameters()

◆ paramsChanged()

◆ setNoiseLevel

◆ updateFilter()

Member Data Documentation

◆ m_last_level

◆ m_level