#include <PitchShiftPlugin.h>

Inheritance diagram for Kwave::PitchShiftPlugin:

Collaboration diagram for Kwave::PitchShiftPlugin:

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

virtual	~PitchShiftPlugin () 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	setValues (double speed, double frequency)

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_speed

double	m_frequency

bool	m_percentage_mode

double	m_last_speed

double	m_last_freq

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 PitchShiftPlugin.h.

Constructor & Destructor Documentation

◆ PitchShiftPlugin()

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

Constructor

Parameters

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

Definition at line 34 of file PitchShiftPlugin.cpp.

     :Kwave::FilterPlugin(parent, args),
      m_speed(1.0), m_frequency(5.0), m_percentage_mode(false),
      m_last_speed(0), m_last_freq(0)
 {
 }

◆ ~PitchShiftPlugin()

Kwave::PitchShiftPlugin::~PitchShiftPlugin ( )

virtual

Destructor

Definition at line 43 of file PitchShiftPlugin.cpp.

44 {

45 }

Member Function Documentation

◆ actionName()

QString Kwave::PitchShiftPlugin::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 122 of file PitchShiftPlugin.cpp.

 {
     return i18n("Pitch Shift");
 }

◆ createDialog()

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

virtual

Creates the setup dialog and connects it's signals

Implements Kwave::FilterPlugin.

Definition at line 75 of file PitchShiftPlugin.cpp.

References Kwave::connect(), and setValues().

 {
     Kwave::PitchShiftDialog *dialog = new Kwave::PitchShiftDialog(parent);
     Q_ASSERT(dialog);
     if (!dialog) return Q_NULLPTR;
 
     // connect the signals for detecting value changes in pre-listen mode
     connect(dialog, SIGNAL(changed(double,double)),
             this, SLOT(setValues(double,double)));
 
     return dialog;
 }

Here is the call graph for this function:

◆ createFilter()

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

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

◆ interpreteParameters()

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

protectedvirtual

Reads values from the parameter list

Implements Kwave::FilterPlugin.

Definition at line 48 of file PitchShiftPlugin.cpp.

References m_frequency, m_percentage_mode, and m_speed.

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

◆ paramsChanged()

bool Kwave::PitchShiftPlugin::paramsChanged ( )

virtual

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

Reimplemented from Kwave::FilterPlugin.

Definition at line 95 of file PitchShiftPlugin.cpp.

References m_frequency, m_last_freq, m_last_speed, and m_speed.

 {
     return (!qFuzzyCompare(m_speed, m_last_speed) ||
             !qFuzzyCompare(m_frequency, m_last_freq));
 }

◆ setValues

void Kwave::PitchShiftPlugin::setValues	(	double	speed,
		double	frequency
	)

protectedslot

Called when the parameters of the pre-listen have changed

Parameters

speed	the speed factor, floating point
frequency	the frequency parameter in Hz

Definition at line 128 of file PitchShiftPlugin.cpp.

References m_frequency, and m_speed.

Referenced by createDialog().

 {
     m_frequency = frequency;
     m_speed     = speed;
 }

Here is the caller graph for this function:

◆ updateFilter()

void Kwave::PitchShiftPlugin::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 102 of file PitchShiftPlugin.cpp.

References m_frequency, m_last_freq, m_last_speed, m_speed, 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_speed, m_last_speed) || force)
         filter->setAttribute(SLOT(setSpeed(QVariant)),
             QVariant(m_speed));
 
     m_last_freq  = m_frequency;
     m_last_speed = m_speed;
 }

Here is the call graph for this function:

Member Data Documentation

◆ m_frequency

double Kwave::PitchShiftPlugin::m_frequency

private

base frequency

Definition at line 106 of file PitchShiftPlugin.h.

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

◆ m_last_freq

double Kwave::PitchShiftPlugin::m_last_freq

private

last value of m_frequency

Definition at line 115 of file PitchShiftPlugin.h.

Referenced by paramsChanged(), and updateFilter().

◆ m_last_speed

double Kwave::PitchShiftPlugin::m_last_speed

private

last value of m_speed

Definition at line 112 of file PitchShiftPlugin.h.

Referenced by paramsChanged(), and updateFilter().

◆ m_percentage_mode

bool Kwave::PitchShiftPlugin::m_percentage_mode

private

mode for selecting speed (factor or percentage)

Definition at line 109 of file PitchShiftPlugin.h.

Referenced by interpreteParameters().

◆ m_speed

double Kwave::PitchShiftPlugin::m_speed

private

speed factor

Definition at line 103 of file PitchShiftPlugin.h.

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

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

plugins/pitch_shift/PitchShiftPlugin.h
plugins/pitch_shift/PitchShiftPlugin.cpp

Public Member Functions

Protected Slots

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PitchShiftPlugin()

◆ ~PitchShiftPlugin()

Member Function Documentation

◆ actionName()

◆ createDialog()

◆ createFilter()

◆ interpreteParameters()

◆ paramsChanged()

◆ setValues

◆ updateFilter()

Member Data Documentation

◆ m_frequency

◆ m_last_freq

◆ m_last_speed

◆ m_percentage_mode

◆ m_speed