sdrangel/plugins/channelrx/tcpsrc/tcpsrc.cpp

// Copyright (C) 2012 maintech GmbH, Otto-Hahn-Str. 15, 97204 Hoechberg, Germany //
// (C) 2015 John Greb                                                            //
//                                                                               //
// 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 "tcpsrc.h"

#include <QTcpServer>
#include <QTcpSocket>

#include "dsp/downchannelizer.h"
#include "dsp/threadedbasebandsamplesink.h"
#include "dsp/dspcommands.h"
#include "device/devicesourceapi.h"

#include "tcpsrcgui.h"

MESSAGE_CLASS_DEFINITION(TCPSrc::MsgConfigureTCPSrc, Message)
MESSAGE_CLASS_DEFINITION(TCPSrc::MsgConfigureChannelizer, Message)
MESSAGE_CLASS_DEFINITION(TCPSrc::MsgTCPSrcConnection, Message)
MESSAGE_CLASS_DEFINITION(TCPSrc::MsgTCPSrcSpectrum, Message)

const QString TCPSrc::m_channelIdURI = "sdrangel.channel.tcpsrc";
const QString TCPSrc::m_channelId = "TCPSrc";

TCPSrc::TCPSrc(DeviceSourceAPI* deviceAPI) :
        ChannelSinkAPI(m_channelIdURI),
        m_deviceAPI(deviceAPI),
        m_absoluteFrequencyOffset(0),
        m_settingsMutex(QMutex::Recursive)
{
	setObjectName(m_channelId);

	m_inputSampleRate = 96000;
	m_sampleFormat = TCPSrcSettings::FormatSSB;
	m_outputSampleRate = 48000;
	m_rfBandwidth = 32000;
	m_tcpServer = 0;
	m_tcpPort = 9999;
	m_nco.setFreq(0, m_inputSampleRate);
	m_interpolator.create(16, m_inputSampleRate, m_rfBandwidth / 2.0);
	m_sampleDistanceRemain = m_inputSampleRate / m_outputSampleRate;
	m_spectrum = 0;
	m_spectrumEnabled = false;
	m_nextSSBId = 0;
	m_nextS16leId = 0;

	m_last = 0;
	m_this = 0;
	m_scale = 0;
	m_volume = 0;
	m_magsq = 0;

	m_sampleBufferSSB.resize(tcpFftLen);
	TCPFilter = new fftfilt(0.3 / 48.0, 16.0 / 48.0, tcpFftLen);

    m_channelizer = new DownChannelizer(this);
    m_threadedChannelizer = new ThreadedBasebandSampleSink(m_channelizer, this);
    m_deviceAPI->addThreadedSink(m_threadedChannelizer);
    m_deviceAPI->addChannelAPI(this);
}

TCPSrc::~TCPSrc()
{
	if (TCPFilter) delete TCPFilter;

	m_deviceAPI->removeChannelAPI(this);
    m_deviceAPI->removeThreadedSink(m_threadedChannelizer);
    delete m_threadedChannelizer;
    delete m_channelizer;
}

void TCPSrc::setSpectrum(MessageQueue* messageQueue, bool enabled)
{
	Message* cmd = MsgTCPSrcSpectrum::create(enabled);
	messageQueue->push(cmd);
}

