/////////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2018-2022 Edouard Griffiths, F4EXB // // Copyright (C) 2019 Davide Gerhard // // Copyright (C) 2020 Kacper Michajłow // // // // Remote sink channel (Rx) UDP sender thread // // // // SDRangel can work as a detached SDR front end. With this plugin it can // // sends the I/Q samples stream to another SDRangel instance via UDP. // // It is controlled via a Web REST API. // // // // 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 "remotesink.h" #include #include #include #include #include "SWGChannelSettings.h" #include "SWGWorkspaceInfo.h" #include "util/simpleserializer.h" #include "dsp/dspcommands.h" #include "dsp/hbfilterchainconverter.h" #include "dsp/devicesamplemimo.h" #include "dsp/dspdevicesourceengine.h" #include "dsp/devicesamplesource.h" #include "device/deviceapi.h" #include "feature/feature.h" #include "settings/serializable.h" #include "maincore.h" #include "remotesinkbaseband.h" MESSAGE_CLASS_DEFINITION(RemoteSink::MsgConfigureRemoteSink, Message) const char* const RemoteSink::m_channelIdURI = "sdrangel.channel.remotesink"; const char* const RemoteSink::m_channelId = "RemoteSink"; RemoteSink::RemoteSink(DeviceAPI *deviceAPI) : ChannelAPI(m_channelIdURI, ChannelAPI::StreamSingleSink), m_deviceAPI(deviceAPI), m_thread(nullptr), m_basebandSink(nullptr), m_running(false), m_frequencyOffset(0), m_basebandSampleRate(0) { setObjectName(m_channelId); updateWithDeviceData(); applySettings(m_settings, true); m_deviceAPI->addChannelSink(this); m_deviceAPI->addChannelSinkAPI(this); m_networkManager = new QNetworkAccessManager(); QObject::connect( m_networkManager, &QNetworkAccessManager::finished, this, &RemoteSink::networkManagerFinished ); QObject::connect( this, &ChannelAPI::indexInDeviceSetChanged, this, &RemoteSink::handleIndexInDeviceSetChanged ); start(); } RemoteSink::~RemoteSink() { QObject::disconnect( m_networkManager, &QNetworkAccessManager::finished, this, &RemoteSink::networkManagerFinished ); delete m_networkManager; m_deviceAPI->removeChannelSinkAPI(this); m_deviceAPI->removeChannelSink(this); stop(); } void RemoteSink::setDeviceAPI(DeviceAPI *deviceAPI) { if (deviceAPI != m_deviceAPI) { m_deviceAPI->removeChannelSinkAPI(this); m_deviceAPI->removeChannelSink(this); m_deviceAPI = deviceAPI; m_deviceAPI->addChannelSink(this); m_deviceAPI->addChannelSinkAPI(this); } } uint32_t RemoteSink::getNumberOfDeviceStreams() const { return m_deviceAPI->getNbSourceStreams(); } void RemoteSink::feed(const SampleVector::const_iterator& begin, const SampleVector::const_iterator& end, bool firstOfBurst) { (void) firstOfBurst; if (m_running) { m_basebandSink->feed(begin, end); } } void RemoteSink::start() { if (m_running) { return; } qDebug("RemoteSink::start: m_basebandSampleRate: %d", m_basebandSampleRate); m_thread = new QThread(); m_basebandSink = new RemoteSinkBaseband(); m_basebandSink->moveToThread(m_thread); QObject::connect(m_thread, &QThread::finished, m_basebandSink, &QObject::deleteLater); QObject::connect(m_thread, &QThread::finished, m_thread, &QThread::deleteLater); m_basebandSink->reset(); m_basebandSink->setDeviceIndex(m_deviceAPI->getDeviceSetIndex()); m_basebandSink->setChannelIndex(getIndexInDeviceSet()); m_basebandSink->startWork(); m_thread->start(); if (m_basebandSampleRate != 0) { m_basebandSink->setBasebandSampleRate(m_basebandSampleRate); } RemoteSinkBaseband::MsgConfigureRemoteSinkBaseband *msg = RemoteSinkBaseband::MsgConfigureRemoteSinkBaseband::create(m_settings, true); m_basebandSink->getInputMessageQueue()->push(msg); m_running = true; } void RemoteSink::stop() { if (!m_running) { return; } qDebug("RemoteSink::stop"); m_running = false; m_basebandSink->stopWork(); m_thread->quit(); m_thread->wait(); } bool RemoteSink::handleMessage(const Message& cmd) { if (MsgConfigureRemoteSink::match(cmd)) { MsgConfigureRemoteSink& cfg = (MsgConfigureRemoteSink&) cmd; qDebug() << "RemoteSink::handleMessage: MsgConfigureRemoteSink"; applySettings(cfg.getSettings(), cfg.getForce()); return true; } else if (DSPSignalNotification::match(cmd)) { DSPSignalNotification& notif = (DSPSignalNotification&) cmd; m_basebandSampleRate = notif.getSampleRate(); qDebug() << "RemoteSink::handleMessage: DSPSignalNotification: m_basebandSampleRate:" << m_basebandSampleRate; calculateFrequencyOffset(); updateWithDeviceData(); // Device center frequency and/or sample rate has changed // Forward to the sink if (m_running) { DSPSignalNotification* msgToBaseband = new DSPSignalNotification(notif); // make a copy m_basebandSink->getInputMessageQueue()->push(msgToBaseband); } // Forward to the GUI if (getMessageQueueToGUI()) { getMessageQueueToGUI()->push(new DSPSignalNotification(notif)); } return true; } else { return false; } } QByteArray RemoteSink::serialize() const { return m_settings.serialize(); } bool RemoteSink::deserialize(const QByteArray& data) { (void) data; if (m_settings.deserialize(data)) { MsgConfigureRemoteSink *msg = MsgConfigureRemoteSink::create(m_settings, true); m_inputMessageQueue.push(msg); return true; } else { m_settings.resetToDefaults(); MsgConfigureRemoteSink *msg = MsgConfigureRemoteSink::create(m_settings, true); m_inputMessageQueue.push(msg); return false; } } void RemoteSink::applySettings(const RemoteSinkSettings& settings, bool force) { qDebug() << "RemoteSink::applySettings:" << " m_nbFECBlocks: " << settings.m_nbFECBlocks << " m_dataAddress: " << settings.m_dataAddress << " m_dataPort: " << settings.m_dataPort << " m_streamIndex: " << settings.m_streamIndex << " force: " << force; QList reverseAPIKeys; bool frequencyOffsetChange = false; if ((m_settings.m_nbFECBlocks != settings.m_nbFECBlocks) || force) { reverseAPIKeys.append("nbFECBlocks"); } if ((m_settings.m_dataAddress != settings.m_dataAddress) || force) { reverseAPIKeys.append("dataAddress"); } if ((m_settings.m_dataPort != settings.m_dataPort) || force) { reverseAPIKeys.append("dataPort"); } if ((m_settings.m_rgbColor != settings.m_rgbColor) || force) { reverseAPIKeys.append("rgbColor"); } if ((m_settings.m_title != settings.m_title) || force) { reverseAPIKeys.append("title"); } if ((m_settings.m_deviceCenterFrequency != settings.m_deviceCenterFrequency) || force) { reverseAPIKeys.append("deviceCenterFrequency"); if (m_deviceAPI->getSampleSource()) { m_deviceAPI->getSampleSource()->setCenterFrequency(settings.m_deviceCenterFrequency); } else if (m_deviceAPI->getSampleMIMO()) { m_deviceAPI->getSampleMIMO()->setSourceCenterFrequency(settings.m_deviceCenterFrequency, settings.m_streamIndex); } } if ((m_settings.m_log2Decim != settings.m_log2Decim) || force) { reverseAPIKeys.append("log2Decim"); frequencyOffsetChange = true; } if ((m_settings.m_filterChainHash != settings.m_filterChainHash) || force) { reverseAPIKeys.append("filterChainHash"); frequencyOffsetChange = true; } if ((m_settings.m_nbTxBytes != settings.m_nbTxBytes) || force) { reverseAPIKeys.append("nbTxBytes"); stop(); start(); m_basebandSink->setNbTxBytes(settings.m_nbTxBytes); } if (m_settings.m_streamIndex != settings.m_streamIndex) { if (m_deviceAPI->getSampleMIMO()) // change of stream is possible for MIMO devices only { m_deviceAPI->removeChannelSinkAPI(this); m_deviceAPI->removeChannelSink(this, m_settings.m_streamIndex); m_deviceAPI->addChannelSink(this, settings.m_streamIndex); m_deviceAPI->addChannelSinkAPI(this); } reverseAPIKeys.append("streamIndex"); } if (m_running) { RemoteSinkBaseband::MsgConfigureRemoteSinkBaseband *msg = RemoteSinkBaseband::MsgConfigureRemoteSinkBaseband::create(settings, force); m_basebandSink->getInputMessageQueue()->push(msg); } if ((settings.m_useReverseAPI) && (reverseAPIKeys.size() != 0)) { 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_reverseAPIDeviceIndex != settings.m_reverseAPIDeviceIndex) || (m_settings.m_reverseAPIChannelIndex != settings.m_reverseAPIChannelIndex); webapiReverseSendSettings(reverseAPIKeys, settings, fullUpdate || force); } QList pipes; MainCore::instance()->getMessagePipes().getMessagePipes(this, "settings", pipes); if (pipes.size() > 0) { sendChannelSettings(pipes, reverseAPIKeys, settings, force); } m_settings = settings; if (frequencyOffsetChange) { calculateFrequencyOffset(); } } void RemoteSink::validateFilterChainHash(RemoteSinkSettings& settings) { unsigned int s = 1; for (unsigned int i = 0; i < settings.m_log2Decim; i++) { s *= 3; } settings.m_filterChainHash = settings.m_filterChainHash >= s ? s-1 : settings.m_filterChainHash; } void RemoteSink::calculateFrequencyOffset() { double shiftFactor = HBFilterChainConverter::getShiftFactor(m_settings.m_log2Decim, m_settings.m_filterChainHash); m_frequencyOffset = m_basebandSampleRate * shiftFactor; } void RemoteSink::updateWithDeviceData() { if (m_deviceAPI->getSampleSource()) { m_settings.m_deviceCenterFrequency = m_deviceAPI->getSampleSource()->getCenterFrequency(); } else if (m_deviceAPI->getSampleMIMO()) { m_settings.m_deviceCenterFrequency = m_deviceAPI->getSampleMIMO()->getSourceCenterFrequency(m_settings.m_streamIndex); } } int RemoteSink::webapiSettingsGet( SWGSDRangel::SWGChannelSettings& response, QString& errorMessage) { (void) errorMessage; response.setRemoteSinkSettings(new SWGSDRangel::SWGRemoteSinkSettings()); response.getRemoteSinkSettings()->init(); webapiFormatChannelSettings(response, m_settings); return 200; } int RemoteSink::webapiWorkspaceGet( SWGSDRangel::SWGWorkspaceInfo& response, QString& errorMessage) { (void) errorMessage; response.setIndex(m_settings.m_workspaceIndex); return 200; } int RemoteSink::webapiSettingsPutPatch( bool force, const QStringList& channelSettingsKeys, SWGSDRangel::SWGChannelSettings& response, QString& errorMessage) { (void) errorMessage; RemoteSinkSettings settings = m_settings; webapiUpdateChannelSettings(settings, channelSettingsKeys, response); MsgConfigureRemoteSink *msg = MsgConfigureRemoteSink::create(settings, force); m_inputMessageQueue.push(msg); qDebug("RemoteSink::webapiSettingsPutPatch: forward to GUI: %p", m_guiMessageQueue); if (m_guiMessageQueue) // forward to GUI if any { MsgConfigureRemoteSink *msgToGUI = MsgConfigureRemoteSink::create(settings, force); m_guiMessageQueue->push(msgToGUI); } webapiFormatChannelSettings(response, settings); return 200; } void RemoteSink::webapiUpdateChannelSettings( RemoteSinkSettings& settings, const QStringList& channelSettingsKeys, SWGSDRangel::SWGChannelSettings& response) { if (channelSettingsKeys.contains("nbFECBlocks")) { int nbFECBlocks = response.getRemoteSinkSettings()->getNbFecBlocks(); if ((nbFECBlocks < 0) || (nbFECBlocks > 127)) { settings.m_nbFECBlocks = 8; } else { settings.m_nbFECBlocks = response.getRemoteSinkSettings()->getNbFecBlocks(); } } if (channelSettingsKeys.contains("nbTxBytes")) { settings.m_nbTxBytes = response.getRemoteSinkSettings()->getNbTxBytes(); } if (channelSettingsKeys.contains("deviceCenterFrequency")) { settings.m_deviceCenterFrequency = response.getRemoteSinkSettings()->getDeviceCenterFrequency(); } if (channelSettingsKeys.contains("dataAddress")) { settings.m_dataAddress = *response.getRemoteSinkSettings()->getDataAddress(); } if (channelSettingsKeys.contains("dataPort")) { int dataPort = response.getRemoteSinkSettings()->getDataPort(); if ((dataPort < 1024) || (dataPort > 65535)) { settings.m_dataPort = 9090; } else { settings.m_dataPort = dataPort; } } if (channelSettingsKeys.contains("rgbColor")) { settings.m_rgbColor = response.getRemoteSinkSettings()->getRgbColor(); } if (channelSettingsKeys.contains("title")) { settings.m_title = *response.getRemoteSinkSettings()->getTitle(); } if (channelSettingsKeys.contains("log2Decim")) { settings.m_log2Decim = response.getRemoteSinkSettings()->getLog2Decim(); } if (channelSettingsKeys.contains("filterChainHash")) { settings.m_filterChainHash = response.getRemoteSinkSettings()->getFilterChainHash(); validateFilterChainHash(settings); } if (channelSettingsKeys.contains("streamIndex")) { settings.m_streamIndex = response.getRemoteSinkSettings()->getStreamIndex(); } if (channelSettingsKeys.contains("useReverseAPI")) { settings.m_useReverseAPI = response.getRemoteSinkSettings()->getUseReverseApi() != 0; } if (channelSettingsKeys.contains("reverseAPIAddress")) { settings.m_reverseAPIAddress = *response.getRemoteSinkSettings()->getReverseApiAddress(); } if (channelSettingsKeys.contains("reverseAPIPort")) { settings.m_reverseAPIPort = response.getRemoteSinkSettings()->getReverseApiPort(); } if (channelSettingsKeys.contains("reverseAPIDeviceIndex")) { settings.m_reverseAPIDeviceIndex = response.getRemoteSinkSettings()->getReverseApiDeviceIndex(); } if (channelSettingsKeys.contains("reverseAPIChannelIndex")) { settings.m_reverseAPIChannelIndex = response.getRemoteSinkSettings()->getReverseApiChannelIndex(); } if (settings.m_channelMarker && channelSettingsKeys.contains("channelMarker")) { settings.m_channelMarker->updateFrom(channelSettingsKeys, response.getRemoteSinkSettings()->getChannelMarker()); } if (settings.m_rollupState && channelSettingsKeys.contains("rollupState")) { settings.m_rollupState->updateFrom(channelSettingsKeys, response.getRemoteSinkSettings()->getRollupState()); } } void RemoteSink::webapiFormatChannelSettings(SWGSDRangel::SWGChannelSettings& response, const RemoteSinkSettings& settings) { response.getRemoteSinkSettings()->setNbFecBlocks(settings.m_nbFECBlocks); if (response.getRemoteSinkSettings()->getDataAddress()) { *response.getRemoteSinkSettings()->getDataAddress() = settings.m_dataAddress; } else { response.getRemoteSinkSettings()->setDataAddress(new QString(settings.m_dataAddress)); } response.getRemoteSinkSettings()->setNbTxBytes(settings.m_nbTxBytes); response.getRemoteSinkSettings()->setDeviceCenterFrequency(settings.m_deviceCenterFrequency); response.getRemoteSinkSettings()->setDataPort(settings.m_dataPort); response.getRemoteSinkSettings()->setRgbColor(settings.m_rgbColor); if (response.getRemoteSinkSettings()->getTitle()) { *response.getRemoteSinkSettings()->getTitle() = settings.m_title; } else { response.getRemoteSinkSettings()->setTitle(new QString(settings.m_title)); } response.getRemoteSinkSettings()->setLog2Decim(settings.m_log2Decim); response.getRemoteSinkSettings()->setFilterChainHash(settings.m_filterChainHash); response.getRemoteSinkSettings()->setStreamIndex(settings.m_streamIndex); response.getRemoteSinkSettings()->setUseReverseApi(settings.m_useReverseAPI ? 1 : 0); if (response.getRemoteSinkSettings()->getReverseApiAddress()) { *response.getRemoteSinkSettings()->getReverseApiAddress() = settings.m_reverseAPIAddress; } else { response.getRemoteSinkSettings()->setReverseApiAddress(new QString(settings.m_reverseAPIAddress)); } response.getRemoteSinkSettings()->setReverseApiPort(settings.m_reverseAPIPort); response.getRemoteSinkSettings()->setReverseApiDeviceIndex(settings.m_reverseAPIDeviceIndex); response.getRemoteSinkSettings()->setReverseApiChannelIndex(settings.m_reverseAPIChannelIndex); if (settings.m_channelMarker) { if (response.getRemoteSinkSettings()->getChannelMarker()) { settings.m_channelMarker->formatTo(response.getRemoteSinkSettings()->getChannelMarker()); } else { SWGSDRangel::SWGChannelMarker *swgChannelMarker = new SWGSDRangel::SWGChannelMarker(); settings.m_channelMarker->formatTo(swgChannelMarker); response.getRemoteSinkSettings()->setChannelMarker(swgChannelMarker); } } if (settings.m_rollupState) { if (response.getRemoteSinkSettings()->getRollupState()) { settings.m_rollupState->formatTo(response.getRemoteSinkSettings()->getRollupState()); } else { SWGSDRangel::SWGRollupState *swgRollupState = new SWGSDRangel::SWGRollupState(); settings.m_rollupState->formatTo(swgRollupState); response.getRemoteSinkSettings()->setRollupState(swgRollupState); } } } void RemoteSink::webapiReverseSendSettings(QList& channelSettingsKeys, const RemoteSinkSettings& settings, bool force) { SWGSDRangel::SWGChannelSettings *swgChannelSettings = new SWGSDRangel::SWGChannelSettings(); webapiFormatChannelSettings(channelSettingsKeys, swgChannelSettings, settings, force); QString channelSettingsURL = QString("http://%1:%2/sdrangel/deviceset/%3/channel/%4/settings") .arg(settings.m_reverseAPIAddress) .arg(settings.m_reverseAPIPort) .arg(settings.m_reverseAPIDeviceIndex) .arg(settings.m_reverseAPIChannelIndex); m_networkRequest.setUrl(QUrl(channelSettingsURL)); m_networkRequest.setHeader(QNetworkRequest::ContentTypeHeader, "application/json"); QBuffer *buffer = new QBuffer(); buffer->open((QBuffer::ReadWrite)); buffer->write(swgChannelSettings->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 swgChannelSettings; } void RemoteSink::sendChannelSettings( const QList& pipes, QList& channelSettingsKeys, const RemoteSinkSettings& settings, bool force) { for (const auto& pipe : pipes) { MessageQueue *messageQueue = qobject_cast(pipe->m_element); if (messageQueue) { SWGSDRangel::SWGChannelSettings *swgChannelSettings = new SWGSDRangel::SWGChannelSettings(); webapiFormatChannelSettings(channelSettingsKeys, swgChannelSettings, settings, force); MainCore::MsgChannelSettings *msg = MainCore::MsgChannelSettings::create( this, channelSettingsKeys, swgChannelSettings, force ); messageQueue->push(msg); } } } void RemoteSink::webapiFormatChannelSettings( QList& channelSettingsKeys, SWGSDRangel::SWGChannelSettings *swgChannelSettings, const RemoteSinkSettings& settings, bool force ) { swgChannelSettings->setDirection(0); // Single sink (Rx) swgChannelSettings->setOriginatorChannelIndex(getIndexInDeviceSet()); swgChannelSettings->setOriginatorDeviceSetIndex(getDeviceSetIndex()); swgChannelSettings->setChannelType(new QString(m_channelId)); swgChannelSettings->setRemoteSinkSettings(new SWGSDRangel::SWGRemoteSinkSettings()); SWGSDRangel::SWGRemoteSinkSettings *swgRemoteSinkSettings = swgChannelSettings->getRemoteSinkSettings(); // transfer data that has been modified. When force is on transfer all data except reverse API data if (channelSettingsKeys.contains("nbFECBlocks") || force) { swgRemoteSinkSettings->setNbFecBlocks(settings.m_nbFECBlocks); } if (channelSettingsKeys.contains("nbTxBytes") || force) { swgRemoteSinkSettings->setNbTxBytes(settings.m_nbTxBytes); } if (channelSettingsKeys.contains("deviceCenterFrequency") || force) { swgRemoteSinkSettings->setDeviceCenterFrequency(settings.m_deviceCenterFrequency); } if (channelSettingsKeys.contains("dataAddress") || force) { swgRemoteSinkSettings->setDataAddress(new QString(settings.m_dataAddress)); } if (channelSettingsKeys.contains("dataPort") || force) { swgRemoteSinkSettings->setDataPort(settings.m_dataPort); } if (channelSettingsKeys.contains("rgbColor") || force) { swgRemoteSinkSettings->setRgbColor(settings.m_rgbColor); } if (channelSettingsKeys.contains("title") || force) { swgRemoteSinkSettings->setTitle(new QString(settings.m_title)); } if (channelSettingsKeys.contains("log2Decim") || force) { swgRemoteSinkSettings->setLog2Decim(settings.m_log2Decim); } if (channelSettingsKeys.contains("filterChainHash") || force) { swgRemoteSinkSettings->setFilterChainHash(settings.m_filterChainHash); } if (channelSettingsKeys.contains("streamIndex") || force) { swgRemoteSinkSettings->setStreamIndex(settings.m_streamIndex); } if (settings.m_channelMarker && (channelSettingsKeys.contains("channelMarker") || force)) { SWGSDRangel::SWGChannelMarker *swgChannelMarker = new SWGSDRangel::SWGChannelMarker(); settings.m_channelMarker->formatTo(swgChannelMarker); swgRemoteSinkSettings->setChannelMarker(swgChannelMarker); } if (settings.m_rollupState && (channelSettingsKeys.contains("rollupState") || force)) { SWGSDRangel::SWGRollupState *swgRollupState = new SWGSDRangel::SWGRollupState(); settings.m_rollupState->formatTo(swgRollupState); swgRemoteSinkSettings->setRollupState(swgRollupState); } } void RemoteSink::networkManagerFinished(QNetworkReply *reply) { QNetworkReply::NetworkError replyError = reply->error(); if (replyError) { qWarning() << "RemoteSink::networkManagerFinished:" << " error(" << (int) replyError << "): " << replyError << ": " << reply->errorString(); } else { QString answer = reply->readAll(); answer.chop(1); // remove last \n qDebug("RemoteSink::networkManagerFinished: reply:\n%s", answer.toStdString().c_str()); } reply->deleteLater(); } void RemoteSink::handleIndexInDeviceSetChanged(int index) { if (!m_running || (index < 0)) { return; } QString fifoLabel = QString("%1 [%2:%3]") .arg(m_channelId) .arg(m_deviceAPI->getDeviceSetIndex()) .arg(index); m_basebandSink->setFifoLabel(fifoLabel); }