sdrangel/plugins/channelrx/demoddsd/dsddemod.h

///////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2016 F4EXB                                                      //
// written by Edouard Griffiths                                                  //
//                                                                               //
// 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/>.          //
///////////////////////////////////////////////////////////////////////////////////

#ifndef INCLUDE_DSDDEMOD_H
#define INCLUDE_DSDDEMOD_H

#include <dsp/basebandsamplesink.h>
#include <dsp/phasediscri.h>
#include <QMutex>
#include <vector>
#include "dsp/nco.h"
#include "dsp/interpolator.h"
#include "dsp/lowpass.h"
#include "dsp/bandpass.h"
#include "dsp/afsquelch.h"
#include "dsp/movingaverage.h"
#include "dsp/afsquelch.h"
#include "audio/audiofifo.h"
#include "util/message.h"
#include "util/udpsink.h"

#include "dsddemodsettings.h"
#include "dsddecoder.h"

class DeviceSourceAPI;
class ThreadedBasebandSampleSink;
class DownChannelizer;

class DSDDemod : public BasebandSampleSink {
public:
    class MsgConfigureDSDDemod : public Message {
        MESSAGE_CLASS_DECLARATION

    public:
        const DSDDemodSettings& getSettings() const { return m_settings; }
        bool getForce() const { return m_force; }

        static MsgConfigureDSDDemod* create(const DSDDemodSettings& settings, bool force)
        {
            return new MsgConfigureDSDDemod(settings, force);
        }

    private:
        DSDDemodSettings m_settings;
        bool m_force;

        MsgConfigureDSDDemod(const DSDDemodSettings& settings, bool force) :
            Message(),
            m_settings(settings),
            m_force(force)
        { }
    };

    class MsgConfigureChannelizer : public Message {
        MESSAGE_CLASS_DECLARATION

    public:
        int getSampleRate() const { return m_sampleRate; }
        int getCenterFrequency() const { return m_centerFrequency; }

        static MsgConfigureChannelizer* create(int sampleRate, int centerFrequency)
        {
            return new MsgConfigureChannelizer(sampleRate, centerFrequency);
        }

    private:
        int m_sampleRate;
        int  m_centerFrequency;

        MsgConfigureChannelizer(int sampleRate, int centerFrequency) :
            Message(),
            m_sampleRate(sampleRate),
            m_centerFrequency(centerFrequency)
        { }
    };

    DSDDemod(DeviceSourceAPI *deviceAPI);
	~DSDDemod();
	void setScopeSink(BasebandSampleSink* sampleSink) { m_scope = sampleSink; }

	void configure(MessageQueue* messageQueue,
			Real rfBandwidth,
			Real fmDeviation,
			Real demodGain,
            Real volume,
            int  baudRate,
			int  squelchGate,
			Real squelch,
			bool audioMute,
			bool enableCosineFiltering,
			bool syncOrConstellation,
			bool slot1On,
			bool slot2On,
			bool tdmaStereo,
			bool pllLock,
			bool udpCopyAudio,
			const QString& udpAddress,
			quint16 udpPort,
			bool force);

	void configureMyPosition(MessageQueue* messageQueue, float myLatitude, float myLongitude);

	virtual void feed(const SampleVector::const_iterator& begin, const SampleVector::const_iterator& end, bool po);
	virtual void start();
	virtual void stop();
	virtual bool handleMessage(const Message& cmd);

	double getMagSq() { return m_magsq; }
	bool getSquelchOpen() const { return m_squelchOpen; }

	const DSDDecoder& getDecoder() const { return m_dsdDecoder; }

    void getMagSqLevels(double& avg, double& peak, int& nbSamples)
    {
        avg = m_magsqCount == 0 ? 1e-10 : m_magsqSum / m_magsqCount;
        m_magsq = avg;
        peak = m_magsqPeak == 0.0 ? 1e-10 : m_magsqPeak;
        nbSamples = m_magsqCount == 0 ? 1 : m_magsqCount;
        m_magsqSum = 0.0f;
        m_magsqPeak = 0.0f;
        m_magsqCount = 0;
    }


private:
	class MsgConfigureMyPosition : public Message {
		MESSAGE_CLASS_DECLARATION

