GNU Radio 3.5.1 C++ API
gr_pll_refout_cc.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2011 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_PLL_REFOUT_CC_H
00024 #define INCLUDED_GR_PLL_REFOUT_CC_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_sync_block.h>
00028 #include <gri_control_loop.h>
00029 
00030 class gr_pll_refout_cc;
00031 typedef boost::shared_ptr<gr_pll_refout_cc> gr_pll_refout_cc_sptr;
00032 
00033 GR_CORE_API gr_pll_refout_cc_sptr gr_make_pll_refout_cc (float loop_bw,
00034                                              float max_freq, float min_freq);
00035 /*!
00036  * \brief Implements a PLL which locks to the input frequency and outputs a carrier
00037  * \ingroup sync_blk
00038  *
00039  * input: stream of complex; output: stream of complex
00040  *
00041  * This PLL locks onto a [possibly noisy] reference carrier on
00042  * the input and outputs a clean version which is phase and frequency
00043  * aligned to it.
00044  * 
00045  * All settings max_freq and min_freq are in terms of radians per sample, 
00046  * NOT HERTZ.  The loop bandwidth determins the lock range and should be set
00047  * around pi/200 -- 2pi/100.
00048  * \sa gr_pll_freqdet_cf, gr_pll_carriertracking_cc
00049  */
00050 class GR_CORE_API gr_pll_refout_cc : public gr_sync_block, public gri_control_loop
00051 {
00052   friend GR_CORE_API gr_pll_refout_cc_sptr gr_make_pll_refout_cc (float loop_bw,
00053                                                       float max_freq, float min_freq);
00054 
00055   gr_pll_refout_cc (float loop_bw, float max_freq, float min_freq);
00056 
00057   int work (int noutput_items,
00058             gr_vector_const_void_star &input_items,
00059             gr_vector_void_star &output_items);
00060 private:
00061   float mod_2pi (float in);
00062   float phase_detector(gr_complex sample, float ref_phase);
00063 };
00064 
00065 #endif