sdrangel/sdrbase/plugin/pluginmanager.h

#ifndef INCLUDE_PLUGINMANAGER_H
#define INCLUDE_PLUGINMANAGER_H

#include <QObject>
#include <QDir>
#include "plugin/plugininterface.h"
#include "plugin/pluginapi.h"
#include "util/export.h"

class QComboBox;
class QPluginLoader;
class Preset;
class MainWindow;
class Message;
class MessageQueue;
class DeviceSourceAPI;
class DeviceSinkAPI;

class SDRANGEL_API PluginManager : public QObject {
	Q_OBJECT

public:
	struct Plugin
	{
		QString filename;
		QPluginLoader* loader;
		PluginInterface* pluginInterface;

		Plugin(const QString& _filename, QPluginLoader* pluginLoader, PluginInterface* _plugin) :
			filename(_filename),
			loader(pluginLoader),
			pluginInterface(_plugin)
		{ }
	};

	typedef QList<Plugin> Plugins;

	explicit PluginManager(MainWindow* mainWindow, QObject* parent = NULL);
	~PluginManager();

	void loadPlugins();
	const Plugins& getPlugins() const { return m_plugins; }

	// Callbacks from the plugins
	void registerRxChannel(const QString& channelName, PluginInterface* plugin);
	void registerSampleSource(const QString& sourceName, PluginInterface* plugin);
	void registerTxChannel(const QString& channelName, PluginInterface* plugin);
	void registerSampleSink(const QString& sourceName, PluginInterface* plugin);

	PluginAPI::ChannelRegistrations *getRxChannelRegistrations() { return &m_rxChannelRegistrations; }
	PluginAPI::ChannelRegistrations *getTxChannelRegistrations() { return &m_txChannelRegistrations; }

	void updateSampleSourceDevices();
	void duplicateLocalSampleSourceDevices(uint deviceUID);
	void fillSampleSourceSelector(QComboBox* comboBox, uint deviceUID);
	int getSampleSourceSelectorIndex(QComboBox* comboBox, DeviceSourceAPI *deviceSourceAPI);

	void updateSampleSinkDevices();
	void duplicateLocalSampleSinkDevices(uint deviceUID);
	void fillSampleSinkSelector(QComboBox* comboBox, uint deviceUID);
	int getSampleSinkSelectorIndex(QComboBox* comboBox, DeviceSinkAPI *deviceSinkAPI);

	int selectSampleSourceByIndex(int index, DeviceSourceAPI *deviceAPI);
	int selectFirstSampleSource(const QString& sourceId, DeviceSourceAPI *deviceAPI);
	int selectSampleSourceBySerialOrSequence(const QString& sourceId, const QString& sourceSerial, int sourceSequence, DeviceSourceAPI *deviceAPI);
	void selectSampleSourceByDevice(void *devicePtr, DeviceSourceAPI *deviceAPI);

	int selectSampleSinkByIndex(int index, DeviceSinkAPI *deviceAPI);
	int selectFirstSampleSink(const QString& sourceId, DeviceSinkAPI *deviceAPI);
	int selectSampleSinkBySerialOrSequence(const QString& sinkId, const QString& sinkSerial, int sinkSequence, DeviceSinkAPI *deviceAPI);
	void selectSampleSinkByDevice(void *devicePtr, DeviceSinkAPI *deviceAPI);

	void populateRxChannelComboBox(QComboBox *channels);
	void createRxChannelInstance(int channelPluginIndex, DeviceSourceAPI *deviceAPI);

	void populateTxChannelComboBox(QComboBox *channels);
	void createTxChannelInstance(int channelPluginIndex, DeviceSinkAPI *deviceAPI);

private:
	struct SamplingDeviceRegistration {
		QString m_deviceId;
		PluginInterface* m_plugin;
		SamplingDeviceRegistration(const QString& deviceId, PluginInterface* plugin) :
			m_deviceId(deviceId),
			m_plugin(plugin)
		{ }
	};

	typedef QList<SamplingDeviceRegistration> SamplingDeviceRegistrations;

	struct SamplingDevice {
		PluginInterface* m_plugin;
		QString m_displayName;
		QString m_hadrwareId;
		QString m_deviceId;
		QString m_deviceSerial;
		int m_deviceSequence;

		SamplingDevice(PluginInterface* plugin,
				const QString& displayName,
				const QString& hadrwareId,
				const QString& deviceId,
				const QString& deviceSerial,
				int deviceSequence) :
			m_plugin(plugin),
			m_displayName(displayName),
			m_hadrwareId(hadrwareId),
			m_deviceId(deviceId),
			m_deviceSerial(deviceSerial),
			m_deviceSequence(deviceSequence)
		{ }
	};

	typedef QList<SamplingDevice> SamplingDevices;

	PluginAPI m_pluginAPI;
	MainWindow* m_mainWindow;
	Plugins m_plugins;

	PluginAPI::ChannelRegistrations m_rxChannelRegistrations; //!< Channel plugins register here
	SamplingDeviceRegistrations m_sampleSourceRegistrations;  //!< Input source plugins (one per device kind) register here
	SamplingDevices m_sampleSourceDevices;                    //!< Instances of input sources present in the system

	PluginAPI::ChannelRegistrations m_txChannelRegistrations; //!< Channel plugins register here
	SamplingDeviceRegistrations m_sampleSinkRegistrations;    //!< Output sink plugins (one per device kind) register here
	SamplingDevices m_sampleSinkDevices;                      //!< Instances of output sinks present in the system

	// "Local" sample source device IDs
    static const QString m_sdrDaemonHardwareID;       //!< SDRdaemon hardware ID
	static const QString m_sdrDaemonDeviceTypeID;     //!< SDRdaemon source plugin ID
	static const QString m_sdrDaemonFECHardwareID;    //!< SDRdaemon with FEC hardware ID
    static const QString m_sdrDaemonFECDeviceTypeID;  //!< SDRdaemon with FEC source plugin ID
    static const QString m_fileSourceHardwareID;      //!< FileSource source hardware ID
    static const QString m_fileSourceDeviceTypeID;    //!< FileSource source plugin ID

    // "Local" sample sink device IDs
    static const QString m_fileSinkDeviceTypeID;      //!< FileSink sink plugin ID

	void loadPlugins(const QDir& dir);

	friend class MainWindow;
};

static inline bool operator<(const PluginManager::Plugin& a, const PluginManager::Plugin& b)
{
	return a.pluginInterface->getPluginDescriptor().displayedName < b.pluginInterface->getPluginDescriptor().displayedName;
}

#endif // INCLUDE_PLUGINMANAGER_H