Lv2 core implementation

.travis/linux..install.sh

@@ -13,8 +13,11 @@ SWH_PACKAGES="perl libxml2-utils libxml-perl liblist-moreutils-perl"
 # VST dependencies
 VST_PACKAGES="wine-dev qt59x11extras qtbase5-private-dev libxcb-util0-dev libxcb-keysyms1-dev"
 
+# LV2 dependencies; libsuil-dev is not required
+LV2_PACKAGES="lv2-dev liblilv-dev"
+
 # Help with unmet dependencies
-PACKAGES="$PACKAGES $SWH_PACKAGES $VST_PACKAGES libjack-jackd2-0"
+PACKAGES="$PACKAGES $SWH_PACKAGES $VST_PACKAGES $LV2_PACKAGES libjack-jackd2-0"
 
 # shellcheck disable=SC2086
 sudo apt-get install -y $PACKAGES

CMakeLists.txt

@@ -54,6 +54,8 @@ OPTION(WANT_CARLA	"Include Carla plugin" ON)
 OPTION(WANT_CMT		"Include Computer Music Toolkit LADSPA plugins" ON)
 OPTION(WANT_JACK	"Include JACK (Jack Audio Connection Kit) support" ON)
 OPTION(WANT_WEAKJACK	"Loosely link JACK libraries" ON)
+OPTION(WANT_LV2		"Include Lv2 plugins" ON)
+OPTION(WANT_SUIL	"Include SUIL for plugin UIs" ON)
 OPTION(WANT_MP3LAME	"Include MP3/Lame support" ON)
 OPTION(WANT_OGGVORBIS	"Include OGG/Vorbis support" ON)
 OPTION(WANT_PULSEAUDIO	"Include PulseAudio support" ON)
@@ -176,6 +178,39 @@ IF(NOT SNDFILE_VERSION VERSION_LESS 1.0.26)
 	SET(LMMS_HAVE_SF_COMPLEVEL TRUE)
 ENDIF()
 
+IF(WANT_LV2)
+	IF(PKG_CONFIG_FOUND)
+		PKG_CHECK_MODULES(LV2 lv2)
+		PKG_CHECK_MODULES(LILV lilv-0)
+		IF(${LV2_FOUND} AND ${LILV_FOUND})
+			SET(LMMS_HAVE_LV2 TRUE)
+			SET(STATUS_LV2 "OK")
+		ELSE()
+			SET(STATUS_LV2 "not found, install it or set PKG_CONFIG_PATH appropriately")
+		ENDIF()
+	ELSE()
+		SET(STATUS_LV2 "not found, requires pkg-config")
+	ENDIF()
+ELSE(WANT_LV2)
+	SET(STATUS_LV2 "not built as requested")
+ENDIF(WANT_LV2)
+
+IF(WANT_SUIL)
+	IF(PKG_CONFIG_FOUND)
+		PKG_CHECK_MODULES(SUIL suil-0)
+		IF(${SUIL_FOUND})
+			SET(LMMS_HAVE_SUIL TRUE)
+			SET(STATUS_SUIL "OK")
+		ELSE()
+			SET(STATUS_SUIL "not found, install it or set PKG_CONFIG_PATH appropriately")
+		ENDIF()
+	ELSE()
+		SET(STATUS_SUIL "not found, requires pkg-config")
+	ENDIF()
+ELSE(WANT_SUIL)
+	SET(STATUS_SUIL "not built as requested")
+ENDIF(WANT_SUIL)
+
 IF(WANT_CALF)
 	SET(LMMS_HAVE_CALF TRUE)
 	SET(STATUS_CALF "OK")
