deviceapi.h

Go to the documentation of this file.

// 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 DeviceSampleMIMO;
class MessageQueue;
class PluginInterface;
class PluginInstanceGUI;
class DSPDeviceSourceEngine;
class DSPDeviceSinkEngine;
class DSPDeviceMIMOEngine;
class Preset;

class SDRBASE_API DeviceAPI : public QObject {
    Q_OBJECT
public:
    enum StreamType 
    {
        StreamSingleRx, 
        StreamSingleTx, 
        StreamMIMO      
    };

    enum EngineState {
        StNotStarted,  
        StIdle,        
        StReady,       
        StRunning,     
        StError        
    };

    DeviceAPI(
        StreamType streamType,
        int deviceTabIndex,
        DSPDeviceSourceEngine *deviceSourceEngine,
        DSPDeviceSinkEngine *deviceSinkEngine,
        DSPDeviceMIMOEngine *deviceMIMOEngine
    );
    ~DeviceAPI();

    // MIMO Engine baseband / channel lists management
    void addSourceStream(bool connect);
    void removeLastSourceStream();
    void addSinkStream(bool connect);
    void removeLastSinkStream();

    void addAncillarySink(BasebandSampleSink* sink, unsigned int index = 0);       
    void removeAncillarySink(BasebandSampleSink* sink, unsigned int index = 0);    
    void setSpectrumSinkInput(bool sourceElseSink = true, unsigned int index = 0); 

    void addChannelSink(ThreadedBasebandSampleSink* sink, int streamIndex = 0);        
    void removeChannelSink(ThreadedBasebandSampleSink* sink, int streamIndex = 0);     
    void addChannelSource(ThreadedBasebandSampleSource* sink, int streamIndex = 0);    
    void removeChannelSource(ThreadedBasebandSampleSource* sink, int streamIndex = 0); 

    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); 
    void setSampleSink(DeviceSampleSink* sink);       
    void setSampleMIMO(DeviceSampleMIMO* mimo);       
    DeviceSampleSource *getSampleSource();            
    DeviceSampleSink *getSampleSink();                
    DeviceSampleMIMO *getSampleMIMO();                

    bool initDeviceEngine();    
    bool startDeviceEngine();   
    void stopDeviceEngine();    
    EngineState state() const;  
    QString errorMessage();     
    uint getDeviceUID() const;  

    MessageQueue *getDeviceEngineInputMessageQueue();   
    MessageQueue *getSamplingDeviceInputMessageQueue(); 
    MessageQueue *getSamplingDeviceGUIMessageQueue();   

    void configureCorrections(bool dcOffsetCorrection, bool iqImbalanceCorrection, int streamIndex = 0); 

    void setHardwareId(const QString& id);
    void setSamplingDeviceId(const QString& id) { m_samplingDeviceId = id; }
    void resetSamplingDeviceId() { m_samplingDeviceId.clear(); }
    void setSamplingDeviceSerial(const QString& serial) { m_samplingDeviceSerial = serial; }
    void setSamplingDeviceDisplayName(const QString& name) { m_samplingDeviceDisplayName = name; }
    void setSamplingDeviceSequence(int sequence) { m_samplingDeviceSequence = sequence; }
    void setHardwareUserArguments(const QString& userArguments) { m_hardwareUserArguments = userArguments; }
    void setSamplingDevicePluginInterface(PluginInterface *iface);
    void setSamplingDevicePluginInstanceGUI(PluginInstanceGUI *gui);

    const QString& getHardwareId() const { return m_hardwareId; }
    const QString& getSamplingDeviceId() const { return m_samplingDeviceId; }
    const QString& getSamplingDeviceSerial() const { return m_samplingDeviceSerial; }
    const QString& getSamplingDeviceDisplayName() const { return m_samplingDeviceDisplayName; }
    uint32_t getSamplingDeviceSequence() const { return m_samplingDeviceSequence; }
    const QString& getHardwareUserArguments() const { return m_hardwareUserArguments; }

    void setDeviceNbItems(uint32_t nbItems);
    void setDeviceItemIndex(uint32_t index);
    uint32_t getDeviceNbItems() const { return m_deviceNbItems; }
    uint32_t getDeviceItemIndex() const { return m_deviceItemIndex; }

    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; }

    void setNbSourceStreams(uint32_t nbSourceStreams) { m_nbSourceStreams = nbSourceStreams; }
    void setNbSinkStreams(uint32_t nbSinkStreams) { m_nbSinkStreams = nbSinkStreams; }
    uint32_t getNbSourceStreams() const { return m_nbSourceStreams; }
    uint32_t getNbSinkStreams() const { return m_nbSinkStreams; }

    const QTimer& getMasterTimer() const { return m_masterTimer; } 

protected:
    // common

    StreamType m_streamType;
    int m_deviceTabIndex;                
    QString m_hardwareId;                
    uint32_t m_deviceNbItems;            
    uint32_t m_deviceItemIndex;          
    uint32_t m_nbSourceStreams;          
    uint32_t m_nbSinkStreams;            
    PluginInterface* m_pluginInterface;
    const QTimer& m_masterTimer;         
    QString m_samplingDeviceId;          
    QString m_samplingDeviceSerial;      
    QString m_samplingDeviceDisplayName; 
    uint32_t m_samplingDeviceSequence;   
    QString m_hardwareUserArguments;     
    PluginInstanceGUI* m_samplingDevicePluginInstanceUI;

    // Buddies (single Rx or single Tx)

    std::vector<DeviceAPI*> m_sourceBuddies; 
    std::vector<DeviceAPI*> m_sinkBuddies;   
    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;

    // MIMO

    DSPDeviceMIMOEngine *m_deviceMIMOEngine;

private:
    void renumerateChannels();
};
#endif // SDRBASE_DEVICE_DEVICEAPI_H_