sdrangel/plugins/channelrx/chanalyzerng/chanalyzernggui.cpp

///////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2017 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                  //
//                                                                               //
// 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 "chanalyzernggui.h"

#include <device/devicesourceapi.h>
#include "device/deviceuiset.h"
#include <dsp/downchannelizer.h>
#include <QDockWidget>
#include <QMainWindow>

#include "dsp/threadedbasebandsamplesink.h"
#include "ui_chanalyzernggui.h"
#include "dsp/spectrumscopengcombovis.h"
#include "dsp/spectrumvis.h"
#include "dsp/scopevis.h"
#include "gui/glspectrum.h"
#include "gui/glscopeng.h"
#include "plugin/pluginapi.h"
#include "util/simpleserializer.h"
#include "util/db.h"
#include "dsp/dspengine.h"
#include "mainwindow.h"

#include "chanalyzerng.h"

ChannelAnalyzerNGGUI* ChannelAnalyzerNGGUI::create(PluginAPI* pluginAPI, DeviceUISet *deviceUISet, BasebandSampleSink *rxChannel)
{
    ChannelAnalyzerNGGUI* gui = new ChannelAnalyzerNGGUI(pluginAPI, deviceUISet, rxChannel);
	return gui;
}

void ChannelAnalyzerNGGUI::destroy()
{
	delete this;
}

void ChannelAnalyzerNGGUI::setName(const QString& name)
{
	setObjectName(name);
}

QString ChannelAnalyzerNGGUI::getName() const
{
	return objectName();
}

qint64 ChannelAnalyzerNGGUI::getCenterFrequency() const
{
	return m_channelMarker.getCenterFrequency();
}

void ChannelAnalyzerNGGUI::setCenterFrequency(qint64 centerFrequency)
{
	m_channelMarker.setCenterFrequency(centerFrequency);
	applySettings();
}

void ChannelAnalyzerNGGUI::resetToDefaults()
{
	blockApplySettings(true);

	ui->useRationalDownsampler->setChecked(false);
	ui->BW->setValue(30);
	ui->deltaFrequency->setValue(0);
	ui->spanLog2->setCurrentIndex(3);

	blockApplySettings(false);
	applySettings();
}

QByteArray ChannelAnalyzerNGGUI::serialize() const
{
	SimpleSerializer s(1);
	s.writeS32(1, m_channelMarker.getCenterFrequency());
	s.writeS32(2, ui->BW->value());
	s.writeBlob(3, ui->spectrumGUI->serialize());
	s.writeU32(4, m_channelMarker.getColor().rgb());
	s.writeS32(5, ui->lowCut->value());
	s.writeS32(6, ui->spanLog2->currentIndex());
	s.writeBool(7, ui->ssb->isChecked());
	s.writeBlob(8, ui->scopeGUI->serialize());
	s.writeU64(9, ui->channelSampleRate->getValueNew());
	return s.final();
}

bool ChannelAnalyzerNGGUI::deserialize(const QByteArray& data)
{
	SimpleDeserializer d(data);

	if(!d.isValid())
    {
		resetToDefaults();
		return false;
	}

	if(d.getVersion() == 1)
    {
		QByteArray bytetmp;
		quint32 u32tmp;
		quint64 u64tmp;
		qint32 tmp, spanLog2, bw, lowCut;
		bool tmpBool;

		blockApplySettings(true);
	    m_channelMarker.blockSignals(true);

		d.readS32(1, &tmp, 0);
		m_channelMarker.setCenterFrequency(tmp);
		ui->deltaFrequency->setValue(m_channelMarker.getCenterFrequency());
		d.readS32(2, &bw, 30);
		d.readBlob(3, &bytetmp);
		ui->spectrumGUI->deserialize(bytetmp);

		if(d.readU32(4, &u32tmp))
		{
			m_channelMarker.setColor(u32tmp);
		}

		d.readS32(5, &lowCut, 3);
		d.readS32(6, &spanLog2, 3);
		d.readBool(7, &tmpBool, false);
		ui->ssb->setChecked(tmpBool);
		d.readBlob(8, &bytetmp);
		ui->scopeGUI->deserialize(bytetmp);
		d.readU64(9, &u64tmp, 2000U);
		ui->channelSampleRate->setValue(u64tmp);

		blockApplySettings(false);
	    m_channelMarker.blockSignals(false);
	    m_channelMarker.emitChangedByAPI();

        ui->spanLog2->setCurrentIndex(spanLog2);
        setNewFinalRate(spanLog2);
		ui->BW->setValue(bw);
		ui->lowCut->setValue(lowCut); // does applySettings();

		return true;
	}
    else
    {
		resetToDefaults();
		return false;
	}
}

