dspdevicesinkengine.h

Go to the documentation of this file.

// Copyright (C) 2016 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 SDRBASE_DSP_DSPDEVICESINKENGINE_H_
#define SDRBASE_DSP_DSPDEVICESINKENGINE_H_

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

class DeviceSampleSink;
class BasebandSampleSource;
class ThreadedBasebandSampleSource;
class BasebandSampleSink;

class SDRBASE_API DSPDeviceSinkEngine : public QThread {
    Q_OBJECT

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

    DSPDeviceSinkEngine(uint32_t uid, QObject* parent = NULL);
    ~DSPDeviceSinkEngine();

    uint32_t getUID() const { return m_uid; }

    MessageQueue* getInputMessageQueue() { return &m_inputMessageQueue; }

    void start(); 
    void stop();  

    bool initGeneration(); 
    bool startGeneration(); 
    void stopGeneration();   

    void setSink(DeviceSampleSink* sink); 
    DeviceSampleSink *getSink() { return m_deviceSampleSink; }
    void setSinkSequence(int sequence); 

    void addThreadedSource(ThreadedBasebandSampleSource* source); 
    void removeThreadedSource(ThreadedBasebandSampleSource* source); 

    void addSpectrumSink(BasebandSampleSink* spectrumSink);    
    void removeSpectrumSink(BasebandSampleSink* spectrumSink); 

    State state() const { return m_state; } 

    QString errorMessage(); 
    QString sinkDeviceDescription(); 

private:
    uint32_t m_uid; 

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

    State m_state;

    QString m_errorMessage;
    QString m_deviceDescription;

    DeviceSampleSink* m_deviceSampleSink;
    int m_sampleSinkSequence;

    typedef std::list<BasebandSampleSource*> BasebandSampleSources;
    BasebandSampleSources m_basebandSampleSources; 

    typedef std::list<ThreadedBasebandSampleSource*> ThreadedBasebandSampleSources;
    ThreadedBasebandSampleSources m_threadedBasebandSampleSources; 

    typedef std::map<BasebandSampleSource*, SampleVector::iterator> BasebandSampleSourcesIteratorMap;
    typedef std::pair<BasebandSampleSource*, SampleVector::iterator> BasebandSampleSourcesIteratorMapKV;
    BasebandSampleSourcesIteratorMap m_basebandSampleSourcesIteratorMap;

    typedef std::map<ThreadedBasebandSampleSource*, SampleVector::iterator> ThreadedBasebandSampleSourcesIteratorMap;
    typedef std::pair<ThreadedBasebandSampleSource*, SampleVector::iterator> ThreadedBasebandSampleSourcesIteratorMapKV;
    ThreadedBasebandSampleSourcesIteratorMap m_threadedBasebandSampleSourcesIteratorMap;

    BasebandSampleSink *m_spectrumSink;

    uint32_t m_sampleRate;
    quint64 m_centerFrequency;
    uint32_t m_multipleSourcesDivisionFactor;

    void run();
    void work(int nbWriteSamples); 

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

    void handleSetSink(DeviceSampleSink* sink); 
    void checkNumberOfBasebandSources();

private slots:
    void handleData(int nbSamples); 
    void handleInputMessages(); 
    void handleSynchronousMessages(); 
    void handleForwardToSpectrumSink(int nbSamples);
};





#endif /* SDRBASE_DSP_DSPDEVICESINKENGINE_H_ */