#include <Patman.h>

Inheritance diagram for lmms::PatmanInstrument:

Classes
struct	handle_data

Public Slots
void	setFile (const QString &_patch_file, bool _rename=true)

Signals
void	fileChanged ()
Signals inherited from lmms::Model
void	dataChanged ()
void	dataUnchanged ()
void	propertiesChanged ()

Public Member Functions
	PatmanInstrument (InstrumentTrack *_track)
	~PatmanInstrument () override
void	playNote (NotePlayHandle _n, SampleFrame _working_buffer) override
void	deleteNotePluginData (NotePlayHandle *_n) override
void	saveSettings (QDomDocument &_doc, QDomElement &_parent) override
void	loadSettings (const QDomElement &_this) override
void	loadFile (const QString &_file) override
QString	nodeName () const override
float	desiredReleaseTimeMs () const override
gui::PluginView *	instantiateView (QWidget *_parent) override
	Create a view for the model.
Public Member Functions inherited from lmms::Instrument
	Instrument (InstrumentTrack _instrument_track, const Descriptor _descriptor, const Descriptor::SubPluginFeatures::Key *key=nullptr, Flags flags=Flag::NoFlags)
	~Instrument () override=default
virtual bool	hasNoteInput () const
virtual void	play (SampleFrame *_working_buffer)
virtual auto	midiPatch () const -> std::optional< MidiPatch >
	For applicable instruments: Provides host with current MIDI bank and program.
virtual auto	childModel (std::string_view modelName) -> AutomatableModel *
virtual f_cnt_t	beatLen (NotePlayHandle *_n) const
f_cnt_t	desiredReleaseFrames () const
sample_rate_t	getSampleRate () const
bool	isSingleStreamed () const
bool	isMidiBased () const
bool	isBendable () const
virtual bool	handleMidiEvent (const MidiEvent &, const TimePos &=TimePos(), f_cnt_t offset=0)
QString	fullDisplayName () const override
virtual bool	isFromTrack (const Track *_track) const
InstrumentTrack *	instrumentTrack () 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
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)
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
enum class	LoadError { OK , Open , NotGUS , Instruments , Layers , IO }

Private Member Functions
LoadError	loadPatch (const QString &_filename)
void	unloadCurrentPatch ()
void	selectSample (NotePlayHandle *_n)

Private Attributes
QString	m_patchFile
QVector< std::shared_ptr< Sample > >	m_patchSamples
BoolModel	m_loopedModel
BoolModel	m_tunedModel

Friends
class	gui::PatmanView

Additional Inherited Members
Public Types inherited from lmms::Instrument
enum class	Flag { NoFlags = 0x00 , IsSingleStreamed = 0x01 , IsMidiBased = 0x02 , IsNotBendable = 0x04 }
using	Flags = lmms::Flags<Flag>
Public Types inherited from lmms::Plugin
enum class	Type { Instrument , Effect , ImportFilter , ExportFilter , Tool , Library , Other , Undefined = 255 }
using	DescriptorList = QList<Descriptor*>
Static Public Member Functions inherited from lmms::Instrument
static Instrument *	instantiate (const QString &_plugin_name, InstrumentTrack _instrument_track, const Plugin::Descriptor::SubPluginFeatures::Key key, bool keyFromDnd=false)
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 Member Functions inherited from lmms::Instrument
void	applyFadeIn (SampleFrame buf, NotePlayHandle n)
void	applyRelease (SampleFrame buf, const NotePlayHandle _n)
float	computeReleaseTimeMsByFrameCount (f_cnt_t frames) const
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 Enumeration Documentation

◆ LoadError

enum class lmms::PatmanInstrument::LoadError

strongprivate

Enumerator
OK
Open
NotGUS
Instruments
Layers
IO

Constructor & Destructor Documentation

◆ PatmanInstrument()

lmms::PatmanInstrument::PatmanInstrument ( InstrumentTrack * _track )

◆ ~PatmanInstrument()

lmms::PatmanInstrument::~PatmanInstrument ( )

override

Member Function Documentation

◆ deleteNotePluginData()

void lmms::PatmanInstrument::deleteNotePluginData ( NotePlayHandle * _n )

overridevirtual

Reimplemented from lmms::Instrument.

◆ desiredReleaseTimeMs()

float lmms::PatmanInstrument::desiredReleaseTimeMs ( ) const

inlineoverridevirtual

Reimplemented from lmms::Instrument.

◆ fileChanged

void lmms::PatmanInstrument::fileChanged ( )

signal

◆ instantiateView()

gui::PluginView * lmms::PatmanInstrument::instantiateView ( QWidget * _parent )

overridevirtual

Create a view for the model.

Implements lmms::Plugin.

◆ loadFile()

void lmms::PatmanInstrument::loadFile ( const QString & file )

overridevirtual

Can be called if a file matching supportedFileTypes should be loaded/processed with the help of this plugin

Reimplemented from lmms::Plugin.

◆ loadPatch()

PatmanInstrument::LoadError lmms::PatmanInstrument::loadPatch ( const QString & _filename )

private

◆ loadSettings()

void lmms::PatmanInstrument::loadSettings ( const QDomElement & _this )

overridevirtual

Implements lmms::SerializingObject.

◆ nodeName()

QString lmms::PatmanInstrument::nodeName ( void ) const

overridevirtual

Implements lmms::SerializingObject.

◆ playNote()

void lmms::PatmanInstrument::playNote	(	NotePlayHandle *	_n,
		SampleFrame *	_working_buffer )

overridevirtual

Reimplemented from lmms::Instrument.

◆ saveSettings()

void lmms::PatmanInstrument::saveSettings	(	QDomDocument &	_doc,
		QDomElement &	_parent )

overridevirtual

Implements lmms::SerializingObject.

◆ selectSample()

void lmms::PatmanInstrument::selectSample ( NotePlayHandle * _n )

private

◆ setFile

void lmms::PatmanInstrument::setFile	(	const QString &	_patch_file,
		bool	_rename = true )

slot

◆ unloadCurrentPatch()

void lmms::PatmanInstrument::unloadCurrentPatch ( )

private

◆ gui::PatmanView

friend class gui::PatmanView

friend

Member Data Documentation

◆ m_loopedModel

BoolModel lmms::PatmanInstrument::m_loopedModel

private

◆ m_patchFile

QString lmms::PatmanInstrument::m_patchFile

private

◆ m_patchSamples

QVector<std::shared_ptr<Sample> > lmms::PatmanInstrument::m_patchSamples

private

◆ m_tunedModel

BoolModel lmms::PatmanInstrument::m_tunedModel

private

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

plugins/Patman/Patman.h
plugins/Patman/Patman.cpp

Classes

Public Slots

Signals

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Enumeration Documentation

◆ LoadError

Constructor & Destructor Documentation

◆ PatmanInstrument()

◆ ~PatmanInstrument()

Member Function Documentation

◆ deleteNotePluginData()

◆ desiredReleaseTimeMs()

◆ fileChanged

◆ instantiateView()

◆ loadFile()

◆ loadPatch()

◆ loadSettings()

◆ nodeName()

◆ playNote()

◆ saveSettings()

◆ selectSample()

◆ setFile

◆ unloadCurrentPatch()

Friends And Related Symbol Documentation

◆ gui::PatmanView

Member Data Documentation

◆ m_loopedModel

◆ m_patchFile

◆ m_patchSamples

◆ m_tunedModel