void TCPSrc::feed(const SampleVector::const_iterator& begin, const SampleVector::const_iterator& end, bool positiveOnly)
{
	Complex ci;
	fftfilt::cmplx* sideband;
	Real l, r;

	m_sampleBuffer.clear();

	m_settingsMutex.lock();

	// Rtl-Sdr uses full 16-bit scale; FCDPP does not
	int rescale = (1 << m_volume);

	for(SampleVector::const_iterator it = begin; it < end; ++it) {
		Complex c(it->real(), it->imag());
		c *= m_nco.nextIQ();

		if(m_interpolator.decimate(&m_sampleDistanceRemain, c, &ci))
		{
			m_magsq = ((ci.real()*ci.real() +  ci.imag()*ci.imag())*rescale*rescale) / (SDR_RX_SCALED*SDR_RX_SCALED);
			m_sampleBuffer.push_back(Sample(ci.real() * rescale, ci.imag() * rescale));
			m_sampleDistanceRemain += m_inputSampleRate / m_outputSampleRate;
		}
	}

	if((m_spectrum != 0) && (m_spectrumEnabled))
	{
		m_spectrum->feed(m_sampleBuffer.begin(), m_sampleBuffer.end(), positiveOnly);
	}

	for(int i = 0; i < m_s16leSockets.count(); i++)
	{
		m_s16leSockets[i].socket->write((const char*)&m_sampleBuffer[0], m_sampleBuffer.size() * 4);
	}

	if((m_sampleFormat == TCPSrcSettings::FormatSSB) && (m_ssbSockets.count() > 0)) {
		for(SampleVector::const_iterator it = m_sampleBuffer.begin(); it != m_sampleBuffer.end(); ++it) {
			//Complex cj(it->real() / 30000.0, it->imag() / 30000.0);
			Complex cj(it->real(), it->imag());
			int n_out = TCPFilter->runSSB(cj, &sideband, true);
			if (n_out) {
				for (int i = 0; i < n_out; i+=2) {
					//l = (sideband[i].real() + sideband[i].imag()) * 0.7 * 32000.0;
					//r = (sideband[i+1].real() + sideband[i+1].imag()) * 0.7 * 32000.0;
					l = (sideband[i].real() + sideband[i].imag()) * 0.7;
					r = (sideband[i+1].real() + sideband[i+1].imag()) * 0.7;
					m_sampleBufferSSB.push_back(Sample(l, r));
				}
				for(int i = 0; i < m_ssbSockets.count(); i++)
					m_ssbSockets[i].socket->write((const char*)&m_sampleBufferSSB[0], n_out * 2);
				m_sampleBufferSSB.clear();
			}
		}
	}

	if((m_sampleFormat == TCPSrcSettings::FormatNFM) && (m_ssbSockets.count() > 0)) {
		for(SampleVector::const_iterator it = m_sampleBuffer.begin(); it != m_sampleBuffer.end(); ++it) {
			Complex cj(it->real() / SDR_RX_SCALEF, it->imag() / SDR_RX_SCALEF);
			// An FFT filter here is overkill, but was already set up for SSB
			int n_out = TCPFilter->runFilt(cj, &sideband);
			if (n_out) {
				Real sum = 1.0;
				for (int i = 0; i < n_out; i+=2) {
					l = m_this.real() * (m_last.imag() - sideband[i].imag())
					  - m_this.imag() * (m_last.real() - sideband[i].real());
					m_last = sideband[i];
					r = m_last.real() * (m_this.imag() - sideband[i+1].imag())
					  - m_last.imag() * (m_this.real() - sideband[i+1].real());
					m_this = sideband[i+1];
					m_sampleBufferSSB.push_back(Sample(l * m_scale, r * m_scale));
					sum += m_this.real() * m_this.real() + m_this.imag() * m_this.imag();
				}
				// TODO: correct levels
				m_scale = 24000 * tcpFftLen / sum;
				for(int i = 0; i < m_ssbSockets.count(); i++)
					m_ssbSockets[i].socket->write((const char*)&m_sampleBufferSSB[0], n_out * 2);
				m_sampleBufferSSB.clear();
			}
		}
	}

	m_settingsMutex.unlock();
}

void TCPSrc::start()
{
	m_tcpServer = new QTcpServer();
	connect(m_tcpServer, SIGNAL(newConnection()), this, SLOT(onNewConnection()));
	connect(m_tcpServer, SIGNAL(acceptError(QAbstractSocket::SocketError)), this, SLOT(onTcpServerError(QAbstractSocket::SocketError)));
	m_tcpServer->listen(QHostAddress::Any, m_tcpPort);
}

void TCPSrc::stop()
{
	closeAllSockets(&m_ssbSockets);
	closeAllSockets(&m_s16leSockets);

	if(m_tcpServer->isListening())
		m_tcpServer->close();
	delete m_tcpServer;
}

