summaryrefslogtreecommitdiff
path: root/gr-digital/lib/mpsk_snr_est_cc_impl.cc
blob: f31ae3f6e9497554948defd0bbd71f0a6aa52878 (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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/* -*- c++ -*- */
/*
 * Copyright 2011,2012 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio 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, or (at your option)
 * any later version.
 *
 * GNU Radio 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 GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

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

#include "mpsk_snr_est_cc_impl.h"
#include <gnuradio/io_signature.h>
#include <cstdio>

namespace gr {
namespace digital {

mpsk_snr_est_cc::sptr
mpsk_snr_est_cc::make(snr_est_type_t type, int tag_nsamples, double alpha)
{
    return gnuradio::get_initial_sptr(
        new mpsk_snr_est_cc_impl(type, tag_nsamples, alpha));
}

mpsk_snr_est_cc_impl::mpsk_snr_est_cc_impl(snr_est_type_t type,
                                           int tag_nsamples,
                                           double alpha)
    : sync_block("mpsk_snr_est_cc",
                 io_signature::make(1, 1, sizeof(gr_complex)),
                 io_signature::make(1, 1, sizeof(gr_complex)))
{
    d_snr_est = NULL;

    d_type = type;
    d_nsamples = tag_nsamples;
    d_count = 0;
    set_alpha(alpha);

    set_type(type);

    // at least 1 estimator has to look back
    set_history(2);

    std::stringstream str;
    str << name() << unique_id();
    d_me = pmt::string_to_symbol(str.str());
    d_key = pmt::string_to_symbol("snr");
}

mpsk_snr_est_cc_impl::~mpsk_snr_est_cc_impl()
{
    if (d_snr_est)
        delete d_snr_est;
}

int mpsk_snr_est_cc_impl::work(int noutput_items,
                               gr_vector_const_void_star& input_items,
                               gr_vector_void_star& output_items)
{
    // This is a pass-through block; copy input to output
    memcpy(output_items[0], input_items[0], noutput_items * sizeof(gr_complex));

    const gr_complex* in = (const gr_complex*)input_items[0];

    // Update, calculate, and issue an SNR tag every d_nsamples
    int index = 0, x = 0;
    int64_t nwritten = nitems_written(0);
    while (index + (d_nsamples - d_count) < noutput_items) {
        x = d_nsamples - d_count;
        nwritten += x;

        // Update the SNR estimate registers from the current input
        d_snr_est->update(x, &in[index]);

        // Issue a tag with the SNR data
        pmt::pmt_t pmt_snr = pmt::from_double(d_snr_est->snr());
        add_item_tag(0,        // stream ID
                     nwritten, // tag's sample number
                     d_key,    // snr key
                     pmt_snr,  // SNR
                     d_me);    // block src id

        index += x;
        d_count = 0;
    }

    // Keep track of remaining items and update estimators
    x = noutput_items - index;
    d_count += x;
    d_snr_est->update(x, &in[index]);

    return noutput_items;
}

double mpsk_snr_est_cc_impl::snr()
{
    if (d_snr_est)
        return d_snr_est->snr();
    else
        throw std::runtime_error("mpsk_snr_est_cc_impl:: No SNR estimator defined.");
}

snr_est_type_t mpsk_snr_est_cc_impl::type() const { return d_type; }

int mpsk_snr_est_cc_impl::tag_nsample() const { return d_nsamples; }

double mpsk_snr_est_cc_impl::alpha() const { return d_alpha; }

void mpsk_snr_est_cc_impl::set_type(snr_est_type_t t)
{
    d_type = t;

    if (d_snr_est)
        delete d_snr_est;

    switch (d_type) {
    case (SNR_EST_SIMPLE):
        d_snr_est = new mpsk_snr_est_simple(d_alpha);
        break;
    case (SNR_EST_SKEW):
        d_snr_est = new mpsk_snr_est_skew(d_alpha);
        break;
    case (SNR_EST_M2M4):
        d_snr_est = new mpsk_snr_est_m2m4(d_alpha);
        break;
    case (SNR_EST_SVR):
        d_snr_est = new mpsk_snr_est_svr(d_alpha);
        break;
    default:
        throw std::invalid_argument("mpsk_snr_est_cc_impl: unknown type specified.");
    }
}

void mpsk_snr_est_cc_impl::set_tag_nsample(int n)
{
    if (n > 0) {
        d_nsamples = n;
        d_count = 0; // reset state
    } else
        throw std::invalid_argument("mpsk_snr_est_cc_impl: tag_nsamples can't be <= 0");
}

void mpsk_snr_est_cc_impl::set_alpha(double alpha)
{
    if ((alpha >= 0) && (alpha <= 1.0)) {
        d_alpha = alpha;
        if (d_snr_est)
            d_snr_est->set_alpha(d_alpha);
    } else
        throw std::invalid_argument("mpsk_snr_est_cc_impl: alpha must be in [0,1]");
}

} /* namespace digital */
} /* namespace gr */