bool ChannelAnalyzerNGGUI::handleMessage(const Message& message)
{
    if (ChannelAnalyzerNG::MsgReportChannelSampleRateChanged::match(message))
    {
        int newRate = getRequestedChannelSampleRate() / (1<<m_spanLog2);

        uint64_t newBW = (ui->BW->value() * 100L * m_rate) / newRate;
        uint64_t newLC = (ui->lowCut->value() * 100L * m_rate) / newRate;

        qDebug() << "ChannelAnalyzerNGGUI::handleMessage: MsgReportChannelSampleRateChanged:"
                << " newRate: " << newRate
                << " newBW: " << newBW
                << " newLC: " << newLC;

        m_rate = newRate;

        ui->BW->setValue(newBW/100);
        ui->lowCut->setValue(newLC/100);

        blockApplySettings(true);
        setFiltersUIBoundaries();
        blockApplySettings(false);

        if (ui->ssb->isChecked())
        {
            QString s = QString::number(ui->BW->value()/10.0, 'f', 1);
            ui->BWText->setText(tr("%1k").arg(s));
        }
        else
        {
            QString s = QString::number(ui->BW->value()/5.0, 'f', 1); // BW = value * 2
            ui->BWText->setText(tr("%1k").arg(s));
        }

        QString s = QString::number(ui->lowCut->value()/10.0, 'f', 1);
        ui->lowCutText->setText(tr("%1k").arg(s));

        s = QString::number(m_rate/1000.0, 'f', 1);
        ui->spanText->setText(tr("%1 kS/s").arg(s));

        ui->glScope->setSampleRate(m_rate);

        displayBandwidth(); // sets ui->glSpectrum sample rate

        return true;
    }

    return false;
}

void ChannelAnalyzerNGGUI::handleInputMessages()
{
    Message* message;

    while ((message = getInputMessageQueue()->pop()) != 0)
    {
        qDebug("ChannelAnalyzerGUI::handleInputMessages: message: %s", message->getIdentifier());

        if (handleMessage(*message))
        {
            delete message;
        }
    }
}

void ChannelAnalyzerNGGUI::channelMarkerChangedByCursor()
{
    ui->deltaFrequency->setValue(m_channelMarker.getCenterFrequency());
	applySettings();
}

void ChannelAnalyzerNGGUI::channelMarkerHighlightedByCursor()
{
    setHighlighted(m_channelMarker.getHighlighted());
}

void ChannelAnalyzerNGGUI::tick()
{
	double powDb = CalcDb::dbPower(m_channelAnalyzer->getMagSq());
	m_channelPowerDbAvg(powDb);
	ui->channelPower->setText(tr("%1 dB").arg((Real) m_channelPowerDbAvg, 0, 'f', 1));

	if (m_channelAnalyzer->isPllLocked()) {
	    ui->pll->setStyleSheet("QToolButton { background-color : green; }");
	} else {
	    ui->pll->setStyleSheet("QToolButton { background:rgb(79,79,79); }");
	}

	if (ui->pll->isChecked())
	{
	    int fHz = round(m_channelAnalyzer->getPllFrequency()*m_rate);
	    ui->pll->setToolTip(tr("PLL lock (f:%1 Hz e:%2 rad p:%3 rad)")
	            .arg(fHz)
	            .arg(m_channelAnalyzer->getPllDeltaPhase())
	            .arg(m_channelAnalyzer->getPllPhase()));
	}
}

void ChannelAnalyzerNGGUI::on_channelSampleRate_changed(quint64 value)
{
    ui->channelSampleRate->setValueRange(7, 2000U, m_channelAnalyzer->getInputSampleRate());

    if (ui->useRationalDownsampler->isChecked())
    {
        qDebug("ChannelAnalyzerNGGUI::on_channelSampleRate_changed: %llu", value);
        setNewFinalRate(m_spanLog2);
        applySettings();
    }
}

void ChannelAnalyzerNGGUI::on_pll_toggled(bool checked)
{
    if (!checked && m_usePll) {
        ui->pll->setToolTip("PLL lock");
    }

    m_usePll = checked;
    applySettings();
}

void ChannelAnalyzerNGGUI::on_pllPskOrder_currentIndexChanged(int index __attribute__((unused)))
{
	applySettings();
}

