Merge pull request #2590 from f4exb/feature-2561

FT8 Demodulator: added option to send reports to PSK reporter. Fixes #2561

Author: f4exb

doc/img/FT8Demod_plugin_C1.png

@@ -9,6 +9,7 @@ set(demodft8_SOURCES
 	ft8plugin.cpp
     ft8buffer.cpp
     ft8demodworker.cpp
+    pskreporterworker.cpp
 )
 
 set(demodft8_HEADERS
@@ -19,7 +20,8 @@ set(demodft8_HEADERS
     ft8demodwebapiadapter.h
 	ft8plugin.h
     ft8buffer.h
-    ft8demodworker.h;
+    ft8demodworker.h
+    pskreporterworker.h
 )
 
 include_directories(

doc/img/FT8Demod_plugin_C1.xcf

@@ -329,6 +329,18 @@ void FT8Demod::applySettings(const FT8DemodSettings& settings, bool force)
     if ((m_settings.m_verifyOSD != settings.m_verifyOSD) || force) {
         reverseAPIKeys.append("verifyOSD");
     }
+    if ((m_settings.m_enablePSKReporter != settings.m_enablePSKReporter) || force) {
+        reverseAPIKeys.append("enablePSKReporter");
+    }
+    if ((m_settings.m_pskReporterCallsign != settings.m_pskReporterCallsign) || force) {
+        reverseAPIKeys.append("pskReporterCallsign");
+    }
+    if ((m_settings.m_pskReporterLocator != settings.m_pskReporterLocator) || force) {
+        reverseAPIKeys.append("pskReporterLocator");
+    }
+    if ((m_settings.m_pskReporterSoftware != settings.m_pskReporterSoftware) || force) {
+        reverseAPIKeys.append("pskReporterSoftware");
+    }
 
     if (m_settings.m_streamIndex != settings.m_streamIndex)
     {
@@ -525,6 +537,18 @@ void FT8Demod::webapiUpdateChannelSettings(
     if (channelSettingsKeys.contains("verifyOSD")) {
         settings.m_verifyOSD = response.getFt8DemodSettings()->getVerifyOsd() != 0;
     }
+    if (channelSettingsKeys.contains("enablePSKReporter")) {
+        settings.m_enablePSKReporter = response.getFt8DemodSettings()->getEnablePskReporter() != 0;
+    }
+    if (channelSettingsKeys.contains("pskReporterCallsign")) {
+        settings.m_pskReporterCallsign = *response.getFt8DemodSettings()->getPskReporterCallsign();
+    }
+    if (channelSettingsKeys.contains("pskReporterLocator")) {
+        settings.m_pskReporterLocator = *response.getFt8DemodSettings()->getPskReporterLocator();
+    }
+    if (channelSettingsKeys.contains("pskReporterSoftware")) {
+        settings.m_pskReporterSoftware = *response.getFt8DemodSettings()->getPskReporterSoftware();
+    }
     if (channelSettingsKeys.contains("rgbColor")) {
         settings.m_rgbColor = response.getFt8DemodSettings()->getRgbColor();
     }
@@ -589,6 +613,10 @@ void FT8Demod::webapiFormatChannelSettings(SWGSDRangel::SWGChannelSettings& resp
     response.getFt8DemodSettings()->setOsdDepth(settings.m_osdDepth);
     response.getFt8DemodSettings()->setOsdLdpcThreshold(settings.m_osdLDPCThreshold);
     response.getFt8DemodSettings()->setUseOsd(settings.m_verifyOSD ? 1 : 0);
+    response.getFt8DemodSettings()->setEnablePskReporter(settings.m_enablePSKReporter ? 1 : 0);
+    response.getFt8DemodSettings()->setPskReporterCallsign(new QString(settings.m_pskReporterCallsign));
+    response.getFt8DemodSettings()->setPskReporterLocator(new QString(settings.m_pskReporterLocator));
+    response.getFt8DemodSettings()->setPskReporterSoftware(new QString(settings.m_pskReporterSoftware));
     response.getFt8DemodSettings()->setRgbColor(settings.m_rgbColor);
 
     if (response.getFt8DemodSettings()->getTitle()) {
@@ -784,6 +812,18 @@ void FT8Demod::webapiFormatChannelSettings(
     if (channelSettingsKeys.contains("verifyOSD") || force) {
         swgFT8DemodSettings->setVerifyOsd(settings.m_verifyOSD ? 1 : 0);
     }
+    if (channelSettingsKeys.contains("enablePSKReporter") || force) {
+        swgFT8DemodSettings->setEnablePskReporter(settings.m_enablePSKReporter ? 1 : 0);
+    }
+    if (channelSettingsKeys.contains("pskReporterCallsign") || force) {
+        swgFT8DemodSettings->setPskReporterCallsign(new QString(settings.m_pskReporterCallsign));
+    }
+    if (channelSettingsKeys.contains("pskReporterLocator") || force) {
+        swgFT8DemodSettings->setPskReporterLocator(new QString(settings.m_pskReporterLocator));
+    }
+    if (channelSettingsKeys.contains("pskReporterSoftware") || force) {
+        swgFT8DemodSettings->setPskReporterSoftware(new QString(settings.m_pskReporterSoftware));
+    }
     if (channelSettingsKeys.contains("rgbColor") || force) {
         swgFT8DemodSettings->setRgbColor(settings.m_rgbColor);
     }

plugins/channelrx/demodft8/CMakeLists.txt

@@ -24,6 +24,7 @@
 #include "maincore.h"
 
 #include "ft8demodworker.h"
+#include "pskreporterworker.h"
 #include "ft8demodbaseband.h"
 
 MESSAGE_CLASS_DEFINITION(FT8DemodBaseband::MsgConfigureFT8DemodBaseband, Message)
@@ -48,12 +49,7 @@ FT8DemodBaseband::FT8DemodBaseband() :
         m_ft8DemodWorker,
         &QObject::deleteLater
     );
-    QObject::connect(
-        m_workerThread,
-        &QThread::finished,
-        m_ft8DemodWorker,
-        &QThread::deleteLater
-    );
+
     QObject::connect(
         this,
         &FT8DemodBaseband::bufferReady,
@@ -64,6 +60,20 @@ FT8DemodBaseband::FT8DemodBaseband() :
 
     m_workerThread->start();
 
+    m_pskReporterThread = new QThread();
+    m_pskReporterWorker = new PskReporterWorker();
+    m_ft8DemodWorker->setPSKReportingMessageQueue(m_pskReporterWorker->getInputMessageQueue());
+    m_pskReporterWorker->moveToThread(m_pskReporterThread);
+
+    QObject::connect(
+        m_pskReporterThread,
+        &QThread::finished,
+        m_pskReporterWorker,
+        &QObject::deleteLater
+    );
+
+    m_pskReporterThread->start();
+
     QObject::connect(
         &m_sampleFifo,
         &SampleSinkFifo::dataReady,
@@ -84,6 +94,8 @@ FT8DemodBaseband::~FT8DemodBaseband()
     m_workerThread->exit();
 	m_workerThread->wait();
     delete[] m_ft8WorkerBuffer;
+    m_pskReporterThread->exit();
+    m_pskReporterThread->wait();
 }
 
 void FT8DemodBaseband::reset()
@@ -96,7 +108,7 @@ void FT8DemodBaseband::reset()
 void FT8DemodBaseband::setMessageQueueToGUI(MessageQueue *messageQueue)
 {
     m_messageQueueToGUI = messageQueue;
-    m_ft8DemodWorker->setReportingMessageQueue(m_messageQueueToGUI);
+    m_ft8DemodWorker->setGUIReportingMessageQueue(m_messageQueueToGUI);
 }
 
 void FT8DemodBaseband::setChannel(ChannelAPI *channel)
@@ -237,6 +249,22 @@ void FT8DemodBaseband::applySettings(const FT8DemodSettings& settings, bool forc
         m_ft8DemodWorker->setLogMessages(settings.m_logMessages);
     }
 
+    if ((settings.m_enablePSKReporter != m_settings.m_enablePSKReporter) || force) {
+        m_ft8DemodWorker->setEnablePskReporter(settings.m_enablePSKReporter);
+    }
+
+    if ((settings.m_pskReporterCallsign != m_settings.m_pskReporterCallsign) || force) {
+        m_pskReporterWorker->setMyCallsign(settings.m_pskReporterCallsign);
+    }
+
+    if ((settings.m_pskReporterLocator != m_settings.m_pskReporterLocator) || force) {
+        m_pskReporterWorker->setMyLocator(settings.m_pskReporterLocator);
+    }
+
+    if ((settings.m_pskReporterSoftware != m_settings.m_pskReporterSoftware) || force) {
+        m_pskReporterWorker->setDecoderInfo(settings.m_pskReporterSoftware);
+    }
+
     if ((settings.m_nbDecoderThreads != m_settings.m_nbDecoderThreads) || force) {
         m_ft8DemodWorker->setNbDecoderThreads(settings.m_nbDecoderThreads);
     }

plugins/channelrx/demodft8/ft8demod.cpp

@@ -36,6 +36,7 @@ class ChannelAPI;
 class SpectrumVis;
 class QThread;
 class FT8DemodWorker;
+class PskReporterWorker;
 
 class FT8DemodBaseband : public QObject
 {
@@ -102,6 +103,8 @@ class FT8DemodBaseband : public QObject
     int m_tickCount;
     QThread *m_workerThread;
     FT8DemodWorker *m_ft8DemodWorker;
+    QThread *m_pskReporterThread;
+    PskReporterWorker *m_pskReporterWorker;
     int16_t *m_ft8WorkerBuffer;
     qint64 m_deviceCenterFrequency;
     QRecursiveMutex m_mutex;

plugins/channelrx/demodft8/ft8demodbaseband.cpp

@@ -528,6 +528,30 @@ void FT8DemodGUI::on_settings_clicked()
             changed = true;
         }
 
+        if (settingsKeys.contains("enablePSKReporter"))
+        {
+            m_settings.m_enablePSKReporter = settings.m_enablePSKReporter;
+            changed = true;
+        }
+
+        if (settingsKeys.contains("pskReporterCallsign"))
+        {
+            m_settings.m_pskReporterCallsign = settings.m_pskReporterCallsign;
+            changed = true;
+        }
+
+        if (settingsKeys.contains("pskReporterLocator"))
+        {
+            m_settings.m_pskReporterLocator = settings.m_pskReporterLocator;
+            changed = true;
+        }
+
+        if (settingsKeys.contains("pskReporterSoftware"))
+        {
+            m_settings.m_pskReporterSoftware = settings.m_pskReporterSoftware;
+            changed = true;
+        }
+
         if (settingsKeys.contains("bandPresets"))
         {
             m_settings.m_bandPresets = settings.m_bandPresets;

plugins/channelrx/demodft8/ft8demodbaseband.h

@@ -19,9 +19,12 @@
 ///////////////////////////////////////////////////////////////////////////////////
 
 #include <QColor>
+#include <QCoreApplication>
 
 #include "util/simpleserializer.h"
 #include "settings/serializable.h"
+#include "maincore.h"
+#include "util/maidenhead.h"
 #include "ft8demodsettings.h"
 
 const int FT8DemodSettings::m_ft8SampleRate = 12000;
@@ -66,6 +69,10 @@ void FT8DemodSettings::resetToDefaults()
     m_workspaceIndex = 0;
     m_hidden = false;
     m_filterIndex = 0;
+    m_enablePSKReporter = false;
+    m_pskReporterCallsign = getDefaultReporterCallsign();
+    m_pskReporterLocator = getDefaultReporterLocator();
+    m_pskReporterSoftware = "SDRangel FT8 Demod";
     resetBandPresets();
 }
 
@@ -133,6 +140,10 @@ QByteArray FT8DemodSettings::serialize() const
     s.writeBlob(26, m_geometryBytes);
     s.writeBool(27, m_hidden);
     s.writeU32(29, m_filterIndex);
+    s.writeBool(30, m_enablePSKReporter);
+    s.writeString(31, m_pskReporterCallsign);
+    s.writeString(32, m_pskReporterLocator);
+    s.writeString(33, m_pskReporterSoftware);
 
     for (unsigned int i = 0; i <  10; i++)
     {
@@ -214,6 +225,10 @@ bool FT8DemodSettings::deserialize(const QByteArray& data)
         d.readBool(27, &m_hidden, false);
         d.readU32(29, &utmp, 0);
         m_filterIndex = utmp < 10 ? utmp : 0;
+        d.readBool(30, &m_enablePSKReporter, false);
+        d.readString(31, &m_pskReporterCallsign, getDefaultReporterCallsign());
+        d.readString(32, &m_pskReporterLocator, getDefaultReporterLocator());
+        d.readString(33, &m_pskReporterSoftware, getDefaultReporterSoftware());
 
         for (unsigned int i = 0; (i < 10); i++)
         {
@@ -252,3 +267,20 @@ QDataStream& operator>>(QDataStream& in, FT8DemodBandPreset& bandPreset)
     in >> bandPreset.m_channelOffset;
     return in;
 }
+
+QString FT8DemodSettings::getDefaultReporterCallsign() const
+{
+    return MainCore::instance()->getSettings().getStationName();
+}
+
+QString FT8DemodSettings::getDefaultReporterLocator() const
+{
+    float lat = MainCore::instance()->getSettings().getLatitude();
+    float lon = MainCore::instance()->getSettings().getLongitude();
+    return Maidenhead::toMaidenhead(lat, lon);
+}
+
+QString FT8DemodSettings::getDefaultReporterSoftware() const
+{
+    return QCoreApplication::applicationName() + " " + QCoreApplication::applicationVersion();
+}

plugins/channelrx/demodft8/ft8demodgui.cpp

@@ -97,6 +97,10 @@ class FT8DemodSettings
     std::vector<FT8DemodFilterSettings> m_filterBank;
     unsigned int m_filterIndex;
     QList<FT8DemodBandPreset> m_bandPresets;
+    bool m_enablePSKReporter;
+    QString m_pskReporterCallsign;
+    QString m_pskReporterLocator;
+    QString m_pskReporterSoftware;
 
     Serializable *m_channelMarker;
     Serializable *m_spectrumGUI;
@@ -110,6 +114,9 @@ class FT8DemodSettings
     QByteArray serialize() const;
     bool deserialize(const QByteArray& data);
     void resetBandPresets();
+    QString getDefaultReporterCallsign() const;
+    QString getDefaultReporterLocator() const;
+    QString getDefaultReporterSoftware() const;
 
     static const int m_ft8SampleRate;
     static const int m_minPowerThresholdDB;

plugins/channelrx/demodft8/ft8demodsettings.cpp

@@ -35,6 +35,10 @@ FT8DemodSettingsDialog::FT8DemodSettingsDialog(FT8DemodSettings& settings, QStri
     ui->osdLDPCThreshold->setValue(m_settings.m_osdLDPCThreshold);
     ui->osdLDPCThresholdText->setText(tr("%1").arg(m_settings.m_osdLDPCThreshold));
     ui->verifyOSD->setChecked(m_settings.m_verifyOSD);
+    ui->enablePSKReporter->setChecked(m_settings.m_enablePSKReporter);
+    ui->reportingStation->setText(m_settings.m_pskReporterCallsign);
+    ui->reportingLocator->setText(m_settings.m_pskReporterLocator);
+    ui->reportingSoftware->setText(m_settings.m_pskReporterSoftware);
     resizeBandsTable();
     populateBandsTable();
     connect(ui->bands, &QTableWidget::cellChanged, this, &FT8DemodSettingsDialog::textCellChanged);
@@ -162,6 +166,65 @@ void FT8DemodSettingsDialog::on_verifyOSD_stateChanged(int state)
     }
 }
 
+void FT8DemodSettingsDialog::on_enablePSKReporter_toggled(bool checked)
+{
+    m_settings.m_enablePSKReporter = checked;
+
+    if (!m_settingsKeys.contains("enablePSKReporter")) {
+        m_settingsKeys.append("enablePSKReporter");
+    }
+}
+
+void FT8DemodSettingsDialog::on_pskReporterCallsign_editingFinished()
+{
+    m_settings.m_pskReporterCallsign = ui->reportingStation->text();
+
+    if (!m_settingsKeys.contains("pskReporterCallsign")) {
+        m_settingsKeys.append("pskReporterCallsign");
+    }
+}
+
+void FT8DemodSettingsDialog::on_pskReporterLocator_editingFinished()
+{
+    m_settings.m_pskReporterLocator = ui->reportingLocator->text();
+
+    if (!m_settingsKeys.contains("pskReporterLocator")) {
+        m_settingsKeys.append("pskReporterLocator");
+    }
+}
+
+void FT8DemodSettingsDialog::on_pskReporterSoftware_editingFinished()
+{
+    m_settings.m_pskReporterSoftware =  ui->reportingSoftware->text();
+
+    if (!m_settingsKeys.contains("pskReporterSoftware")) {
+        m_settingsKeys.append("pskReporterSoftware");
+    }
+}
+
+void FT8DemodSettingsDialog::on_reportingDefaults_clicked()
+{
+    ui->reportingStation->setText(m_settings.getDefaultReporterCallsign());
+    ui->reportingLocator->setText(m_settings.getDefaultReporterLocator());
+    ui->reportingSoftware->setText(m_settings.getDefaultReporterSoftware());
+
+    m_settings.m_pskReporterCallsign = ui->reportingStation->text();
+    m_settings.m_pskReporterLocator = ui->reportingLocator->text();
+    m_settings.m_pskReporterSoftware = ui->reportingSoftware->text();
+
+    if (!m_settingsKeys.contains("pskReporterCallsign")) {
+        m_settingsKeys.append("pskReporterCallsign");
+    }
+
+    if (!m_settingsKeys.contains("pskReporterLocator")) {
+        m_settingsKeys.append("pskReporterLocator");
+    }
+
+    if (!m_settingsKeys.contains("pskReporterSoftware")) {
+        m_settingsKeys.append("pskReporterSoftware");
+    }
+}
+
 void FT8DemodSettingsDialog::on_addBand_clicked()
 {
     int currentRow = ui->bands->currentRow();