File: module_ccsds_turbo_decoder.cpp

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 (324 lines) | stat: -rw-r--r-- 13,186 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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
#include "module_ccsds_turbo_decoder.h"
#include "logger.h"
#include "common/widgets/themed_widgets.h"
#include "common/utils.h"
#include "common/codings/rotation.h"
#include "common/codings/randomization.h"
#include "common/codings/turbo/ccsds_turbo.h"
#include "common/codings/crc/crc_generic.h"
#include "core/exception.h"

namespace ccsds
{
    CCSDSTurboDecoderModule::CCSDSTurboDecoderModule(std::string input_file, std::string output_file_hint, nlohmann::json parameters)
        : ProcessingModule(input_file, output_file_hint, parameters)
    {
        if (parameters.contains("turbo_rate"))
            d_turbo_rate = parameters["turbo_rate"].get<std::string>();
        else
            throw satdump_exception("Turbo Rate is required!");

        if (parameters.contains("turbo_base"))
            d_turbo_base = parameters["turbo_base"].get<int>();
        else
            throw satdump_exception("Turbo Base is required!");

        if (parameters.contains("turbo_iters"))
            d_turbo_iters = parameters["turbo_iters"].get<int>();
        else
            throw satdump_exception("Turbo Iters is required!");

        if (!(d_turbo_base == 223 || d_turbo_base == 446 || d_turbo_base == 892 || d_turbo_base == 1115))
            throw satdump_exception("Turbo Base must be 223, 446, 892 or 1115!");

        if (d_turbo_rate == "1/2")
        {
            // Generate ASM softs. 0x034776C7272895B0
            uint8_t asm_bits[] = {0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 1,
                                  0, 1, 1, 0, 1, 1, 0, 0, 0, 1, 1, 1, 0, 0, 1, 0, 0, 1, 1, 1,
                                  0, 0, 1, 0, 1, 0, 0, 0, 1, 0, 0, 1, 0, 1, 0, 1, 1, 0, 1, 1,
                                  0, 0, 0, 0};
            for (int i = 0; i < 64; i++)
                asm_softs[i] = asm_bits[i] ? 1.0f : -1.0f;

            d_asm_size = 64;

            if (d_turbo_base == 223)
                d_codeword_size = 3576;
            else if (d_turbo_base == 446)
                d_codeword_size = 7144;
            else if (d_turbo_base == 892)
                d_codeword_size = 14280;
            else if (d_turbo_base == 1115)
                d_codeword_size = 17848;
        }
        else if (d_turbo_rate == "1/3")
        {
            // Generate ASM softs. 0x25D5C0CE8990F6C9461BF79C
            uint8_t asm_bits[] = {0, 0, 1, 0, 0, 1, 0, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 0, 0,
                                  0, 0, 0, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 0, 0, 0, 1, 0, 0, 1,
                                  1, 0, 0, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 1, 1, 0, 1, 1, 0, 0,
                                  1, 0, 0, 1, 0, 1, 0, 0, 0, 1, 1, 0, 0, 0, 0, 1, 1, 0, 1, 1,
                                  1, 1, 1, 1, 0, 1, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0};
            for (int i = 0; i < 96; i++)
                asm_softs[i] = asm_bits[i] ? 1.0f : -1.0f;

            d_asm_size = 96;

            if (d_turbo_base == 223)
                d_codeword_size = 5364;
            else if (d_turbo_base == 446)
                d_codeword_size = 10716;
            else if (d_turbo_base == 892)
                d_codeword_size = 21420;
            else if (d_turbo_base == 1115)
                d_codeword_size = 26772;
        }
        else if (d_turbo_rate == "1/4")
        {
            // Generate ASM softs. 0x034776C7272895B0FCB88938D8D76A4F
            uint8_t asm_bits[] = {0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 1,
                                  0, 1, 1, 0, 1, 1, 0, 0, 0, 1, 1, 1, 0, 0, 1, 0, 0, 1, 1, 1,
                                  0, 0, 1, 0, 1, 0, 0, 0, 1, 0, 0, 1, 0, 1, 0, 1, 1, 0, 1, 1,
                                  0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 1, 0, 1, 1, 1, 0, 0, 0,
                                  1, 0, 0, 0, 1, 0, 0, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 1, 0, 1,
                                  1, 0, 0, 0, 1, 1, 0, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1, 0, 1, 0,
                                  0, 1, 0, 0, 1, 1, 1, 1};
            for (int i = 0; i < 128; i++)
                asm_softs[i] = asm_bits[i] ? 1.0f : -1.0f;

            d_asm_size = 128;

            if (d_turbo_base == 223)
                d_codeword_size = 7152;
            else if (d_turbo_base == 446)
                d_codeword_size = 14288;
            else if (d_turbo_base == 892)
                d_codeword_size = 28560;
            else if (d_turbo_base == 1115)
                d_codeword_size = 35696;
        }

        else if (d_turbo_rate == "1/6")
        {
            // Generate ASM softs. 0x25D5C0CE8990F6C9461BF79CDA2A3F31766F0936B9E40863
            uint8_t asm_bits[] = {0, 0, 1, 0, 0, 1, 0, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 0, 0,
                                  0, 0, 0, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 0, 0, 0, 1, 0, 0, 1,
                                  1, 0, 0, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 1, 1, 0, 1, 1, 0, 0,
                                  1, 0, 0, 1, 0, 1, 0, 0, 0, 1, 1, 0, 0, 0, 0, 1, 1, 0, 1, 1,
                                  1, 1, 1, 1, 0, 1, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 1, 1, 0, 1,
                                  1, 0, 1, 0, 0, 0, 1, 0, 1, 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1,
                                  0, 0, 1, 1, 0, 0, 0, 1, 0, 1, 1, 1, 0, 1, 1, 0, 0, 1, 1, 0,
                                  1, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 1, 0, 0, 1, 1, 0, 1, 1, 0,
                                  1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0,
                                  1, 0, 0, 0, 0, 1, 1, 0, 0, 0, 1, 1};
            for (int i = 0; i < 192; i++)
                asm_softs[i] = asm_bits[i] ? 1.0f : -1.0f;

            d_asm_size = 192;

            if (d_turbo_base == 223)
                d_codeword_size = 10728;
            else if (d_turbo_base == 446)
                d_codeword_size = 21432;
            else if (d_turbo_base == 892)
                d_codeword_size = 42840;
            else if (d_turbo_base == 1115)
                d_codeword_size = 53544;
        }
        else
            throw satdump_exception("Invalid Turbo Rate!");

        d_frame_size = d_codeword_size + d_asm_size;

        buffer_soft = new int8_t[d_frame_size];
        buffer_floats = new float[d_frame_size];

        window_name = "CCSDS Turbo r=" + d_turbo_rate + " b=" + std::to_string(d_turbo_base) + " Decoder";
    }

