Implement SPA support (enabling zyn-fusion)

CMakeLists.txt

@@ -60,6 +60,7 @@ OPTION(WANT_CALF	"Include CALF LADSPA plugins" ON)
 OPTION(WANT_CAPS	"Include C* Audio Plugin Suite (LADSPA plugins)" ON)
 OPTION(WANT_CARLA	"Include Carla plugin" ON)
 OPTION(WANT_CMT		"Include Computer Music Toolkit LADSPA plugins" ON)
+OPTION(WANT_SPA		"Include SPA 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)
@@ -276,6 +277,25 @@ ELSE(WANT_TAP)
 ENDIF(WANT_TAP)
 
 
+IF(WANT_SPA)
+	IF(PKG_CONFIG_FOUND)
+		PKG_CHECK_MODULES(LIBSPA spa)
+		IF(${LIBSPA_FOUND})
+			INCLUDE_DIRECTORIES(${LIBSPA_INCLUDE_DIRS})
+			LINK_DIRECTORIES(${LIBSPA_LIBRARY_DIRS})
+			SET(LMMS_HAVE_SPA TRUE)
+			SET(STATUS_SPA "OK")
+		ELSE()
+			SET(STATUS_SPA "not found, install it or set PKG_CONFIG_PATH appropriately")
+		ENDIF()
+	ELSE()
+		SET(STATUS_SPA "not found, requires pkg-config")
+	ENDIF()
+ELSE(WANT_SPA)
+	SET(STATUS_SPA "not built as requested")
+ENDIF(WANT_SPA)
+
+
 # check for CARLA
 IF(WANT_CARLA)
 	PKG_CHECK_MODULES(CARLA carla-native-plugin)
@@ -764,6 +784,7 @@ MESSAGE(
 "* CMT LADSPA plugins          : ${STATUS_CMT}\n"
 "* TAP LADSPA plugins          : ${STATUS_TAP}\n"
 "* SWH LADSPA plugins          : ${STATUS_SWH}\n"
+"* SPA plugin API              : ${STATUS_SPA}\n"
 "* GIG player                  : ${STATUS_GIG}\n"
 )
 

cmake/modules/PluginList.cmake

@@ -58,6 +58,8 @@ SET(LMMS_PLUGIN_LIST
 	Sf2Player
 	Sfxr
 	Sid
+	SpaEffect
+	SpaInstrument
 	SpectrumAnalyzer
 	StereoEnhancer
 	StereoMatrix

include/Clipboard.h

@@ -27,6 +27,7 @@
 
 #include <QMap>
 #include <QDomElement>
+class QMimeData;
 
 class QMimeData;
 
@@ -36,6 +37,7 @@ namespace lmms::Clipboard
 	enum class MimeType
 	{
 		StringPair,
+		Osc,
 		Default
 	};
 
@@ -58,11 +60,11 @@ namespace lmms::Clipboard
 		{
 			case MimeType::StringPair:
 				return "application/x-lmms-stringpair";
-			break;
+			case MimeType::Osc:
+				return "application/x-osc-stringpair";
 			case MimeType::Default:
 			default:
 				return "application/x-lmms-clipboard";
-				break;
 		}
 	}
 

include/ConfigManager.h

@@ -205,6 +205,12 @@ class LMMS_EXPORT ConfigManager : public QObject
 		return m_dataDir + TRACK_ICON_PATH;
 	}
 
