aboutsummaryrefslogtreecommitdiffstats
path: root/src/TII.h
blob: 4c5c6052f82a5329a7c4f58711871365b861cd1f (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
/*
   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011 Her Majesty
   the Queen in Right of Canada (Communications Research Center Canada)

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

    http://opendigitalradio.org

   TII generation according to ETSI EN 300 401 Clause 14.8
 */
/*
   This file is part of ODR-DabMod.

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

#pragma once

#ifdef HAVE_CONFIG_H
#   include <config.h>
#endif

#include "ModPlugin.h"
#include "RemoteControl.h"

#include <boost/thread.hpp>
#include <sys/types.h>
#include <complex>
#include <vector>
#include <string>

struct tii_config_t
{
    tii_config_t() : enable(false), comb(0), pattern(0), old_variant(false) {}

    bool enable;
    int comb;
    int pattern;

    /* EN 300 401 clause 14.8 describes how to generate the TII signal, and
     * defines z_{m,0,k}:
     *
     * z_{m,0,k} = A_{c,p}(k) e^{j \psi_k} + A_{c,p}(k-1) e^{j \psi{k-1}}
     *
     * What was implemented in the old variant was
     *
     * z_{m,0,k} = A_{c,p}(k) e^{j \psi_k} + A_{c,p}(k-1) e^{j \psi{k}}
     *                                                              ^
     *                                                              |
     *                                                  Wrong phase on the second
     *                                                  carrier of the pair.
     *
     * Correctly implemented decoders ought to be able to decode such a TII,
     * but will not be able to correctly estimate the delay of different
     * transmitters.
     *
     * The option 'old_variant' allows the user to choose between this
     * old incorrect implementation and the new conforming one.
     */
    bool old_variant;
};

class TIIError : public std::runtime_error {
    public:
        TIIError(const char* msg) :
            std::runtime_error(msg) {}
        TIIError(const std::string& msg) :
            std::runtime_error(msg) {}
};

class TII : public ModCodec, public RemoteControllable
{
    public:
        TII(unsigned int dabmode, const tii_config_t& tii_config, unsigned phase);
        virtual ~TII();
        TII(const TII&) = delete;
        TII& operator=(const TII&) = delete;

        int process(Buffer* dataIn, Buffer* dataOut);
        const char* name();

        /******* 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;

    protected:
        // Fill m_enabled_carriers with the correct carriers for the pattern/comb
        // combination
        void prepare_pattern(void);

        // prerequisites: calling thread must hold m_enabled_carriers mutex
        void enable_carrier(int k);

        // Configuration settings
        unsigned int m_dabmode;

        // Remote-controllable settings
        tii_config_t m_conf;

        // Internal flag when to insert TII
        bool m_insert;

        size_t m_carriers;

        std::string m_name;

        // m_enabled_carriers is read by modulator thread, and written
        // to by RC thread.
        mutable boost::mutex m_enabled_carriers_mutex;

        // m_enabled_carriers is true only for the first carrier in the
        // active pair
        std::vector<bool> m_enabled_carriers;
};