Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_align_on_samplenumbers_ss.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005 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 2, 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 #ifndef INCLUDED_GR_ALIGN_ON_SAMPLE_NUMBERS_SS_H
24 #define INCLUDED_GR_ALIGN_ON_SAMPLE_NUMBERS_SS_H
25
26 #include <gr_block.h>
27
28 class gr_align_on_samplenumbers_ss;
29 typedef boost::shared_ptr<gr_align_on_samplenumbers_ss> gr_align_on_samplenumbers_ss_sptr;
30
31 gr_align_on_samplenumbers_ss_sptr gr_make_align_on_samplenumbers_ss (int nchan=2, int align_interval=128);
32
33 /*!
34  * \brief align several complex short (interleaved short) input channels with corresponding unsigned 32 bit sample_counters (provided as interleaved 16 bit values)
35  * \param number of complex_short input channels (including the 32 bit counting channel)
36  * \param align_interval is after how much samples (minimally) the sample-alignement is refreshed. Default is 128.
37  * A bigger value means less processing power but also requests more buffer space, which has a maximum.
38  * Decrease the align_interval if you get an error like:
39  * "sched: <gr_block align_on_samplenumbers_ss (0)> is requesting more input data  than we can provide.
40  *  ninput_items_required = 32768
41  *  max_possible_items_available = 16383
42  *  If this is a filter, consider reducing the number of taps."
43  * \ingroup block
44  * Pay attention on how you connect this block.
45  * It expects a minimum of 2 usrp_source_s with nchan number of channels and FPGA_MODE_COUNTING_32BIT enabled.
46  * This means that the first complex_short channel on every input is an interleaved 32 bit counter. 
47  * The samples are aligned by dropping samples untill the samplenumbers match.
48  */
49
50
51 class gr_align_on_samplenumbers_ss : public gr_block
52 {
53   int  d_align_interval;
54   int  d_sample_counter;
55   int  d_nchan;
56   bool d_in_presync;
57   unsigned int d_ninputs;
58   class align_state {
59       public:
60         unsigned int ucounter_end;
61         unsigned int ucounter_begin;
62         int diff;
63         int diff_comp;
64         int diff_end;
65         int diff_comp_end;
66         bool sync_found;
67         bool sync_end_found;
68         int ninput_items;
69         int ninput_items_used;
70       };
71   std::vector<align_state>   d_state;
72     
73   friend gr_align_on_samplenumbers_ss_sptr gr_make_align_on_samplenumbers_ss (int nchan,int align_interval);
74   gr_align_on_samplenumbers_ss (int nchan,int align_interval);
75
76  public:
77    ~gr_align_on_samplenumbers_ss();
78   bool check_topology (int ninputs, int noutputs);
79   void forecast (int noutput_items,
80         gr_vector_int &ninput_items_required);
81
82   int general_work (int noutput_items,
83         gr_vector_int &ninput_items,
84         gr_vector_const_void_star &input_items,
85         gr_vector_void_star &output_items);
86 };
87
88
89 #endif /* INCLUDED_GR_ALIGN_ON_SAMPLE_NUMBERS_SS_H */