+	const QString & spaDir() const
+	{
+		return m_spaDir;
+	}
+
+
 	const QString recoveryFile() const
 	{
 		return m_workingDir + "recover.mmp";
@@ -258,6 +264,7 @@ class LMMS_EXPORT ConfigManager : public QObject
 	void setLADSPADir(const QString & ladspaDir);
 	void setSF2Dir(const QString & sf2Dir);
 	void setSF2File(const QString & sf2File);
+	void setSPADir(const QString & sd);
 	void setSTKDir(const QString & stkDir);
 	void setGIGDir(const QString & gigDir);
 	void setThemeDir(const QString & themeDir);
@@ -288,6 +295,7 @@ class LMMS_EXPORT ConfigManager : public QObject
 	QString m_dataDir;
 	QString m_vstDir;
 	QString m_ladspaDir;
+	QString m_spaDir;
 	QString m_sf2Dir;
 #ifdef LMMS_HAVE_FLUIDSYNTH
 	QString m_sf2File;

include/ControllerRackView.h

@@ -71,6 +71,8 @@ public slots:
 
 protected:
 	void closeEvent( QCloseEvent * _ce ) override;
+	virtual void dragEnterEvent( QDragEnterEvent *dee );
+	virtual void dropEvent( QDropEvent * de );
 
 private slots:
 	void addController();

include/ControllerView.h

@@ -75,7 +75,8 @@ public slots:
 	void contextMenuEvent( QContextMenuEvent * _me ) override;
 	void modelChanged() override;
 	void mouseDoubleClickEvent( QMouseEvent * event ) override;
-
+	virtual void dragEnterEvent( QDragEnterEvent *dee );
+	virtual void dropEvent( QDropEvent * de );
 
 private:
 	QMdiSubWindow * m_subWindow;

include/Engine.h

@@ -97,6 +97,15 @@ class LMMS_EXPORT Engine : public QObject
 		return s_ladspaManager;
 	}
 
+#ifdef LMMS_HAVE_SPA
+	static class SpaManager * getSPAManager()
+	{
+		return s_spaManager;
+	}
+#endif
+
+	static void addPluginByPort(unsigned port, class Plugin* plug);
+
 	static float framesPerTick()
 	{
 		return s_framesPerTick;
@@ -115,6 +124,8 @@ class LMMS_EXPORT Engine : public QObject
 		return s_instanceOfMe;
 	}
 
+	static class AutomatableModel*
+	getAutomatableModel(const QString &val, bool hasPort);
 	static void setDndPluginKey(void* newKey);
 	static void* pickDndPluginKey();
 
@@ -123,6 +134,9 @@ class LMMS_EXPORT Engine : public QObject
 
 
 private:
+	static class AutomatableModel*
+	getAutomatableModelAtPort(const QString& val, const QUrl& url);
+
 	// small helper function which sets the pointer to NULL before actually deleting
 	// the object it refers to
 	template<class T>
@@ -146,6 +160,10 @@ class LMMS_EXPORT Engine : public QObject
 	static class Lv2Manager* s_lv2Manager;
 #endif
 	static Ladspa2LMMS* s_ladspaManager;
+#ifdef LMMS_HAVE_SPA
+	static class SpaManager* s_spaManager;
+#endif
+	static QMap<unsigned, class Plugin*> s_pluginsByPort;
 	static void* s_dndPluginKey;
 
 	// even though most methods are static, an instance is needed for Qt slots/signals

include/Plugin.h

@@ -297,6 +297,22 @@ class LMMS_EXPORT Plugin : public Model, public JournallingObject
 	//! Create a view for the model
 	gui::PluginView * createView( QWidget * parent );
 
+	//! If the plugin offers to identify controls as strings (aka "ports",
+	//! like OSC does), this shall return the AutomatableModel for given
+	//! port or nullptr if there's none at that port
+	virtual class AutomatableModel *modelAtPort(const class QString &)
+	{
+		return nullptr;
+	}
+
+	//! If the plugin has a network port where it can be reached, this
+	//! should return that port; if not, it should return 0
+	virtual unsigned netPort(std::size_t channel) const
+	{
+		(void)channel;
+		return 0;
+	}
+
 protected:
 	//! Create a view for the model
 	virtual gui::PluginView* instantiateView( QWidget * ) = 0;

include/SetupDialog.h

@@ -87,6 +87,7 @@ private slots:
 	void toggleDisableBackup(bool enabled);
 	void toggleOpenLastProject(bool enabled);
 	void setLanguage(int lang);
+	void setSPADir(const QString& ld);
 
 	// Performance settings widget.
 	void setAutoSaveInterval(int time);
@@ -116,6 +117,7 @@ private slots:
 	void setVSTDir(const QString & vstDir);
 	void openLADSPADir();
 	void setLADSPADir(const QString & ladspaDir);