	public:
		float getMyLatitude() const { return m_myLatitude; }
		float getMyLongitude() const { return m_myLongitude; }

		static MsgConfigureMyPosition* create(float myLatitude, float myLongitude)
		{
			return new MsgConfigureMyPosition(myLatitude, myLongitude);
		}

	private:
		float m_myLatitude;
		float m_myLongitude;

		MsgConfigureMyPosition(float myLatitude, float myLongitude) :
			m_myLatitude(myLatitude),
			m_myLongitude(myLongitude)
		{}
	};

	class MsgConfigureDSDDemodPrivate : public Message {
		MESSAGE_CLASS_DECLARATION

	public:
		Real getRFBandwidth() const { return m_rfBandwidth; }
        Real getFMDeviation() const { return m_fmDeviation; }
        Real getDemodGain() const { return m_demodGain; }
        Real getVolume() const { return m_volume; }
        int  getBaudRate() const { return m_baudRate; }
		int  getSquelchGate() const { return m_squelchGate; }
		Real getSquelch() const { return m_squelch; }
		bool getAudioMute() const { return m_audioMute; }
		bool getEnableCosineFiltering() const { return m_enableCosineFiltering; }
		bool getSyncOrConstellation() const { return m_syncOrConstellation; }
		bool getSlot1On() const { return m_slot1On; }
		bool getSlot2On() const { return m_slot2On; }
		bool getTDMAStereo() const { return m_tdmaStereo; }
		bool getPLLLock() const { return m_pllLock; }
		bool getUDPCopyAudio() const { return m_udpCopyAudio; }
		const QString& getUDPAddress() const { return m_udpAddress; }
		quint16 getUDPPort() const { return m_udpPort; }

		static MsgConfigureDSDDemodPrivate* create(Real rfBandwidth,
                Real fmDeviation,
                Real demodGain,
				Real volume,
				int  baudRate,
				int  squelchGate,
				Real squelch,
				bool audioMute,
				bool enableCosineFiltering,
				bool syncOrConstellation,
				bool slot1On,
				bool slot2On,
				bool tdmaStereo,
				bool pllLock,
				bool udpCopyAudio,
				const QString& udpAddress,
				quint16 udpPort,
				bool force)
		{
			return new MsgConfigureDSDDemodPrivate(rfBandwidth,
                    fmDeviation,
			        demodGain,
			        volume,
			        baudRate,
			        squelchGate,
			        squelch,
			        audioMute,
			        enableCosineFiltering,
			        syncOrConstellation,
			        slot1On,
			        slot2On,
			        tdmaStereo,
			        pllLock,
			        udpCopyAudio,
			        udpAddress,
			        udpPort,
			        force);
		}

	private:
		Real m_rfBandwidth;
        Real m_fmDeviation;
		Real m_demodGain;
		Real m_volume;
		int  m_baudRate;
		int  m_squelchGate;
		Real m_squelch;
		bool m_audioMute;
		bool m_enableCosineFiltering;
		bool m_syncOrConstellation;
        bool m_slot1On;
        bool m_slot2On;
        bool m_tdmaStereo;
        bool m_pllLock;
        bool m_udpCopyAudio;
        QString m_udpAddress;
        quint16 m_udpPort;
        bool m_force;

