#include <Oscilloscope.h>

Inheritance diagram for lmms::Oscilloscope:

Public Member Functions
	Oscilloscope (Model parent, const Descriptor::SubPluginFeatures::Key key)
ProcessStatus	processImpl (SampleFrame *buf, const f_cnt_t frames) override
EffectControls *	controls () override
LocklessRingBuffer< SampleFrame > &	inputBuffer ()
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 ()

Static Public Attributes
static constexpr int	InputBufferSize = 4096 * 4

Private Attributes
OscilloscopeControls	m_controls
LocklessRingBuffer< SampleFrame >	m_inputBuffer

Friends
class	OscilloscopeControls

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

◆ Oscilloscope()

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

Member Function Documentation

◆ controls()

EffectControls * lmms::Oscilloscope::controls ( )

inlineoverridevirtual

Implements lmms::Effect.

◆ inputBuffer()

LocklessRingBuffer< SampleFrame > & lmms::Oscilloscope::inputBuffer ( )

inline

◆ processImpl()

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

◆ OscilloscopeControls

friend class OscilloscopeControls

friend

Member Data Documentation

◆ InputBufferSize

int lmms::Oscilloscope::InputBufferSize = 4096 * 4

staticconstexpr

Ring buffer size for the data being transfered from the audio thread to the gui thread This is not the history length! The actual size of the history buffer is defined in OscilloscopeGraph.h

◆ m_controls

OscilloscopeControls lmms::Oscilloscope::m_controls

private

◆ m_inputBuffer

LocklessRingBuffer<SampleFrame> lmms::Oscilloscope::m_inputBuffer

private

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

plugins/Oscilloscope/Oscilloscope.h
plugins/Oscilloscope/Oscilloscope.cpp

Public Member Functions

Static Public Attributes

Private Attributes

Friends

Additional Inherited Members