lmms::FrequencyShifterEffect Class Reference

#include <FrequencyShifterEffect.h>

Inheritance diagram for lmms::FrequencyShifterEffect:

Public Member Functions
	FrequencyShifterEffect (Model *parent, const Descriptor::SubPluginFeatures::Key *key)
	~FrequencyShifterEffect () override=default
ProcessStatus	processImpl (SampleFrame *buf, const f_cnt_t frames) override
EffectControls *	controls () override
Public Member Functions inherited from lmms::Effect
	Effect (const Plugin::Descriptor *_desc, Model *_parent, const Descriptor::SubPluginFeatures::Key *_key)
void	saveSettings (QDomDocument &_doc, QDomElement &_parent) override
void	loadSettings (const QDomElement &_this) override
QString	nodeName () const override
bool	processAudioBuffer (AudioBuffer &inOut)
	Returns true if audio was processed and should continue being processed.
bool	isOkay () const
void	setOkay (bool _state)
bool	isAwake () const
	"Awake" means the effect has not been put to sleep by auto-quit
bool	isEnabled () const
f_cnt_t	timeout () const
float	wetLevel () const
float	dryLevel () const
bool	dontRun () const
void	setDontRun (bool _state)
bool	isProcessingAudio () const
TempoSyncKnobModel *	autoQuitModel ()
bool	autoQuitEnabled () const
EffectChain *	effectChain () const
Public Member Functions inherited from lmms::Plugin
	Plugin (const Descriptor *descriptor, Model *parent, const Descriptor::SubPluginFeatures::Key *key=nullptr)
	~Plugin () override=default
QString	displayName () const override
	Return display-name out of sub plugin or descriptor.
const PixmapLoader *	logo () const
	Return logo out of sub plugin or descriptor.
Type	type () const
	Return plugin type.
const Descriptor *	descriptor () const
	Return plugin Descriptor.
const Descriptor::SubPluginFeatures::Key &	key () const
virtual void	loadFile (const QString &file)
virtual AutomatableModel *	childModel (const QString &modelName)
gui::PluginView *	createView (QWidget *parent)
	Create a view for the model.
Public Member Functions inherited from lmms::Model
	Model (Model *parent, QString displayName=QString(), bool defaultConstructed=false)
	~Model () override=default
bool	isDefaultConstructed () const
Model *	parentModel () const
virtual void	setDisplayName (const QString &displayName)
virtual QString	fullDisplayName () const
Public Member Functions inherited from lmms::JournallingObject
	JournallingObject ()
	~JournallingObject () override
jo_id_t	id () const
void	saveJournallingState (const bool newState)
void	restoreJournallingState ()
void	addJournalCheckPoint ()
QDomElement	saveState (QDomDocument &_doc, QDomElement &_parent) override
void	restoreState (const QDomElement &_this) override
bool	isJournalling () const
void	setJournalling (const bool _sr)
bool	testAndSetJournalling (const bool newState)
bool	isJournallingStateStackEmpty () const
Public Member Functions inherited from lmms::SerializingObject
	SerializingObject ()
virtual	~SerializingObject ()
void	setHook (SerializingObjectHook *_hook)
SerializingObjectHook *	hook ()

Private Slots
void	updateSampleRate ()

Private Member Functions
std::array< float, 2 >	getHermiteSample (int indexFloor, float fraction)

Private Attributes
HilbertIIRFloat< 2 >	m_hilbert1
HilbertIIRFloat< 2 >	m_hilbert2
std::vector< std::array< float, 2 > >	m_ringBuf
std::array< float, 2 >	m_phase {}
std::array< float, 2 >	m_trueShift {}
std::array< float, 2 >	m_dampState {}
std::array< float, 2 >	m_toneState {}
float	m_lfoPhase {}
float	m_truePhase {}
float	m_trueDelay {1.f}
float	m_twoPiOverSr {}
float	m_sampleRate {}
int	m_ringBufSize {}
int	m_writeIndex {}
bool	m_prevResetShifter {}
bool	m_prevResetLfo {}
FrequencyShifterControls	m_controls