+	void openSPADir();
 	void openSF2Dir();
 	void setSF2Dir(const QString & sf2Dir);
 	void openSF2File();
@@ -192,6 +194,7 @@ private slots:
 	QString m_workingDir;
 	QString m_vstDir;
 	QString m_ladspaDir;
+	QString m_spaDir;
 	QString m_gigDir;
 	QString m_sf2Dir;
 #ifdef LMMS_HAVE_FLUIDSYNTH
@@ -204,6 +207,7 @@ private slots:
 	QLineEdit * m_vstDirLineEdit;
 	QLineEdit * m_themeDirLineEdit;
 	QLineEdit * m_ladspaDirLineEdit;
+	QLineEdit * m_spaLineEdit;
 	QLineEdit * m_gigDirLineEdit;
 	QLineEdit * m_sf2DirLineEdit;
 #ifdef LMMS_HAVE_FLUIDSYNTH

include/SpaControlBase.h

@@ -0,0 +1,121 @@
+/*
+ * SpaControlBase.h - implementation of SPA interface
+ *
+ * Copyright (c) 2018-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 SPA_CONTROL_BASE_H
+#define SPA_CONTROL_BASE_H
+
+#include "lmmsconfig.h"
+
+#ifdef LMMS_HAVE_SPA
+
+//#include <QMutex>
+#include <QString>
+#include <memory>
+#include <vector>
+
+// general LMMS includes
+#include "DataFile.h"
+#include "LinkedModelGroups.h"
+#include "lmms_basics.h"
+
+// includes from the spa library
+#include <spa/spa_fwd.h>
+
+namespace lmms
+{
+
+namespace gui
+{
+	class SpaViewBase;
+}
+
+class SpaProc;
+
+class SpaControlBase : public LinkedModelGroups
+{
+	friend class gui::SpaViewBase;
+public:
+	SpaControlBase(Model *that, const QString &uniqueName,
+				DataFile::Types settingsType);
+	~SpaControlBase() override;
+
+	std::vector<std::unique_ptr<SpaProc>>& controls() { return m_procs; }
+
+	void saveSettings(QDomDocument &doc, QDomElement &that);
+	void loadSettings(const QDomElement &that);
+
+//	void writeOsc(const char *dest, const char *args, va_list va) {}
+//	void writeOsc(const char *dest, const char *args, ...) {}
+
+	void loadFile(const QString &file, bool user);
+
+	const spa::descriptor *m_spaDescriptor = nullptr;
+	bool hasUi() const;
+	void uiExtShow(bool doShow);
+	void copyModelsFromLmms();
+	void copyBuffersFromLmms(const sampleFrame *buf, fpp_t frames);
+	void copyBuffersToLmms(sampleFrame *buf, fpp_t frames) const;
+	void run(unsigned frames);
+
+	AutomatableModel *modelAtPort(const QString &dest);
+	void writeOscToAll(const char *dest, const char *args, va_list va);
+	void writeOscToAll(const char *dest, const char *args...);
+protected:
+	void reloadPlugin() { /* TODO */ }
+	bool isValid() { return m_valid; }
+
+private:
+	bool m_valid = true;
+
+	virtual void setNameFromFile(const QString &fname) = 0;
+
+	Model* m_that;
+
+protected:
+
+	LinkedModelGroup* getGroup(std::size_t idx) override;
+	const LinkedModelGroup* getGroup(std::size_t idx) const override;
+
+/*	bool initPlugin() {}
+	void shutdownPlugin() {}*/
+
+	bool m_hasGUI = false;
+	bool m_loaded;
+
+	QString nodeName() const { return "spacontrols"; }
+
+	std::vector<std::unique_ptr<SpaProc>> m_procs;
+
+	void handleMidiInputEvent(const class MidiEvent &event,
+		const class TimePos &time, f_cnt_t offset);
+
+private:
+	unsigned m_channelsPerProc;
+};
+
+} // namespace lmms
+
+#endif // LMMS_HAVE_SPA
+
+#endif // SPA_CONTROL_BASE_H