dspdevicesourceengine.h

Go to the documentation of this file.

// Copyright (C) 2015 F4EXB                                                      //
// written by Edouard Griffiths                                                  //
//                                                                               //
// 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 INCLUDE_DSPDEVICEENGINE_H
#define INCLUDE_DSPDEVICEENGINE_H

#include <QThread>
#include <QTimer>
#include <QMutex>
#include <QWaitCondition>
#include "dsp/dsptypes.h"
#include "dsp/fftwindow.h"
#include "util/messagequeue.h"
#include "util/syncmessenger.h"
#include "export.h"
#include "util/movingaverage.h"

class DeviceSampleSource;
class BasebandSampleSink;
class ThreadedBasebandSampleSink;

class SDRBASE_API DSPDeviceSourceEngine : public QThread {
    Q_OBJECT

public:
    enum State {
        StNotStarted,  
        StIdle,        
        StReady,       
        StRunning,     
        StError        
    };

    DSPDeviceSourceEngine(uint uid, QObject* parent = NULL);
    ~DSPDeviceSourceEngine();

    uint getUID() const { return m_uid; }

    MessageQueue* getInputMessageQueue() { return &m_inputMessageQueue; }

    void start(); 
    void stop();  

    bool initAcquisition(); 
    bool startAcquisition(); 
    void stopAcquistion();   

    void setSource(DeviceSampleSource* source); 
    void setSourceSequence(int sequence); 
    DeviceSampleSource *getSource() { return m_deviceSampleSource; }

    void addSink(BasebandSampleSink* sink); 
    void removeSink(BasebandSampleSink* sink); 

    void addThreadedSink(ThreadedBasebandSampleSink* sink); 
    void removeThreadedSink(ThreadedBasebandSampleSink* sink); 

    void configureCorrections(bool dcOffsetCorrection, bool iqImbalanceCorrection); 

    State state() const { return m_state; } 

    QString errorMessage(); 
    QString sourceDeviceDescription(); 

private:
    uint m_uid; 

    MessageQueue m_inputMessageQueue;  //<! Input message queue. Post here.
    SyncMessenger m_syncMessenger;     

    State m_state;

    QString m_errorMessage;
    QString m_deviceDescription;

    DeviceSampleSource* m_deviceSampleSource;
    int m_sampleSourceSequence;

    typedef std::list<BasebandSampleSink*> BasebandSampleSinks;
    BasebandSampleSinks m_basebandSampleSinks; 

    typedef std::list<ThreadedBasebandSampleSink*> ThreadedBasebandSampleSinks;
    ThreadedBasebandSampleSinks m_threadedBasebandSampleSinks; 

    uint m_sampleRate;
    quint64 m_centerFrequency;

    bool m_dcOffsetCorrection;
    bool m_iqImbalanceCorrection;
    double m_iOffset, m_qOffset;

    MovingAverageUtil<int32_t, int64_t, 1024> m_iBeta;
    MovingAverageUtil<int32_t, int64_t, 1024> m_qBeta;

#if IMBALANCE_INT
    // Fixed point DC + IQ corrections
    MovingAverageUtil<int64_t, int64_t, 128> m_avgII;
    MovingAverageUtil<int64_t, int64_t, 128> m_avgIQ;
    MovingAverageUtil<int64_t, int64_t, 128> m_avgPhi;
    MovingAverageUtil<int64_t, int64_t, 128> m_avgII2;
    MovingAverageUtil<int64_t, int64_t, 128> m_avgQQ2;
    MovingAverageUtil<int64_t, int64_t, 128> m_avgAmp;

#else
    // Floating point DC + IQ corrections
    MovingAverageUtil<float, double, 128> m_avgII;
    MovingAverageUtil<float, double, 128> m_avgIQ;
    MovingAverageUtil<float, double, 128> m_avgII2;
    MovingAverageUtil<float, double, 128> m_avgQQ2;
    MovingAverageUtil<double, double, 128> m_avgPhi;
    MovingAverageUtil<double, double, 128> m_avgAmp;
#endif

    qint32 m_iRange;
    qint32 m_qRange;
    qint32 m_imbalance;

    void run();

    void iqCorrections(SampleVector::iterator begin, SampleVector::iterator end, bool imbalanceCorrection);
    void dcOffset(SampleVector::iterator begin, SampleVector::iterator end);
    void imbalance(SampleVector::iterator begin, SampleVector::iterator end);
    void work(); 

    State gotoIdle();     
    State gotoInit();     
    State gotoRunning();  
    State gotoError(const QString& errorMsg); 

    void handleSetSource(DeviceSampleSource* source); 

private slots:
    void handleData(); 
    void handleInputMessages(); 
    void handleSynchronousMessages(); 
};

#endif // INCLUDE_DSPDEVICEENGINE_H