aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edi/ETIDecoder.hpp
blob: 9624c48fba98c46265086e6b0079a5763d185cbf (plain)
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
/*
   Copyright (C) 2017
   Matthias P. Braendli, matthias.braendli@mpb.li

   http://opendigitalradio.org

    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; either version 2 of the License, or
    (at your option) any later version.

    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 for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
#pragma once

#include <stdint.h>
#include <deque>
#include <string>
#include <vector>
#include "PFT.hpp"
#include "eti.hpp"

namespace EdiDecoder {

// Information for Frame Characterisation available in
// EDI.
//
// Number of streams is given separately, and frame length
// is calculated in the DataCollector
struct eti_fc_data {
    bool atstf;
    uint32_t tsta;
    bool ficf;
    uint16_t dflc;
    uint8_t mid;
    uint8_t fp;

    uint8_t fct(void) const { return dflc % 250; }
};

// Information for a subchannel available in EDI
struct eti_stc_data {
    uint8_t stream_index;
    uint8_t scid;
    uint8_t sad;
    uint8_t tpl;
    std::vector<uint8_t> mst;

    // Return the length of the MST in multiples of 64 bits
    uint16_t stl(void) const { return mst.size() / 8; }
};

/* A class that receives multiplex data must implement the interface described
 * in the DataCollector. This can be e.g. a converter to ETI, or something that
 * prepares data structures for a modulator.
 */
class DataCollector {
    public:
        // Tell the ETIWriter what EDI protocol we receive in *ptr.
        // This is not part of the ETI data, but is used as check
        virtual void update_protocol(
                const std::string& proto,
                uint16_t major,
                uint16_t minor) = 0;

        // Update the data for the frame characterisation
        virtual void update_fc_data(const eti_fc_data& fc_data) = 0;

        virtual void update_fic(const std::vector<uint8_t>& fic) = 0;

        virtual void update_err(uint8_t err) = 0;

        // In addition to TSTA in ETI, EDI also transports more time
        // stamp information.
        virtual void update_edi_time(
                uint32_t utco,
                uint32_t seconds) = 0;

        virtual void update_mnsc(uint16_t mnsc) = 0;

        virtual void update_rfu(uint16_t rfu) = 0;

        virtual void add_subchannel(const eti_stc_data& stc) = 0;

        // Tell the ETIWriter that the AFPacket is complete
        virtual void assemble(void) = 0;
};

/* The ETIDecoder takes care of decoding the EDI TAGs related to the transport
 * of ETI(NI) data inside AF and PF packets.
 *
 * PF packets are handed over to the PFT decoder, which will in turn return
 * AF packets. AF packets are directly handled (TAG extraction) here.
 */
class ETIDecoder {
    public:
        ETIDecoder(DataCollector& data_collector);

        /* Push bytes into the decoder. The buf can contain more
         * than a single packet. This is useful when reading from streams
         * (files, TCP)
         */
        void push_bytes(const std::vector<uint8_t> &buf);

        /* Push a complete packet into the decoder. Useful for UDP and other
         * datagram-oriented protocols.
         */
        void push_packet(const std::vector<uint8_t> &buf);

        /* Set the maximum delay in number of AF Packets before we
         * abandon decoding a given pseq.
         */
        void setMaxDelay(int num_af_packets);

    private:
        struct decode_state_t {
            decode_state_t(bool _complete, size_t _num_bytes_consumed) :
                complete(_complete), num_bytes_consumed(_num_bytes_consumed) {}
            bool complete;
            size_t num_bytes_consumed;
        };

        decode_state_t decode_afpacket(const std::vector<uint8_t> &input_data);
        bool decode_tagpacket(const std::vector<uint8_t> &payload);
        bool decode_starptr(const std::vector<uint8_t> &value);
        bool decode_deti(const std::vector<uint8_t> &value);
        bool decode_estn(const std::vector<uint8_t> &value, uint8_t n);
        bool decode_stardmy(const std::vector<uint8_t> &value);

        DataCollector& m_data_collector;

        PFT::PFT m_pft;

        uint16_t m_last_seq;

        std::vector<uint8_t> m_input_data;
};

}