lmms::VstPlugin Class Reference

#include <VstPlugin.h>

Inheritance diagram for lmms::VstPlugin:

Public Slots
void	setTempo (lmms::bpm_t _bpm)
void	updateSampleRate ()
void	openPreset ()
void	setProgram (int index)
void	rotateProgram (int offset)
void	loadProgramNames ()
void	loadParameterLabels ()
void	loadParameterDisplays ()
void	updateParameterLabel (int index)
void	updateParameterDisplay (int index)
void	savePreset ()
void	setParam (int i, float f)
void	idleUpdate ()
void	showUI () override
void	hideUI () override
void	toggleUI () override
void	handleClientEmbed ()
Public Slots inherited from lmms::RemotePlugin
virtual void	showUI ()
virtual void	hideUI ()

Public Member Functions
	VstPlugin (const QString &_plugin)
	~VstPlugin () override
void	tryLoad (const QString &remoteVstPluginExecutable)
bool	processMessage (const message &_m) override
bool	hasEditor () const
virtual QWidget *	editor ()
const QString &	name () const
int	version () const
const QString &	vendorString () const
const QString &	productString () const
const QString &	currentProgramName () const
const QString &	allProgramNames () const
const std::vector< QString > &	allParameterLabels () const
const std::vector< QString > &	allParameterDisplays () const
int	currentProgram ()
const QMap< QString, QString > &	parameterDump ()
void	setParameterDump (const QMap< QString, QString > &_pdump)
QWidget *	pluginWidget ()
void	loadSettings (const QDomElement &_this) override
void	saveSettings (QDomDocument &_doc, QDomElement &_this) override
QString	nodeName () const override
virtual void	createUI (QWidget *parent)
bool	eventFilter (QObject *obj, QEvent *event) override
QString	embedMethod () const
Public Member Functions inherited from lmms::RemotePlugin
	RemotePlugin ()
	~RemotePlugin () override
bool	isRunning ()
bool	init (const QString &pluginExecutable, bool waitForInitDoneMsg, QStringList extraArgs={})
void	waitForHostInfoGotten ()
void	waitForInitDone (bool _busyWaiting=true)
bool	process (const SampleFrame *_in_buf, SampleFrame *_out_buf)
void	processMidiEvent (const MidiEvent &, const f_cnt_t _offset)
void	updateSampleRate (sample_rate_t _sr)
virtual void	toggleUI ()
int	isUIVisible ()
bool	failed () const
void	lock ()
void	unlock ()
Public Member Functions inherited from lmms::RemotePluginBase
	RemotePluginBase ()
virtual	~RemotePluginBase ()
int	sendMessage (const message &_m)
message	receiveMessage ()
bool	isInvalid () const
message	waitForMessage (const message &_m, bool _busy_waiting=false)
message	fetchAndProcessNextMessage ()
int32_t	readInt ()
void	writeInt (const int32_t &_i)
std::string	readString ()
void	writeString (const std::string &_s)
bool	messagesLeft ()
void	fetchAndProcessAllMessages ()
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 Member Functions
void	loadChunk (const QByteArray &_chunk)
QByteArray	saveChunk ()
void	toggleEditorVisibility (int visible=-1)

Private Attributes
QString	m_plugin
QPointer< QWidget >	m_pluginWidget
int	m_pluginWindowID
QSize	m_pluginGeometry
const QString	m_embedMethod
QString	m_name
int	m_version
QString	m_vendorString
QString	m_productString
QString	m_currentProgramName
QString	m_allProgramNames
std::vector< QString >	m_allParameterLabels
std::vector< QString >	m_allParameterDisplays
QString	p_name
QMap< QString, QString >	m_parameterDump
int	m_currentProgram
QTimer	m_idleTimer

Additional Inherited Members
Static Public Member Functions inherited from lmms::RemotePluginBase
static bool	isMainThreadWaiting ()
Protected Member Functions inherited from lmms::RemotePlugin
void	setSplittedChannels (bool _on)
Protected Member Functions inherited from lmms::RemotePluginBase
void	invalidate ()
Protected Member Functions inherited from lmms::JournallingObject
void	changeID (jo_id_t _id)
Protected Attributes inherited from lmms::RemotePlugin
bool	m_failed
Protected Attributes inherited from lmms::RemotePluginBase
int	m_socket

Constructor & Destructor Documentation

VstPlugin()

lmms::VstPlugin::VstPlugin

(

const QString &

_plugin

)

~VstPlugin()

lmms::VstPlugin::~VstPlugin ( )

override

Member Function Documentation

allParameterDisplays()

const std::vector< QString > & lmms::VstPlugin::allParameterDisplays ( ) const

inline

allParameterLabels()

const std::vector< QString > & lmms::VstPlugin::allParameterLabels ( ) const

inline

allProgramNames()

const QString & lmms::VstPlugin::allProgramNames ( ) const

inline

createUI()

void lmms::VstPlugin::createUI ( QWidget * parent )

virtual

Reimplemented in lmms::VstInstrumentPlugin.

currentProgram()

int lmms::VstPlugin::currentProgram

(

)

currentProgramName()

