/////////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2020 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 . // /////////////////////////////////////////////////////////////////////////////////// #include #include #include #include #include "SWGFeatureSettings.h" #include "SWGFeatureReport.h" #include "SWGFeatureActions.h" #include "SWGSimplePTTReport.h" #include "SWGDeviceState.h" #include "SWGChannelReport.h" #include "dsp/dspengine.h" #include "dsp/dspdevicesourceengine.h" #include "dsp/devicesamplesource.h" #include "device/deviceset.h" #include "channel/channelapi.h" #include "maincore.h" #include "vorlocalizerreport.h" #include "vorlocalizerworker.h" #include "vorlocalizer.h" MESSAGE_CLASS_DEFINITION(VORLocalizer::MsgConfigureVORLocalizer, Message) MESSAGE_CLASS_DEFINITION(VORLocalizer::MsgStartStop, Message) MESSAGE_CLASS_DEFINITION(VORLocalizer::MsgAddVORChannel, Message) MESSAGE_CLASS_DEFINITION(VORLocalizer::MsgRemoveVORChannel, Message) MESSAGE_CLASS_DEFINITION(VORLocalizer::MsgRefreshChannels, Message) const char* const VORLocalizer::m_featureIdURI = "sdrangel.feature.vorlocalizer"; const char* const VORLocalizer::m_featureId = "VORLocalizer"; VORLocalizer::VORLocalizer(WebAPIAdapterInterface *webAPIAdapterInterface) : Feature(m_featureIdURI, webAPIAdapterInterface) { setObjectName(m_featureId); m_worker = new VorLocalizerWorker(webAPIAdapterInterface); m_state = StIdle; m_errorMessage = "VORLocalizer error"; } VORLocalizer::~VORLocalizer() { if (m_worker->isRunning()) { stop(); } delete m_worker; } void VORLocalizer::start() { qDebug("VORLocalizer::start"); m_worker->reset(); m_worker->setMessageQueueToFeature(getInputMessageQueue()); m_worker->setAvailableChannels(&m_availableChannels); bool ok = m_worker->startWork(); m_state = ok ? StRunning : StError; m_thread.start(); VorLocalizerWorker::MsgConfigureVORLocalizerWorker *msg = VorLocalizerWorker::MsgConfigureVORLocalizerWorker::create(m_settings, true); m_worker->getInputMessageQueue()->push(msg); } void VORLocalizer::stop() { qDebug("VORLocalizer::stop"); m_worker->stopWork(); m_state = StIdle; m_thread.quit(); m_thread.wait(); } bool VORLocalizer::handleMessage(const Message& cmd) { if (MsgConfigureVORLocalizer::match(cmd)) { MsgConfigureVORLocalizer& cfg = (MsgConfigureVORLocalizer&) cmd; qDebug() << "VORLocalizer::handleMessage: MsgConfigureVORLocalizer"; applySettings(cfg.getSettings(), cfg.getForce()); return true; } else if (MsgStartStop::match(cmd)) { MsgStartStop& cfg = (MsgStartStop&) cmd; qDebug() << "VORLocalizer::handleMessage: MsgStartStop: start:" << cfg.getStartStop(); if (cfg.getStartStop()) { start(); } else { stop(); } return true; } else if (MsgRefreshChannels::match(cmd)) { qDebug() << "VORLocalizer::handleMessage: MsgRefreshChannels"; updateChannels(); return true; } else if (MainCore::MsgChannelReport::match(cmd)) { MainCore::MsgChannelReport& report = (MainCore::MsgChannelReport&) cmd; SWGSDRangel::SWGChannelReport* swgChannelReport = report.getSWGReport(); QString *channelType = swgChannelReport->getChannelType(); if (*channelType == "VORDemodSC") { SWGSDRangel::SWGVORDemodSCReport *swgVORDemodSCReport = swgChannelReport->getVorDemodScReport(); int navId = swgVORDemodSCReport->getNavId(); if (navId < 0) { // disregard message for unallocated channels return true; } bool singlePlan = (m_vorSinglePlans.contains(navId)) && !m_settings.m_forceRRAveraging ? m_vorSinglePlans[navId] : false; // qDebug() << "VORLocalizer::handleMessage: MainCore::MsgChannelReport(VORDemodSC): " // << "navId:" << navId // << "singlePlanProvided" << m_vorSinglePlans.contains(navId) // << "singlePlan:" << singlePlan; if (m_vorChannelReports.contains(navId)) { m_vorChannelReports[navId].m_radial = swgVORDemodSCReport->getRadial(); m_vorChannelReports[navId].m_refMag = swgVORDemodSCReport->getRefMag(); m_vorChannelReports[navId].m_varMag = swgVORDemodSCReport->getVarMag(); m_vorChannelReports[navId].m_validRadial = swgVORDemodSCReport->getValidRadial() != 0; m_vorChannelReports[navId].m_validRefMag = swgVORDemodSCReport->getValidRefMag() != 0; m_vorChannelReports[navId].m_validVarMag = swgVORDemodSCReport->getValidVarMag() != 0; m_vorChannelReports[navId].m_morseIdent = *swgVORDemodSCReport->getMorseIdent(); } else { m_vorChannelReports[navId] = VORChannelReport{ swgVORDemodSCReport->getRadial(), swgVORDemodSCReport->getRefMag(), swgVORDemodSCReport->getVarMag(), AverageUtil(), AverageUtil(), AverageUtil(), swgVORDemodSCReport->getValidRadial() != 0, swgVORDemodSCReport->getValidRefMag() != 0, swgVORDemodSCReport->getValidVarMag() != 0, *swgVORDemodSCReport->getMorseIdent() }; } if (m_vorChannelReports[navId].m_validRadial) { m_vorChannelReports[navId].m_radialAvg(swgVORDemodSCReport->getRadial()); } if (m_vorChannelReports[navId].m_validRefMag) { m_vorChannelReports[navId].m_refMagAvg(swgVORDemodSCReport->getRefMag()); } if (m_vorChannelReports[navId].m_validVarMag) { m_vorChannelReports[navId].m_varMagAvg(swgVORDemodSCReport->getVarMag()); } if (getMessageQueueToGUI()) { float radial = ((m_vorChannelReports[navId].m_radialAvg.getNumSamples() == 0) || singlePlan) ? m_vorChannelReports[navId].m_radial : m_vorChannelReports[navId].m_radialAvg.instantAverage(); float refMag = ((m_vorChannelReports[navId].m_refMagAvg.getNumSamples() == 0) || singlePlan) ? m_vorChannelReports[navId].m_refMag : m_vorChannelReports[navId].m_refMagAvg.instantAverage(); float varMag = ((m_vorChannelReports[navId].m_varMagAvg.getNumSamples() == 0) || singlePlan) ? m_vorChannelReports[navId].m_varMag : m_vorChannelReports[navId].m_varMagAvg.instantAverage(); bool validRadial = singlePlan ? m_vorChannelReports[navId].m_validRadial : m_vorChannelReports[navId].m_radialAvg.getNumSamples() != 0 || m_vorChannelReports[navId].m_validRadial; bool validRefMag = singlePlan ? m_vorChannelReports[navId].m_validRefMag : m_vorChannelReports[navId].m_refMagAvg.getNumSamples() != 0 || m_vorChannelReports[navId].m_validRefMag; bool validVarMag = singlePlan ? m_vorChannelReports[navId].m_validVarMag : m_vorChannelReports[navId].m_varMagAvg.getNumSamples() != 0 || m_vorChannelReports[navId].m_validVarMag; VORLocalizerReport::MsgReportRadial *msgRadial = VORLocalizerReport::MsgReportRadial::create( navId, radial, refMag, varMag, validRadial, validRefMag, validVarMag ); getMessageQueueToGUI()->push(msgRadial); VORLocalizerReport::MsgReportIdent *msgIdent = VORLocalizerReport::MsgReportIdent::create( navId, m_vorChannelReports[navId].m_morseIdent ); getMessageQueueToGUI()->push(msgIdent); } } return true; } else if (VORLocalizerReport::MsgReportServiceddVORs::match(cmd)) { qDebug() << "VORLocalizer::handleMessage: MsgReportServiceddVORs"; VORLocalizerReport::MsgReportServiceddVORs& report = (VORLocalizerReport::MsgReportServiceddVORs&) cmd; std::vector& vorNavIds = report.getNavIds(); m_vorSinglePlans = report.getSinglePlans(); for (std::vector::const_iterator it = vorNavIds.begin(); it != vorNavIds.end(); ++it) { m_vorChannelReports[*it].m_radialAvg.reset(); m_vorChannelReports[*it].m_refMagAvg.reset(); m_vorChannelReports[*it].m_varMagAvg.reset(); } if (getMessageQueueToGUI()) { VORLocalizerReport::MsgReportServiceddVORs *msgToGUI = VORLocalizerReport::MsgReportServiceddVORs::create(); msgToGUI->getNavIds() = vorNavIds; getMessageQueueToGUI()->push(msgToGUI); } return true; } else if (MessagePipesCommon::MsgReportChannelDeleted::match(cmd)) { qDebug() << "VORLocalizer::handleMessage: MsgReportChannelDeleted"; MessagePipesCommon::MsgReportChannelDeleted& report = (MessagePipesCommon::MsgReportChannelDeleted&) cmd; const MessagePipesCommon::ChannelRegistrationKey& channelKey = report.getChannelRegistrationKey(); const ChannelAPI *channel = channelKey.m_key; m_availableChannels.remove(const_cast(channel)); updateChannels(); MessageQueue *messageQueue = MainCore::instance()->getMessagePipes().unregisterChannelToFeature(channel, this, "report"); disconnect(messageQueue, SIGNAL(messageEnqueued()), this, SLOT(handleChannelMessageQueue(MessageQueue*))); return true; } else { return false; } } QByteArray VORLocalizer::serialize() const { return m_settings.serialize(); } bool VORLocalizer::deserialize(const QByteArray& data) { if (m_settings.deserialize(data)) { MsgConfigureVORLocalizer *msg = MsgConfigureVORLocalizer::create(m_settings, true); m_inputMessageQueue.push(msg); return true; } else { m_settings.resetToDefaults(); MsgConfigureVORLocalizer *msg = MsgConfigureVORLocalizer::create(m_settings, true); m_inputMessageQueue.push(msg); return false; } } void VORLocalizer::applySettings(const VORLocalizerSettings& settings, bool force) { qDebug() << "VORLocalizer::applySettings:" << " m_title: " << settings.m_title << " m_rgbColor: " << settings.m_rgbColor << " m_magDecAdjust: " << settings.m_magDecAdjust << " m_rrTime: " << settings.m_rrTime << " m_centerShift: " << settings.m_centerShift << " force: " << force; QList reverseAPIKeys; if ((m_settings.m_title != settings.m_title) || force) { reverseAPIKeys.append("title"); } if ((m_settings.m_rgbColor != settings.m_rgbColor) || force) { reverseAPIKeys.append("rgbColor"); } if ((m_settings.m_magDecAdjust != settings.m_magDecAdjust) || force) { reverseAPIKeys.append("magDecAdjust"); } if ((m_settings.m_rrTime != settings.m_rrTime) || force) { reverseAPIKeys.append("rrTime"); } if ((m_settings.m_forceRRAveraging != settings.m_forceRRAveraging) || force) { reverseAPIKeys.append("forceRRAveraging"); } if ((m_settings.m_centerShift != settings.m_centerShift) || force) { reverseAPIKeys.append("centerShift"); } VorLocalizerWorker::MsgConfigureVORLocalizerWorker *msg = VorLocalizerWorker::MsgConfigureVORLocalizerWorker::create( settings, force ); m_worker->getInputMessageQueue()->push(msg); if (settings.m_useReverseAPI) { bool fullUpdate = ((m_settings.m_useReverseAPI != settings.m_useReverseAPI) && settings.m_useReverseAPI) || (m_settings.m_reverseAPIAddress != settings.m_reverseAPIAddress) || (m_settings.m_reverseAPIPort != settings.m_reverseAPIPort) || (m_settings.m_reverseAPIFeatureSetIndex != settings.m_reverseAPIFeatureSetIndex) || (m_settings.m_reverseAPIFeatureIndex != settings.m_reverseAPIFeatureIndex); webapiReverseSendSettings(reverseAPIKeys, settings, fullUpdate || force); } m_settings = settings; } void VORLocalizer::updateChannels() { MainCore *mainCore = MainCore::instance(); MessagePipes& messagePipes = mainCore->getMessagePipes(); std::vector& deviceSets = mainCore->getDeviceSets(); std::vector::const_iterator it = deviceSets.begin(); m_availableChannels.clear(); int deviceIndex = 0; for (; it != deviceSets.end(); ++it, deviceIndex++) { DSPDeviceSourceEngine *deviceSourceEngine = (*it)->m_deviceSourceEngine; if (deviceSourceEngine) { DeviceSampleSource *deviceSource = deviceSourceEngine->getSource(); quint64 deviceCenterFrequency = deviceSource->getCenterFrequency(); int basebandSampleRate = deviceSource->getSampleRate(); for (int chi = 0; chi < (*it)->getNumberOfChannels(); chi++) { ChannelAPI *channel = (*it)->getChannelAt(chi); if (channel->getURI() == "sdrangel.channel.vordemodsc") { if (!m_availableChannels.contains(channel)) { MessageQueue *messageQueue = messagePipes.registerChannelToFeature(channel, this, "report"); QObject::connect( messageQueue, &MessageQueue::messageEnqueued, this, [=](){ this->handleChannelMessageQueue(messageQueue); }, Qt::QueuedConnection ); } VORLocalizerSettings::AvailableChannel availableChannel = VORLocalizerSettings::AvailableChannel{deviceIndex, chi, channel, deviceCenterFrequency, basebandSampleRate, -1}; m_availableChannels[channel] = availableChannel; } } } } if (getMessageQueueToGUI()) { VORLocalizerReport::MsgReportChannels *msgToGUI = VORLocalizerReport::MsgReportChannels::create(); std::vector& msgChannels = msgToGUI->getChannels(); // TODO: check https://github.com/microsoft/vscode-cpptools/issues/6222 QHash::iterator it = m_availableChannels.begin(); for (; it != m_availableChannels.end(); ++it) { VORLocalizerReport::MsgReportChannels::Channel msgChannel = VORLocalizerReport::MsgReportChannels::Channel{ it->m_deviceSetIndex, it->m_channelIndex }; msgChannels.push_back(msgChannel); } getMessageQueueToGUI()->push(msgToGUI); } VorLocalizerWorker::MsgRefreshChannels *msgToWorker = VorLocalizerWorker::MsgRefreshChannels::create(); m_worker->getInputMessageQueue()->push(msgToWorker); } int VORLocalizer::webapiRun(bool run, SWGSDRangel::SWGDeviceState& response, QString& errorMessage) { (void) errorMessage; getFeatureStateStr(*response.getState()); MsgStartStop *msg = MsgStartStop::create(run); getInputMessageQueue()->push(msg); return 202; } int VORLocalizer::webapiSettingsGet( SWGSDRangel::SWGFeatureSettings& response, QString& errorMessage) { (void) errorMessage; response.setSimplePttSettings(new SWGSDRangel::SWGSimplePTTSettings()); response.getSimplePttSettings()->init(); webapiFormatFeatureSettings(response, m_settings); return 200; } int VORLocalizer::webapiSettingsPutPatch( bool force, const QStringList& featureSettingsKeys, SWGSDRangel::SWGFeatureSettings& response, QString& errorMessage) { (void) errorMessage; VORLocalizerSettings settings = m_settings; webapiUpdateFeatureSettings(settings, featureSettingsKeys, response); MsgConfigureVORLocalizer *msg = MsgConfigureVORLocalizer::create(settings, force); m_inputMessageQueue.push(msg); qDebug("VORLocalizer::webapiSettingsPutPatch: forward to GUI: %p", m_guiMessageQueue); if (m_guiMessageQueue) // forward to GUI if any { MsgConfigureVORLocalizer *msgToGUI = MsgConfigureVORLocalizer::create(settings, force); m_guiMessageQueue->push(msgToGUI); } webapiFormatFeatureSettings(response, settings); return 200; } void VORLocalizer::webapiFormatFeatureSettings( SWGSDRangel::SWGFeatureSettings& response, const VORLocalizerSettings& settings) { if (response.getVorLocalizerSettings()->getTitle()) { *response.getVorLocalizerSettings()->getTitle() = settings.m_title; } else { response.getVorLocalizerSettings()->setTitle(new QString(settings.m_title)); } response.getVorLocalizerSettings()->setRgbColor(settings.m_rgbColor); response.getVorLocalizerSettings()->setMagDecAdjust(settings.m_magDecAdjust); response.getVorLocalizerSettings()->setRrTime(settings.m_rrTime); response.getVorLocalizerSettings()->setForceRrAveraging(settings.m_forceRRAveraging ? 1 : 0); response.getVorLocalizerSettings()->setCenterShift(settings.m_centerShift); response.getVorLocalizerSettings()->setUseReverseApi(settings.m_useReverseAPI ? 1 : 0); if (response.getVorLocalizerSettings()->getReverseApiAddress()) { *response.getVorLocalizerSettings()->getReverseApiAddress() = settings.m_reverseAPIAddress; } else { response.getVorLocalizerSettings()->setReverseApiAddress(new QString(settings.m_reverseAPIAddress)); } response.getVorLocalizerSettings()->setReverseApiPort(settings.m_reverseAPIPort); response.getVorLocalizerSettings()->setReverseApiFeatureSetIndex(settings.m_reverseAPIFeatureSetIndex); response.getVorLocalizerSettings()->setReverseApiFeatureIndex(settings.m_reverseAPIFeatureIndex); } void VORLocalizer::webapiUpdateFeatureSettings( VORLocalizerSettings& settings, const QStringList& featureSettingsKeys, SWGSDRangel::SWGFeatureSettings& response) { if (featureSettingsKeys.contains("title")) { settings.m_title = *response.getVorLocalizerSettings()->getTitle(); } if (featureSettingsKeys.contains("rgbColor")) { settings.m_rgbColor = response.getVorLocalizerSettings()->getRgbColor(); } if (featureSettingsKeys.contains("magDecAdjust")) { settings.m_magDecAdjust = response.getVorLocalizerSettings()->getMagDecAdjust(); } if (featureSettingsKeys.contains("rrTime")) { settings.m_rrTime = response.getVorLocalizerSettings()->getRrTime(); } if (featureSettingsKeys.contains("forceRRAveraging")) { settings.m_forceRRAveraging = response.getVorLocalizerSettings()->getForceRrAveraging() != 0; } if (featureSettingsKeys.contains("centerShift")) { settings.m_centerShift = response.getVorLocalizerSettings()->getCenterShift(); } if (featureSettingsKeys.contains("useReverseAPI")) { settings.m_useReverseAPI = response.getVorLocalizerSettings()->getUseReverseApi() != 0; } if (featureSettingsKeys.contains("reverseAPIAddress")) { settings.m_reverseAPIAddress = *response.getVorLocalizerSettings()->getReverseApiAddress(); } if (featureSettingsKeys.contains("reverseAPIPort")) { settings.m_reverseAPIPort = response.getVorLocalizerSettings()->getReverseApiPort(); } if (featureSettingsKeys.contains("reverseAPIFeatureSetIndex")) { settings.m_reverseAPIFeatureSetIndex = response.getVorLocalizerSettings()->getReverseApiFeatureSetIndex(); } if (featureSettingsKeys.contains("reverseAPIFeatureIndex")) { settings.m_reverseAPIFeatureIndex = response.getVorLocalizerSettings()->getReverseApiFeatureIndex(); } } void VORLocalizer::webapiReverseSendSettings(QList& channelSettingsKeys, const VORLocalizerSettings& settings, bool force) { SWGSDRangel::SWGFeatureSettings *swgFeatureSettings = new SWGSDRangel::SWGFeatureSettings(); // swgFeatureSettings->setOriginatorFeatureIndex(getIndexInDeviceSet()); // swgFeatureSettings->setOriginatorFeatureSetIndex(getDeviceSetIndex()); swgFeatureSettings->setFeatureType(new QString("VORLocalizer")); swgFeatureSettings->setVorLocalizerSettings(new SWGSDRangel::SWGVORLocalizerSettings()); SWGSDRangel::SWGVORLocalizerSettings *swgVORLocalizerSettings = swgFeatureSettings->getVorLocalizerSettings(); // transfer data that has been modified. When force is on transfer all data except reverse API data if (channelSettingsKeys.contains("title") || force) { swgVORLocalizerSettings->setTitle(new QString(settings.m_title)); } if (channelSettingsKeys.contains("rgbColor") || force) { swgVORLocalizerSettings->setRgbColor(settings.m_rgbColor); } if (channelSettingsKeys.contains("magDecAdjust") || force) { swgVORLocalizerSettings->setMagDecAdjust(settings.m_magDecAdjust); } if (channelSettingsKeys.contains("rrTime") || force) { swgVORLocalizerSettings->setRrTime(settings.m_rrTime); } if (channelSettingsKeys.contains("forceRRAveraging") || force) { swgVORLocalizerSettings->setForceRrAveraging(settings.m_forceRRAveraging ? 1 : 0); } if (channelSettingsKeys.contains("centerShift") || force) { swgVORLocalizerSettings->setCenterShift(settings.m_centerShift); } QString channelSettingsURL = QString("http://%1:%2/sdrangel/featureset/%3/feature/%4/settings") .arg(settings.m_reverseAPIAddress) .arg(settings.m_reverseAPIPort) .arg(settings.m_reverseAPIFeatureSetIndex) .arg(settings.m_reverseAPIFeatureIndex); m_networkRequest.setUrl(QUrl(channelSettingsURL)); m_networkRequest.setHeader(QNetworkRequest::ContentTypeHeader, "application/json"); QBuffer *buffer = new QBuffer(); buffer->open((QBuffer::ReadWrite)); buffer->write(swgFeatureSettings->asJson().toUtf8()); buffer->seek(0); // Always use PATCH to avoid passing reverse API settings QNetworkReply *reply = m_networkManager->sendCustomRequest(m_networkRequest, "PATCH", buffer); buffer->setParent(reply); delete swgFeatureSettings; } void VORLocalizer::networkManagerFinished(QNetworkReply *reply) { QNetworkReply::NetworkError replyError = reply->error(); if (replyError) { qWarning() << "VORLocalizer::networkManagerFinished:" << " error(" << (int) replyError << "): " << replyError << ": " << reply->errorString(); } else { QString answer = reply->readAll(); answer.chop(1); // remove last \n qDebug("VORLocalizer::networkManagerFinished: reply:\n%s", answer.toStdString().c_str()); } reply->deleteLater(); } void VORLocalizer::handleChannelMessageQueue(MessageQueue* messageQueue) { Message* message; while ((message = messageQueue->pop()) != nullptr) { if (handleMessage(*message)) { delete message; } } }