remoteoutput.h

Go to the documentation of this file.

// Copyright (C) 2017 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 INCLUDE_REMOTEOUTPUT_H
#define INCLUDE_REMOTEOUTPUT_H

#include <ctime>
#include <iostream>
#include <fstream>

#include <QObject>
#include <QString>
#include <QTimer>
#include <QNetworkRequest>

#include "dsp/devicesamplesink.h"

#include "remoteoutputsettings.h"

class RemoteOutputThread;
class DeviceAPI;
class QNetworkAccessManager;
class QNetworkReply;
class QJsonObject;

class RemoteOutput : public DeviceSampleSink {
    Q_OBJECT
public:
    class MsgConfigureRemoteOutput : public Message {
        MESSAGE_CLASS_DECLARATION

    public:
        const RemoteOutputSettings& getSettings() const { return m_settings; }
        bool getForce() const { return m_force; }

        static MsgConfigureRemoteOutput* create(const RemoteOutputSettings& settings, bool force = false)
        {
            return new MsgConfigureRemoteOutput(settings, force);
        }

    private:
        RemoteOutputSettings m_settings;
        bool m_force;

        MsgConfigureRemoteOutput(const RemoteOutputSettings& settings, bool force) :
            Message(),
            m_settings(settings),
            m_force(force)
        { }
    };

    class MsgConfigureRemoteOutputWork : public Message {
        MESSAGE_CLASS_DECLARATION

    public:
        bool isWorking() const { return m_working; }

        static MsgConfigureRemoteOutputWork* create(bool working)
        {
            return new MsgConfigureRemoteOutputWork(working);
        }

    private:
        bool m_working;

        MsgConfigureRemoteOutputWork(bool working) :
            Message(),
            m_working(working)
        { }
    };

    class MsgStartStop : public Message {
        MESSAGE_CLASS_DECLARATION

    public:
        bool getStartStop() const { return m_startStop; }

        static MsgStartStop* create(bool startStop) {
            return new MsgStartStop(startStop);
        }

    protected:
        bool m_startStop;

        MsgStartStop(bool startStop) :
            Message(),
            m_startStop(startStop)
        { }
    };

    class MsgConfigureRemoteOutputChunkCorrection : public Message {
        MESSAGE_CLASS_DECLARATION

    public:
        int getChunkCorrection() const { return m_chunkCorrection; }

        static MsgConfigureRemoteOutputChunkCorrection* create(int chunkCorrection)
        {
            return new MsgConfigureRemoteOutputChunkCorrection(chunkCorrection);
        }

    private:
        int m_chunkCorrection;

        MsgConfigureRemoteOutputChunkCorrection(int chunkCorrection) :
            Message(),
            m_chunkCorrection(chunkCorrection)
        { }
    };

    RemoteOutput(DeviceAPI *deviceAPI);
    virtual ~RemoteOutput();
    virtual void destroy();

    virtual void init();
    virtual bool start();
    virtual void stop();

    virtual QByteArray serialize() const;
    virtual bool deserialize(const QByteArray& data);

    virtual void setMessageQueueToGUI(MessageQueue *queue) { m_guiMessageQueue = queue; }
    virtual const QString& getDeviceDescription() const;
    virtual int getSampleRate() const;
    virtual void setSampleRate(int sampleRate) { (void) sampleRate; }
    virtual quint64 getCenterFrequency() const;
    virtual void setCenterFrequency(qint64 centerFrequency) { (void) centerFrequency; }
    std::time_t getStartingTimeStamp() const;

    virtual bool handleMessage(const Message& message);

    virtual int webapiSettingsGet(
                SWGSDRangel::SWGDeviceSettings& response,
                QString& errorMessage);

    virtual int webapiSettingsPutPatch(
                bool force,
                const QStringList& deviceSettingsKeys,
                SWGSDRangel::SWGDeviceSettings& response, // query + response
                QString& errorMessage);

    virtual int webapiReportGet(
            SWGSDRangel::SWGDeviceReport& response,
            QString& errorMessage);

    virtual int webapiRunGet(
            SWGSDRangel::SWGDeviceState& response,
            QString& errorMessage);

    virtual int webapiRun(
            bool run,
            SWGSDRangel::SWGDeviceState& response,
            QString& errorMessage);

private:
    DeviceAPI *m_deviceAPI;
    QMutex m_mutex;
    RemoteOutputSettings m_settings;
    uint64_t m_centerFrequency;
    RemoteOutputThread* m_remoteOutputThread;
    QString m_deviceDescription;
    std::time_t m_startingTimeStamp;
    const QTimer& m_masterTimer;
    uint32_t m_tickCount;
    uint32_t m_tickMultiplier;

    QNetworkAccessManager *m_networkManager;
    QNetworkRequest m_networkRequest;

    uint32_t m_lastRemoteSampleCount;
    uint32_t m_lastSampleCount;
    uint64_t m_lastRemoteTimestampRateCorrection;
    uint64_t m_lastTimestampRateCorrection;
    int m_lastQueueLength;
    uint32_t m_nbRemoteSamplesSinceRateCorrection;
    uint32_t m_nbSamplesSinceRateCorrection;
    int m_chunkSizeCorrection;
    static const uint32_t NbSamplesForRateCorrection;

    void applySettings(const RemoteOutputSettings& settings, bool force = false);
    void webapiFormatDeviceSettings(SWGSDRangel::SWGDeviceSettings& response, const RemoteOutputSettings& settings);
    void webapiFormatDeviceReport(SWGSDRangel::SWGDeviceReport& response);

    void analyzeApiReply(const QJsonObject& jsonObject, const QString& answer);
    void sampleRateCorrection(double remoteTimeDeltaUs, double timeDeltaUs, uint32_t remoteSampleCount, uint32_t sampleCount);
    void webapiReverseSendSettings(QList<QString>& deviceSettingsKeys, const RemoteOutputSettings& settings, bool force);
    void webapiReverseSendStartStop(bool start);

private slots:
    void tick();
    void networkManagerFinished(QNetworkReply *reply);
};

#endif // INCLUDE_REMOTEOUTPUT_H