    std::vector<ModuleDataType> CCSDSTurboDecoderModule::getInputTypes()
    {
        return {DATA_FILE, DATA_STREAM};
    }

    std::vector<ModuleDataType> CCSDSTurboDecoderModule::getOutputTypes()
    {
        return {DATA_FILE};
    }

    CCSDSTurboDecoderModule::~CCSDSTurboDecoderModule()
    {
        delete[] buffer_soft;
        delete[] buffer_floats;
    }

    void CCSDSTurboDecoderModule::process()
    {
        if (input_data_type == DATA_FILE)
            filesize = getFilesize(d_input_file);
        else
            filesize = 0;
        if (input_data_type == DATA_FILE)
            data_in = std::ifstream(d_input_file, std::ios::binary);
        data_out = std::ofstream(d_output_file_hint + ".cadu", std::ios::binary);
        d_output_files.push_back(d_output_file_hint + ".cadu");

        logger->info("Using input symbols " + d_input_file);
        logger->info("Decoding to " + d_output_file_hint + ".cadu");

        codings::turbo::turbo_rate_t frate = codings::turbo::RATE_1_2;

        if (d_turbo_rate == "1/2")
            frate = codings::turbo::RATE_1_2;
        else if (d_turbo_rate == "1/3")
            frate = codings::turbo::RATE_1_3;
        else if (d_turbo_rate == "1/4")
            frate = codings::turbo::RATE_1_4;
        else if (d_turbo_rate == "1/6")
            frate = codings::turbo::RATE_1_6;

        codings::turbo::CCSDSTurbo turbo_dec((codings::turbo::turbo_base_t)d_turbo_base, frate);
        codings::crc::GenericCRC crc_check(16, 0x1021, 0xFFFF, 0x0, false, false);
        uint8_t output_frame_buffer[1115 + 4];

        time_t lastTime = 0;

        while (input_data_type == DATA_FILE ? !data_in.eof() : input_active.load())
        {
            // Read a buffer
            if (input_data_type == DATA_FILE)
                data_in.read((char *)buffer_soft, d_frame_size);
            else
                input_fifo->read((uint8_t *)buffer_soft, d_frame_size);
            volk_8i_s32f_convert_32f(buffer_floats, buffer_soft, 127, d_frame_size);

            // Correlate. Slow, but Turbo rate 1/6 shouldn't be used on fast links
            int best_pos = 0;
            float best_cor = 0;
            bool best_swapped = false;
            float corr_value = 0;
            for (int pos = 0; pos < d_frame_size - d_asm_size; pos++)
            {
                volk_32f_x2_dot_prod_32f(&corr_value, &buffer_floats[pos], asm_softs, d_asm_size);

                if (corr_value > best_cor)
                {
                    best_cor = corr_value;
                    best_pos = pos;
                    best_swapped = false;
                }

                if (-corr_value > best_cor)
                {
                    best_cor = -corr_value;
                    best_pos = pos;
                    best_swapped = true;
                }

                // logger->critical("%d %f %f", pos, corr_nwap, corr_swap);
            }

            locked = best_pos == 0; // Update locking state
            cor = best_cor;

            if (best_pos != 0 && best_pos < d_frame_size) // Safety
            {
                std::memmove(buffer_soft, &buffer_soft[best_pos], best_pos);

                if (input_data_type == DATA_FILE)
                    data_in.read((char *)&buffer_soft[d_frame_size - best_pos], best_pos);
                else
                    input_fifo->read((uint8_t *)&buffer_soft[d_frame_size - best_pos], best_pos);
            }

            derand_ccsds_soft(&buffer_soft[d_asm_size], d_codeword_size);
            volk_8i_s32f_convert_32f(buffer_floats, buffer_soft, 127.0, d_frame_size);

            // logger->critical(best_pos);

            if (best_swapped) // Swap if required
                for (int i = 0; i < d_frame_size; i++)
                    buffer_floats[i] = -buffer_floats[i];

            turbo_dec.decode(&buffer_floats[d_asm_size], &output_frame_buffer[4], d_turbo_iters);

            output_frame_buffer[0] = 0x1a;
            output_frame_buffer[1] = 0xcf;
            output_frame_buffer[2] = 0xfc;
            output_frame_buffer[3] = 0x1d;

            // Check CRC
            uint16_t compu_crc = crc_check.compute(&output_frame_buffer[4], d_turbo_base - 2);
            uint16_t local_crc = output_frame_buffer[(d_turbo_base + 4) - 2] << 8 | output_frame_buffer[(d_turbo_base + 4) - 1];

            crc_lock = compu_crc == local_crc;

            if (crc_lock)
                data_out.write((char *)output_frame_buffer, (d_turbo_base + 4));

            if (input_data_type == DATA_FILE)
                progress = data_in.tellg();

            if (time(NULL) % 10 == 0 && lastTime != time(NULL))
            {
                lastTime = time(NULL);
                std::string lock_state = locked ? "SYNCED" : "NOSYNC";
                logger->info("Progress " + std::to_string(round(((double)progress / (double)filesize) * 1000.0f) / 10.0f) + "%%, Lock : " + lock_state);
            }
        }

        data_out.close();
        if (input_data_type == DATA_FILE)
            data_in.close();
    }

