3 * Copyright 2004,206 Free Software Foundation, Inc.
5 * This file is part of GNU Radio
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)
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.
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.
23 #ifndef INCLUDED_GR_PLL_CARRIERTRACKING_CC_H
24 #define INCLUDED_GR_PLL_CARRIERTRACKING_CC_H
26 #include <gr_sync_block.h>
28 class gr_pll_carriertracking_cc;
29 typedef boost::shared_ptr<gr_pll_carriertracking_cc> gr_pll_carriertracking_cc_sptr;
31 gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float alpha, float beta,
32 float max_freq, float min_freq);
34 * \brief Implements a PLL which locks to the input frequency and outputs the
35 * input signal mixed with that carrier.
38 * input: stream of complex; output: stream of complex
40 * This PLL locks onto a [possibly noisy] reference carrier on
41 * the input and outputs that signal, downconverted to DC
43 * All settings max_freq and min_freq are in terms of radians per sample,
44 * NOT HERTZ. Alpha is the phase gain (first order, units of radians per radian)
45 * and beta is the frequency gain (second order, units of radians per sample per radian)
46 * \sa gr_pll_freqdet_cf, gr_pll_carriertracking_cc
49 class gr_pll_carriertracking_cc : public gr_sync_block
51 friend gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float alpha, float beta,
52 float max_freq, float min_freq);
54 float d_alpha,d_beta,d_max_freq,d_min_freq,d_phase,d_freq,d_locksig,d_lock_threshold;
55 bool d_squelch_enable;
56 gr_pll_carriertracking_cc (float alpha, float beta, float max_freq, float min_freq);
58 int work (int noutput_items,
59 gr_vector_const_void_star &input_items,
60 gr_vector_void_star &output_items);
62 float mod_2pi (float in);
63 float phase_detector(gr_complex sample,float ref_phase);
65 bool lock_detector(void);
66 bool squelch_enable(bool);
67 float set_lock_threshold(float);