const QString & lmms::VstPlugin::currentProgramName ( ) const

inline

editor()

QWidget * lmms::VstPlugin::editor ( )

virtual

Same as pluginWidget(), but can be overwritten in sub-classes to modify behavior the UI. This is used in VstInstrumentPlugin to wrap the VST UI in a QMdiSubWindow

Reimplemented in lmms::VstInstrumentPlugin.

embedMethod()

QString lmms::VstPlugin::embedMethod

(

)

const

eventFilter()

bool lmms::VstPlugin::eventFilter ( QObject * obj, QEvent * event )

override

handleClientEmbed

void lmms::VstPlugin::handleClientEmbed ( )

slot

hasEditor()

bool lmms::VstPlugin::hasEditor ( ) const

inline

hideUI

void lmms::VstPlugin::hideUI ( )

overrideslot

idleUpdate

void lmms::VstPlugin::idleUpdate ( )

slot

loadChunk()

void lmms::VstPlugin::loadChunk ( const QByteArray & _chunk )

private

loadParameterDisplays

void lmms::VstPlugin::loadParameterDisplays ( )

slot

loadParameterLabels

void lmms::VstPlugin::loadParameterLabels ( )

slot

loadProgramNames

void lmms::VstPlugin::loadProgramNames ( )

slot

loadSettings()

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

overridevirtual

Implements lmms::SerializingObject.

name()

const QString & lmms::VstPlugin::name ( ) const

inline

nodeName()

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

inlineoverridevirtual

Implements lmms::SerializingObject.

openPreset

void lmms::VstPlugin::openPreset ( )

slot

parameterDump()

const QMap< QString, QString > & lmms::VstPlugin::parameterDump

(

)

pluginWidget()

QWidget * lmms::VstPlugin::pluginWidget

(

)

processMessage()

bool lmms::VstPlugin::processMessage ( const message & _m )

overridevirtual

Reimplemented from lmms::RemotePlugin.

productString()

const QString & lmms::VstPlugin::productString ( ) const

inline

rotateProgram

void lmms::VstPlugin::rotateProgram ( int offset )

slot

saveChunk()

QByteArray lmms::VstPlugin::saveChunk ( )

private

savePreset

void lmms::VstPlugin::savePreset ( )

slot

saveSettings()

void lmms::VstPlugin::saveSettings ( QDomDocument & _doc, QDomElement & _this )

overridevirtual

Implements lmms::SerializingObject.

setParam

void lmms::VstPlugin::setParam ( int i, float f )

slot

setParameterDump()

void lmms::VstPlugin::setParameterDump

(

const QMap< QString, QString > &

_pdump

)

setProgram

void lmms::VstPlugin::setProgram ( int index )

slot

setTempo

void lmms::VstPlugin::setTempo ( lmms::bpm_t _bpm )

slot

showUI

void lmms::VstPlugin::showUI ( )

overrideslot

toggleEditorVisibility()

void lmms::VstPlugin::toggleEditorVisibility ( int visible = -1 )

private

toggleUI

void lmms::VstPlugin::toggleUI ( )

overrideslot

tryLoad()

void lmms::VstPlugin::tryLoad

(

const QString &

remoteVstPluginExecutable

)

updateParameterDisplay

void lmms::VstPlugin::updateParameterDisplay ( int index )

slot

updateParameterLabel

void lmms::VstPlugin::updateParameterLabel ( int index )

slot

updateSampleRate

void lmms::VstPlugin::updateSampleRate ( )

slot

vendorString()

const QString & lmms::VstPlugin::vendorString ( ) const

inline

version()

int lmms::VstPlugin::version ( ) const

inline

Member Data Documentation

m_allParameterDisplays

std::vector<QString> lmms::VstPlugin::m_allParameterDisplays

private

m_allParameterLabels

std::vector<QString> lmms::VstPlugin::m_allParameterLabels

private

m_allProgramNames

QString lmms::VstPlugin::m_allProgramNames

private

m_currentProgram

int lmms::VstPlugin::m_currentProgram

private

m_currentProgramName

QString lmms::VstPlugin::m_currentProgramName

private

m_embedMethod

const QString lmms::VstPlugin::m_embedMethod

private

m_idleTimer

QTimer lmms::VstPlugin::m_idleTimer

private

m_name

QString lmms::VstPlugin::m_name

private

m_parameterDump

QMap<QString, QString> lmms::VstPlugin::m_parameterDump

private

m_plugin

QString lmms::VstPlugin::m_plugin

private

m_pluginGeometry

QSize lmms::VstPlugin::m_pluginGeometry

private

m_pluginWidget

QPointer<QWidget> lmms::VstPlugin::m_pluginWidget

private

m_pluginWindowID

int lmms::VstPlugin::m_pluginWindowID

private

m_productString

QString lmms::VstPlugin::m_productString

private

m_vendorString

QString lmms::VstPlugin::m_vendorString

private

m_version

int lmms::VstPlugin::m_version

private

p_name

QString lmms::VstPlugin::p_name

private

---

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

• plugins/VstBase/VstPlugin.h
• plugins/VstBase/VstPlugin.cpp