Updated license from GPL version 2 or later to GPL version 3 or later.
[debian/gnuradio] / gr-atsc / src / lib / atsc_bit_timing_loop.cc
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #endif
26
27 #include <atsc_bit_timing_loop.h>
28 #include <gr_io_signature.h>
29 #include <atsc_consts.h>
30
31 // Input rate changed from 20MHz to 19.2 to support usrp at 3 * 6.4MHz
32 float input_rate = 19.2e6;
33 double ratio_of_rx_clock_to_symbol_freq = input_rate / ATSC_SYMBOL_RATE;
34
35
36 atsc_bit_timing_loop_sptr
37 atsc_make_bit_timing_loop()
38 {
39   return atsc_bit_timing_loop_sptr(new atsc_bit_timing_loop());
40 }
41
42
43 atsc_bit_timing_loop::atsc_bit_timing_loop()
44   : gr_block("atsc_bit_timing_loop",
45                   gr_make_io_signature(1, 1, sizeof(float)),
46                   gr_make_io_signature(2, 2, sizeof(float))),
47                   d_interp(ratio_of_rx_clock_to_symbol_freq), d_next_input(0),
48                   d_rx_clock_to_symbol_freq (ratio_of_rx_clock_to_symbol_freq),
49                   d_si(0)
50 {
51   reset();
52 }
53
54 void
55 atsc_bit_timing_loop::forecast (int noutput_items, gr_vector_int &ninput_items_required)
56 {
57   unsigned ninputs = ninput_items_required.size();
58   for (unsigned i = 0; i < ninputs; i++)
59     ninput_items_required[i] = static_cast<int>(noutput_items * d_rx_clock_to_symbol_freq) + 1500 - 1;
60
61 }
62
63 int
64 atsc_bit_timing_loop::general_work (int noutput_items,
65                                  gr_vector_int &ninput_items,
66                                  gr_vector_const_void_star &input_items,
67                                  gr_vector_void_star &output_items)
68 {
69   int   r = work (noutput_items, input_items, output_items);
70   if (r > 0)
71     consume_each (d_si);
72   return r;
73 }
74
75
76 int
77 atsc_bit_timing_loop::work (int noutput_items,
78                        gr_vector_const_void_star &input_items,
79                        gr_vector_void_star &output_items)
80 {
81   const float *in = (const float *) input_items[0];
82   float *out_sample = (float *) output_items[0];
83   atsc::syminfo *out_tag = (atsc::syminfo *) output_items[1];
84
85   assert(sizeof(float) == sizeof(atsc::syminfo));
86
87   // We are tasked with producing output.size output samples.
88   // We will consume approximately 2 * output.size input samples.
89
90   unsigned int  k;              // output index
91
92   float         interp_sample;
93   int           symbol_index;
94   double        timing_adjustment = 0;
95   bool          seg_locked;
96   atsc::syminfo    tag;
97   // ammount requested in forecast
98   unsigned long input_size = noutput_items * d_rx_clock_to_symbol_freq + 1500 -1;
99
100   memset (&tag, 0, sizeof (tag));
101
102   // ammount actually consumed
103   d_si = 0;
104   
105   for (k = 0; k < noutput_items; k++){
106     if (!d_interp.update (in, input_size, &d_si, timing_adjustment, &interp_sample)){
107       fprintf (stderr, "GrAtscBitTimingLoop3: ran short on data...\n");
108       break;
109     }
110
111     d_sssr.update (interp_sample, &seg_locked, &symbol_index, &timing_adjustment);
112     out_sample[k] = interp_sample;
113     tag.valid = seg_locked;
114     tag.symbol_num = symbol_index;
115     out_tag[k] = tag;
116
117   }
118
119   return k;
120 }