		MsgConfigureDSDDemodPrivate(Real rfBandwidth,
		        Real fmDeviation,
		        Real demodGain,
				Real volume,
				int  baudRate,
				int  squelchGate,
				Real squelch,
				bool audioMute,
				bool enableCosineFiltering,
				bool syncOrConstellation,
				bool slot1On,
				bool slot2On,
				bool tdmaStereo,
				bool pllLock,
				bool udpCopyAudio,
				const QString& udpAddress,
				quint16 udpPort,
				bool force) :
			Message(),
			m_rfBandwidth(rfBandwidth),
            m_fmDeviation(fmDeviation),
			m_demodGain(demodGain),
			m_volume(volume),
			m_baudRate(baudRate),
			m_squelchGate(squelchGate),
			m_squelch(squelch),
			m_audioMute(audioMute),
			m_enableCosineFiltering(enableCosineFiltering),
			m_syncOrConstellation(syncOrConstellation),
			m_slot1On(slot1On),
			m_slot2On(slot2On),
			m_tdmaStereo(tdmaStereo),
			m_pllLock(pllLock),
			m_udpCopyAudio(udpCopyAudio),
			m_udpAddress(udpAddress),
			m_udpPort(udpPort),
			m_force(force)
		{ }
	};

	enum RateState {
		RSInitialFill,
		RSRunning
	};

	struct Config {
		int m_inputSampleRate;
		qint64 m_inputFrequencyOffset;
		Real m_rfBandwidth;
        Real m_fmDeviation;
        Real m_demodGain;
        Real m_volume;
		int  m_baudRate;
		int  m_squelchGate;
		Real m_squelch;
		bool m_audioMute;
		quint32 m_audioSampleRate;
		bool m_enableCosineFiltering;
		bool m_syncOrConstellation;
		bool m_slot1On;
		bool m_slot2On;
		bool m_tdmaStereo;
		bool m_pllLock;
		bool m_udpCopyAudio;
		QString m_udpAddress;
		quint16 m_udpPort;

		Config() :
			m_inputSampleRate(-1),
			m_inputFrequencyOffset(0),
			m_rfBandwidth(10000.0),
            m_fmDeviation(5000.0),
			m_demodGain(1.0),
			m_volume(1.0),
			m_baudRate(4800),
			m_squelchGate(1),
			m_squelch(-40.0),
			m_audioMute(false),
			m_audioSampleRate(0),
			m_enableCosineFiltering(false),
			m_syncOrConstellation(false),
			m_slot1On(false),
			m_slot2On(false),
			m_tdmaStereo(false),
			m_pllLock(true),
			m_udpCopyAudio(false),
			m_udpAddress("127.0.0.1"),
			m_udpPort(9999)
		{ }
	};

	Config m_config;
	Config m_running;
	DSDDemodSettings m_settings;

	DeviceSourceAPI *m_deviceAPI;
    ThreadedBasebandSampleSink* m_threadedChannelizer;
    DownChannelizer* m_channelizer;

	NCO m_nco;
	Interpolator m_interpolator;
	Real m_interpolatorDistance;
	Real m_interpolatorDistanceRemain;
	int m_sampleCount;
	int m_squelchCount;
	int m_squelchGate;

	double m_squelchLevel;
	bool m_squelchOpen;

	Real m_lastArgument;
    MovingAverage<double> m_movingAverage;
    double m_magsq;
    double m_magsqSum;
    double m_magsqPeak;
    int  m_magsqCount;

	Real m_fmExcursion;

	SampleVector m_scopeSampleBuffer;
	AudioVector m_audioBuffer;
	uint m_audioBufferFill;
	qint16 *m_sampleBuffer; //!< samples ring buffer
	int m_sampleBufferIndex;

	AudioFifo m_audioFifo1;
    AudioFifo m_audioFifo2;
	BasebandSampleSink* m_scope;
	bool m_scopeEnabled;

	DSDDecoder m_dsdDecoder;
	QMutex m_settingsMutex;

    PhaseDiscriminators m_phaseDiscri;
    UDPSink<AudioSample> *m_udpBufferAudio;

    static const int m_udpBlockSize;

	void apply(bool force = false);
	void applySettings(DSDDemodSettings& settings, bool force = false);
};

#endif // INCLUDE_DSDDEMOD_H