mirror of
https://github.com/f4exb/sdrangel.git
synced 2024-11-23 00:18:37 -05:00
217 lines
12 KiB
C++
217 lines
12 KiB
C++
///////////////////////////////////////////////////////////////////////////////////
|
|
// Copyright (C) 2019 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 //
|
|
// (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 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_DEVICEAPI_H_
|
|
#define SDRBASE_DEVICE_DEVICEAPI_H_
|
|
|
|
#include <QObject>
|
|
#include <QString>
|
|
#include <QTimer>
|
|
|
|
#include "export.h"
|
|
|
|
class BasebandSampleSink;
|
|
class ThreadedBasebandSampleSink;
|
|
class ThreadedBasebandSampleSource;
|
|
class ChannelAPI;
|
|
class DeviceSampleSink;
|
|
class DeviceSampleSource;
|
|
class MessageQueue;
|
|
class PluginInterface;
|
|
class PluginInstanceGUI;
|
|
class DSPDeviceSourceEngine;
|
|
class DSPDeviceSinkEngine;
|
|
class Preset;
|
|
|
|
class SDRBASE_API DeviceAPI : public QObject {
|
|
Q_OBJECT
|
|
public:
|
|
enum StreamType //!< This is the same enum as in PluginInterface
|
|
{
|
|
StreamSingleRx, //!< Exposes a single input stream that can be one of the streams of a physical device
|
|
StreamSingleTx, //!< Exposes a single output stream that can be one of the streams of a physical device
|
|
StreamAny //!< May expose any number of input and/or output streams
|
|
};
|
|
|
|
enum EngineState {
|
|
StNotStarted, //!< engine is before initialization
|
|
StIdle, //!< engine is idle
|
|
StReady, //!< engine is ready to run
|
|
StRunning, //!< engine is running
|
|
StError //!< engine is in error
|
|
};
|
|
|
|
DeviceAPI(
|
|
StreamType streamType,
|
|
int deviceTabIndex,
|
|
DSPDeviceSourceEngine *deviceSourceEngine,
|
|
DSPDeviceSinkEngine *deviceSinkEngine
|
|
);
|
|
~DeviceAPI();
|
|
|
|
void addAncillarySink(BasebandSampleSink* sink); //!< Adds a sink to receive full baseband and that is not a channel (e.g. spectrum)
|
|
void removeAncillarySink(BasebandSampleSink* sink); //!< Removes it
|
|
|
|
void addChannelSink(ThreadedBasebandSampleSink* sink, int streamIndex = 0); //!< Add a channel sink (Rx)
|
|
void removeChannelSink(ThreadedBasebandSampleSink* sink, int streamIndex = 0); //!< Remove a channel sink (Rx)
|
|
void addChannelSource(ThreadedBasebandSampleSource* sink, int streamIndex = 0); //!< Add a channel source (Tx)
|
|
void removeChannelSource(ThreadedBasebandSampleSource* sink, int streamIndex = 0); //!< Remove a channel source (Tx)
|
|
|
|
void addChannelSinkAPI(ChannelAPI* channelAPI, int streamIndex = 0);
|
|
void removeChannelSinkAPI(ChannelAPI* channelAPI, int streamIndex = 0);
|
|
void addChannelSourceAPI(ChannelAPI* channelAPI, int streamIndex = 0);
|
|
void removeChannelSourceAPI(ChannelAPI* channelAPI, int streamIndex = 0);
|
|
|
|
void setSampleSource(DeviceSampleSource* source); //!< Set the device sample source (single Rx)
|
|
void setSampleSink(DeviceSampleSink* sink); //!< Set the device sample sink (single Tx)
|
|
DeviceSampleSource *getSampleSource(); //!< Return pointer to the device sample source (single Rx) or nullptr
|
|
DeviceSampleSink *getSampleSink(); //!< Return pointer to the device sample sink (single Tx) or nullptr
|
|
|
|
bool initDeviceEngine(); //!< Init the device engine corresponding to the stream type
|
|
bool startDeviceEngine(); //!< Start the device engine corresponding to the stream type
|
|
void stopDeviceEngine(); //!< Stop the device engine corresponding to the stream type
|
|
EngineState state() const; //!< Return the state of the device engine corresponding to the stream type
|
|
QString errorMessage(); //!< Last error message from the device engine
|
|
uint getDeviceUID() const; //!< Return the current device engine unique ID
|
|
|
|
MessageQueue *getDeviceEngineInputMessageQueue(); //!< Device engine message queue
|
|
MessageQueue *getSamplingDeviceInputMessageQueue(); //!< Sampling device (ex: single Rx) input message queue
|
|
// MessageQueue *getSampleSinkInputMessageQueue();
|
|
// MessageQueue *getSampleSourceInputMessageQueue();
|
|
MessageQueue *getSamplingDeviceGUIMessageQueue(); //!< Sampling device (ex: single Tx) GUI input message queue
|
|
// MessageQueue *getSampleSinkGUIMessageQueue();
|
|
// MessageQueue *getSampleSourceGUIMessageQueue();
|
|
|
|
void configureCorrections(bool dcOffsetCorrection, bool iqImbalanceCorrection, int streamIndex = 0); //!< Configure current device engine DSP corrections (Rx)
|
|
|
|
void setHardwareId(const QString& id);
|
|
void setSamplingDeviceId(const QString& id) { m_samplingDeviceId = id; }
|
|
// void setSampleSourceId(const QString& id);
|
|
// void setSampleSinkId(const QString& id);
|
|
void resetSamplingDeviceId() { m_samplingDeviceId.clear(); }
|
|
// void resetSampleSourceId();
|
|
// void resetSampleSinkId();
|
|
void setSamplingDeviceSerial(const QString& serial) { m_samplingDeviceSerial = serial; }
|
|
// void setSampleSourceSerial(const QString& serial);
|
|
// void setSampleSinkSerial(const QString& serial);
|
|
void setSamplingDeviceDisplayName(const QString& name) { m_samplingDeviceDisplayName = name; }
|
|
// void setSampleSourceDisplayName(const QString& serial);
|
|
// void setSampleSinkDisplayName(const QString& serial);
|
|
void setSamplingDeviceSequence(int sequence) { m_samplingDeviceSequence = sequence; }
|
|
// void setSampleSourceSequence(int sequence);
|
|
// void setSampleSinkSequence(int sequence);
|
|
void setNbItems(uint32_t nbItems);
|
|
void setItemIndex(uint32_t index);
|
|
void setSamplingDevicePluginInterface(PluginInterface *iface);
|
|
// void setSampleSourcePluginInterface(PluginInterface *iface);
|
|
// void setSampleSinkPluginInterface(PluginInterface *iface);
|
|
void setSamplingDevicePluginInstanceGUI(PluginInstanceGUI *gui);
|
|
// void setSampleSourcePluginInstanceGUI(PluginInstanceGUI *gui);
|
|
// void setSampleSinkPluginInstanceUI(PluginInstanceGUI *gui);
|
|
|
|
const QString& getHardwareId() const { return m_hardwareId; }
|
|
const QString& getSamplingDeviceId() const { return m_samplingDeviceId; }
|
|
// const QString& getSampleSourceId() const { return m_sampleSourceId; }
|
|
// const QString& getSampleSinkId() const { return m_sampleSinkId; }
|
|
const QString& getSamplingDeviceSerial() const { return m_samplingDeviceSerial; }
|
|
// const QString& getSampleSourceSerial() const { return m_sampleSourceSerial; }
|
|
// const QString& getSampleSinkSerial() const { return m_sampleSinkSerial; }
|
|
const QString& getSamplingDeviceDisplayName() const { return m_samplingDeviceDisplayName; }
|
|
// const QString& getSampleSourceDisplayName() const { return m_sampleSourceDisplayName; }
|
|
// const QString& getSampleSinkDisplayName() const { return m_sampleSinkDisplayName; }
|
|
uint32_t getSamplingDeviceSequence() const { return m_samplingDeviceSequence; }
|
|
// uint32_t getSampleSourceSequence() const { return m_sampleSourceSequence; }
|
|
// uint32_t getSampleSinkSequence() const { return m_sampleSinkSequence; }
|
|
|
|
uint32_t getNbItems() const { return m_nbItems; }
|
|
uint32_t getItemIndex() const { return m_itemIndex; }
|
|
int getDeviceSetIndex() const { return m_deviceTabIndex; }
|
|
PluginInterface *getPluginInterface() { return m_pluginInterface; }
|
|
|
|
PluginInstanceGUI *getSamplingDevicePluginInstanceGUI() { return m_samplingDevicePluginInstanceUI; }
|
|
// PluginInstanceGUI *getSampleSourcePluginInstanceGUI() { return m_sampleSourcePluginInstanceUI; }
|
|
// PluginInstanceGUI *getSampleSinkPluginInstanceGUI() { return m_sampleSinkPluginInstanceUI; }
|
|
|
|
void getDeviceEngineStateStr(QString& state);
|
|
|
|
ChannelAPI *getChanelSinkAPIAt(int index, int streamIndex = 0);
|
|
ChannelAPI *getChanelSourceAPIAt(int index, int streamIndex = 0);
|
|
|
|
int getNbSourceChannels() const { return m_channelSourceAPIs.size(); }
|
|
int getNbSinkChannels() const { return m_channelSinkAPIs.size(); }
|
|
|
|
void loadSamplingDeviceSettings(const Preset* preset);
|
|
// void loadSourceSettings(const Preset* preset);
|
|
// void loadSinkSettings(const Preset* preset);
|
|
void saveSamplingDeviceSettings(Preset* preset);
|
|
// void saveSourceSettings(Preset* preset);
|
|
// void saveSinkSettings(Preset* preset);
|
|
|
|
DSPDeviceSourceEngine *getDeviceSourceEngine() { return m_deviceSourceEngine; }
|
|
DSPDeviceSinkEngine *getDeviceSinkEngine() { return m_deviceSinkEngine; }
|
|
|
|
void addSourceBuddy(DeviceAPI* buddy);
|
|
void addSinkBuddy(DeviceAPI* buddy);
|
|
void removeSourceBuddy(DeviceAPI* buddy);
|
|
void removeSinkBuddy(DeviceAPI* 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 std::vector<DeviceAPI*>& getSourceBuddies() const { return m_sourceBuddies; }
|
|
const std::vector<DeviceAPI*>& getSinkBuddies() const { return m_sinkBuddies; }
|
|
|
|
const QTimer& getMasterTimer() const { return m_masterTimer; } //!< This is the DSPEngine master timer
|
|
|
|
protected:
|
|
// common
|
|
|
|
StreamType m_streamType;
|
|
int m_deviceTabIndex; //!< This is the tab index in the GUI and also the device set index
|
|
QString m_hardwareId; //!< The internal id that identifies the type of hardware (i.e. HackRF, BladeRF, ...)
|
|
uint32_t m_nbItems; //!< Number of items or streams in the device. Can be >1 for NxM devices (i.e. 2 for LimeSDR)
|
|
uint32_t m_itemIndex; //!< The Rx stream index. Can be >0 for NxM devices (i.e. 0 or 1 for LimeSDR)
|
|
PluginInterface* m_pluginInterface;
|
|
const QTimer& m_masterTimer; //!< This is the DSPEngine master timer
|
|
QString m_samplingDeviceId; //!< The internal plugin ID corresponding to the device (i.e. for HackRF input, for HackRF output ...)
|
|
QString m_samplingDeviceSerial; //!< The device serial number defined by the vendor or a fake one (SDRplay)
|
|
QString m_samplingDeviceDisplayName; //!< The human readable name identifying this instance
|
|
uint32_t m_samplingDeviceSequence; //!< The device sequence. >0 when more than one device of the same type is connected
|
|
PluginInstanceGUI* m_samplingDevicePluginInstanceUI;
|
|
|
|
// Buddies (single Rx or single Tx)
|
|
|
|
std::vector<DeviceAPI*> m_sourceBuddies; //!< Device source APIs referencing the same physical device
|
|
std::vector<DeviceAPI*> m_sinkBuddies; //!< Device sink APIs referencing the same physical device
|
|
void *m_buddySharedPtr;
|
|
bool m_isBuddyLeader;
|
|
|
|
// Single Rx (i.e. source)
|
|
|
|
DSPDeviceSourceEngine *m_deviceSourceEngine;
|
|
QList<ChannelAPI*> m_channelSinkAPIs;
|
|
|
|
// Single Tx (i.e. sink)
|
|
|
|
DSPDeviceSinkEngine *m_deviceSinkEngine;
|
|
QList<ChannelAPI*> m_channelSourceAPIs;
|
|
|
|
private:
|
|
void renumerateChannels();
|
|
};
|
|
#endif // SDRBASE_DEVICE_DEVICEAPI_H_
|