aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edi/STIDecoder.hpp
blob: e2aa850a439c7defd89814507ec16ac22ba6647b (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
/*
   Copyright (C) 2019
   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 "common.hpp"
#include <cstdint>
#include <deque>
#include <string>
#include <vector>
#include <array>

namespace EdiDecoder {

// Information for STI-D Management
struct sti_management_data {
    bool stihf;
    bool atstf;
    bool rfadf;
    uint16_t dflc;

    uint32_t tsta;
};

// Information for a subchannel available in EDI
struct sti_payload_data {
    uint16_t stream_index;
    uint8_t rfa;
    uint8_t tid;
    uint8_t tidext;
    bool crcstf;
    uint16_t stid;
    std::vector<uint8_t> istd;

    // Return the length of ISTD in bytes
    uint16_t stl(void) const { return istd.size(); }
};

struct audio_level_data {
    int16_t left = 0;
    int16_t right = 0;
};


/* A class that receives STI data must implement the interface described
 * in the STIDataCollector. This can be e.g. a converter to ETI, or something that
 * prepares data structures for a modulator.
 */
class STIDataCollector {
    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;

        // STAT error field and service provider ID
        virtual void update_stat(uint8_t stat, uint16_t spid) = 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_rfad(std::array<uint8_t, 9> rfad) = 0;
        virtual void update_sti_management(const sti_management_data& data) = 0;

        virtual void add_payload(sti_payload_data&& payload) = 0;

        virtual void update_audio_levels(const audio_level_data& data) = 0;
        virtual void update_odr_version(const odr_version_data& data) = 0;

        virtual void assemble() = 0;
};

/* The STIDecoder 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 STIDecoder {
    public:
        STIDecoder(STIDataCollector& data_collector, bool verbose);

        /* 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:
        bool decode_starptr(const std::vector<uint8_t> &value, uint16_t);
        bool decode_dsti(const std::vector<uint8_t> &value, uint16_t);
        bool decode_ssn(const std::vector<uint8_t> &value, uint16_t n);
        bool decode_stardmy(const std::vector<uint8_t> &value, uint16_t);

        bool decode_odraudiolevel(const std::vector<uint8_t> &value, uint16_t);
        bool decode_odrversion(const std::vector<uint8_t> &value, uint16_t);

        void packet_completed();

        STIDataCollector& m_data_collector;
        TagDispatcher m_dispatcher;
};

}