bool TCPSrc::handleMessage(const Message& cmd)
{
	if (DownChannelizer::MsgChannelizerNotification::match(cmd))
	{
		DownChannelizer::MsgChannelizerNotification& notif = (DownChannelizer::MsgChannelizerNotification&) cmd;

		m_settingsMutex.lock();

		m_inputSampleRate = notif.getSampleRate();
		m_nco.setFreq(-notif.getFrequencyOffset(), m_inputSampleRate);
		m_interpolator.create(16, m_inputSampleRate, m_rfBandwidth / 2.0);
		m_sampleDistanceRemain = m_inputSampleRate / m_outputSampleRate;

		m_settingsMutex.unlock();

		qDebug() << "TCPSrc::handleMessage: MsgChannelizerNotification: m_inputSampleRate: " << m_inputSampleRate
				<< " frequencyOffset: " << notif.getFrequencyOffset();

		return true;
	}
    else if (MsgConfigureChannelizer::match(cmd))
    {
        MsgConfigureChannelizer& cfg = (MsgConfigureChannelizer&) cmd;

        m_channelizer->configure(m_channelizer->getInputMessageQueue(),
            cfg.getSampleRate(),
            cfg.getCenterFrequency());

        qDebug() << "TCPSrc::handleMessage: MsgConfigureChannelizer:"
                << " sampleRate: " << cfg.getSampleRate()
                << " centerFrequency: " << cfg.getCenterFrequency();

        return true;
    }
    else if (MsgConfigureTCPSrc::match(cmd))
    {
        MsgConfigureTCPSrc& cfg = (MsgConfigureTCPSrc&) cmd;

        TCPSrcSettings settings = cfg.getSettings();

        // These settings are set with DownChannelizer::MsgChannelizerNotification
        m_absoluteFrequencyOffset = settings.m_inputFrequencyOffset;
        settings.m_inputSampleRate = m_settings.m_inputSampleRate;
        settings.m_inputFrequencyOffset = m_settings.m_inputFrequencyOffset;

        m_settingsMutex.lock();

        m_sampleFormat = settings.m_sampleFormat;
        m_outputSampleRate = settings.m_outputSampleRate;
        m_rfBandwidth = settings.m_rfBandwidth;

        if (settings.m_tcpPort != m_tcpPort)
        {
            m_tcpPort = settings.m_tcpPort;

            if(m_tcpServer->isListening())
            {
                m_tcpServer->close();
            }

            m_tcpServer->listen(QHostAddress::Any, m_tcpPort);
        }

        m_volume = settings.m_volume;
        m_interpolator.create(16, m_inputSampleRate, m_rfBandwidth / 2.0);
        m_sampleDistanceRemain = m_inputSampleRate / m_outputSampleRate;

        if (m_sampleFormat == TCPSrcSettings::FormatSSB)
        {
            TCPFilter->create_filter(0.3 / 48.0, m_rfBandwidth / 2.0 / m_outputSampleRate);
        }
        else
        {
            TCPFilter->create_filter(0.0, m_rfBandwidth / 2.0 / m_outputSampleRate);
        }

        m_settingsMutex.unlock();

        qDebug() << "TCPSrc::handleMessage: MsgConfigureTCPSrc:"
                << " m_sampleFormat: " << m_sampleFormat
                << " m_outputSampleRate: " << m_outputSampleRate
                << " m_rfBandwidth: " << m_rfBandwidth
                << " m_volume: " << m_volume;

        m_settings = settings;

        return true;
    }
	else if (MsgTCPSrcSpectrum::match(cmd))
	{
		MsgTCPSrcSpectrum& spc = (MsgTCPSrcSpectrum&) cmd;

		m_spectrumEnabled = spc.getEnabled();

		qDebug() << "TCPSrc::handleMessage: MsgTCPSrcSpectrum: m_spectrumEnabled: " << m_spectrumEnabled;

		return true;
	}
	else if (MsgTCPSrcConnection::match(cmd))
	{
		MsgTCPSrcConnection& con = (MsgTCPSrcConnection&) cmd;

	    qDebug() << "TCPSrc::handleMessage: MsgTCPSrcConnection"
                << " connect: " << con.getConnect()
                << " id: " << con.getID()
                << " peer address: " << con.getPeerAddress()
                << " peer port: " << con.getPeerPort();

		if (con.getConnect())
		{
			processNewConnection();
		}
		else
		{
			processDeconnection();
		}
	}
    else if (DSPSignalNotification::match(cmd))
    {
        return true;
    }
	else
	{
		if(m_spectrum != 0)
		{
		   return m_spectrum->handleMessage(cmd);
		}
		else
		{
			return false;
		}
	}

	return false;
}

void TCPSrc::closeAllSockets(Sockets* sockets)
{
	for(int i = 0; i < sockets->count(); ++i)
	{
		MsgTCPSrcConnection* msg = MsgTCPSrcConnection::create(false, sockets->at(i).id, QHostAddress(), 0);
		getInputMessageQueue()->push(msg);

		if (getMessageQueueToGUI()) { // Propagate to GUI
		    getMessageQueueToGUI()->push(msg);
		}

		sockets->at(i).socket->close();
	}
}

void TCPSrc::onNewConnection()
{
	qDebug("TCPSrc::onNewConnection");
	processNewConnection();
}

