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