    void CCSDSTurboDecoderModule::drawUI(bool window)
    {
        ImGui::Begin(window_name.c_str(), NULL, window ? 0 : NOWINDOW_FLAGS);

        ImGui::BeginGroup();
        {
            ImGui::Button("Correlator", {200 * ui_scale, 20 * ui_scale});
            {
                ImGui::Text("Corr  : ");
                ImGui::SameLine();
                ImGui::TextColored(locked ? style::theme.green : style::theme.orange, UITO_C_STR(cor));

                std::memmove(&cor_history[0], &cor_history[1], (200 - 1) * sizeof(float));
                cor_history[200 - 1] = cor;

                widgets::ThemedPlotLines(style::theme.plot_bg.Value, "", cor_history, IM_ARRAYSIZE(cor_history), 0, "", 0.0f, 100.0f,
                    ImVec2(200 * ui_scale, 50 * ui_scale));
            }

            ImGui::Button("CRC Check", {200 * ui_scale, 20 * ui_scale});
            {
                ImGui::Text("Check  : ");
                ImGui::SameLine();
                ImGui::TextColored(crc_lock ? style::theme.green : style::theme.orange, crc_lock ? "PASS" : "FAIL");
            }
        }
        ImGui::EndGroup();

        if (!streamingInput)
            ImGui::ProgressBar((double)progress / (double)filesize, ImVec2(ImGui::GetContentRegionAvail().x, 20 * ui_scale));

        ImGui::End();
    }

    std::string CCSDSTurboDecoderModule::getID()
    {
        return "ccsds_turbo_decoder";
    }

    std::vector<std::string> CCSDSTurboDecoderModule::getParameters()
    {
        return {};
    }

    std::shared_ptr<ProcessingModule> CCSDSTurboDecoderModule::getInstance(std::string input_file, std::string output_file_hint, nlohmann::json parameters)
    {
        return std::make_shared<CCSDSTurboDecoderModule>(input_file, output_file_hint, parameters);
    }
} // namespace meteor