Working on allowing fractional samples per symbol.
[debian/gnuradio] / gnuradio-core / src / lib / filter / gr_pfb_clock_sync_ccf.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2009 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
24 #ifndef INCLUDED_GR_PFB_CLOCK_SYNC_CCF_H
25 #define INCLUDED_GR_PFB_CLOCK_SYNC_CCF_H
26
27 #include <gr_block.h>
28
29 class gr_pfb_clock_sync_ccf;
30 typedef boost::shared_ptr<gr_pfb_clock_sync_ccf> gr_pfb_clock_sync_ccf_sptr;
31 gr_pfb_clock_sync_ccf_sptr gr_make_pfb_clock_sync_ccf (float sps, float gain,
32                                                        const std::vector<float> &taps,
33                                                        unsigned int filter_size=32,
34                                                        float init_phase=0,
35                                                        float max_rate_deviation=1.5);
36
37 class gr_fir_ccf;
38
39 /*!
40  * \class gr_pfb_clock_sync_ccf
41  *
42  * \brief Timing synchronizer using polyphase filterbanks
43  *
44  * \ingroup filter_blk
45  * 
46  */
47
48 class gr_pfb_clock_sync_ccf : public gr_block
49 {
50  private:
51   /*!
52    * Build the polyphase filterbank timing synchronizer.
53    */
54   friend gr_pfb_clock_sync_ccf_sptr gr_make_pfb_clock_sync_ccf (float sps, float gain,
55                                                                 const std::vector<float> &taps,
56                                                                 unsigned int filter_size,
57                                                                 float init_phase,
58                                                                 float max_rate_deviation);
59
60   bool                     d_updated;
61   float                    d_sps;
62   float                    d_alpha;
63   float                    d_beta;
64   float                    d_sample_num;
65   int                      d_nfilters;
66   std::vector<gr_fir_ccf*> d_filters;
67   std::vector<gr_fir_ccf*> d_diff_filters;
68   std::vector< std::vector<float> > d_taps;
69   std::vector< std::vector<float> > d_dtaps;
70   float                    d_k;
71   float                    d_rate;
72   float                    d_max_dev;
73   int                      d_filtnum;
74   int                      d_taps_per_filter;
75   unsigned int             d_start_count;
76
77   /*!
78    * Build the polyphase filterbank timing synchronizer.
79    */
80   gr_pfb_clock_sync_ccf (float sps, float gain,
81                          const std::vector<float> &taps,
82                          unsigned int filter_size,
83                          float init_phase,
84                          float max_rate_deviation);
85   
86   void create_diff_taps(const std::vector<float> &newtaps,
87                         std::vector<float> &difftaps);
88
89 public:
90   ~gr_pfb_clock_sync_ccf ();
91   
92   /*!
93    * Resets the filterbank's filter taps with the new prototype filter
94    */
95   void set_taps (const std::vector<float> &taps,
96                  std::vector< std::vector<float> > &ourtaps,
97                  std::vector<gr_fir_ccf*> &ourfilter);
98   std::vector<float> channel_taps(int channel);
99   std::vector<float> diff_channel_taps(int channel);
100
101   /*!
102    * Print all of the filterbank taps to screen.
103    */
104   void print_taps();
105   void print_diff_taps();
106
107   void set_alpha(float alpha)
108   {
109     d_alpha = alpha;
110   }
111   void set_beta(float beta)
112   {
113     d_beta = beta;
114   }
115
116   void set_max_rate_deviation(float m)
117   {
118     d_max_dev = m;
119   }
120   
121   int general_work (int noutput_items,
122                     gr_vector_int &ninput_items,
123                     gr_vector_const_void_star &input_items,
124                     gr_vector_void_star &output_items);
125 };
126
127 #endif