/////////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2018 Edouard Griffiths, F4EXB. // // // // 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" #if (defined _WIN32_) || (defined _MSC_VER) #include "windows_time.h" #include #else #include #include #endif #include #include #include #include #include #include "SWGChannelSettings.h" #include "util/simpleserializer.h" #include "dsp/threadedbasebandsamplesink.h" #include "dsp/downchannelizer.h" #include "dsp/dspcommands.h" #include "dsp/hbfilterchainconverter.h" #include "device/deviceapi.h" #include "remotesinkthread.h" MESSAGE_CLASS_DEFINITION(RemoteSink::MsgConfigureRemoteSink, Message) MESSAGE_CLASS_DEFINITION(RemoteSink::MsgSampleRateNotification, Message) MESSAGE_CLASS_DEFINITION(RemoteSink::MsgConfigureChannelizer, Message) const QString RemoteSink::m_channelIdURI = "sdrangel.channel.remotesink"; const QString RemoteSink::m_channelId = "RemoteSink"; RemoteSink::RemoteSink(DeviceAPI *deviceAPI) : ChannelAPI(m_channelIdURI, ChannelAPI::StreamSingleSink), m_deviceAPI(deviceAPI), m_running(false), m_sinkThread(0), m_txBlockIndex(0), m_frameCount(0), m_sampleIndex(0), m_dataBlock(0), m_centerFrequency(0), m_frequencyOffset(0), m_sampleRate(48000), m_deviceSampleRate(48000), m_nbBlocksFEC(0), m_txDelay(35), m_dataAddress("127.0.0.1"), m_dataPort(9090) { setObjectName(m_channelId); m_channelizer = new DownChannelizer(this); m_threadedChannelizer = new ThreadedBasebandSampleSink(m_channelizer, this); m_deviceAPI->addChannelSink(m_threadedChannelizer); m_deviceAPI->addChannelSinkAPI(this); m_networkManager = new QNetworkAccessManager(); connect(m_networkManager, SIGNAL(finished(QNetworkReply*)), this, SLOT(networkManagerFinished(QNetworkReply*))); } RemoteSink::~RemoteSink() { disconnect(m_networkManager, SIGNAL(finished(QNetworkReply*)), this, SLOT(networkManagerFinished(QNetworkReply*))); delete m_networkManager; m_dataBlockMutex.lock(); if (m_dataBlock && !m_dataBlock->m_txControlBlock.m_complete) { delete m_dataBlock; } m_dataBlockMutex.unlock(); m_deviceAPI->removeChannelSinkAPI(this); m_deviceAPI->removeChannelSink(m_threadedChannelizer); delete m_threadedChannelizer; delete m_channelizer; } void RemoteSink::setTxDelay(int txDelay, int nbBlocksFEC) { double txDelayRatio = txDelay / 100.0; int samplesPerBlock = RemoteNbBytesPerBlock / sizeof(Sample); double delay = m_sampleRate == 0 ? 1.0 : (127*samplesPerBlock*txDelayRatio) / m_sampleRate; delay /= 128 + nbBlocksFEC; m_txDelay = roundf(delay*1e6); // microseconds qDebug() << "RemoteSink::setTxDelay:" << " " << txDelay << "% m_txDelay: " << m_txDelay << "us" << " m_sampleRate: " << m_sampleRate << "S/s"; } void RemoteSink::setNbBlocksFEC(int nbBlocksFEC) { qDebug() << "RemoteSink::setNbBlocksFEC: nbBlocksFEC: " << nbBlocksFEC; m_nbBlocksFEC = nbBlocksFEC; } void RemoteSink::feed(const SampleVector::const_iterator& begin, const SampleVector::const_iterator& end, bool firstOfBurst) { (void) firstOfBurst; SampleVector::const_iterator it = begin; while (it != end) { int inSamplesIndex = it - begin; int inRemainingSamples = end - it; if (m_txBlockIndex == 0) { struct timeval tv; RemoteMetaDataFEC metaData; gettimeofday(&tv, 0); metaData.m_centerFrequency = m_centerFrequency + m_frequencyOffset; metaData.m_sampleRate = m_sampleRate; metaData.m_sampleBytes = (SDR_RX_SAMP_SZ <= 16 ? 2 : 4); metaData.m_sampleBits = SDR_RX_SAMP_SZ; metaData.m_nbOriginalBlocks = RemoteNbOrginalBlocks; metaData.m_nbFECBlocks = m_nbBlocksFEC; metaData.m_tv_sec = tv.tv_sec; metaData.m_tv_usec = tv.tv_usec; if (!m_dataBlock) { // on the very first cycle there is no data block allocated m_dataBlock = new RemoteDataBlock(); } boost::crc_32_type crc32; crc32.process_bytes(&metaData, sizeof(RemoteMetaDataFEC)-4); metaData.m_crc32 = crc32.checksum(); RemoteSuperBlock& superBlock = m_dataBlock->m_superBlocks[0]; // first block superBlock.init(); superBlock.m_header.m_frameIndex = m_frameCount; superBlock.m_header.m_blockIndex = m_txBlockIndex; superBlock.m_header.m_sampleBytes = (SDR_RX_SAMP_SZ <= 16 ? 2 : 4); superBlock.m_header.m_sampleBits = SDR_RX_SAMP_SZ; RemoteMetaDataFEC *destMeta = (RemoteMetaDataFEC *) &superBlock.m_protectedBlock; *destMeta = metaData; if (!(metaData == m_currentMetaFEC)) { qDebug() << "RemoteSink::feed: meta: " << "|" << metaData.m_centerFrequency << ":" << metaData.m_sampleRate << ":" << (int) (metaData.m_sampleBytes & 0xF) << ":" << (int) metaData.m_sampleBits << "|" << (int) metaData.m_nbOriginalBlocks << ":" << (int) metaData.m_nbFECBlocks << "|" << metaData.m_tv_sec << ":" << metaData.m_tv_usec; m_currentMetaFEC = metaData; } m_txBlockIndex = 1; // next Tx block with data } // block zero // handle different sample sizes... int samplesPerBlock = RemoteNbBytesPerBlock / (SDR_RX_SAMP_SZ <= 16 ? 4 : 8); // two I or Q samples if (m_sampleIndex + inRemainingSamples < samplesPerBlock) // there is still room in the current super block { memcpy((void *) &m_superBlock.m_protectedBlock.buf[m_sampleIndex*sizeof(Sample)], (const void *) &(*(begin+inSamplesIndex)), inRemainingSamples * sizeof(Sample)); m_sampleIndex += inRemainingSamples; it = end; // all input samples are consumed } else // complete super block and initiate the next if not end of frame { memcpy((void *) &m_superBlock.m_protectedBlock.buf[m_sampleIndex*sizeof(Sample)], (const void *) &(*(begin+inSamplesIndex)), (samplesPerBlock - m_sampleIndex) * sizeof(Sample)); it += samplesPerBlock - m_sampleIndex; m_sampleIndex = 0; m_superBlock.m_header.m_frameIndex = m_frameCount; m_superBlock.m_header.m_blockIndex = m_txBlockIndex; m_superBlock.m_header.m_sampleBytes = (SDR_RX_SAMP_SZ <= 16 ? 2 : 4); m_superBlock.m_header.m_sampleBits = SDR_RX_SAMP_SZ; m_dataBlock->m_superBlocks[m_txBlockIndex] = m_superBlock; if (m_txBlockIndex == RemoteNbOrginalBlocks - 1) // frame complete { m_dataBlockMutex.lock(); m_dataBlock->m_txControlBlock.m_frameIndex = m_frameCount; m_dataBlock->m_txControlBlock.m_processed = false; m_dataBlock->m_txControlBlock.m_complete = true; m_dataBlock->m_txControlBlock.m_nbBlocksFEC = m_nbBlocksFEC; m_dataBlock->m_txControlBlock.m_txDelay = m_txDelay; m_dataBlock->m_txControlBlock.m_dataAddress = m_dataAddress; m_dataBlock->m_txControlBlock.m_dataPort = m_dataPort; emit dataBlockAvailable(m_dataBlock); m_dataBlock = new RemoteDataBlock(); // create a new one immediately m_dataBlockMutex.unlock(); m_txBlockIndex = 0; m_frameCount++; } else { m_txBlockIndex++; } } } } void RemoteSink::start() { qDebug("RemoteSink::start"); memset((void *) &m_currentMetaFEC, 0, sizeof(RemoteMetaDataFEC)); if (m_running) { stop(); } m_sinkThread = new RemoteSinkThread(); connect(this, SIGNAL(dataBlockAvailable(RemoteDataBlock *)), m_sinkThread, SLOT(processDataBlock(RemoteDataBlock *)), Qt::QueuedConnection); m_sinkThread->startStop(true); m_running = true; } void RemoteSink::stop() { qDebug("RemoteSink::stop"); if (m_sinkThread != 0) { m_sinkThread->startStop(false); m_sinkThread->deleteLater(); m_sinkThread = 0; } m_running = false; } bool RemoteSink::handleMessage(const Message& cmd) { (void) cmd; if (DownChannelizer::MsgChannelizerNotification::match(cmd)) { DownChannelizer::MsgChannelizerNotification& notif = (DownChannelizer::MsgChannelizerNotification&) cmd; qDebug() << "RemoteSink::handleMessage: MsgChannelizerNotification:" << " channelSampleRate: " << notif.getSampleRate() << " offsetFrequency: " << notif.getFrequencyOffset(); if (notif.getSampleRate() > 0) { setSampleRate(notif.getSampleRate()); } setTxDelay(m_settings.m_txDelay, m_settings.m_nbFECBlocks); return true; } else if (DSPSignalNotification::match(cmd)) { DSPSignalNotification& notif = (DSPSignalNotification&) cmd; qDebug() << "RemoteSink::handleMessage: DSPSignalNotification:" << " inputSampleRate: " << notif.getSampleRate() << " centerFrequency: " << notif.getCenterFrequency(); setCenterFrequency(notif.getCenterFrequency()); m_deviceSampleRate = notif.getSampleRate(); calculateFrequencyOffset(); // This is when device sample rate changes // Redo the channelizer stuff with the new sample rate to re-synchronize everything m_channelizer->set(m_channelizer->getInputMessageQueue(), m_settings.m_log2Decim, m_settings.m_filterChainHash); if (m_guiMessageQueue) { MsgSampleRateNotification *msg = MsgSampleRateNotification::create(notif.getSampleRate()); m_guiMessageQueue->push(msg); } return true; } else if (MsgConfigureRemoteSink::match(cmd)) { MsgConfigureRemoteSink& cfg = (MsgConfigureRemoteSink&) cmd; qDebug() << "RemoteSink::handleMessage: MsgConfigureRemoteSink"; applySettings(cfg.getSettings(), cfg.getForce()); return true; } else if (MsgConfigureChannelizer::match(cmd)) { MsgConfigureChannelizer& cfg = (MsgConfigureChannelizer&) cmd; m_settings.m_log2Decim = cfg.getLog2Decim(); m_settings.m_filterChainHash = cfg.getFilterChainHash(); qDebug() << "RemoteSink::handleMessage: MsgConfigureChannelizer:" << " log2Decim: " << m_settings.m_log2Decim << " filterChainHash: " << m_settings.m_filterChainHash; m_channelizer->set(m_channelizer->getInputMessageQueue(), m_settings.m_log2Decim, m_settings.m_filterChainHash); calculateFrequencyOffset(); // This is when decimation or filter chain changes 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_txDelay: " << settings.m_txDelay << " m_dataAddress: " << settings.m_dataAddress << " m_dataPort: " << settings.m_dataPort << " force: " << force; QList reverseAPIKeys; if ((m_settings.m_nbFECBlocks != settings.m_nbFECBlocks) || force) { reverseAPIKeys.append("nbFECBlocks"); setNbBlocksFEC(settings.m_nbFECBlocks); setTxDelay(settings.m_txDelay, settings.m_nbFECBlocks); } if ((m_settings.m_txDelay != settings.m_txDelay) || force) { reverseAPIKeys.append("txDelay"); setTxDelay(settings.m_txDelay, settings.m_nbFECBlocks); } if ((m_settings.m_dataAddress != settings.m_dataAddress) || force) { reverseAPIKeys.append("dataAddress"); m_dataAddress = settings.m_dataAddress; } if ((m_settings.m_dataPort != settings.m_dataPort) || force) { reverseAPIKeys.append("dataPort"); m_dataPort = settings.m_dataPort; } 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); } m_settings = settings; } 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_deviceSampleRate * shiftFactor; } 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::webapiSettingsPutPatch( bool force, const QStringList& channelSettingsKeys, SWGSDRangel::SWGChannelSettings& response, QString& errorMessage) { (void) errorMessage; RemoteSinkSettings settings = m_settings; 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("txDelay")) { int txDelay = response.getRemoteSinkSettings()->getTxDelay(); if (txDelay < 0) { settings.m_txDelay = 35; } else { settings.m_txDelay = txDelay; } } 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("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(); } MsgConfigureRemoteSink *msg = MsgConfigureRemoteSink::create(settings, force); m_inputMessageQueue.push(msg); if ((settings.m_log2Decim != m_settings.m_log2Decim) || (settings.m_filterChainHash != m_settings.m_filterChainHash) || force) { MsgConfigureChannelizer *msg = MsgConfigureChannelizer::create(settings.m_log2Decim, settings.m_filterChainHash); 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::webapiFormatChannelSettings(SWGSDRangel::SWGChannelSettings& response, const RemoteSinkSettings& settings) { response.getRemoteSinkSettings()->setNbFecBlocks(settings.m_nbFECBlocks); response.getRemoteSinkSettings()->setTxDelay(settings.m_txDelay); if (response.getRemoteSinkSettings()->getDataAddress()) { *response.getRemoteSinkSettings()->getDataAddress() = settings.m_dataAddress; } else { response.getRemoteSinkSettings()->setDataAddress(new QString(settings.m_dataAddress)); } 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()->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); } void RemoteSink::webapiReverseSendSettings(QList& channelSettingsKeys, const RemoteSinkSettings& settings, bool force) { SWGSDRangel::SWGChannelSettings *swgChannelSettings = new SWGSDRangel::SWGChannelSettings(); swgChannelSettings->setDirection(0); // single sink (Rx) swgChannelSettings->setOriginatorChannelIndex(getIndexInDeviceSet()); swgChannelSettings->setOriginatorDeviceSetIndex(getDeviceSetIndex()); swgChannelSettings->setChannelType(new QString("RemoteSink")); 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("txDelay") || force) { swgRemoteSinkSettings->setTxDelay(settings.m_txDelay); } 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); } 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 m_networkManager->sendCustomRequest(m_networkRequest, "PATCH", buffer); delete swgChannelSettings; } void RemoteSink::networkManagerFinished(QNetworkReply *reply) { QNetworkReply::NetworkError replyError = reply->error(); if (replyError) { qWarning() << "RemoteSink::networkManagerFinished:" << " error(" << (int) replyError << "): " << replyError << ": " << reply->errorString(); return; } QString answer = reply->readAll(); answer.chop(1); // remove last \n qDebug("RemoteSink::networkManagerFinished: reply:\n%s", answer.toStdString().c_str()); }