sdrangel/sdrbase/device/devicesinkapi.h

173 wiersze
7.9 KiB
C++

///////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2016 Edouard Griffiths, F4EXB //
// //
// 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 as version 3 of the License, or //
// //
// 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 V3 for more details. //
// //
// You should have received a copy of the GNU General Public License //
// along with this program. If not, see <http://www.gnu.org/licenses/>. //
///////////////////////////////////////////////////////////////////////////////////
#ifndef SDRBASE_DEVICE_DEVICESINKAPI_H_
#define SDRBASE_DEVICE_DEVICESINKAPI_H_
#include <QObject>
#include <QString>
#include "dsp/dspdevicesinkengine.h"
#include "util/export.h"
class MainWindow;
class GLSpectrum;
class ChannelWindow;
class BasebandSampleSource;
class ThreadedBasebandSampleSource;
class DeviceSampleSink;
class MessageQueue;
class ChannelMarker;
class QWidget;
class PluginInstanceGUI;
class PluginAPI;
class PluginInterface;
class Preset;
class DeviceSourceAPI;
class SDRANGEL_API DeviceSinkAPI : public QObject {
Q_OBJECT
public:
// Device engine stuff
void addSpectrumSink(BasebandSampleSink* sink); //!< Add the spectrum sample sink to device engine (spectrum vis)
void removeSpectrumSink(BasebandSampleSink* sink); //!< Remove the spectrum sample sink from device engine (spectrum vis)
void addSource(BasebandSampleSource* source); //!< Add a baseband sample source to device engine
void removeSource(BasebandSampleSource* sink); //!< Remove a baseband sample source from device engine
void addThreadedSource(ThreadedBasebandSampleSource* sink); //!< Add a baseband sample source that will run on its own thread to device engine
void removeThreadedSource(ThreadedBasebandSampleSource* sink); //!< Remove a baseband sample source that runs on its own thread from device engine
uint32_t getNumberOfSources();
void setSampleSink(DeviceSampleSink* sink); //!< Set device engine sample sink type
DeviceSampleSink *getSampleSink(); //!< Return pointer to the device sample sink
bool initGeneration(); //!< Initialize device engine generation sequence
bool startGeneration(); //!< Start device engine generation sequence
void stopGeneration(); //!< Stop device engine generation sequence
DSPDeviceSinkEngine::State state() const; //!< device engine state
QString errorMessage(); //!< Return the current device engine error message
uint getDeviceUID() const; //!< Return the current device engine unique ID
MessageQueue *getDeviceEngineInputMessageQueue();
MessageQueue *getSampleSinkInputMessageQueue();
MessageQueue *getSampleSinkGUIMessageQueue();
// device related stuff
GLSpectrum *getSpectrum(); //!< Direct spectrum getter
void addChannelMarker(ChannelMarker* channelMarker); //!< Add channel marker to spectrum
ChannelWindow *getChannelWindow(); //!< Direct channel window getter
void addRollupWidget(QWidget *widget); //!< Add rollup widget to channel window
void setHardwareId(const QString& id);
void setSampleSinkId(const QString& id);
void resetSampleSinkId();
void setSampleSinkSerial(const QString& serial);
void setSampleSinkDisplayName(const QString& serial);
void setSampleSinkSequence(int sequence);
void setSampleSinkPluginInterface(PluginInterface *iface);
void setSampleSinkPluginInstanceUI(PluginInstanceGUI *gui);
const QString& getHardwareId() const { return m_hardwareId; }
const QString& getSampleSinkId() const { return m_sampleSinkId; }
const QString& getSampleSinkSerial() const { return m_sampleSinkSerial; }
const QString& getSampleSinkDisplayName() const { return m_sampleSinkDisplayName; }
PluginInterface *getPluginInterface() { return m_pluginInterface; }
uint32_t getSampleSinkSequence() const { return m_sampleSinkSequence; }
PluginInstanceGUI *getSampleSinkPluginInstanceGUI() { return m_sampleSinkPluginInstanceUI; }
void registerChannelInstance(const QString& channelName, PluginInstanceGUI* pluginGUI);
void removeChannelInstance(PluginInstanceGUI* pluginGUI);
void freeChannels();
void loadSinkSettings(const Preset* preset);
void saveSinkSettings(Preset* preset);
void loadChannelSettings(const Preset* preset, PluginAPI *pluginAPI);
void saveChannelSettings(Preset* preset);
MainWindow *getMainWindow() { return m_mainWindow; }
DSPDeviceSinkEngine *getDeviceSinkEngine() { return m_deviceSinkEngine; }
const std::vector<DeviceSourceAPI*>& getSourceBuddies() const { return m_sourceBuddies; }
const std::vector<DeviceSinkAPI*>& getSinkBuddies() const { return m_sinkBuddies; }
void addSourceBuddy(DeviceSourceAPI* buddy);
void addSinkBuddy(DeviceSinkAPI* buddy);
void removeSourceBuddy(DeviceSourceAPI* buddy);
void removeSinkBuddy(DeviceSinkAPI* buddy);
void clearBuddiesLists();
void *getBuddySharedPtr() const { return m_buddySharedPtr; }
void setBuddySharedPtr(void *ptr) { m_buddySharedPtr = ptr; }
bool isBuddyLeader() const { return m_isBuddyLeader; }
void setBuddyLeader(bool isBuddyLeader) { m_isBuddyLeader = isBuddyLeader; }
const QTimer& getMasterTimer() const { return m_masterTimer; }
protected:
struct ChannelInstanceRegistration
{
QString m_channelName;
PluginInstanceGUI* m_gui;
ChannelInstanceRegistration() :
m_channelName(),
m_gui(0)
{ }
ChannelInstanceRegistration(const QString& channelName, PluginInstanceGUI* pluginGUI) :
m_channelName(channelName),
m_gui(pluginGUI)
{ }
bool operator<(const ChannelInstanceRegistration& other) const;
};
typedef QList<ChannelInstanceRegistration> ChannelInstanceRegistrations;
DeviceSinkAPI(MainWindow *mainWindow,
int deviceTabIndex,
DSPDeviceSinkEngine *deviceEngine,
GLSpectrum *glSpectrum,
ChannelWindow *channelWindow);
~DeviceSinkAPI();
void renameChannelInstances();
MainWindow *m_mainWindow;
int m_deviceTabIndex;
DSPDeviceSinkEngine *m_deviceSinkEngine;
GLSpectrum *m_spectrum;
ChannelWindow *m_channelWindow;
QString m_hardwareId;
QString m_sampleSinkId;
QString m_sampleSinkSerial;
QString m_sampleSinkDisplayName;
uint32_t m_sampleSinkSequence;
PluginInterface* m_pluginInterface;
PluginInstanceGUI* m_sampleSinkPluginInstanceUI;
ChannelInstanceRegistrations m_channelInstanceRegistrations;
std::vector<DeviceSourceAPI*> m_sourceBuddies; //!< Device source APIs referencing the same physical device
std::vector<DeviceSinkAPI*> m_sinkBuddies; //!< Device sink APIs referencing the same physical device
void *m_buddySharedPtr;
bool m_isBuddyLeader;
const QTimer& m_masterTimer;
friend class MainWindow;
friend class DeviceSourceAPI;
};
#endif /* SDRBASE_DEVICE_DEVICESINKAPI_H_ */