1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-12-23 10:05:46 -05:00
sdrangel/plugins/feature/jogdialcontroller/jogdialcontroller.cpp
Mykola Dvornik 15337cac66 Fix bug that prevents settings changes updates via reverse API
Most plugins that use reverse API to PATCH settings updates to remote
server only do so when `useReverseAPI` is toggled, but not when the
relevant settings are being updated. So lets fix the precondition to
use the `m_useReverseAPI` flag instead.
2024-04-14 18:58:12 +02:00

647 lines
22 KiB
C++

///////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2022 Edouard Griffiths, F4EXB <f4exb06@gmail.com> //
// //
// 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 <http://www.gnu.org/licenses/>. //
///////////////////////////////////////////////////////////////////////////////////
#include <QDebug>
#include <QNetworkAccessManager>
#include <QNetworkReply>
#include <QBuffer>
#include "SWGFeatureSettings.h"
#include "SWGDeviceState.h"
#include "dsp/dspdevicesourceengine.h"
#include "dsp/dspdevicesinkengine.h"
#include "dsp/devicesamplesource.h"
#include "dsp/devicesamplesink.h"
#include "device/deviceset.h"
#include "channel/channelapi.h"
#include "device/deviceapi.h"
#include "settings/serializable.h"
#include "maincore.h"
#include "jogdialcontroller.h"
MESSAGE_CLASS_DEFINITION(JogdialController::MsgConfigureJogdialController, Message)
MESSAGE_CLASS_DEFINITION(JogdialController::MsgStartStop, Message)
MESSAGE_CLASS_DEFINITION(JogdialController::MsgRefreshChannels, Message)
MESSAGE_CLASS_DEFINITION(JogdialController::MsgReportChannels, Message)
MESSAGE_CLASS_DEFINITION(JogdialController::MsgReportControl, Message)
MESSAGE_CLASS_DEFINITION(JogdialController::MsgSelectChannel, Message)
const char* const JogdialController::m_featureIdURI = "sdrangel.feature.jogdialcontroller";
const char* const JogdialController::m_featureId = "JogdialController";
JogdialController::JogdialController(WebAPIAdapterInterface *webAPIAdapterInterface) :
Feature(m_featureIdURI, webAPIAdapterInterface),
m_selectedDevice(nullptr),
m_selectedChannel(nullptr),
m_selectedIndex(-1),
m_deviceElseChannelControl(true),
m_multiplier(1)
{
qDebug("JogdialController::JogdialController: webAPIAdapterInterface: %p", webAPIAdapterInterface);
setObjectName(m_featureId);
m_state = StIdle;
m_errorMessage = "JogdialController error";
m_networkManager = new QNetworkAccessManager();
QObject::connect(
m_networkManager,
&QNetworkAccessManager::finished,
this,
&JogdialController::networkManagerFinished
);
connect(&m_repeatTimer, SIGNAL(timeout()), this, SLOT(handleRepeat()));
}
JogdialController::~JogdialController()
{
QObject::disconnect(
m_networkManager,
&QNetworkAccessManager::finished,
this,
&JogdialController::networkManagerFinished
);
delete m_networkManager;
}
void JogdialController::start()
{
qDebug("JogdialController::start");
m_state = StRunning;
}
void JogdialController::stop()
{
qDebug("JogdialController::stop");
m_state = StIdle;
}
bool JogdialController::handleMessage(const Message& cmd)
{
if (MsgConfigureJogdialController::match(cmd))
{
MsgConfigureJogdialController& cfg = (MsgConfigureJogdialController&) cmd;
qDebug() << "JogdialController::handleMessage: MsgConfigureJogdialController";
applySettings(cfg.getSettings(), cfg.getSettingsKeys(), cfg.getForce());
return true;
}
else if (MsgStartStop::match(cmd))
{
MsgStartStop& cfg = (MsgStartStop&) cmd;
qDebug() << "JogdialController::handleMessage: MsgStartStop: start:" << cfg.getStartStop();
if (cfg.getStartStop()) {
start();
} else {
stop();
}
return true;
}
else if (MsgRefreshChannels::match(cmd))
{
qDebug() << "JogdialController::handleMessage: MsgRefreshChannels";
updateChannels();
return true;
}
else if (MsgSelectChannel::match(cmd))
{
MsgSelectChannel& cfg = (MsgSelectChannel&) cmd;
int index = cfg.getIndex();
if ((index >= 0) && (index < m_availableChannels.size()))
{
DeviceAPI *selectedDevice = m_availableChannels[cfg.getIndex()].m_deviceAPI;
ChannelAPI *selectedChannel = m_availableChannels[cfg.getIndex()].m_channelAPI;
qDebug() << "JogdialController::handleMessage: MsgSelectChannel"
<< "device:" << selectedDevice->getHardwareId()
<< "channel:" << selectedChannel->getIdentifier();
m_selectedDevice = selectedDevice;
m_selectedChannel = selectedChannel;
m_selectedIndex = index;
}
else
{
qWarning("JogdialController::handleMessage: MsgSelectChannel: index out of range: %d", index);
}
return true;
}
else
{
return false;
}
}
QByteArray JogdialController::serialize() const
{
return m_settings.serialize();
}
bool JogdialController::deserialize(const QByteArray& data)
{
if (m_settings.deserialize(data))
{
MsgConfigureJogdialController *msg = MsgConfigureJogdialController::create(m_settings, QList<QString>(), true);
m_inputMessageQueue.push(msg);
return true;
}
else
{
m_settings.resetToDefaults();
MsgConfigureJogdialController *msg = MsgConfigureJogdialController::create(m_settings, QList<QString>(), true);
m_inputMessageQueue.push(msg);
return false;
}
}
void JogdialController::applySettings(const JogdialControllerSettings& settings, const QList<QString>& settingsKeys, bool force)
{
qDebug() << "JogdialController::applySettings:" << settings.getDebugString(settingsKeys, force) << " force: " << force;
if (settings.m_useReverseAPI)
{
bool fullUpdate = (settingsKeys.contains("useReverseAPI") && settings.m_useReverseAPI) ||
settingsKeys.contains("reverseAPIAddress") ||
settingsKeys.contains("reverseAPIPort") ||
settingsKeys.contains("reverseAPIFeatureSetIndex") ||
settingsKeys.contains("m_reverseAPIFeatureIndex");
webapiReverseSendSettings(settingsKeys, settings, fullUpdate || force);
}
m_settings = settings;
}
void JogdialController::updateChannels()
{
MainCore *mainCore = MainCore::instance();
std::vector<DeviceSet*>& deviceSets = mainCore->getDeviceSets();
std::vector<DeviceSet*>::const_iterator it = deviceSets.begin();
m_availableChannels.clear();
int deviceIndex = 0;
for (; it != deviceSets.end(); ++it, deviceIndex++)
{
DSPDeviceSourceEngine *deviceSourceEngine = (*it)->m_deviceSourceEngine;
DSPDeviceSinkEngine *deviceSinkEngine = (*it)->m_deviceSinkEngine;
DeviceAPI *device = (*it)->m_deviceAPI;
device->getHardwareId();
if (deviceSourceEngine || deviceSinkEngine)
{
for (int chi = 0; chi < (*it)->getNumberOfChannels(); chi++)
{
ChannelAPI *channel = (*it)->getChannelAt(chi);
JogdialControllerSettings::AvailableChannel availableChannel =
JogdialControllerSettings::AvailableChannel{
deviceSinkEngine != nullptr,
deviceIndex,
chi,
device,
channel,
device->getHardwareId(),
channel->getIdentifier()
};
m_availableChannels.push_back(availableChannel);
}
}
}
if (getMessageQueueToGUI())
{
MsgReportChannels *msgToGUI = MsgReportChannels::create();
QList<JogdialControllerSettings::AvailableChannel>& msgAvailableChannels = msgToGUI->getAvailableChannels();
msgAvailableChannels = m_availableChannels;
getMessageQueueToGUI()->push(msgToGUI);
}
}
void JogdialController::channelUp()
{
if ((m_selectedIndex < 0) || (m_availableChannels.size() == 0)) {
return;
}
m_selectedIndex++;
if (m_selectedIndex >= m_availableChannels.size()) {
m_selectedIndex = 0;
}
m_selectedDevice = m_availableChannels.at(m_selectedIndex).m_deviceAPI;
m_selectedChannel = m_availableChannels.at(m_selectedIndex).m_channelAPI;
if (getMessageQueueToGUI())
{
MsgSelectChannel *msgToGUI = MsgSelectChannel::create(m_selectedIndex);
getMessageQueueToGUI()->push(msgToGUI);
}
}
void JogdialController::channelDown()
{
if ((m_selectedIndex < 0) || (m_availableChannels.size() == 0)) {
return;
}
m_selectedIndex--;
if (m_selectedIndex < 0) {
m_selectedIndex = m_availableChannels.size() - 1;
}
m_selectedDevice = m_availableChannels.at(m_selectedIndex).m_deviceAPI;
m_selectedChannel = m_availableChannels.at(m_selectedIndex).m_channelAPI;
if (getMessageQueueToGUI())
{
MsgSelectChannel *msgToGUI = MsgSelectChannel::create(m_selectedIndex);
getMessageQueueToGUI()->push(msgToGUI);
}
}
int JogdialController::webapiRun(bool run,
SWGSDRangel::SWGDeviceState& response,
QString& errorMessage)
{
(void) errorMessage;
getFeatureStateStr(*response.getState());
MsgStartStop *msg = MsgStartStop::create(run);
getInputMessageQueue()->push(msg);
return 202;
}
int JogdialController::webapiSettingsGet(
SWGSDRangel::SWGFeatureSettings& response,
QString& errorMessage)
{
(void) errorMessage;
response.setJogdialControllerSettings(new SWGSDRangel::SWGJogdialControllerSettings());
response.getJogdialControllerSettings()->init();
webapiFormatFeatureSettings(response, m_settings);
return 200;
}
int JogdialController::webapiSettingsPutPatch(
bool force,
const QStringList& featureSettingsKeys,
SWGSDRangel::SWGFeatureSettings& response,
QString& errorMessage)
{
(void) errorMessage;
JogdialControllerSettings settings = m_settings;
webapiUpdateFeatureSettings(settings, featureSettingsKeys, response);
MsgConfigureJogdialController *msg = MsgConfigureJogdialController::create(settings, featureSettingsKeys, force);
m_inputMessageQueue.push(msg);
qDebug("JogdialController::webapiSettingsPutPatch: forward to GUI: %p", m_guiMessageQueue);
if (m_guiMessageQueue) // forward to GUI if any
{
MsgConfigureJogdialController *msgToGUI = MsgConfigureJogdialController::create(settings, featureSettingsKeys, force);
m_guiMessageQueue->push(msgToGUI);
}
webapiFormatFeatureSettings(response, settings);
return 200;
}
void JogdialController::webapiFormatFeatureSettings(
SWGSDRangel::SWGFeatureSettings& response,
const JogdialControllerSettings& settings)
{
if (response.getJogdialControllerSettings()->getTitle()) {
*response.getJogdialControllerSettings()->getTitle() = settings.m_title;
} else {
response.getJogdialControllerSettings()->setTitle(new QString(settings.m_title));
}
response.getJogdialControllerSettings()->setRgbColor(settings.m_rgbColor);
response.getJogdialControllerSettings()->setUseReverseApi(settings.m_useReverseAPI ? 1 : 0);
if (response.getJogdialControllerSettings()->getReverseApiAddress()) {
*response.getJogdialControllerSettings()->getReverseApiAddress() = settings.m_reverseAPIAddress;
} else {
response.getJogdialControllerSettings()->setReverseApiAddress(new QString(settings.m_reverseAPIAddress));
}
response.getJogdialControllerSettings()->setReverseApiPort(settings.m_reverseAPIPort);
response.getJogdialControllerSettings()->setReverseApiFeatureSetIndex(settings.m_reverseAPIFeatureSetIndex);
response.getJogdialControllerSettings()->setReverseApiFeatureIndex(settings.m_reverseAPIFeatureIndex);
if (settings.m_rollupState)
{
if (response.getJogdialControllerSettings()->getRollupState())
{
settings.m_rollupState->formatTo(response.getJogdialControllerSettings()->getRollupState());
}
else
{
SWGSDRangel::SWGRollupState *swgRollupState = new SWGSDRangel::SWGRollupState();
settings.m_rollupState->formatTo(swgRollupState);
response.getJogdialControllerSettings()->setRollupState(swgRollupState);
}
}
}
void JogdialController::webapiUpdateFeatureSettings(
JogdialControllerSettings& settings,
const QStringList& featureSettingsKeys,
SWGSDRangel::SWGFeatureSettings& response)
{
if (featureSettingsKeys.contains("title")) {
settings.m_title = *response.getJogdialControllerSettings()->getTitle();
}
if (featureSettingsKeys.contains("rgbColor")) {
settings.m_rgbColor = response.getJogdialControllerSettings()->getRgbColor();
}
if (featureSettingsKeys.contains("useReverseAPI")) {
settings.m_useReverseAPI = response.getJogdialControllerSettings()->getUseReverseApi() != 0;
}
if (featureSettingsKeys.contains("reverseAPIAddress")) {
settings.m_reverseAPIAddress = *response.getJogdialControllerSettings()->getReverseApiAddress();
}
if (featureSettingsKeys.contains("reverseAPIPort")) {
settings.m_reverseAPIPort = response.getJogdialControllerSettings()->getReverseApiPort();
}
if (featureSettingsKeys.contains("reverseAPIFeatureSetIndex")) {
settings.m_reverseAPIFeatureSetIndex = response.getJogdialControllerSettings()->getReverseApiFeatureSetIndex();
}
if (featureSettingsKeys.contains("reverseAPIFeatureIndex")) {
settings.m_reverseAPIFeatureIndex = response.getJogdialControllerSettings()->getReverseApiFeatureIndex();
}
if (settings.m_rollupState && featureSettingsKeys.contains("rollupState")) {
settings.m_rollupState->updateFrom(featureSettingsKeys, response.getJogdialControllerSettings()->getRollupState());
}
}
void JogdialController::webapiReverseSendSettings(const QList<QString>& featureSettingsKeys, const JogdialControllerSettings& settings, bool force)
{
SWGSDRangel::SWGFeatureSettings *swgFeatureSettings = new SWGSDRangel::SWGFeatureSettings();
// swgFeatureSettings->setOriginatorFeatureIndex(getIndexInDeviceSet());
// swgFeatureSettings->setOriginatorFeatureSetIndex(getDeviceSetIndex());
swgFeatureSettings->setFeatureType(new QString("JogdialAnalyzer"));
swgFeatureSettings->setJogdialControllerSettings(new SWGSDRangel::SWGJogdialControllerSettings());
SWGSDRangel::SWGJogdialControllerSettings *swgJogdialControllerSettings = swgFeatureSettings->getJogdialControllerSettings();
// transfer data that has been modified. When force is on transfer all data except reverse API data
if (featureSettingsKeys.contains("title") || force) {
swgJogdialControllerSettings->setTitle(new QString(settings.m_title));
}
if (featureSettingsKeys.contains("rgbColor") || force) {
swgJogdialControllerSettings->setRgbColor(settings.m_rgbColor);
}
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 JogdialController::networkManagerFinished(QNetworkReply *reply)
{
QNetworkReply::NetworkError replyError = reply->error();
if (replyError)
{
qWarning() << "JogdialController::networkManagerFinished:"
<< " error(" << (int) replyError
<< "): " << replyError
<< ": " << reply->errorString();
}
else
{
QString answer = reply->readAll();
answer.chop(1); // remove last \n
qDebug("JogdialController::networkManagerFinished: reply:\n%s", answer.toStdString().c_str());
}
reply->deleteLater();
}
void JogdialController::handleChannelMessageQueue(MessageQueue* messageQueue)
{
Message* message;
while ((message = messageQueue->pop()) != nullptr)
{
if (handleMessage(*message)) {
delete message;
}
}
}
void JogdialController::commandKeyPressed(Qt::Key key, Qt::KeyboardModifiers keyModifiers, bool release)
{
(void) release;
if (key == Qt::Key_C)
{
m_deviceElseChannelControl = false;
if (m_guiMessageQueue) {
m_guiMessageQueue->push(MsgReportControl::create(false));
}
}
else if (key == Qt::Key_D)
{
m_deviceElseChannelControl = true;
if (m_guiMessageQueue) {
m_guiMessageQueue->push(MsgReportControl::create(true));
}
}
else if (key == Qt::Key_Left)
{
channelDown();
}
else if (key == Qt::Key_Right)
{
channelUp();
}
else if (key == Qt::Key_Up)
{
m_repeatTimer.stop();
if (keyModifiers == Qt::NoModifier) {
stepFrequency(1);
} else if (keyModifiers == Qt::ControlModifier) {
stepFrequency(10);
} else if (keyModifiers == Qt::ShiftModifier) {
stepFrequency(100);
} else if (keyModifiers == (Qt::ControlModifier | Qt::ShiftModifier)) {
stepFrequency(1000);
}
}
else if (key == Qt::Key_Down)
{
m_repeatTimer.stop();
if (keyModifiers == Qt::NoModifier) {
stepFrequency(-1);
} else if (keyModifiers == Qt::ControlModifier) {
stepFrequency(-10);
} else if (keyModifiers == Qt::ShiftModifier) {
stepFrequency(-100);
} else if (keyModifiers == (Qt::ControlModifier | Qt::ShiftModifier)) {
stepFrequency(-1000);
}
}
else if (key == Qt::Key_Home)
{
resetChannelFrequency();
}
else if (key == Qt::Key_0)
{
m_repeatTimer.stop();
}
else if (key == Qt::Key_1)
{
m_multiplier = 1;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_2)
{
m_multiplier = 10;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_3)
{
m_multiplier = 100;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_4)
{
m_multiplier = 1000;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_5)
{
m_multiplier = 10000;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_6)
{
m_multiplier = 100000;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_7)
{
m_multiplier = 1000000;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_Exclam)
{
m_multiplier = -1;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_At)
{
m_multiplier = -10;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_NumberSign)
{
m_multiplier = -100;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_Dollar)
{
m_multiplier = -1000;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_Percent)
{
m_multiplier = -10000;
m_repeatTimer.start(m_repeatms);
}
else if ((key == Qt::Key_Dead_Circumflex) || (key == Qt::Key_AsciiCircum))
{
m_multiplier = -100000;
m_repeatTimer.start(m_repeatms);
}
else if (key == Qt::Key_Ampersand)
{
m_multiplier = -1000000;
m_repeatTimer.start(m_repeatms);
}
}
void JogdialController::resetChannelFrequency()
{
if (m_selectedChannel) {
m_selectedChannel->setCenterFrequency(0);
}
}
void JogdialController::stepFrequency(int step)
{
qDebug("JogdialController::stepFrequency: step: %d", step);
if (m_deviceElseChannelControl)
{
if (m_selectedDevice)
{
DSPDeviceSourceEngine *sourceEngine = m_selectedDevice->getDeviceSourceEngine();
DSPDeviceSinkEngine *sinkEngine = m_selectedDevice->getDeviceSinkEngine();
if (sourceEngine)
{
quint64 frequency = sourceEngine->getSource()->getCenterFrequency();
qDebug("JogdialController::stepFrequency: frequency: %llu", frequency);
sourceEngine->getSource()->setCenterFrequency(frequency + step*1000LL);
}
if (sinkEngine)
{
quint64 frequency = sinkEngine->getSink()->getCenterFrequency();
sinkEngine->getSink()->setCenterFrequency(frequency + step*1000LL);
}
}
}
else
{
if (m_selectedChannel)
{
qint64 frequency = m_selectedChannel->getCenterFrequency();
m_selectedChannel->setCenterFrequency(frequency + step);
}
}
}
void JogdialController::handleRepeat()
{
stepFrequency(m_multiplier);
}