@@ -674,6 +709,8 @@ MESSAGE(
 MESSAGE(
 "Optional plugins\n"
 "----------------\n"
+"* Lv2 plugins                 : ${STATUS_LV2}\n"
+"* SUIL for plugin UIs         : ${STATUS_SUIL}\n"
 "* ZynAddSubFX instrument      : ${STATUS_ZYN}\n"
 "* Carla Patchbay & Rack       : ${STATUS_CARLA}\n"
 "* SoundFont2 player           : ${STATUS_FLUIDSYNTH}\n"

include/AutomatableModel.h

@@ -33,6 +33,7 @@
 #include "MidiTime.h"
 #include "ValueBuffer.h"
 #include "MemoryManager.h"
+#include "ModelVisitor.h"
 
 // simple way to map a property of a view to a model
 #define mapPropertyFromModelPtr(type,getfunc,setfunc,modelname)	\
@@ -68,6 +69,7 @@ class LMMS_EXPORT AutomatableModel : public Model, public JournallingObject
 	Q_OBJECT
 	MM_OPERATORS
 public:
+
 	typedef QVector<AutomatableModel *> AutoModelVector;
 
 	enum ScaleType
@@ -80,6 +82,32 @@ class LMMS_EXPORT AutomatableModel : public Model, public JournallingObject
 
 	virtual ~AutomatableModel();
 
+	// Implement those by using the MODEL_IS_VISITABLE macro
+	virtual void accept(ModelVisitor& v) = 0;
+	virtual void accept(ConstModelVisitor& v) const = 0;
+	// use this to make subclasses visitable
+#define MODEL_IS_VISITABLE \
+	void accept(ModelVisitor& v) override { v.visit(*this); } \
+	void accept(ConstModelVisitor& v) const override { v.visit(*this); }
+
+public:
+	//! Return this class casted to Target, or nullptr if impossible
+	template<class Target>
+	Target* dcast(bool doThrow = false)
+	{
+		DCastVisitor<Target> vis; accept(vis);
+		if(doThrow && !vis.result) Q_ASSERT(false);
+		return vis.result;
+	}
+
+	//! Return this class casted to const Target, or nullptr if impossible
+	template<class Target>
+	const Target* dcast(bool doThrow = false) const
+	{
+		ConstDCastVisitor<Target> vis; accept(vis);
+		if(doThrow && !vis.result) Q_ASSERT(false);
+		return vis.result;
+	}
 
 	bool isAutomated() const;
 	bool isAutomatedOrControlled() const
@@ -283,6 +311,20 @@ public slots:
 
 
 private:
+	template<class Target>
+	struct DCastVisitor : public ModelVisitor
+	{
+		Target* result = nullptr;
+		void visit(Target& tar) { result = &tar; }
+	};
+
+	template<class Target>
+	struct ConstDCastVisitor : public ConstModelVisitor
+	{
+		const Target* result = nullptr;
+		void visit(const Target& tar) { result = &tar; }
+	};
+
 	static bool mustQuoteName(const QString &name);
 
 	virtual void saveSettings( QDomDocument& doc, QDomElement& element )
@@ -382,6 +424,7 @@ template <typename T> class LMMS_EXPORT TypedAutomatableModel : public Automatab
 class LMMS_EXPORT FloatModel : public TypedAutomatableModel<float>
 {
 	Q_OBJECT
+	MODEL_IS_VISITABLE
 public:
 	FloatModel( float val = 0, float min = 0, float max = 0, float step = 0,
 				Model * parent = NULL,
@@ -399,6 +442,7 @@ class LMMS_EXPORT FloatModel : public TypedAutomatableModel<float>
 class LMMS_EXPORT IntModel : public TypedAutomatableModel<int>
 {
 	Q_OBJECT
+	MODEL_IS_VISITABLE
 public:
 	IntModel( int val = 0, int min = 0, int max = 0,
 				Model* parent = NULL,
@@ -414,6 +458,7 @@ class LMMS_EXPORT IntModel : public TypedAutomatableModel<int>
 class LMMS_EXPORT BoolModel : public TypedAutomatableModel<bool>
 {
 	Q_OBJECT
+	MODEL_IS_VISITABLE
 public:
 	BoolModel( const bool val = false,
 				Model* parent = NULL,

include/ComboBoxModel.h

@@ -36,6 +36,7 @@
 class LMMS_EXPORT ComboBoxModel : public IntModel
 {
 	Q_OBJECT
+	MODEL_IS_VISITABLE
 public:
 	ComboBoxModel( Model* parent = NULL,
 					const QString& displayName = QString(),

include/Controls.h

@@ -0,0 +1,129 @@
+/*
+ * Controls.h - labeled control widgets
+ *
+ * Copyright (c) 2019-2019 Johannes Lorenz <j.git$$$lorenz-ho.me, $$$=@>
+ *
+ * This file is part of LMMS - https://lmms.io
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this program (see COPYING); if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301 USA.
+ *
+ */
+
+#ifndef CONTROLS_H
+#define CONTROLS_H
+
+
+#include "Model.h"
+
+// headers only required for covariance
+#include "AutomatableModel.h"
+#include "ComboBoxModel.h"
+
+
+class QString;
+class QWidget;
+class AutomatableModel;
+
+
+/**
+	These classes provide
+	- a control with a text label
+	- a type safe way to set a model
+		(justification: setting the wrong typed model to a widget will cause
+		hard-to-find runtime errors)
+*/
+class ControlBase
+{
+public:
+	virtual QWidget* topWidget() = 0;
+	virtual void setText(const QString& text) = 0;
+
+	virtual void setModel(AutomatableModel* model) = 0;
+	virtual AutomatableModel* model() = 0;
+
+	virtual ~ControlBase();
+};
+
+
+class KnobControl : public ControlBase
+{
+	class Knob* m_knob;
+
+public:
+	void setText(const QString& text) override;
+	QWidget* topWidget() override;
+
+	void setModel(AutomatableModel* model) override;
+	FloatModel* model() override;
+
+	KnobControl(QWidget* parent = nullptr);
+	~KnobControl() override;
+};
+
+
+class ComboControl : public ControlBase
+{
+	QWidget* m_widget;
+	class ComboBox* m_combo;
+	class QLabel* m_label;
+
+public:
+	void setText(const QString& text) override;
+	QWidget* topWidget() override { return m_widget; }
+
+	void setModel(AutomatableModel* model) override;
+	ComboBoxModel* model() override;
+
+	ComboControl(QWidget* parent = nullptr);
+	~ComboControl() override;
+};
+
+
+class LcdControl : public ControlBase
+{
+	class LcdSpinBox* m_lcd;
+
+public:
+	void setText(const QString& text) override;
+	QWidget* topWidget() override;
+
+	void setModel(AutomatableModel* model) override;
+	IntModel* model() override;
+
+	LcdControl(int numDigits, QWidget* parent = nullptr);
+	~LcdControl() override;
+};
+
+
+class CheckControl : public ControlBase
+{
+	QWidget* m_widget;
+	class LedCheckBox* m_checkBox;
+	QLabel* m_label;
+
+public:
+	void setText(const QString& text) override;
+	QWidget* topWidget() override;
+
+	void setModel(AutomatableModel* model) override;
+	BoolModel *model() override;
+
+	CheckControl(QWidget* parent = nullptr);
+	~CheckControl() override;
+};
+
+
+#endif // CONTROLS_H

include/Effect.h

@@ -148,11 +148,6 @@ class LMMS_EXPORT Effect : public Plugin
 		m_noRun = _state;
 	}
 
-	inline const Descriptor::SubPluginFeatures::Key & key() const
-	{
-		return m_key;
-	}
-
 	EffectChain * effectChain() const
 	{
 		return m_parent;
@@ -201,8 +196,6 @@ class LMMS_EXPORT Effect : public Plugin
 					sampleFrame * _dst_buf, sample_rate_t _dst_sr,
 					const f_cnt_t _frames );
 
-	Descriptor::SubPluginFeatures::Key m_key;
-
 	ch_cnt_t m_processors;
 
 	bool m_okay;

include/Engine.h

@@ -30,6 +30,7 @@
 #include <QtCore/QObject>
 
 
+#include "lmmsconfig.h"
 #include "lmms_export.h"
 
 class BBTrackContainer;
@@ -86,6 +87,13 @@ class LMMS_EXPORT LmmsCore : public QObject
 		return s_projectJournal;
 	}
 
+#ifdef LMMS_HAVE_LV2
+	static class Lv2Manager * getLv2Manager()
+	{
+		return s_lv2Manager;
+	}
+#endif
+
 	static Ladspa2LMMS * getLADSPAManager()
 	{
 		return s_ladspaManager;
@@ -111,6 +119,9 @@ class LMMS_EXPORT LmmsCore : public QObject
 		return s_instanceOfMe;
 	}
 
+	static void setDndPluginKey(void* newKey);
+	static void* pickDndPluginKey();
+
 signals:
 	void initProgress(const QString &msg);
 
@@ -136,7 +147,11 @@ class LMMS_EXPORT LmmsCore : public QObject
 	static ProjectJournal * s_projectJournal;
 	static DummyTrackContainer * s_dummyTC;
 
+#ifdef LMMS_HAVE_LV2
+	static class Lv2Manager* s_lv2Manager;
+#endif
 	static Ladspa2LMMS * s_ladspaManager;
+	static void* s_dndPluginKey;
 
 	// even though most methods are static, an instance is needed for Qt slots/signals
 	static LmmsCore * s_instanceOfMe;