Updated FSF address in all files. Fixes ticket:51
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_costas_loop_cc.h
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 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
24 #ifndef INCLUDED_GR_COSTAS_LOOP_CC_H
25 #define INCLUDED_GR_COSTAS_LOOP_CC_H
26
27 #include <gr_sync_block.h>
28 #include <stdexcept>
29
30 class gr_costas_loop_cc;
31 typedef boost::shared_ptr<gr_costas_loop_cc> gr_costas_loop_cc_sptr;
32
33 gr_costas_loop_cc_sptr 
34 gr_make_costas_loop_cc (float alpha, float beta,
35                         float max_freq, float min_freq, 
36                         int order
37                         ) throw (std::invalid_argument);
38
39
40 /*!
41  * \brief Carrier tracking PLL for QPSK
42  * input: complex; output: complex
43  *
44  * \p order must be 2 or 4.
45  */
46 class gr_costas_loop_cc : public gr_sync_block
47 {
48   friend gr_costas_loop_cc_sptr gr_make_costas_loop_cc (float alpha, float beta,
49                                                         float max_freq, float min_freq, 
50                                                         int order
51                                                         ) throw (std::invalid_argument);
52
53   float d_alpha, d_beta, d_max_freq, d_min_freq, d_phase, d_freq;
54   int d_order;
55
56   gr_costas_loop_cc (float alpha, float beta,
57                      float max_freq, float min_freq, 
58                      int order
59                      ) throw (std::invalid_argument);
60
61   float phase_detector_4(gr_complex sample) const;    // for QPSK
62   float phase_detector_2(gr_complex sample) const;    // for BPSK
63   float (gr_costas_loop_cc::*d_phase_detector)(gr_complex sample) const;
64
65 public:
66
67   int work (int noutput_items,
68             gr_vector_const_void_star &input_items,
69             gr_vector_void_star &output_items);
70 };
71
72 #endif