Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_pll_refout_cc.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 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
25 #ifndef INCLUDED_GR_PLL_REFOUT_CC_H
26 #define INCLUDED_GR_PLL_REFOUT_CC_H
27
28 #include <gr_sync_block.h>
29
30 class gr_pll_refout_cc;
31 typedef boost::shared_ptr<gr_pll_refout_cc> gr_pll_refout_cc_sptr;
32
33 gr_pll_refout_cc_sptr gr_make_pll_refout_cc (float alpha, float beta,
34                                                float max_freq, float min_freq);
35 /*!
36  * \brief Implements a PLL which locks to the input frequency and outputs a carrier
37  * \ingroup sync_blk
38  *
39  * input: stream of complex; output: stream of complex
40  *
41  * This PLL locks onto a [possibly noisy] reference carrier on
42  * the input and outputs a clean version which is phase and frequency
43  * aligned to it.
44  * 
45  * All settings max_freq and min_freq are in terms of radians per sample, 
46  * NOT HERTZ.  Alpha is the phase gain (first order, units of radians per radian) 
47  * and beta is the frequency gain (second order, units of radians per sample per radian)
48  * \sa gr_pll_freqdet_cf, gr_pll_carriertracking_cc
49  */
50 class gr_pll_refout_cc : public gr_sync_block
51 {
52   friend gr_pll_refout_cc_sptr gr_make_pll_refout_cc (float alpha, float beta,
53                                                         float max_freq, float min_freq);
54
55   float d_alpha,d_beta,d_max_freq,d_min_freq,d_phase,d_freq;
56   gr_pll_refout_cc (float alpha, float beta, float max_freq, float min_freq);
57
58   int work (int noutput_items,
59             gr_vector_const_void_star &input_items,
60             gr_vector_void_star &output_items);
61 private:
62   float mod_2pi (float in);
63   float phase_detector(gr_complex sample,float ref_phase);
64 };
65
66 #endif