/////////////////////////////////////////////////////////////////////////////////// // 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 . // /////////////////////////////////////////////////////////////////////////////////// #ifndef INCLUDE_REMOTEOUTPUT_H #define INCLUDE_REMOTEOUTPUT_H #include #include #include #include #include #include #include #include #include "dsp/devicesamplesink.h" #include "remoteoutputsettings.h" class RemoteOutputWorker; 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) { } }; class MsgReportRemoteData : public Message { MESSAGE_CLASS_DECLARATION public: struct RemoteData { quint64 m_centerFrequency; //!< Center frequency where the stream is placed int m_sampleRate; //!< Sample rate requested by remote int m_queueSize; //!< Remote data read queue size int m_queueLength; //!< Remote data queue length int m_unrecoverableCount; //!< Number of unrecoverable errors from FEC int m_recoverableCount; //!< Number of recoverable errors from FEC uint64_t m_timestampUs; //!< Unix time stamp of request in microseconds uint32_t m_sampleCount; //!< Number of samples processed in the remote at request time }; const RemoteData& getData() const { return m_remoteData; } static MsgReportRemoteData* create(const RemoteData& remoteData) { return new MsgReportRemoteData(remoteData); } private: RemoteData m_remoteData; MsgReportRemoteData(const RemoteData& remoteData) : Message(), m_remoteData(remoteData) {} }; class MsgReportRemoteFixedData : public Message { MESSAGE_CLASS_DECLARATION public: struct RemoteData { QString m_version; //!< Remote SDRangel version QString m_qtVersion; //!< Remote Qt version used to build SDRangel QString m_architecture; //!< Remote CPU architecture QString m_os; //!< Remote O/S int m_rxBits; //!< Number of bits used for I or Q sample on Rx side int m_txBits; //!< Number of bits used for I or Q sample on Tx side }; const RemoteData& getData() const { return m_remoteData; } static MsgReportRemoteFixedData* create(const RemoteData& remoteData) { return new MsgReportRemoteFixedData(remoteData); } private: RemoteData m_remoteData; MsgReportRemoteFixedData(const RemoteData& remoteData) : Message(), m_remoteData(remoteData) {} }; class MsgRequestFixedData : public Message { MESSAGE_CLASS_DECLARATION public: static MsgRequestFixedData* create() { return new MsgRequestFixedData(); } private: MsgRequestFixedData() : Message() {} }; 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); static void webapiFormatDeviceSettings( SWGSDRangel::SWGDeviceSettings& response, const RemoteOutputSettings& settings); static void webapiUpdateDeviceSettings( RemoteOutputSettings& settings, const QStringList& deviceSettingsKeys, SWGSDRangel::SWGDeviceSettings& response); private: DeviceAPI *m_deviceAPI; QMutex m_mutex; RemoteOutputSettings m_settings; uint64_t m_centerFrequency; int m_sampleRate; RemoteOutputWorker* m_remoteOutputWorker; QThread m_remoteOutputWorkerThread; QString m_deviceDescription; std::time_t m_startingTimeStamp; const QTimer& m_masterTimer; uint32_t m_tickCount; // for 50 ms timer uint32_t m_greaterTickCount; // for 1 s derived timer uint32_t m_tickMultiplier; // for greater tick count int m_queueLength; int m_queueSize; int m_recoverableCount; int m_unrecoverableCount; QNetworkAccessManager *m_networkManager; QNetworkRequest m_networkRequest; void startWorker(); void stopWorker(); void applySettings(const RemoteOutputSettings& settings, bool force = false); void applyCenterFrequency(); void applySampleRate(); void webapiFormatDeviceReport(SWGSDRangel::SWGDeviceReport& response); void analyzeApiReply(const QJsonObject& jsonObject, const QString& answer); void queueLengthCompensation( int nominalSR, int queueLength, int queueSize ); void webapiReverseSendSettings(QList& deviceSettingsKeys, const RemoteOutputSettings& settings, bool force); void webapiReverseSendStartStop(bool start); private slots: void tick(); void networkManagerFinished(QNetworkReply *reply); }; #endif // INCLUDE_REMOTEOUTPUT_H