void TCPSrc::processNewConnection()
{
	qDebug("TCPSrc::processNewConnection");

	while(m_tcpServer->hasPendingConnections())
	{
		qDebug("TCPSrc::processNewConnection: has a pending connection");
		QTcpSocket* connection = m_tcpServer->nextPendingConnection();
		connection->setSocketOption(QAbstractSocket:: KeepAliveOption, 1);
		connect(connection, SIGNAL(disconnected()), this, SLOT(onDisconnected()));

		switch(m_sampleFormat) {

			case TCPSrcSettings::FormatNFM:
			case TCPSrcSettings::FormatSSB:
			{
				quint32 id = (TCPSrcSettings::FormatSSB << 24) | m_nextSSBId;
				m_nextSSBId = (m_nextSSBId + 1) & 0xffffff;
				m_ssbSockets.push_back(Socket(id, connection));

				if (getMessageQueueToGUI()) // Notify GUI of peer details
				{
                    MsgTCPSrcConnection* msg = MsgTCPSrcConnection::create(true, id, connection->peerAddress(), connection->peerPort());
                    getMessageQueueToGUI()->push(msg);
				}

				break;
			}

			case TCPSrcSettings::FormatS16LE:
			{
				qDebug("TCPSrc::processNewConnection: establish new S16LE connection");
				quint32 id = (TCPSrcSettings::FormatS16LE << 24) | m_nextS16leId;
				m_nextS16leId = (m_nextS16leId + 1) & 0xffffff;
				m_s16leSockets.push_back(Socket(id, connection));

				if (getMessageQueueToGUI()) // Notify GUI of peer details
				{
                    MsgTCPSrcConnection* msg = MsgTCPSrcConnection::create(true, id, connection->peerAddress(), connection->peerPort());
                    getMessageQueueToGUI()->push(msg);
				}

				break;
			}

			default:
				delete connection;
				break;
		}
	}
}

void TCPSrc::onDisconnected()
{
	qDebug("TCPSrc::onDisconnected");
	MsgTCPSrcConnection *cmd = MsgTCPSrcConnection::create(false, 0, QHostAddress::Any, 0);
	getInputMessageQueue()->push(cmd);

    if (getMessageQueueToGUI()) { // Propagate to GUI
        getMessageQueueToGUI()->push(cmd);
    }

}

void TCPSrc::processDeconnection()
{
	quint32 id;
	QTcpSocket* socket = 0;

	qDebug("TCPSrc::processDeconnection");

	for(int i = 0; i < m_ssbSockets.count(); i++)
	{
		if(m_ssbSockets[i].socket == sender())
		{
			id = m_ssbSockets[i].id;
			socket = m_ssbSockets[i].socket;
			socket->close();
			m_ssbSockets.removeAt(i);
			break;
		}
	}

	if(socket == 0)
	{
		for(int i = 0; i < m_s16leSockets.count(); i++)
		{
			if(m_s16leSockets[i].socket == sender())
			{
				qDebug("TCPSrc::processDeconnection: remove S16LE socket #%d", i);

				id = m_s16leSockets[i].id;
				socket = m_s16leSockets[i].socket;
				socket->close();
				m_s16leSockets.removeAt(i);
				break;
			}
		}
	}

	if(socket != 0)
	{
        MsgTCPSrcConnection* msg = MsgTCPSrcConnection::create(false, id, QHostAddress(), 0);
        getInputMessageQueue()->push(msg);

        if (getMessageQueueToGUI()) { // Propagate to GUI
            getMessageQueueToGUI()->push(msg);
        }

        socket->deleteLater();
	}
}

void TCPSrc::onTcpServerError(QAbstractSocket::SocketError socketError __attribute__((unused)))
{
	qDebug("TCPSrc::onTcpServerError: %s", qPrintable(m_tcpServer->errorString()));
}

QByteArray TCPSrc::serialize() const
{
    return m_settings.serialize();
}

bool TCPSrc::deserialize(const QByteArray& data)
{
    if (m_settings.deserialize(data))
    {
        MsgConfigureTCPSrc *msg = MsgConfigureTCPSrc::create(m_settings, true);
        m_inputMessageQueue.push(msg);
        return true;
    }
    else
    {
        m_settings.resetToDefaults();
        MsgConfigureTCPSrc *msg = MsgConfigureTCPSrc::create(m_settings, true);
        m_inputMessageQueue.push(msg);
        return false;
    }
}