add ryfi decoder module

Author: AlexandreRouma

CMakeLists.txt

@@ -48,6 +48,7 @@ option(OPT_BUILD_M17_DECODER "Build the M17 decoder module (Dependencies: codec2
 option(OPT_BUILD_METEOR_DEMODULATOR "Build the meteor demodulator module (no dependencies required)" ON)
 option(OPT_BUILD_PAGER_DECODER "Build the pager decoder module (no dependencies required)" ON)
 option(OPT_BUILD_RADIO "Main audio modulation decoder (AM, FM, SSB, etc...)" ON)
+option(OPT_BUILD_RYFI_DECODER "RyFi data link decoder" OFF)
 option(OPT_BUILD_WEATHER_SAT_DECODER "Build the HRPT decoder module (no dependencies required)" OFF)
 
 # Misc
@@ -260,6 +261,10 @@ if (OPT_BUILD_RADIO)
 add_subdirectory("decoder_modules/radio")
 endif (OPT_BUILD_RADIO)
 
+if (OPT_BUILD_RYFI_DECODER)
+add_subdirectory("decoder_modules/ryfi_decoder")
+endif (OPT_BUILD_RYFI_DECODER)
+
 if (OPT_BUILD_WEATHER_SAT_DECODER)
 add_subdirectory("decoder_modules/weather_sat_decoder")
 endif (OPT_BUILD_WEATHER_SAT_DECODER)

decoder_modules/ryfi_decoder/CMakeLists.txt

@@ -0,0 +1,8 @@
+cmake_minimum_required(VERSION 3.13)
+project(ryfi_decoder)
+
+file(GLOB_RECURSE SRC "src/*.cpp" "src/*.c")
+
+include(${SDRPP_MODULE_CMAKE})
+
+target_include_directories(ryfi_decoder PRIVATE "src/")

decoder_modules/ryfi_decoder/src/main.cpp

@@ -0,0 +1,139 @@
+#include <imgui.h>
+#include <config.h>
+#include <core.h>
+#include <gui/style.h>
+#include <gui/gui.h>
+#include <signal_path/signal_path.h>
+#include <module.h>
+#include <filesystem>
+#include <dsp/routing/splitter.h>
+#include <dsp/buffer/reshaper.h>
+#include <dsp/sink/handler_sink.h>
+#include <gui/widgets/folder_select.h>
+#include <gui/widgets/constellation_diagram.h>
+#include "ryfi/receiver.h"
+
+#define CONCAT(a, b) ((std::string(a) + b).c_str())
+
+SDRPP_MOD_INFO{
+    /* Name:            */ "ryfi_decoder",
+    /* Description:     */ "RyFi decoder for SDR++",
+    /* Author:          */ "Ryzerth",
+    /* Version:         */ 0, 1, 0,
+    /* Max instances    */ -1
+};
+
+#define INPUT_BANDWIDTH     800000
+#define INPUT_SAMPLE_RATE   1500000
+#define INPUT_BAUDRATE      720000
+
+#define SYMBOL_DIAG_RATE    30
+#define SYMBOL_DIAG_COUNT   1024
+
+class RyFiDecoderModule : public ModuleManager::Instance {
+public:
+    RyFiDecoderModule(std::string name) {
+        this->name = name;
+
+        vfo = sigpath::vfoManager.createVFO(name, ImGui::WaterfallVFO::REF_CENTER, 0, INPUT_BANDWIDTH, INPUT_SAMPLE_RATE, INPUT_BANDWIDTH, INPUT_BANDWIDTH, true);
+        rx.init(vfo->output, INPUT_BAUDRATE, INPUT_SAMPLE_RATE);
+        reshape.init(rx.softOut, SYMBOL_DIAG_COUNT, (INPUT_BAUDRATE / SYMBOL_DIAG_RATE) - SYMBOL_DIAG_COUNT);
+        symSink.init(&reshape.out, symSinkHandler, this);
+        rx.onPacket.bind(&RyFiDecoderModule::packetHandler, this);
+
+        rx.start();
+        reshape.start();
+        symSink.start();
+
+        gui::menu.registerEntry(name, menuHandler, this, this);
+    }
+
+    ~RyFiDecoderModule() {
+        rx.stop();
+        reshape.stop();
+        symSink.stop();
+        sigpath::vfoManager.deleteVFO(vfo);
+        gui::menu.removeEntry(name);
+    }
+
+    void postInit() {}
+
+    void enable() {
+        double bw = gui::waterfall.getBandwidth();
+        vfo = sigpath::vfoManager.createVFO(name, ImGui::WaterfallVFO::REF_CENTER, std::clamp<double>(0, -bw / 2.0, bw / 2.0), INPUT_BANDWIDTH, INPUT_SAMPLE_RATE, INPUT_BANDWIDTH, INPUT_BANDWIDTH, true);
+
+        rx.setInput(vfo->output);
+
+        rx.start();
+        reshape.start();
+        symSink.start();
+
+        enabled = true;
+    }
+
+    void disable() {
+        rx.stop();
+        reshape.stop();
+        symSink.stop();
+
+        sigpath::vfoManager.deleteVFO(vfo);
+        enabled = false;
+    }
+
+    bool isEnabled() {
+        return enabled;
+    }
+
+private:
+    void packetHandler(ryfi::Packet pkt) {
+        flog::debug("Got a {} byte packet!", pkt.size());
+    }
+
+    static void menuHandler(void* ctx) {
+        RyFiDecoderModule* _this = (RyFiDecoderModule*)ctx;
+
+        float menuWidth = ImGui::GetContentRegionAvail().x;
+
+        if (!_this->enabled) { style::beginDisabled(); }
+
+        ImGui::SetNextItemWidth(menuWidth);
+        _this->constDiagram.draw();
+
+        if (!_this->enabled) { style::endDisabled(); }
+    }
+
+    static void symSinkHandler(dsp::complex_t* data, int count, void* ctx) {
+        RyFiDecoderModule* _this = (RyFiDecoderModule*)ctx;
+
+        dsp::complex_t* buf = _this->constDiagram.acquireBuffer();
+        memcpy(buf, data, 1024 * sizeof(dsp::complex_t));
+        _this->constDiagram.releaseBuffer();
+    }
+
+    std::string name;
+    bool enabled = true;
+
+    // DSP Chain
+    VFOManager::VFO* vfo;
+    ryfi::Receiver rx;
+    dsp::buffer::Reshaper<dsp::complex_t> reshape;
+    dsp::sink::Handler<dsp::complex_t> symSink;
+
+    ImGui::ConstellationDiagram constDiagram;
+};
+
+MOD_EXPORT void _INIT_() {
+
+}
+
+MOD_EXPORT ModuleManager::Instance* _CREATE_INSTANCE_(std::string name) {
+    return new RyFiDecoderModule(name);
+}
+
+MOD_EXPORT void _DELETE_INSTANCE_(void* instance) {
+    delete (RyFiDecoderModule*)instance;
+}
+
+MOD_EXPORT void _END_() {
+
+}

decoder_modules/ryfi_decoder/src/ryfi/conv_codec.cpp

@@ -0,0 +1,74 @@
+#include "conv_codec.h"
+
+namespace ryfi {
+    ConvEncoder::ConvEncoder(dsp::stream<uint8_t>* in) {
+        // Create the convolutional encoder instance
+        conv = correct_convolutional_create(2, 7, correct_conv_r12_7_polynomial);
+        
+        // Init the base class
+        base_type::init(in);
+    }
+
+    ConvEncoder::~ConvEncoder() {
+        // Destroy the convolutional encoder instance
+        correct_convolutional_destroy(conv);
+    }
+
+    int ConvEncoder::encode(const uint8_t* in, uint8_t* out, int count) {
+        // Run convolutional encoder on the data
+        return correct_convolutional_encode(conv, in, count, out);
+    }
+
+    int ConvEncoder::run() {
+        int count = base_type::_in->read();
+        if (count < 0) { return -1; }
+
+        count = encode(base_type::_in->readBuf, base_type::out.writeBuf, count);
+
+        base_type::_in->flush();
+        if (!out.swap(count)) { return -1; }
+        return count;
+    }
+
+    ConvDecoder::ConvDecoder(dsp::stream<dsp::complex_t>* in) {
+        // Create the convolutional encoder instance
+        conv = correct_convolutional_create(2, 7, correct_conv_r12_7_polynomial);
+
+        // Allocate the soft symbol buffer
+        soft = dsp::buffer::alloc<uint8_t>(STREAM_BUFFER_SIZE);
+        
+        // Init the base class
+        base_type::init(in);
+    }
+
+    ConvDecoder::~ConvDecoder() {
+        // Destroy the convolutional encoder instance
+        correct_convolutional_destroy(conv);
+
+        // Free the soft symbol buffer
+        dsp::buffer::free(soft);
+    }
+
+    int ConvDecoder::decode(const dsp::complex_t* in, uint8_t* out, int count) {
+        // Convert to uint8
+        const float* _in = (const float*)in;
+        count *= 2;
+        for (int i = 0; i < count; i++) {
+            soft[i] = std::clamp<int>((_in[i] * 127.0f) + 128.0f, 0, 255);
+        }
+        
+        // Run convolutional decoder on the data
+        return correct_convolutional_decode_soft(conv, soft, count, out);
+    }
+
+    int ConvDecoder::run() {
+        int count = base_type::_in->read();
+        if (count < 0) { return -1; }
+
+        count = decode(base_type::_in->readBuf, base_type::out.writeBuf, count);
+
+        base_type::_in->flush();
+        if (!out.swap(count)) { return -1; }
+        return count;
+    }
+}

decoder_modules/ryfi_decoder/src/ryfi/conv_codec.h

@@ -0,0 +1,70 @@
+#pragma once
+#include <stdint.h>
+#include "dsp/processor.h"
+
+extern "C" {
+    #include "correct.h"
+}
+
+namespace ryfi {
+    /**
+     * RyFi Convolutional Encoder.
+    */
+    class ConvEncoder : public dsp::Processor<uint8_t, uint8_t> {
+        using base_type = dsp::Processor<uint8_t, uint8_t>;
+    public:
+        /**
+         * Create a convolutional encoder specifying an input stream.
+         * @param in Input stream.
+        */
+        ConvEncoder(dsp::stream<uint8_t>* in = NULL);
+
+        // Destructor
+        ~ConvEncoder();
+
+        /**
+         * Encode data.
+         * @param in Input bytes.
+         * @param out Output bits.
+         * @param count Number of input bytes.
+         * @return Number of output bits.
+        */
+        int encode(const uint8_t* in, uint8_t* out, int count);
+
+    private:
+        int run();
+
+        correct_convolutional* conv;
+    };
+
+    /**
+     * RyFi Convolutional Decoder.
+    */
+    class ConvDecoder : public dsp::Processor<dsp::complex_t, uint8_t> {
+        using base_type = dsp::Processor<dsp::complex_t, uint8_t>;
+    public:
+        /**
+         * Create a convolutional encoder specifying an input stream.
+         * @param in Input stream.
+        */
+        ConvDecoder(dsp::stream<dsp::complex_t>* in = NULL);
+
+        // Destructor
+        ~ConvDecoder();
+
+        /**
+         * Decode soft symbols.
+         * @param in Input soft symbols.
+         * @param out Output bytes.
+         * @param count Number of input bytes.
+         * @return Number of output bits.
+        */
+        int decode(const dsp::complex_t* in, uint8_t* out, int count);
+
+    private:
+        int run();
+
+        correct_convolutional* conv;
+        uint8_t* soft = NULL;
+    };
+}

decoder_modules/ryfi_decoder/src/ryfi/frame.cpp

@@ -0,0 +1,37 @@
+#include "frame.h"
+
+namespace ryfi {
+    int Frame::serialize(uint8_t* bytes) const {
+        // Write the counter
+        bytes[0] = (counter >> 8) & 0xFF;
+        bytes[1] = counter & 0xFF;
+
+        // Write the first packet pointer
+        bytes[2] = (firstPacket >> 8) & 0xFF;
+        bytes[3] = firstPacket & 0xFF;
+
+        // Write the last packet pointer
+        bytes[4] = (lastPacket >> 8) & 0xFF;
+        bytes[5] = lastPacket & 0xFF;
+
+        // Write the data
+        memcpy(&bytes[6], content, FRAME_DATA_SIZE);
+
+        // Return the length of a serialized frame
+        return FRAME_SIZE;
+    }
+
+    void Frame::deserialize(const uint8_t* bytes, Frame& frame) {
+        // Read the counter
+        frame.counter = (((uint16_t)bytes[0]) << 8) | ((uint16_t)bytes[1]);
+
+        // Read the first packet pointer
+        frame.firstPacket = (((uint16_t)bytes[2]) << 8) | ((uint16_t)bytes[3]);
+
+        // Read the last packet pointer
+        frame.lastPacket = (((uint16_t)bytes[4]) << 8) | ((uint16_t)bytes[5]);
+
+        // Read the data
+        memcpy(frame.content, &bytes[6], FRAME_DATA_SIZE);
+    }
+}