Implement SPA support (enabling zyn-fusion)

include/Engine.h

@@ -91,6 +91,11 @@ class LMMS_EXPORT LmmsCore : public QObject
 		return s_ladspaManager;
 	}
 
+	static class QMap<int, class SpaInstrument*>& getSpaInstruments()
+	{
+		return s_spaInstruments;
+	}
+
 	static DummyTrackContainer * dummyTrackContainer()
 	{
 		return s_dummyTC;
@@ -137,6 +142,7 @@ class LMMS_EXPORT LmmsCore : public QObject
 	static DummyTrackContainer * s_dummyTC;
 
 	static Ladspa2LMMS * s_ladspaManager;
+	static QMap<int, class SpaInstrument*> s_spaInstruments;
 
 	// even though most methods are static, an instance is needed for Qt slots/signals
 	static LmmsCore * s_instanceOfMe;

include/PluginFactory.h

@@ -26,10 +26,13 @@
 #define PLUGINFACTORY_H
 
 #include <memory>
+#include <string>
 
 #include <QtCore/QFileInfo>
 #include <QtCore/QHash>
 #include <QtCore/QList>
+#include <QtCore/QString>
+#include <QtCore/QVector>
 
 #include "lmms_export.h"
 #include "Plugin.h"
@@ -85,6 +88,7 @@ public slots:
 	DescriptorMap m_descriptors;
 	PluginInfoList m_pluginInfos;
 	QMap<QString, PluginInfo> m_pluginByExt;
+	QVector<std::string> m_garbage; //!< cleaned up at destruction
 
 	QHash<QString, QString> m_errors;
 

include/SpaOscModel.h

@@ -0,0 +1,80 @@
+/*
+ * SpaOscModel.h - AutomatableModel which forwards OSC events
+ *
+ * Copyright (c) 2018-2018 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 SPAOSCMODEL_H
+#define SPAOSCMODEL_H
+
+#include "AutomatableModel.h"
+
+template<class Base>
+class SpaOscModel : public Base
+{
+protected:
+	class SpaInstrument* inst_ref;
+	QByteArray dest;
+
+	using Base::Base;
+	void init(class SpaInstrument* _inst_ref, const QString _dest) {
+		inst_ref = _inst_ref;
+		dest = _dest.toUtf8();
+	}
+};
+
+class BoolOscModel : public SpaOscModel<BoolModel>
+{
+	Q_OBJECT
+private slots:
+	void sendOsc();
+public:
+	BoolOscModel(class SpaInstrument* inst_ref, const QString dest,
+		bool val);
+};
+
+class IntOscModel : public SpaOscModel<IntModel>
+{
+	Q_OBJECT
+private slots:
+	void sendOsc();
+public:
+	IntOscModel(class SpaInstrument* inst_ref, const QString dest,
+		int min, int max, int val);
+};
+
+class FloatOscModel : public SpaOscModel<FloatModel>
+{
+	Q_OBJECT
+private slots:
+	void sendOsc();
+public:
+	FloatOscModel(class SpaInstrument* inst_ref, const QString dest,
+		float min, float max, float val);
+};
+
+struct SpaOscModelFactory
+{
+	AutomatableModel* res;
+	SpaOscModelFactory(class SpaInstrument* inst_ref, const QString &dest);
+};
+
+#endif // SPAOSCMODEL_H

include/StringPairDrag.h

@@ -55,6 +55,11 @@ class LMMS_EXPORT StringPairDrag : public QDrag
 		return( "application/x-lmms-stringpair" );
 	}
 
+	static const char * mimeTypeOsc()
+	{
+		return( "application/x-osc-stringpair" );
+	}
+
 } ;
 
 

src/CMakeLists.txt

@@ -58,6 +58,7 @@ INCLUDE_DIRECTORIES(
 	${SNDFILE_INCLUDE_DIRS}
 	${SNDIO_INCLUDE_DIRS}
 	${FFTW3F_INCLUDE_DIRS}
+	${LIBSPA_INCLUDE_DIRS}
 )
 
 IF(NOT ("${SDL2_INCLUDE_DIR}" STREQUAL ""))
@@ -96,6 +97,9 @@ IF(LMMS_BUILD_LINUX)
 ENDIF()
 SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
 
+# Note: LINK_DIRECTORIES only affects targets after its call
+LINK_DIRECTORIES(${LIBSPA_LIBRARY_DIRS})
+
 ADD_LIBRARY(lmmsobjs OBJECT
 	${LMMS_SRCS}
 	${LMMS_INCLUDES}
@@ -163,6 +167,7 @@ SET(LMMS_REQUIRED_LIBS ${LMMS_REQUIRED_LIBS}
 	${LAME_LIBRARIES}
 	${SAMPLERATE_LIBRARIES}
 	${SNDFILE_LIBRARIES}
+	${LIBSPA_LIBRARIES}
 	${EXTRA_LIBRARIES}
 	rpmalloc
 )

src/core/CMakeLists.txt

@@ -1,3 +1,5 @@
+add_subdirectory(spa)
+
 set(LMMS_SRCS
 	${LMMS_SRCS}
 	core/AutomatableModel.cpp
@@ -61,6 +63,7 @@ set(LMMS_SRCS
 	core/SampleRecordHandle.cpp
 	core/SerializingObject.cpp
 	core/Song.cpp
+	core/SpaOscModel.cpp
 	core/TempoSyncKnobModel.cpp
 	core/ToolPlugin.cpp
 	core/Track.cpp
@@ -97,5 +100,8 @@ set(LMMS_SRCS
 	core/midi/MidiTime.cpp
 	core/midi/MidiWinMM.cpp
 
+	${SPA_SRCS}
+
 	PARENT_SCOPE
 )
+

src/core/DataFile.cpp

@@ -163,7 +163,8 @@ bool DataFile::validate( QString extension )
 	case Type::UnknownType:
 		if (! ( extension == "mmp" || extension == "mpt" || extension == "mmpz" ||
 				extension == "xpf" || extension == "xml" ||
-				( extension == "xiz" && ! pluginFactory->pluginSupportingExtension(extension).isNull()) ||
+				( (extension == "xiz" || extension == "xmz") &&
+					! pluginFactory->pluginSupportingExtension(extension).isNull()) ||
 				extension == "sf2" || extension == "sf3" || extension == "pat" || extension == "mid" ||
 				extension == "dll"
 				) )

src/core/Engine.cpp

@@ -41,6 +41,7 @@ BBTrackContainer * LmmsCore::s_bbTrackContainer = NULL;
 Song * LmmsCore::s_song = NULL;
 ProjectJournal * LmmsCore::s_projectJournal = NULL;
 Ladspa2LMMS * LmmsCore::s_ladspaManager = NULL;
+QMap<int, class SpaInstrument*> LmmsCore::s_spaInstruments;
 DummyTrackContainer * LmmsCore::s_dummyTC = NULL;
 
 

src/core/Plugin.cpp

@@ -26,6 +26,9 @@
 #include <QtCore/QDir>
 #include <QtCore/QLibrary>
 #include <QMessageBox>
+#include <spa/spa.h>
+
+#include "../core/spa/SpaInstrument.h"
 
 #include "Plugin.h"
 #include "embed.h"
@@ -107,8 +110,27 @@ Plugin * Plugin::instantiate( const QString& pluginName, Model * parent,
 		return new DummyPlugin();
 	}
 
-	InstantiationHook instantiationHook = ( InstantiationHook ) pi.library->resolve( "lmms_plugin_main" );
-	if( instantiationHook == NULL )
+	Plugin* inst;
+	spa::descriptor_loader_t spa_loader;
+	InstantiationHook instantiationHook;
+	if( (instantiationHook = ( InstantiationHook ) pi.library->resolve( "lmms_plugin_main" )) )
+	{
+		inst = instantiationHook( parent, data );
+	}
+	else if( (spa_loader = (spa::descriptor_loader_t) pi.library->resolve( spa::descriptor_name )) )
+	{
+		// instantiate a SPA Instrument
+		// it will load and contain the SPA plugin
+		// and transfer LMMS events to SPA function calls
+		SpaInstrument* spa_inst = new SpaInstrument(
+			static_cast<InstrumentTrack *>( data ),
+			pi.file.absoluteFilePath().toUtf8().data(),
+			pi.descriptor);
+		unsigned port = spa_inst->plugin->net_port();
+		Engine::getSpaInstruments().insert(port, spa_inst);
+		inst = spa_inst;
+	}
+	else
 	{
 		if( gui )
 		{
@@ -120,7 +142,7 @@ Plugin * Plugin::instantiate( const QString& pluginName, Model * parent,
 		return new DummyPlugin();
 	}
 
-	Plugin * inst = instantiationHook( parent, data );
+
 	return inst;
 }
 

src/core/PluginFactory.cpp

@@ -28,8 +28,11 @@
 #include <QtCore/QDebug>
 #include <QtCore/QDir>
 #include <QtCore/QLibrary>
+#include <spa/spa.h>
 
 #include "ConfigManager.h"
+#include "Plugin.h"
+#include "embed.h"
 
 #ifdef LMMS_BUILD_WIN32
 	QStringList nameFilters("*.dll");
@@ -150,42 +153,79 @@ void PluginFactory::discoverPlugins()
 	for (const QFileInfo& file : files)
 	{
 		auto library = std::make_shared<QLibrary>(file.absoluteFilePath());
+		spa::descriptor_loader_t spaDescriptorLoader;
 
 		if (! library->load()) {
 			m_errors[file.baseName()] = library->errorString();
 			qWarning("%s", library->errorString().toLocal8Bit().data());
 			continue;
 		}
-		if (library->resolve("lmms_plugin_main") == nullptr) {
-			continue;
-		}
 
-		QString descriptorName = file.baseName() + "_plugin_descriptor";
-		if( descriptorName.left(3) == "lib" )
+		Plugin::Descriptor* pluginDescriptor = nullptr;
+		if (library->resolve("lmms_plugin_main"))
 		{
-			descriptorName = descriptorName.mid(3);
+			// LMMS plugin
+
+			QString descriptorName = file.baseName() + "_plugin_descriptor";
+			if( descriptorName.left(3) == "lib" )
+			{
+				descriptorName = descriptorName.mid(3);
+			}
+
+			pluginDescriptor = reinterpret_cast<Plugin::Descriptor*>(library->resolve(descriptorName.toUtf8().constData()));
+			if(pluginDescriptor == nullptr)
+			{
+				qWarning() << qApp->translate("PluginFactory", "LMMS plugin %1 does not have a plugin descriptor named %2!").
+							  arg(file.absoluteFilePath()).arg(descriptorName);
+				continue;
+			}
 		}
-
-		Plugin::Descriptor* pluginDescriptor = reinterpret_cast<Plugin::Descriptor*>(library->resolve(descriptorName.toUtf8().constData()));
-		if(pluginDescriptor == nullptr)
-		{
-			qWarning() << qApp->translate("PluginFactory", "LMMS plugin %1 does not have a plugin descriptor named %2!").
-						  arg(file.absoluteFilePath()).arg(descriptorName);
-			continue;
+		else if ((spaDescriptorLoader = (spa::descriptor_loader_t) library->resolve(spa::descriptor_name))) {
+			spa::descriptor* descriptor = (*spaDescriptorLoader)(0 /* = plugin number, TODO */);
+			if(descriptor)
+			{
+				std::string unique_name =
+					spa::unique_name(*descriptor);
+				m_garbage.push_back(unique_name);
+
+				const char** xpm = descriptor->xpm_load();
+				assert(xpm);
+				QString xpmKey= "spa-plugin:" +
+					QString::fromStdString(unique_name);
+
+				// spa (simple plugin API) plugin
+				pluginDescriptor = new Plugin::Descriptor {
+					m_garbage.back().c_str(),
+					descriptor->name(),
+					descriptor->description_line(),
+					descriptor->authors(),
+					(int)descriptor->version_major() << 24 |
+						(descriptor->version_minor() & 0xff) << 16 |
+						(descriptor->version_patch() & 0xffff),
+					Plugin::Instrument, // TODO... could also be an effect
+					new PixmapLoader(QString("xpm:"
+						+ xpmKey), xpm),
+					descriptor->save_formats()
+				};
+			}
 		}
 
-		PluginInfo info;
-		info.file = file;
-		info.library = library;
-		info.descriptor = pluginDescriptor;
-		pluginInfos << info;
-
-		for (const QString& ext : QString(info.descriptor->supportedFileTypes).split(','))
+		if(pluginDescriptor)
 		{
-			m_pluginByExt.insert(ext, info);
+			PluginInfo info;
+			info.file = file;
+			info.library = library;
+			info.descriptor = pluginDescriptor;
+			pluginInfos << info;
+
+			if(info.descriptor->supportedFileTypes)
+			for (const QString& ext : QString(info.descriptor->supportedFileTypes).split(','))
+			{
+				m_pluginByExt.insert(ext, info);
+			}
+
+			descriptors.insert(info.descriptor->type, info.descriptor);
 		}
-
-		descriptors.insert(info.descriptor->type, info.descriptor);
 	}
 
 	m_pluginInfos = pluginInfos;