void ChannelAnalyzerNGGUI::on_useRationalDownsampler_toggled(bool checked __attribute__((unused)))
{
    setNewFinalRate(m_spanLog2);
    applySettings();
}

int ChannelAnalyzerNGGUI::getRequestedChannelSampleRate()
{
    if (ui->useRationalDownsampler->isChecked()) {
        return ui->channelSampleRate->getValueNew();
    } else {
        return m_channelAnalyzer->getChannelizer()->getInputSampleRate();
    }
}

void ChannelAnalyzerNGGUI::on_deltaFrequency_changed(qint64 value)
{
    m_channelMarker.setCenterFrequency(value);
    applySettings();
}

void ChannelAnalyzerNGGUI::on_BW_valueChanged(int value)
{
//	m_channelMarker.setBandwidth(value * 100 * 2);

	if (ui->ssb->isChecked())
	{
		QString s = QString::number(value/10.0, 'f', 1);
	    ui->BWText->setText(tr("%1k").arg(s));
	}
	else
	{
	    QString s = QString::number(value/5.0, 'f', 1); // BW = value * 2
	    ui->BWText->setText(tr("%1k").arg(s));
	}

	displayBandwidth();
	on_lowCut_valueChanged(m_channelMarker.getLowCutoff()/100); // does apply settings
}

int ChannelAnalyzerNGGUI::getEffectiveLowCutoff(int lowCutoff)
{
	int ssbBW = m_channelMarker.getBandwidth() / 2;
	int effectiveLowCutoff = lowCutoff;
	const int guard = 100;

	if (ssbBW < 0) {
		if (effectiveLowCutoff < ssbBW + guard) {
			effectiveLowCutoff = ssbBW + guard;
		}
		if (effectiveLowCutoff > 0)	{
			effectiveLowCutoff = 0;
		}
	} else {
		if (effectiveLowCutoff > ssbBW - guard)	{
			effectiveLowCutoff = ssbBW - guard;
		}
		if (effectiveLowCutoff < 0)	{
			effectiveLowCutoff = 0;
		}
	}

	return effectiveLowCutoff;
}

void ChannelAnalyzerNGGUI::on_lowCut_valueChanged(int value)
{
    blockApplySettings(true);
	int lowCutoff = getEffectiveLowCutoff(value * 100);
	m_channelMarker.setLowCutoff(lowCutoff);
	QString s = QString::number(lowCutoff/1000.0, 'f', 1);
	ui->lowCutText->setText(tr("%1k").arg(s));
	ui->lowCut->setValue(lowCutoff/100);
	blockApplySettings(false);
	applySettings();
}

void ChannelAnalyzerNGGUI::on_spanLog2_currentIndexChanged(int index)
{
	if (setNewFinalRate(index)) {
		applySettings();
	}

}

void ChannelAnalyzerNGGUI::on_ssb_toggled(bool checked)
{
    //int bw = m_channelMarker.getBandwidth();

	if (checked)
	{
	    setFiltersUIBoundaries();

	    ui->BWLabel->setText("LP");
        QString s = QString::number(ui->BW->value()/10.0, 'f', 1); // bw/2
        ui->BWText->setText(tr("%1k").arg(s));

		on_lowCut_valueChanged(m_channelMarker.getLowCutoff()/100);
	}
	else
	{
        if (ui->BW->value() < 0) {
            ui->BW->setValue(-ui->BW->value());
        }

        setFiltersUIBoundaries();
        //m_channelMarker.setBandwidth(ui->BW->value() * 200.0);

        ui->BWLabel->setText("BP");
        QString s = QString::number(ui->BW->value()/5.0, 'f', 1); // bw
        ui->BWText->setText(tr("%1k").arg(s));

        ui->lowCut->setEnabled(false);
        ui->lowCut->setValue(0);
        ui->lowCutText->setText("0.0k");
	}

    applySettings();
    displayBandwidth();
}

void ChannelAnalyzerNGGUI::onWidgetRolled(QWidget* widget __attribute__((unused)), bool rollDown __attribute__((unused)))
{
	/*
	if((widget == ui->spectrumContainer) && (m_ssbDemod != NULL))
		m_ssbDemod->setSpectrum(m_threadedSampleSink->getMessageQueue(), rollDown);
	*/
}