Additional Inherited Members
Public Types inherited from lmms::Plugin
enum class	Type {   Instrument , Effect , ImportFilter , ExportFilter ,   Tool , Library , Other , Undefined = 255 }
using	DescriptorList = QList<Descriptor*>
Signals inherited from lmms::Model
void	dataChanged ()
void	dataUnchanged ()
void	propertiesChanged ()
Static Public Member Functions inherited from lmms::Effect
static Effect *	instantiate (const QString &_plugin_name, Model *_parent, Descriptor::SubPluginFeatures::Key *_key)
Static Public Member Functions inherited from lmms::Plugin
static Plugin *	instantiateWithKey (const QString &pluginName, Model *parent, const Descriptor::SubPluginFeatures::Key *key, bool keyFromDnd=false)
static Plugin *	instantiate (const QString &pluginName, Model *parent, void *data)
Protected Types inherited from lmms::Effect
enum class	ProcessStatus { Continue , ContinueIfNotQuiet , Sleep }
Protected Member Functions inherited from lmms::Effect
virtual void	processBypassedImpl ()
gui::PluginView *	instantiateView (QWidget *) override
	Create a view for the model.
void	goToSleep ()
void	wakeUp ()
virtual void	onEnabledChanged ()
Protected Member Functions inherited from lmms::Plugin
void	collectErrorForUI (QString errMsg)
Protected Member Functions inherited from lmms::JournallingObject
void	changeID (jo_id_t _id)

Constructor & Destructor Documentation

FrequencyShifterEffect()

lmms::FrequencyShifterEffect::FrequencyShifterEffect	(	Model *	parent,
		const Descriptor::SubPluginFeatures::Key *	key )

~FrequencyShifterEffect()

lmms::FrequencyShifterEffect::~FrequencyShifterEffect ( )

overridedefault

Member Function Documentation

controls()

EffectControls * lmms::FrequencyShifterEffect::controls ( )

inlineoverridevirtual

Implements lmms::Effect.

getHermiteSample()

std::array< float, 2 > lmms::FrequencyShifterEffect::getHermiteSample ( int indexFloor, float fraction )

inlineprivate

processImpl()

Effect::ProcessStatus lmms::FrequencyShifterEffect::processImpl ( SampleFrame * buf, const f_cnt_t frames )

overridevirtual

The main audio processing method that runs when plugin is awake and running

Implements lmms::Effect.

updateSampleRate

void lmms::FrequencyShifterEffect::updateSampleRate ( )

privateslot

Member Data Documentation

m_controls

FrequencyShifterControls lmms::FrequencyShifterEffect::m_controls

private

m_dampState

std::array<float, 2> lmms::FrequencyShifterEffect::m_dampState {}

private

m_hilbert1

HilbertIIRFloat<2> lmms::FrequencyShifterEffect::m_hilbert1

private

m_hilbert2

HilbertIIRFloat<2> lmms::FrequencyShifterEffect::m_hilbert2

private

m_lfoPhase

float lmms::FrequencyShifterEffect::m_lfoPhase {}

private

m_phase

std::array<float, 2> lmms::FrequencyShifterEffect::m_phase {}

private

m_prevResetLfo

bool lmms::FrequencyShifterEffect::m_prevResetLfo {}

private

m_prevResetShifter

bool lmms::FrequencyShifterEffect::m_prevResetShifter {}

private

m_ringBuf

std::vector<std::array<float, 2> > lmms::FrequencyShifterEffect::m_ringBuf

private

m_ringBufSize

int lmms::FrequencyShifterEffect::m_ringBufSize {}

private

m_sampleRate

float lmms::FrequencyShifterEffect::m_sampleRate {}

private

m_toneState

std::array<float, 2> lmms::FrequencyShifterEffect::m_toneState {}

private

m_trueDelay

float lmms::FrequencyShifterEffect::m_trueDelay {1.f}

private

m_truePhase

float lmms::FrequencyShifterEffect::m_truePhase {}

private

m_trueShift

std::array<float, 2> lmms::FrequencyShifterEffect::m_trueShift {}

private

m_twoPiOverSr

float lmms::FrequencyShifterEffect::m_twoPiOverSr {}

private

m_writeIndex

int lmms::FrequencyShifterEffect::m_writeIndex {}

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/FrequencyShifter/FrequencyShifterEffect.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/FrequencyShifter/FrequencyShifterEffect.cpp