#include <NotchFilterPlugin.h>

Inheritance diagram for Kwave::NotchFilterPlugin:

Collaboration diagram for Kwave::NotchFilterPlugin:

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

virtual	~NotchFilterPlugin () 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	setFreqValue (double frequency)

void	setBwValue (double bw)

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_frequency

double	m_last_freq

double	m_bw

double	m_last_bw

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 37 of file NotchFilterPlugin.h.

Constructor & Destructor Documentation

◆ NotchFilterPlugin()

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

Constructor

Parameters

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

Definition at line 35 of file NotchFilterPlugin.cpp.

     :Kwave::FilterPlugin(parent, args),
      m_frequency(3500.0), m_last_freq(100), m_bw(100), m_last_bw(200)
 {
 }

◆ ~NotchFilterPlugin()

Kwave::NotchFilterPlugin::~NotchFilterPlugin ( )

virtual

Destructor

Definition at line 43 of file NotchFilterPlugin.cpp.

44 {

45 }

Member Function Documentation

◆ actionName()

QString Kwave::NotchFilterPlugin::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 119 of file NotchFilterPlugin.cpp.

 {
     return i18n("Notch Filter");
 }

◆ createDialog()

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

virtual

Creates the setup dialog and connects it's signals

Implements Kwave::FilterPlugin.

Definition at line 70 of file NotchFilterPlugin.cpp.

References Kwave::connect(), setBwValue(), setFreqValue(), and Kwave::Plugin::signalRate().

 {
     Kwave::NotchFilterDialog *dialog =
         new Kwave::NotchFilterDialog(parent, signalRate());
     Q_ASSERT(dialog);
     if (!dialog) return Q_NULLPTR;
 
     // connect the signals for detecting value changes in pre-listen mode
     connect(dialog, SIGNAL(freqChanged(double)),
             this, SLOT(setFreqValue(double)));
     connect(dialog, SIGNAL(bwChanged(double)),
             this, SLOT(setBwValue(double)));
     return dialog;
 }

Here is the call graph for this function:

◆ createFilter()

Kwave::SampleSource * Kwave::NotchFilterPlugin::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 86 of file NotchFilterPlugin.cpp.

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

◆ interpreteParameters()

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

protectedvirtual

Reads values from the parameter list

Implements Kwave::FilterPlugin.

Definition at line 48 of file NotchFilterPlugin.cpp.

References m_bw, and m_frequency.

 {
     bool ok;
     QString param;
 
     // evaluate the parameter list
     if (params.count() != 2) return -EINVAL;
 
     param = params[0];
     m_frequency = param.toDouble(&ok);
     Q_ASSERT(ok);
     if (!ok) return -EINVAL;
 
     param = params[1];
     m_bw = param.toDouble(&ok);
     Q_ASSERT(ok);
     if (!ok) return -EINVAL;
 
     return 0;
 }

◆ paramsChanged()

bool Kwave::NotchFilterPlugin::paramsChanged ( )

virtual

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

Reimplemented from Kwave::FilterPlugin.

Definition at line 92 of file NotchFilterPlugin.cpp.

References m_bw, m_frequency, m_last_bw, and m_last_freq.

 {
     return (!qFuzzyCompare(m_frequency, m_last_freq) ||
             !qFuzzyCompare(m_bw, m_last_bw));
 }

◆ setBwValue

void Kwave::NotchFilterPlugin::setBwValue ( double bw )

protectedslot

set a new bandwidth

Parameters

bw	bandwidth [Hz]

Definition at line 131 of file NotchFilterPlugin.cpp.

References m_bw.

Referenced by createDialog().

 {
     m_bw = bw;
 }

Here is the caller graph for this function:

◆ setFreqValue

void Kwave::NotchFilterPlugin::setFreqValue ( double frequency )

protectedslot

Called when the parameter changed during pre-listen

Parameters

frequency the frequency parameter in Hz

Definition at line 125 of file NotchFilterPlugin.cpp.

References m_frequency.

Referenced by createDialog().

 {
     m_frequency = frequency;
 }

Here is the caller graph for this function:

◆ updateFilter()

void Kwave::NotchFilterPlugin::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 99 of file NotchFilterPlugin.cpp.

References m_bw, m_frequency, m_last_bw, m_last_freq, Kwave::StreamObject::setAttribute(), and Kwave::Plugin::signalRate().

 {
     double sr = signalRate();
 
     if (!filter) return;
 
     if (!qFuzzyCompare(m_frequency, m_last_freq) || force)
         filter->setAttribute(SLOT(setFrequency(QVariant)),
             QVariant((m_frequency * 2.0 * M_PI) / sr));
 
     if (!qFuzzyCompare(m_bw, m_last_bw) || force)
         filter->setAttribute(SLOT(setBandwidth(QVariant)),
             QVariant((m_bw * 2.0 * M_PI) / sr));
 
     m_last_freq  = m_frequency;
     m_last_bw    = m_bw;
 }

Here is the call graph for this function:

Member Data Documentation

◆ m_bw

double Kwave::NotchFilterPlugin::m_bw

private

bandwidth value [Hz]

Definition at line 114 of file NotchFilterPlugin.h.

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

◆ m_frequency

double Kwave::NotchFilterPlugin::m_frequency

private

cutoff frequency [Hz]

Definition at line 108 of file NotchFilterPlugin.h.

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

◆ m_last_bw

double Kwave::NotchFilterPlugin::m_last_bw

private

last value of m_bw

Definition at line 117 of file NotchFilterPlugin.h.

Referenced by paramsChanged(), and updateFilter().

◆ m_last_freq

double Kwave::NotchFilterPlugin::m_last_freq

private

last value of m_frequency

Definition at line 111 of file NotchFilterPlugin.h.

Referenced by paramsChanged(), and updateFilter().

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

plugins/notch_filter/NotchFilterPlugin.h
plugins/notch_filter/NotchFilterPlugin.cpp

Public Member Functions

Protected Slots

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NotchFilterPlugin()

◆ ~NotchFilterPlugin()

Member Function Documentation

◆ actionName()

◆ createDialog()

◆ createFilter()

◆ interpreteParameters()

◆ paramsChanged()

◆ setBwValue

◆ setFreqValue

◆ updateFilter()

Member Data Documentation

◆ m_bw

◆ m_frequency

◆ m_last_bw

◆ m_last_freq