lmms::DispersionEffect Class Reference

#include <Dispersion.h>

Inheritance diagram for lmms::DispersionEffect:

Classes
struct	FilterState

Public Member Functions
	DispersionEffect (Model *parent, const Descriptor::SubPluginFeatures::Key *key)
	~DispersionEffect () override=default
ProcessStatus	processImpl (SampleFrame *buf, const f_cnt_t frames) override
EffectControls *	controls () override
void	runDispersionAP (const int filtNum, const float apCoeff1, const float apCoeff2, std::array< sample_t, 2 > &put)
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	isCorrupted () const
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)
	Constructor of a plugin.
	~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)
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 Types
using	Filter = std::array<sample_t, MAX_DISPERSION_FILTERS * 2>

Private Attributes
DispersionControls	m_dispersionControls
float	m_sampleRate
int	m_amountVal
FilterState	m_state = {}
std::array< float, 2 >	m_feedbackVal {}
std::array< float, 2 >	m_integrator {}

Friends
class	DispersionControls

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)

Member Typedef Documentation

Filter

using lmms::DispersionEffect::Filter = std::array<sample_t, MAX_DISPERSION_FILTERS * 2>

private

Constructor & Destructor Documentation

DispersionEffect()

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

~DispersionEffect()

lmms::DispersionEffect::~DispersionEffect ( )

overridedefault

Member Function Documentation

controls()

EffectControls * lmms::DispersionEffect::controls ( )

inlineoverridevirtual

Implements lmms::Effect.

processImpl()

Effect::ProcessStatus lmms::DispersionEffect::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.

runDispersionAP()

void lmms::DispersionEffect::runDispersionAP	(	const int	filtNum,
		const float	apCoeff1,
		const float	apCoeff2,
		std::array< sample_t, 2 > &	put )

Friends And Related Symbol Documentation

DispersionControls

friend class DispersionControls

friend

Member Data Documentation

m_amountVal

int lmms::DispersionEffect::m_amountVal

private

m_dispersionControls

DispersionControls lmms::DispersionEffect::m_dispersionControls

private

m_feedbackVal

std::array<float, 2> lmms::DispersionEffect::m_feedbackVal {}

private

m_integrator

std::array<float, 2> lmms::DispersionEffect::m_integrator {}

private

m_sampleRate

float lmms::DispersionEffect::m_sampleRate

private

m_state

FilterState lmms::DispersionEffect::m_state = {}

private

---

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

• plugins/Dispersion/Dispersion.h
• plugins/Dispersion/Dispersion.cpp