File: module_ccsds_conv_concat_decoder.h

package info (click to toggle)
satdump 1.2.2%2Bgb79af48-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 81,648 kB
  • sloc: cpp: 276,768; ansic: 164,598; lisp: 1,219; sh: 283; xml: 106; makefile: 7
file content (125 lines) | stat: -rw-r--r-- 4,860 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
#pragma once

#include "core/module.h"
#include <complex>
#include "common/codings/viterbi/viterbi_1_2.h"
#include "common/codings/deframing/bpsk_ccsds_deframer.h"
#include <fstream>
#include "common/dsp/demod/constellation.h"
#include "common/codings/reedsolomon/reedsolomon.h"
#include "common/dsp/utils/random.h"
#include "common/codings/viterbi/viterbi_punc.h"

namespace ccsds
{
    /*
    This decoder is meant to decode convolutional r=2 k=7 codes
    concatenated with Reed-Solomon parity bits. This soft of FEC
    is pretty common on CCSDS-compliant satellites, with some
    varients such as :
        - Differential (NRZ-M) encoding
        - Different CADU size
        - RS 223 or 239 codes, with usually I=4 or I=5
        - Bit swap and 90 degs phase rotation on BPSK
        - Reed-Solomon lacking dual-basis

    All those variations are in the end pretty minor so a common
    decoder can be used instead allowing a high degree of tuning.

    Decoding is done by first locking a streaming viterbi decoder
    onto a specific state of the provided modulation, to then feed
    the decoded data to a deframer.

    It is recommended to use a rather low thresold for the Viterbi
    decoder, usually just below the average to ensure it locks as
    soon as possible. 0.300 seems to be good.

    The ASM Marker is left configurable as other satellites use
    similar protocols, just with a different syncword.

    CCSDS naming is kept mostly because this specific convolutional
    code is from the specification and most satellites will use
    CCSDS-compliant concatenated codings anyway.
    */
    class CCSDSConvConcatDecoderModule : public ProcessingModule
    {
    protected:
        const bool is_ccsds; // Just to know if we should output .cadu or .frm

        const std::string d_constellation_str;     // Constellation type string
        dsp::constellation_type_t d_constellation; // Constellation type
        bool d_bpsk_90;                            // Special case for BPSK shifted by 90 degs + IQ-swapped
        bool d_oqpsk_mode;                         // OQPSK does NOT guarantee IQ stability
        const bool d_iq_invert;                    // For some QPSK sats, can need to be inverted...

        const int d_cadu_size;   // CADU Size in bits, including ASM
        const int d_cadu_bytes;  // CADU Size in bytes, including ASM
        const int d_buffer_size; // Processing buffer size, default half of a frame (= d_cadu_size)

        const int d_viterbi_outsync_after;
        const float d_viterbi_ber_threasold;

        const bool d_diff_decode; // If NRZ-M Decoding is required or not

        const bool d_derand;          // Perform derandomizion or not
        const bool d_derand_after_rs; // Derandomization after RS
        const int d_derand_from;      // Byte to start derand on

        const std::string d_conv_type; // Conv rate Type identifier

        const int d_rs_interleaving_depth; // RS Interleaving depth. If = 0, then RS is disabled
        const int d_rs_fill_bytes;         // RS Frame size, if -1, no puncturing
        const bool d_rs_dualbasis;         // RS Representation. Dual basis or none?
        const std::string d_rs_type;       // RS Type identifier
        const bool d_rs_usecheck;          // RS Used as frame check?

        enum vitrate_t
        {
            PUNCRATE_1_2,
            PUNCRATE_2_3,
            PUNCRATE_3_4,
            PUNCRATE_5_6,
            PUNCRATE_7_8,
        };

        vitrate_t viterbi_coderate;

        uint8_t *viterbi_out;
        int8_t *soft_buffer;
        uint8_t *frame_buffer;

        std::ifstream data_in;
        std::ofstream data_out;

        std::atomic<uint64_t> filesize;
        std::atomic<uint64_t> progress;

        std::shared_ptr<viterbi::Viterbi1_2> viterbi, viterbi2;
        std::shared_ptr<viterbi::Viterbi_Depunc> viterbip, viterbip2;
        std::shared_ptr<deframing::BPSK_CCSDS_Deframer> deframer;
        std::shared_ptr<reedsolomon::ReedSolomon> reed_solomon;

        int errors[10];

        // UI Stuff
        float ber_history[200];
        dsp::Random rng;

        float viterbi_ber = 0;
        int viterbi_lock = 0;

    public:
        CCSDSConvConcatDecoderModule(std::string input_file, std::string output_file_hint, nlohmann::json parameters);
        ~CCSDSConvConcatDecoderModule();
        void process();
        void drawUI(bool window);
        std::vector<ModuleDataType> getInputTypes();
        std::vector<ModuleDataType> getOutputTypes();

    public:
        static std::string getID();
        virtual std::string getIDM() { return getID(); };
        static std::vector<std::string> getParameters();
        static std::shared_ptr<ProcessingModule> getInstance(std::string input_file, std::string output_file_hint, nlohmann::json parameters);
    };
} // namespace npp