// Copyright (c) Charles J. Cliffe // SPDX-License-Identifier: GPL-2.0+ #include #include #include #include #include #include #include "DemodulatorMgr.h" #include "CubicSDR.h" #if USE_HAMLIB #include "RigThread.h" #endif #include "DataTree.h" bool demodFreqCompare (DemodulatorInstance *i, DemodulatorInstance *j) { return (i->getFrequency()getFrequency()); } bool inactiveCompare (DemodulatorInstance *i, DemodulatorInstance *j) { return (i->isActive()isActive()); } DemodulatorMgr::DemodulatorMgr() { activeDemodulator = NULL; lastActiveDemodulator = NULL; activeVisualDemodulator = NULL; lastBandwidth = DEFAULT_DEMOD_BW; lastDemodType = DEFAULT_DEMOD_TYPE; lastSquelchEnabled = false; lastSquelch = -100; lastGain = 1.0; lastMuted = false; lastDeltaLock = false; } DemodulatorMgr::~DemodulatorMgr() { terminateAll(); } DemodulatorInstance *DemodulatorMgr::newThread() { std::lock_guard < std::recursive_mutex > lock(demods_busy); DemodulatorInstance *newDemod = new DemodulatorInstance; std::stringstream label; label << demods.size(); newDemod->setLabel(label.str()); demods.push_back(newDemod); return newDemod; } void DemodulatorMgr::terminateAll() { std::lock_guard < std::recursive_mutex > lock(demods_busy); while (demods.size()) { DemodulatorInstance *d = demods.back(); demods.pop_back(); wxGetApp().removeDemodulator(d); deleteThread(d); } } std::vector &DemodulatorMgr::getDemodulators() { std::lock_guard < std::recursive_mutex > lock(demods_busy); return demods; } std::vector DemodulatorMgr::getOrderedDemodulators(bool actives) { std::lock_guard < std::recursive_mutex > lock(demods_busy); std::vector demods_ordered = demods; if (actives) { std::sort(demods_ordered.begin(), demods_ordered.end(), inactiveCompare); std::vector::iterator i; for (i = demods_ordered.begin(); i != demods_ordered.end(); i++) { if ((*i)->isActive()) { break; } } if (i == demods_ordered.end()) { demods_ordered.erase(demods_ordered.begin(), demods_ordered.end()); } else if ((*i) != demods_ordered.front()) { demods_ordered.erase(demods_ordered.begin(), i); } } //if by chance they have the same frequency, keep their relative order std::stable_sort(demods_ordered.begin(), demods_ordered.end(), demodFreqCompare); return demods_ordered; } DemodulatorInstance *DemodulatorMgr::getPreviousDemodulator(DemodulatorInstance *demod, bool actives) { std::lock_guard < std::recursive_mutex > lock(demods_busy); if (!getLastActiveDemodulator()) { return nullptr; } std::vector demods_ordered = getOrderedDemodulators(actives); std::vector::iterator p = std::find(demods_ordered.begin(), demods_ordered.end(), demod); if (p == demods_ordered.end()) { return nullptr; } if (*p == demods_ordered.front()) { return demods_ordered.back(); } return *(--p); } DemodulatorInstance *DemodulatorMgr::getNextDemodulator(DemodulatorInstance *demod, bool actives) { std::lock_guard < std::recursive_mutex > lock(demods_busy); if (!getLastActiveDemodulator()) { return nullptr; } std::vector demods_ordered = getOrderedDemodulators(actives); std::vector::iterator p = std::find(demods_ordered.begin(), demods_ordered.end(), demod); if (actives) { } if (p == demods_ordered.end()) { return nullptr; } if (*p == demods_ordered.back()) { return demods_ordered.front(); } return *(++p); } DemodulatorInstance *DemodulatorMgr::getLastDemodulator() { std::lock_guard < std::recursive_mutex > lock(demods_busy); std::vector demods_ordered = getOrderedDemodulators(); return *(demods_ordered.end()); } DemodulatorInstance *DemodulatorMgr::getFirstDemodulator() { std::lock_guard < std::recursive_mutex > lock(demods_busy); std::vector demods_ordered = getOrderedDemodulators(); return *(demods_ordered.begin()); } void DemodulatorMgr::deleteThread(DemodulatorInstance *demod) { std::lock_guard < std::recursive_mutex > lock(demods_busy); wxGetApp().getBookmarkMgr().addRecent(demod); std::vector::iterator i; i = std::find(demods.begin(), demods.end(), demod); if (activeDemodulator == demod) { activeDemodulator = nullptr; } if (lastActiveDemodulator == demod) { lastActiveDemodulator = nullptr; } if (activeVisualDemodulator == demod) { activeVisualDemodulator = nullptr; } if (i != demods.end()) { demods.erase(i); } //Ask for termination demod->setActive(false); demod->terminate(); //Do not cleanup immediatly demods_deleted.push_back(demod); } std::vector DemodulatorMgr::getDemodulatorsAt(long long freq, int bandwidth) { std::lock_guard < std::recursive_mutex > lock(demods_busy); std::vector foundDemods; for (int i = 0, iMax = demods.size(); i < iMax; i++) { DemodulatorInstance *testDemod = demods[i]; long long freqTest = testDemod->getFrequency(); long long bandwidthTest = testDemod->getBandwidth(); long long halfBandwidthTest = bandwidthTest / 2; long long halfBuffer = bandwidth / 2; if ((freq <= (freqTest + ((testDemod->getDemodulatorType() != "LSB")?halfBandwidthTest:0) + halfBuffer)) && (freq >= (freqTest - ((testDemod->getDemodulatorType() != "USB")?halfBandwidthTest:0) - halfBuffer))) { foundDemods.push_back(testDemod); } } return foundDemods; } bool DemodulatorMgr::anyDemodulatorsAt(long long freq, int bandwidth) { std::lock_guard < std::recursive_mutex > lock(demods_busy); for (int i = 0, iMax = demods.size(); i < iMax; i++) { DemodulatorInstance *testDemod = demods[i]; long long freqTest = testDemod->getFrequency(); long long bandwidthTest = testDemod->getBandwidth(); long long halfBandwidthTest = bandwidthTest / 2; long long halfBuffer = bandwidth / 2; if ((freq <= (freqTest + ((testDemod->getDemodulatorType() != "LSB")?halfBandwidthTest:0) + halfBuffer)) && (freq >= (freqTest - ((testDemod->getDemodulatorType() != "USB")?halfBandwidthTest:0) - halfBuffer))) { return true; } } return false; } void DemodulatorMgr::setActiveDemodulator(DemodulatorInstance *demod, bool temporary) { if (!temporary) { if (activeDemodulator.load() != nullptr) { lastActiveDemodulator = activeDemodulator.load(); updateLastState(); } else { lastActiveDemodulator = demod; } updateLastState(); #if USE_HAMLIB if (wxGetApp().rigIsActive() && wxGetApp().getRigThread()->getFollowModem() && lastActiveDemodulator.load()) { wxGetApp().getRigThread()->setFrequency(lastActiveDemodulator.load()->getFrequency(),true); } #endif wxGetApp().getBookmarkMgr().updateActiveList(); } else { std::lock_guard < std::recursive_mutex > lock(demods_busy); garbageCollect(); } if (activeVisualDemodulator.load()) { activeVisualDemodulator.load()->setVisualOutputQueue(nullptr); } if (demod) { demod->setVisualOutputQueue(wxGetApp().getAudioVisualQueue()); activeVisualDemodulator = demod; } else { DemodulatorInstance *last = getLastActiveDemodulator(); if (last) { last->setVisualOutputQueue(wxGetApp().getAudioVisualQueue()); } activeVisualDemodulator = last; } activeDemodulator = demod; } DemodulatorInstance *DemodulatorMgr::getActiveDemodulator() { if (activeDemodulator.load() && !activeDemodulator.load()->isActive()) { activeDemodulator = getLastActiveDemodulator(); } return activeDemodulator; } DemodulatorInstance *DemodulatorMgr::getLastActiveDemodulator() { return lastActiveDemodulator; } DemodulatorInstance *DemodulatorMgr::getLastDemodulatorWith(const std::string& type, const std::wstring& userLabel, long long frequency, int bandwidth) { std::lock_guard < std::recursive_mutex > lock(demods_busy); //backwards search: for (std::vector::reverse_iterator it = demods.rbegin(); it != demods.rend(); it++) { if ((*it)->getDemodulatorType() == type && (*it)->getDemodulatorUserLabel() == userLabel && (*it)->getFrequency() == frequency && (*it)->getBandwidth() == bandwidth) { return (*it); } } return nullptr; } //Private internal method, no need to protect it with demods_busy void DemodulatorMgr::garbageCollect() { std::vector::iterator it = demods_deleted.begin(); while (it != demods_deleted.end()) { if ((*it)->isTerminated()) { DemodulatorInstance *deleted = (*it); delete deleted; it = demods_deleted.erase(it); std::cout << "Garbage collected demodulator instance '" << deleted->getLabel() << "'... " << std::endl << std::flush; } else { it++; } } //end while } void DemodulatorMgr::updateLastState() { std::lock_guard < std::recursive_mutex > lock(demods_busy); if (std::find(demods.begin(), demods.end(), lastActiveDemodulator) == demods.end()) { if (activeDemodulator.load() && activeDemodulator.load()->isActive()) { lastActiveDemodulator = activeDemodulator.load(); } else if (activeDemodulator.load() && !activeDemodulator.load()->isActive()){ activeDemodulator = nullptr; lastActiveDemodulator = nullptr; } } if (lastActiveDemodulator.load() && !lastActiveDemodulator.load()->isActive()) { lastActiveDemodulator = nullptr; } if (lastActiveDemodulator.load()) { lastBandwidth = lastActiveDemodulator.load()->getBandwidth(); lastDemodType = lastActiveDemodulator.load()->getDemodulatorType(); lastDemodLock = lastActiveDemodulator.load()->getDemodulatorLock()?true:false; lastSquelchEnabled = lastActiveDemodulator.load()->isSquelchEnabled(); lastSquelch = lastActiveDemodulator.load()->getSquelchLevel(); lastGain = lastActiveDemodulator.load()->getGain(); lastModemSettings[lastDemodType] = lastActiveDemodulator.load()->readModemSettings(); } } int DemodulatorMgr::getLastBandwidth() const { return lastBandwidth; } void DemodulatorMgr::setLastBandwidth(int lastBandwidth) { if (lastBandwidth < MIN_BANDWIDTH) { lastBandwidth = MIN_BANDWIDTH; } else if (lastBandwidth > wxGetApp().getSampleRate()) { lastBandwidth = wxGetApp().getSampleRate(); } this->lastBandwidth = lastBandwidth; } std::string DemodulatorMgr::getLastDemodulatorType() const { return lastDemodType; } void DemodulatorMgr::setLastDemodulatorType(std::string lastDemodType) { this->lastDemodType = lastDemodType; } float DemodulatorMgr::getLastGain() const { return lastGain; } void DemodulatorMgr::setLastGain(float lastGain) { this->lastGain = lastGain; } bool DemodulatorMgr::getLastDeltaLock() const { return lastDeltaLock; } void DemodulatorMgr::setLastDeltaLock(bool lock) { lastDeltaLock = lock; } float DemodulatorMgr::getLastSquelchLevel() const { return lastSquelch; } void DemodulatorMgr::setLastSquelchLevel(float lastSquelch) { this->lastSquelch = lastSquelch; } bool DemodulatorMgr::isLastSquelchEnabled() const { return lastSquelchEnabled; } void DemodulatorMgr::setLastSquelchEnabled(bool lastSquelchEnabled) { this->lastSquelchEnabled = lastSquelchEnabled; } bool DemodulatorMgr::isLastMuted() const { return lastMuted; } void DemodulatorMgr::setLastMuted(bool lastMuted) { this->lastMuted = lastMuted; } ModemSettings DemodulatorMgr::getLastModemSettings(std::string modemType) { return lastModemSettings[modemType]; } void DemodulatorMgr::setLastModemSettings(std::string modemType, ModemSettings settings) { lastModemSettings[modemType] = settings; } void DemodulatorMgr::setOutputDevices(std::map devs) { outputDevices = devs; } void DemodulatorMgr::saveInstance(DataNode *node, DemodulatorInstance *inst) { *node->newChild("bandwidth") = inst->getBandwidth(); *node->newChild("frequency") = inst->getFrequency(); *node->newChild("type") = inst->getDemodulatorType(); node->newChild("user_label")->element()->set(inst->getDemodulatorUserLabel()); *node->newChild("squelch_level") = inst->getSquelchLevel(); *node->newChild("squelch_enabled") = inst->isSquelchEnabled() ? 1 : 0; *node->newChild("output_device") = outputDevices[inst->getOutputDevice()].name; *node->newChild("gain") = inst->getGain(); *node->newChild("muted") = inst->isMuted() ? 1 : 0; if (inst->isDeltaLock()) { *node->newChild("delta_lock") = inst->isDeltaLock() ? 1 : 0; *node->newChild("delta_ofs") = inst->getDeltaLockOfs(); } if (inst == getLastActiveDemodulator()) { *node->newChild("active") = 1; } ModemSettings saveSettings = inst->readModemSettings(); if (saveSettings.size()) { DataNode *settingsNode = node->newChild("settings"); for (ModemSettings::const_iterator msi = saveSettings.begin(); msi != saveSettings.end(); msi++) { *settingsNode->newChild(msi->first.c_str()) = msi->second; } } } DemodulatorInstance *DemodulatorMgr::loadInstance(DataNode *node) { std::lock_guard < std::recursive_mutex > lock(demods_busy); DemodulatorInstance *newDemod = nullptr; node->rewindAll(); long bandwidth = *node->getNext("bandwidth"); long long freq = *node->getNext("frequency"); float squelch_level = node->hasAnother("squelch_level") ? (float) *node->getNext("squelch_level") : 0; int squelch_enabled = node->hasAnother("squelch_enabled") ? (int) *node->getNext("squelch_enabled") : 0; int muted = node->hasAnother("muted") ? (int) *node->getNext("muted") : 0; int delta_locked = node->hasAnother("delta_lock") ? (int) *node->getNext("delta_lock") : 0; int delta_ofs = node->hasAnother("delta_ofs") ? (int) *node->getNext("delta_ofs") : 0; std::string output_device = node->hasAnother("output_device") ? string(*(node->getNext("output_device"))) : ""; float gain = node->hasAnother("gain") ? (float) *node->getNext("gain") : 1.0; std::string type = "FM"; DataNode *demodTypeNode = node->hasAnother("type")?node->getNext("type"):nullptr; if (demodTypeNode && demodTypeNode->element()->getDataType() == DATA_INT) { int legacyType = *demodTypeNode; int legacyStereo = node->hasAnother("stereo") ? (int) *node->getNext("stereo") : 0; switch (legacyType) { // legacy demod ID case 1: type = legacyStereo?"FMS":"FM"; break; case 2: type = "AM"; break; case 3: type = "LSB"; break; case 4: type = "USB"; break; case 5: type = "DSB"; break; case 6: type = "ASK"; break; case 7: type = "APSK"; break; case 8: type = "BPSK"; break; case 9: type = "DPSK"; break; case 10: type = "PSK"; break; case 11: type = "OOK"; break; case 12: type = "ST"; break; case 13: type = "SQAM"; break; case 14: type = "QAM"; break; case 15: type = "QPSK"; break; case 16: type = "I/Q"; break; default: type = "FM"; break; } } else if (demodTypeNode && demodTypeNode->element()->getDataType() == DATA_STRING) { demodTypeNode->element()->get(type); } //read the user label associated with the demodulator std::wstring user_label = L""; DataNode *demodUserLabel = node->hasAnother("user_label") ? node->getNext("user_label") : nullptr; if (demodUserLabel) { demodUserLabel->element()->get(user_label); } ModemSettings mSettings; if (node->hasAnother("settings")) { DataNode *modemSettings = node->getNext("settings"); for (int msi = 0, numSettings = modemSettings->numChildren(); msi < numSettings; msi++) { DataNode *settingNode = modemSettings->child(msi); std::string keyName = settingNode->getName(); std::string strSettingValue = settingNode->element()->toString(); if (keyName != "" && strSettingValue != "") { mSettings[keyName] = strSettingValue; } } } newDemod = newThread(); newDemod->setDemodulatorType(type); newDemod->setDemodulatorUserLabel(user_label); newDemod->writeModemSettings(mSettings); newDemod->setBandwidth(bandwidth); newDemod->setFrequency(freq); newDemod->setGain(gain); newDemod->updateLabel(freq); newDemod->setMuted(muted?true:false); if (delta_locked) { newDemod->setDeltaLock(true); newDemod->setDeltaLockOfs(delta_ofs); } if (squelch_enabled) { newDemod->setSquelchEnabled(true); newDemod->setSquelchLevel(squelch_level); } //Attach to sound output: bool found_device = false; std::map::iterator i; for (i = outputDevices.begin(); i != outputDevices.end(); i++) { if (i->second.name == output_device) { newDemod->setOutputDevice(i->first); found_device = true; break; } } return newDemod; }