lmms
Cross-platform music production software
Loading...
Searching...
No Matches
lmms::SidInstrument Class Reference

#include <SidInstrument.h>

Inheritance diagram for lmms::SidInstrument:
lmms::Instrument lmms::Plugin lmms::Model lmms::JournallingObject lmms::SerializingObject

Public Types

enum class  FilterType { HighPass = 0 , BandPass , LowPass , Count }
enum class  ChipModel { MOS6581 = 0 , MOS8580 , Count }
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*>

Public Member Functions

 SidInstrument (InstrumentTrack *_instrument_track)
 ~SidInstrument () override=default
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
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
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)
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 auto NumFilterTypes = static_cast<std::size_t>(FilterType::Count)
static constexpr auto NumChipModels = static_cast<std::size_t>(ChipModel::Count)

Private Attributes

VoiceObject * m_voice [3]
FloatModel m_filterFCModel
FloatModel m_filterResonanceModel
IntModel m_filterModeModel
BoolModel m_voice3OffModel
FloatModel m_volumeModel
IntModel m_chipModel

Friends

class gui::SidInstrumentView

Additional Inherited Members

Signals inherited from lmms::Model
void dataChanged ()
void dataUnchanged ()
void propertiesChanged ()
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

◆ ChipModel

enum class lmms::SidInstrument::ChipModel
strong
Enumerator
MOS6581 
MOS8580 
Count 

◆ FilterType

Enumerator
HighPass 
BandPass 
LowPass 
Count 

Constructor & Destructor Documentation

◆ SidInstrument()

lmms::SidInstrument::SidInstrument ( InstrumentTrack * _instrument_track)

◆ ~SidInstrument()

lmms::SidInstrument::~SidInstrument ( )
overridedefault

Member Function Documentation

◆ deleteNotePluginData()

void lmms::SidInstrument::deleteNotePluginData ( NotePlayHandle * _n)
overridevirtual

Reimplemented from lmms::Instrument.

◆ desiredReleaseTimeMs()

float lmms::SidInstrument::desiredReleaseTimeMs ( ) const
overridevirtual

Reimplemented from lmms::Instrument.

◆ instantiateView()

gui::PluginView * lmms::SidInstrument::instantiateView ( QWidget * _parent)
overridevirtual

Create a view for the model.

Implements lmms::Plugin.

◆ loadSettings()

void lmms::SidInstrument::loadSettings ( const QDomElement & _this)
overridevirtual

◆ nodeName()

QString lmms::SidInstrument::nodeName ( void ) const
overridevirtual

◆ playNote()

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

Reimplemented from lmms::Instrument.

◆ saveSettings()

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

◆ gui::SidInstrumentView

friend class gui::SidInstrumentView
friend

Member Data Documentation

◆ m_chipModel

IntModel lmms::SidInstrument::m_chipModel
private

◆ m_filterFCModel

FloatModel lmms::SidInstrument::m_filterFCModel
private

◆ m_filterModeModel

IntModel lmms::SidInstrument::m_filterModeModel
private

◆ m_filterResonanceModel

FloatModel lmms::SidInstrument::m_filterResonanceModel
private

◆ m_voice

VoiceObject* lmms::SidInstrument::m_voice[3]
private

◆ m_voice3OffModel

BoolModel lmms::SidInstrument::m_voice3OffModel
private

◆ m_volumeModel

FloatModel lmms::SidInstrument::m_volumeModel
private

◆ NumChipModels

auto lmms::SidInstrument::NumChipModels = static_cast<std::size_t>(ChipModel::Count)
staticconstexpr

◆ NumFilterTypes

auto lmms::SidInstrument::NumFilterTypes = static_cast<std::size_t>(FilterType::Count)
staticconstexpr

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