summaryrefslogtreecommitdiffstats
path: root/src/input/Edi.h
blob: 3de17a718ecae3fa49ea7ee0b5fb6500535b4107 (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
/*
   Copyright (C) 2009 Her Majesty the Queen in Right of Canada (Communications
   Research Center Canada)

   Copyright (C) 2024
   Matthias P. Braendli, matthias.braendli@mpb.li

    http://www.opendigitalradio.org
   */
/*
   This file is part of ODR-DabMux.

   ODR-DabMux 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 3 of the
   License, or (at your option) any later version.

   ODR-DabMux 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 ODR-DabMux.  If not, see <http://www.gnu.org/licenses/>.
   */

#pragma once

#include <string>
#include <vector>
#include <deque>
#include <thread>
#include <mutex>
#include "Socket.h"
#include "input/inputs.h"
#include "edi/STIDecoder.hpp"
#include "edi/STIWriter.hpp"
#include "ThreadsafeQueue.h"
#include "ManagementServer.h"

namespace Inputs {

struct dab_input_edi_config_t
{
    /* The size of the internal buffer, measured in number
     * of elements.
     *
     * Each element corresponds to one frame, i.e. 24ms
     */
    size_t buffer_size = 100;

    /* The amount of prebuffering to do before we start streaming
     *
     * Same units as buffer_size
     */
    size_t prebuffering = 30;
};

/*
 * Receives EDI from UDP or TCP in a separate thread and pushes that data
 * into the STIDecoder. Complete frames are then put into a queue for the consumer.
 *
 * This way, the EDI decoding happens in a separate thread.
 */
class Edi : public InputBase, public RemoteControllable {
    public:
        Edi(const std::string& name, const dab_input_edi_config_t& config);
        Edi(const Edi&) = delete;
        Edi& operator=(const Edi&) = delete;
        ~Edi();

        virtual void open(const std::string& name);
        virtual size_t readFrame(uint8_t *buffer, size_t size);
        virtual size_t readFrame(uint8_t *buffer, size_t size, std::time_t seconds, int utco, uint32_t tsta);
        virtual int setBitrate(int bitrate);
        virtual void close();

        /* Remote control */
        virtual void set_parameter(const std::string& parameter, const std::string& value);
        virtual const std::string get_parameter(const std::string& parameter) const;
        virtual const json::map_t get_all_values() const;

    protected:
        void m_run();

        void m_new_sti_frame_callback(EdiDecoder::sti_frame_t&& frame);

        std::mutex m_mutex;

        enum class InputUsed { Invalid, UDP, TCP };
        InputUsed m_input_used = InputUsed::Invalid;
        Socket::UDPSocket m_udp_sock;
        Socket::TCPReceiveServer m_tcp_receive_server;

        EdiDecoder::STIWriter m_sti_writer;
        EdiDecoder::STIDecoder m_sti_decoder;
        std::thread m_thread;
        std::atomic<bool> m_running = ATOMIC_VAR_INIT(false);
        ThreadsafeQueue<EdiDecoder::sti_frame_t> m_frames;

        // InputBase defines bufferManagement and tist delay

        // Used in timestamp-based buffer management
        EdiDecoder::sti_frame_t m_pending_sti_frame;

        // State variable used in prebuffering-based buffer management
        bool m_is_prebuffering = true;

        // Display the 'size mismatch' warning only once
        bool m_size_mismatch_printed = false;

        /* When using prebuffering, consider the buffer to be full on the
         * receive side if it's above the overrun threshold.
         *
         * When using timestamping, start discarding the front of the queue once the queue
         * is this full. Must be smaller than m_max_frames_queued.
         *
         * Parameter 'buffer' inside RC. */
        std::atomic<size_t> m_max_frames_overrun = ATOMIC_VAR_INIT(1000);

        /* When not using timestamping, how many frames to prebuffer.
         * Parameter 'prebuffering' inside RC. */
        std::atomic<size_t> m_num_frames_prebuffering = ATOMIC_VAR_INIT(10);

        std::string m_name;
        InputStat m_stats;
};

};