/////////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2019 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 #include "SWGChannelSettings.h" #include "util/simpleserializer.h" #include "dsp/dspcommands.h" #include "dsp/dspdevicesourceengine.h" #include "dsp/dspengine.h" #include "dsp/devicesamplesource.h" #include "dsp/hbfilterchainconverter.h" #include "dsp/devicesamplemimo.h" #include "device/deviceapi.h" #include "feature/feature.h" #include "settings/serializable.h" #include "maincore.h" #include "localsinkbaseband.h" #include "localsink.h" MESSAGE_CLASS_DEFINITION(LocalSink::MsgConfigureLocalSink, Message) const char* const LocalSink::m_channelIdURI = "sdrangel.channel.localsink"; const char* const LocalSink::m_channelId = "LocalSink"; LocalSink::LocalSink(DeviceAPI *deviceAPI) : ChannelAPI(m_channelIdURI, ChannelAPI::StreamSingleSink), m_deviceAPI(deviceAPI), m_centerFrequency(0), m_frequencyOffset(0), m_basebandSampleRate(48000) { setObjectName(m_channelId); m_thread = new QThread(this); m_basebandSink = new LocalSinkBaseband(); m_basebandSink->moveToThread(m_thread); applySettings(m_settings, true); m_deviceAPI->addChannelSink(this); m_deviceAPI->addChannelSinkAPI(this); m_networkManager = new QNetworkAccessManager(); QObject::connect( m_networkManager, &QNetworkAccessManager::finished, this, &LocalSink::networkManagerFinished ); QObject::connect( this, &ChannelAPI::indexInDeviceSetChanged, this, &LocalSink::handleIndexInDeviceSetChanged ); } LocalSink::~LocalSink() { QObject::disconnect( m_networkManager, &QNetworkAccessManager::finished, this, &LocalSink::networkManagerFinished ); delete m_networkManager; m_deviceAPI->removeChannelSinkAPI(this); m_deviceAPI->removeChannelSink(this); delete m_basebandSink; delete m_thread; } void LocalSink::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 LocalSink::getNumberOfDeviceStreams() const { return m_deviceAPI->getNbSourceStreams(); } void LocalSink::feed(const SampleVector::const_iterator& begin, const SampleVector::const_iterator& end, bool firstOfBurst) { (void) firstOfBurst; m_basebandSink->feed(begin, end); } void LocalSink::start() { qDebug("LocalSink::start"); m_basebandSink->reset(); m_thread->start(); } void LocalSink::stop() { qDebug("LocalSink::stop"); m_thread->exit(); m_thread->wait(); } bool LocalSink::handleMessage(const Message& cmd) { if (DSPSignalNotification::match(cmd)) { DSPSignalNotification& notif = (DSPSignalNotification&) cmd; qDebug() << "LocalSink::handleMessage: DSPSignalNotification:" << " inputSampleRate: " << notif.getSampleRate() << " centerFrequency: " << notif.getCenterFrequency(); m_basebandSampleRate = notif.getSampleRate(); m_centerFrequency = notif.getCenterFrequency(); calculateFrequencyOffset(m_settings.m_log2Decim, m_settings.m_filterChainHash); // This is when device sample rate changes propagateSampleRateAndFrequency(m_settings.m_localDeviceIndex, m_settings.m_log2Decim); DSPSignalNotification *msg = new DSPSignalNotification(notif.getSampleRate(), notif.getCenterFrequency()); m_basebandSink->getInputMessageQueue()->push(msg); if (getMessageQueueToGUI()) { getMessageQueueToGUI()->push(new DSPSignalNotification(notif)); } return true; } else if (MsgConfigureLocalSink::match(cmd)) { MsgConfigureLocalSink& cfg = (MsgConfigureLocalSink&) cmd; qDebug() << "LocalSink::handleMessage: MsgConfigureLocalSink"; applySettings(cfg.getSettings(), cfg.getForce()); return true; } else { return false; } } QByteArray LocalSink::serialize() const { return m_settings.serialize(); } bool LocalSink::deserialize(const QByteArray& data) { (void) data; if (m_settings.deserialize(data)) { MsgConfigureLocalSink *msg = MsgConfigureLocalSink::create(m_settings, true); m_inputMessageQueue.push(msg); return true; } else { m_settings.resetToDefaults(); MsgConfigureLocalSink *msg = MsgConfigureLocalSink::create(m_settings, true); m_inputMessageQueue.push(msg); return false; } } void LocalSink::getLocalDevices(std::vector& indexes) { indexes.clear(); DSPEngine *dspEngine = DSPEngine::instance(); for (uint32_t i = 0; i < dspEngine->getDeviceSourceEnginesNumber(); i++) { DSPDeviceSourceEngine *deviceSourceEngine = dspEngine->getDeviceSourceEngineByIndex(i); DeviceSampleSource *deviceSource = deviceSourceEngine->getSource(); if (deviceSource->getDeviceDescription() == "LocalInput") { indexes.push_back(i); } } } DeviceSampleSource *LocalSink::getLocalDevice(uint32_t index) { DSPEngine *dspEngine = DSPEngine::instance(); if (index < dspEngine->getDeviceSourceEnginesNumber()) { DSPDeviceSourceEngine *deviceSourceEngine = dspEngine->getDeviceSourceEngineByIndex(index); DeviceSampleSource *deviceSource = deviceSourceEngine->getSource(); if (deviceSource->getDeviceDescription() == "LocalInput") { if (!getDeviceAPI()) { qDebug("LocalSink::getLocalDevice: the parent device is unset"); } else if (getDeviceAPI()->getDeviceUID() == deviceSourceEngine->getUID()) { qDebug("LocalSink::getLocalDevice: source device at index %u is the parent device", index); } else { return deviceSource; } } else { qDebug("LocalSink::getLocalDevice: source device at index %u is not a Local Input source", index); } } else { qDebug("LocalSink::getLocalDevice: non existent source device index: %u", index); } return nullptr; } void LocalSink::propagateSampleRateAndFrequency(uint32_t index, uint32_t log2Decim) { qDebug() << "LocalSink::propagateSampleRateAndFrequency:" << " index: " << index << " baseband_freq: " << m_basebandSampleRate << " log2Decim: " << log2Decim << " frequency: " << m_centerFrequency + m_frequencyOffset; DeviceSampleSource *deviceSource = getLocalDevice(index); if (deviceSource) { deviceSource->setSampleRate(m_basebandSampleRate / (1 << log2Decim)); deviceSource->setCenterFrequency(m_centerFrequency + m_frequencyOffset); } else { qDebug("LocalSink::propagateSampleRateAndFrequency: no suitable device at index %u", index); } } void LocalSink::applySettings(const LocalSinkSettings& settings, bool force) { qDebug() << "LocalSink::applySettings:" << "m_localDeviceIndex: " << settings.m_localDeviceIndex << "m_streamIndex: " << settings.m_streamIndex << "m_play:" << settings.m_play << "force: " << force; QList reverseAPIKeys; if ((settings.m_log2Decim != m_settings.m_log2Decim) || force) { reverseAPIKeys.append("log2Decim"); } if ((settings.m_filterChainHash != m_settings.m_filterChainHash) || force) { reverseAPIKeys.append("filterChainHash"); } if ((settings.m_localDeviceIndex != m_settings.m_localDeviceIndex) || force) { reverseAPIKeys.append("localDeviceIndex"); propagateSampleRateAndFrequency(settings.m_localDeviceIndex, settings.m_log2Decim); DeviceSampleSource *deviceSource = getLocalDevice(settings.m_localDeviceIndex); LocalSinkBaseband::MsgConfigureLocalDeviceSampleSource *msg = LocalSinkBaseband::MsgConfigureLocalDeviceSampleSource::create(deviceSource); m_basebandSink->getInputMessageQueue()->push(msg); } if ((settings.m_log2Decim != m_settings.m_log2Decim) || (settings.m_filterChainHash != m_settings.m_filterChainHash) || force) { calculateFrequencyOffset(settings.m_log2Decim, settings.m_filterChainHash); propagateSampleRateAndFrequency(m_settings.m_localDeviceIndex, settings.m_log2Decim); } if ((settings.m_play != m_settings.m_play) || force) { reverseAPIKeys.append("play"); LocalSinkBaseband::MsgConfigureLocalSinkWork *msg = LocalSinkBaseband::MsgConfigureLocalSinkWork::create( settings.m_play ); m_basebandSink->getInputMessageQueue()->push(msg); } 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"); } LocalSinkBaseband::MsgConfigureLocalSinkBaseband *msg = LocalSinkBaseband::MsgConfigureLocalSinkBaseband::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; } void LocalSink::validateFilterChainHash(LocalSinkSettings& 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 LocalSink::calculateFrequencyOffset(uint32_t log2Decim, uint32_t filterChainHash) { double shiftFactor = HBFilterChainConverter::getShiftFactor(log2Decim, filterChainHash); m_frequencyOffset = m_basebandSampleRate * shiftFactor; } int LocalSink::webapiSettingsGet( SWGSDRangel::SWGChannelSettings& response, QString& errorMessage) { (void) errorMessage; response.setLocalSinkSettings(new SWGSDRangel::SWGLocalSinkSettings()); response.getLocalSinkSettings()->init(); webapiFormatChannelSettings(response, m_settings); return 200; } int LocalSink::webapiSettingsPutPatch( bool force, const QStringList& channelSettingsKeys, SWGSDRangel::SWGChannelSettings& response, QString& errorMessage) { (void) errorMessage; LocalSinkSettings settings = m_settings; webapiUpdateChannelSettings(settings, channelSettingsKeys, response); MsgConfigureLocalSink *msg = MsgConfigureLocalSink::create(settings, force); m_inputMessageQueue.push(msg); qDebug("LocalSink::webapiSettingsPutPatch: forward to GUI: %p", m_guiMessageQueue); if (m_guiMessageQueue) // forward to GUI if any { MsgConfigureLocalSink *msgToGUI = MsgConfigureLocalSink::create(settings, force); m_guiMessageQueue->push(msgToGUI); } webapiFormatChannelSettings(response, settings); return 200; } void LocalSink::webapiUpdateChannelSettings( LocalSinkSettings& settings, const QStringList& channelSettingsKeys, SWGSDRangel::SWGChannelSettings& response) { if (channelSettingsKeys.contains("localDeviceIndex")) { settings.m_localDeviceIndex = response.getLocalSinkSettings()->getLocalDeviceIndex(); } if (channelSettingsKeys.contains("rgbColor")) { settings.m_rgbColor = response.getLocalSinkSettings()->getRgbColor(); } if (channelSettingsKeys.contains("title")) { settings.m_title = *response.getLocalSinkSettings()->getTitle(); } if (channelSettingsKeys.contains("log2Decim")) { settings.m_log2Decim = response.getLocalSinkSettings()->getLog2Decim(); } if (channelSettingsKeys.contains("filterChainHash")) { settings.m_filterChainHash = response.getLocalSinkSettings()->getFilterChainHash(); validateFilterChainHash(settings); } if (channelSettingsKeys.contains("play")) { settings.m_play = response.getLocalSinkSettings()->getPlay() != 0; } if (channelSettingsKeys.contains("streamIndex")) { settings.m_streamIndex = response.getLocalSinkSettings()->getStreamIndex(); } if (channelSettingsKeys.contains("useReverseAPI")) { settings.m_useReverseAPI = response.getLocalSinkSettings()->getUseReverseApi() != 0; } if (channelSettingsKeys.contains("reverseAPIAddress")) { settings.m_reverseAPIAddress = *response.getLocalSinkSettings()->getReverseApiAddress(); } if (channelSettingsKeys.contains("reverseAPIPort")) { settings.m_reverseAPIPort = response.getLocalSinkSettings()->getReverseApiPort(); } if (channelSettingsKeys.contains("reverseAPIDeviceIndex")) { settings.m_reverseAPIDeviceIndex = response.getLocalSinkSettings()->getReverseApiDeviceIndex(); } if (channelSettingsKeys.contains("reverseAPIChannelIndex")) { settings.m_reverseAPIChannelIndex = response.getLocalSinkSettings()->getReverseApiChannelIndex(); } if (settings.m_channelMarker && channelSettingsKeys.contains("channelMarker")) { settings.m_channelMarker->updateFrom(channelSettingsKeys, response.getLocalSinkSettings()->getChannelMarker()); } if (settings.m_rollupState && channelSettingsKeys.contains("rollupState")) { settings.m_rollupState->updateFrom(channelSettingsKeys, response.getLocalSinkSettings()->getRollupState()); } } void LocalSink::webapiFormatChannelSettings(SWGSDRangel::SWGChannelSettings& response, const LocalSinkSettings& settings) { response.getLocalSinkSettings()->setLocalDeviceIndex(settings.m_localDeviceIndex); response.getLocalSinkSettings()->setRgbColor(settings.m_rgbColor); if (response.getLocalSinkSettings()->getTitle()) { *response.getLocalSinkSettings()->getTitle() = settings.m_title; } else { response.getLocalSinkSettings()->setTitle(new QString(settings.m_title)); } response.getLocalSinkSettings()->setLog2Decim(settings.m_log2Decim); response.getLocalSinkSettings()->setFilterChainHash(settings.m_filterChainHash); response.getLocalSinkSettings()->setPlay(settings.m_play ? 1 : 0); response.getLocalSinkSettings()->setStreamIndex(settings.m_streamIndex); response.getLocalSinkSettings()->setUseReverseApi(settings.m_useReverseAPI ? 1 : 0); if (response.getLocalSinkSettings()->getReverseApiAddress()) { *response.getLocalSinkSettings()->getReverseApiAddress() = settings.m_reverseAPIAddress; } else { response.getLocalSinkSettings()->setReverseApiAddress(new QString(settings.m_reverseAPIAddress)); } response.getLocalSinkSettings()->setReverseApiPort(settings.m_reverseAPIPort); response.getLocalSinkSettings()->setReverseApiDeviceIndex(settings.m_reverseAPIDeviceIndex); response.getLocalSinkSettings()->setReverseApiChannelIndex(settings.m_reverseAPIChannelIndex); if (settings.m_channelMarker) { if (response.getLocalSinkSettings()->getChannelMarker()) { settings.m_channelMarker->formatTo(response.getLocalSinkSettings()->getChannelMarker()); } else { SWGSDRangel::SWGChannelMarker *swgChannelMarker = new SWGSDRangel::SWGChannelMarker(); settings.m_channelMarker->formatTo(swgChannelMarker); response.getLocalSinkSettings()->setChannelMarker(swgChannelMarker); } } if (settings.m_rollupState) { if (response.getLocalSinkSettings()->getRollupState()) { settings.m_rollupState->formatTo(response.getLocalSinkSettings()->getRollupState()); } else { SWGSDRangel::SWGRollupState *swgRollupState = new SWGSDRangel::SWGRollupState(); settings.m_rollupState->formatTo(swgRollupState); response.getLocalSinkSettings()->setRollupState(swgRollupState); } } } void LocalSink::webapiReverseSendSettings(QList& channelSettingsKeys, const LocalSinkSettings& 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 LocalSink::sendChannelSettings( const QList& pipes, QList& channelSettingsKeys, const LocalSinkSettings& 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 LocalSink::webapiFormatChannelSettings( QList& channelSettingsKeys, SWGSDRangel::SWGChannelSettings *swgChannelSettings, const LocalSinkSettings& settings, bool force ) { swgChannelSettings->setDirection(0); // Single sink (Rx) swgChannelSettings->setOriginatorChannelIndex(getIndexInDeviceSet()); swgChannelSettings->setOriginatorDeviceSetIndex(getDeviceSetIndex()); swgChannelSettings->setChannelType(new QString(m_channelId)); swgChannelSettings->setLocalSinkSettings(new SWGSDRangel::SWGLocalSinkSettings()); SWGSDRangel::SWGLocalSinkSettings *swgLocalSinkSettings = swgChannelSettings->getLocalSinkSettings(); // transfer data that has been modified. When force is on transfer all data except reverse API data if (channelSettingsKeys.contains("localDeviceIndex") || force) { swgLocalSinkSettings->setLocalDeviceIndex(settings.m_localDeviceIndex); } if (channelSettingsKeys.contains("rgbColor") || force) { swgLocalSinkSettings->setRgbColor(settings.m_rgbColor); } if (channelSettingsKeys.contains("title") || force) { swgLocalSinkSettings->setTitle(new QString(settings.m_title)); } if (channelSettingsKeys.contains("log2Decim") || force) { swgLocalSinkSettings->setLog2Decim(settings.m_log2Decim); } if (channelSettingsKeys.contains("filterChainHash") || force) { swgLocalSinkSettings->setFilterChainHash(settings.m_filterChainHash); } if (channelSettingsKeys.contains("play") || force) { swgLocalSinkSettings->setPlay(settings.m_play ? 1 : 0); } if (channelSettingsKeys.contains("streamIndex") || force) { swgLocalSinkSettings->setStreamIndex(settings.m_streamIndex); } if (settings.m_channelMarker && (channelSettingsKeys.contains("channelMarker") || force)) { SWGSDRangel::SWGChannelMarker *swgChannelMarker = new SWGSDRangel::SWGChannelMarker(); settings.m_channelMarker->formatTo(swgChannelMarker); swgLocalSinkSettings->setChannelMarker(swgChannelMarker); } if (settings.m_rollupState && (channelSettingsKeys.contains("rollupState") || force)) { SWGSDRangel::SWGRollupState *swgRollupState = new SWGSDRangel::SWGRollupState(); settings.m_rollupState->formatTo(swgRollupState); swgLocalSinkSettings->setRollupState(swgRollupState); } } void LocalSink::networkManagerFinished(QNetworkReply *reply) { QNetworkReply::NetworkError replyError = reply->error(); if (replyError) { qWarning() << "LocalSink::networkManagerFinished:" << " error(" << (int) replyError << "): " << replyError << ": " << reply->errorString(); } else { QString answer = reply->readAll(); answer.chop(1); // remove last \n qDebug("LocalSink::networkManagerFinished: reply:\n%s", answer.toStdString().c_str()); } reply->deleteLater(); } void LocalSink::handleIndexInDeviceSetChanged(int index) { if (index < 0) { return; } QString fifoLabel = QString("%1 [%2:%3]") .arg(m_channelId) .arg(m_deviceAPI->getDeviceSetIndex()) .arg(index); m_basebandSink->setFifoLabel(fifoLabel); }