ChannelAnalyzerNGGUI::ChannelAnalyzerNGGUI(PluginAPI* pluginAPI, DeviceUISet *deviceUISet, BasebandSampleSink *rxChannel, QWidget* parent) :
	RollupWidget(parent),
	ui(new Ui::ChannelAnalyzerNGGUI),
	m_pluginAPI(pluginAPI),
	m_deviceUISet(deviceUISet),
	m_channelMarker(this),
	m_doApplySettings(true),
	m_rate(6000),
	m_spanLog2(0),
	m_usePll(false)
{
	ui->setupUi(this);
	setAttribute(Qt::WA_DeleteOnClose, true);
	connect(this, SIGNAL(widgetRolled(QWidget*,bool)), this, SLOT(onWidgetRolled(QWidget*,bool)));

	m_spectrumVis = new SpectrumVis(SDR_RX_SCALEF, ui->glSpectrum);
	m_scopeVis = new ScopeVisNG(ui->glScope);
	m_spectrumScopeComboVis = new SpectrumScopeNGComboVis(m_spectrumVis, m_scopeVis);
	m_channelAnalyzer = (ChannelAnalyzerNG*) rxChannel; //new ChannelAnalyzerNG(m_deviceUISet->m_deviceSourceAPI);
	m_channelAnalyzer->setSampleSink(m_spectrumScopeComboVis);
	m_channelAnalyzer->setMessageQueueToGUI(getInputMessageQueue());

    ui->deltaFrequencyLabel->setText(QString("%1f").arg(QChar(0x94, 0x03)));
    ui->deltaFrequency->setColorMapper(ColorMapper(ColorMapper::GrayGold));
    ui->deltaFrequency->setValueRange(false, 7, -9999999, 9999999);

	ui->channelSampleRate->setColorMapper(ColorMapper(ColorMapper::GrayGreenYellow));
	ui->channelSampleRate->setValueRange(7, 2000U, 9999999U);

	ui->glSpectrum->setCenterFrequency(m_rate/2);
	ui->glSpectrum->setSampleRate(m_rate);
	ui->glSpectrum->setDisplayWaterfall(true);
	ui->glSpectrum->setDisplayMaxHold(true);
	ui->glSpectrum->setSsbSpectrum(false);
    ui->glSpectrum->setLsbDisplay(false);
	ui->BWLabel->setText("BP");

	ui->glSpectrum->connectTimer(MainWindow::getInstance()->getMasterTimer());
	ui->glScope->connectTimer(MainWindow::getInstance()->getMasterTimer());
	connect(&MainWindow::getInstance()->getMasterTimer(), SIGNAL(timeout()), this, SLOT(tick()));

	m_channelMarker.blockSignals(true);
	m_channelMarker.setColor(Qt::gray);
	m_channelMarker.setBandwidth(m_rate);
	m_channelMarker.setSidebands(ChannelMarker::usb);
	m_channelMarker.setCenterFrequency(0);
    m_channelMarker.blockSignals(false);
	m_channelMarker.setVisible(true); // activate signal on the last setting only
	setTitleColor(m_channelMarker.getColor());

    m_deviceUISet->registerRxChannelInstance(ChannelAnalyzerNG::m_channelIdURI, this);
	m_deviceUISet->addChannelMarker(&m_channelMarker);
	m_deviceUISet->addRollupWidget(this);

	ui->spectrumGUI->setBuddies(m_spectrumVis->getInputMessageQueue(), m_spectrumVis, ui->glSpectrum);
	ui->scopeGUI->setBuddies(m_scopeVis->getInputMessageQueue(), m_scopeVis, ui->glScope);

	connect(&m_channelMarker, SIGNAL(changedByCursor()), this, SLOT(channelMarkerChangedByCursor()));
    connect(&m_channelMarker, SIGNAL(highlightedByCursor()), this, SLOT(channelMarkerHighlightedByCursor()));
	connect(getInputMessageQueue(), SIGNAL(messageEnqueued()), this, SLOT(handleInputMessages()));

	applySettings();
	setNewFinalRate(m_spanLog2);
}

ChannelAnalyzerNGGUI::~ChannelAnalyzerNGGUI()
{
    m_deviceUISet->removeRxChannelInstance(this);
	delete m_channelAnalyzer; // TODO: check this: when the GUI closes it has to delete the demodulator
	delete m_spectrumVis;
	delete m_scopeVis;
	delete m_spectrumScopeComboVis;
	delete ui;
}

bool ChannelAnalyzerNGGUI::setNewFinalRate(int spanLog2)
{
	qDebug("ChannelAnalyzerNGGUI::setNewRate");

	if ((spanLog2 < 0) || (spanLog2 > 6)) {
		return false;
	}

	m_spanLog2 = spanLog2;
    m_rate = getRequestedChannelSampleRate() / (1<<spanLog2);

    if (m_rate == 0) {
        m_rate = 6000;
    }

	setFiltersUIBoundaries();

	QString s = QString::number(m_rate/1000.0, 'f', 1);
	ui->spanText->setText(tr("%1 kS/s").arg(s));

	displayBandwidth();

	ui->glScope->setSampleRate(m_rate);
	ui->glSpectrum->setSampleRate(m_rate);
	m_scopeVis->setSampleRate(m_rate);

	return true;
}

void ChannelAnalyzerNGGUI::displayBandwidth()
{
    blockApplySettings(true);

    m_channelMarker.setBandwidth(ui->BW->value() * 100 * 2);

    if (ui->ssb->isChecked())
    {
        if (ui->BW->value() < 0)
        {
            m_channelMarker.setSidebands(ChannelMarker::lsb);
            ui->glSpectrum->setLsbDisplay(true);
        }
        else
        {
            m_channelMarker.setSidebands(ChannelMarker::usb);
            ui->glSpectrum->setLsbDisplay(false);
        }

        m_channelMarker.setLowCutoff(ui->lowCut->value()*100);
        ui->glSpectrum->setSampleRate(m_rate/2);
        ui->glSpectrum->setCenterFrequency(m_rate/4);
        ui->glSpectrum->setSsbSpectrum(true);
    }
    else
    {
        m_channelMarker.setSidebands(ChannelMarker::dsb);

        ui->glSpectrum->setCenterFrequency(0);
        ui->glSpectrum->setSampleRate(m_rate);
        ui->glSpectrum->setLsbDisplay(false);
        ui->glSpectrum->setSsbSpectrum(false);
    }

    blockApplySettings(false);
}

void ChannelAnalyzerNGGUI::setFiltersUIBoundaries()
{
    if (ui->BW->value() < -m_rate/200) {
        ui->BW->setValue(-m_rate/200);
        m_channelMarker.setBandwidth(-m_rate*2);
    } else if (ui->BW->value() > m_rate/200) {
        ui->BW->setValue(m_rate/200);
        m_channelMarker.setBandwidth(m_rate*2);
    }

    if (ui->lowCut->value() < -m_rate/200) {
        ui->lowCut->setValue(-m_rate/200);
        m_channelMarker.setLowCutoff(-m_rate);
    } else if (ui->lowCut->value() > m_rate/200) {
        ui->lowCut->setValue(m_rate/200);
        m_channelMarker.setLowCutoff(m_rate);
    }

    if (ui->ssb->isChecked()) {
        ui->BW->setMinimum(-m_rate/200);
        ui->lowCut->setMinimum(-m_rate/200);
    } else {
        ui->BW->setMinimum(0);
        ui->lowCut->setMinimum(-m_rate/200);
        ui->lowCut->setValue(0);
    }

    ui->BW->setMaximum(m_rate/200);
    ui->lowCut->setMaximum(m_rate/200);
}

void ChannelAnalyzerNGGUI::blockApplySettings(bool block)
{
    ui->glScope->blockSignals(block);
    ui->glSpectrum->blockSignals(block);
    m_doApplySettings = !block;
}

void ChannelAnalyzerNGGUI::applySettings()
{
	if (m_doApplySettings)
	{
        int sampleRate = getRequestedChannelSampleRate();

        ChannelAnalyzerNG::MsgConfigureChannelizer *msgChannelizer = ChannelAnalyzerNG::MsgConfigureChannelizer::create(sampleRate, m_channelMarker.getCenterFrequency());
        m_channelAnalyzer->getInputMessageQueue()->push(msgChannelizer);

        ChannelAnalyzerNG::MsgConfigureChannelizer *msg =
                ChannelAnalyzerNG::MsgConfigureChannelizer::create(
                        sampleRate,
                        m_channelMarker.getCenterFrequency());
        m_channelAnalyzer->getInputMessageQueue()->push(msg);

		m_channelAnalyzer->configure(m_channelAnalyzer->getInputMessageQueue(),
		    sampleRate,
			ui->BW->value() * 100.0,
			ui->lowCut->value() * 100.0,
			m_spanLog2,
			ui->ssb->isChecked(),
			ui->pll->isChecked(),
			1<<ui->pllPskOrder->currentIndex());
	}
}

void ChannelAnalyzerNGGUI::leaveEvent(QEvent*)
{
	m_channelMarker.setHighlighted(false);
}

void ChannelAnalyzerNGGUI::enterEvent(QEvent*)
{
	m_channelMarker.setHighlighted(true);
}