git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/general/gr_fll_band_edge_cc.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_FLL_BAND_EDGE_CC_H
  25 #define INCLUDED_GR_FLL_BAND_EDGE_CC_H
  26
  27 #include <gr_sync_block.h>
  28
  29 class gr_fll_band_edge_cc;
  30 typedef boost::shared_ptr<gr_fll_band_edge_cc> gr_fll_band_edge_cc_sptr;
  31 gr_fll_band_edge_cc_sptr gr_make_fll_band_edge_cc (float samps_per_sym, float rolloff,
  32                                                    int filter_size, float alpha, float beta);
  33
  34 class gr_fir_ccc;
  35 class gri_fft_complex;
  36
  37 /*!
  38  * \class gr_fll_band_edge_cc
  39  * \brief Frequency Lock Loop using band-edge filters
  40  *
  41  * \ingroup general
  42  */
  43
  44 class gr_fll_band_edge_cc : public gr_sync_block
  45 {
  46  private:
  47   /*!
  48    * Build the FLL
  49    * \param taps    (vector/list of gr_complex) The taps of the band-edge filter
  50    */
  51   friend gr_fll_band_edge_cc_sptr gr_make_fll_band_edge_cc (float samps_per_sym, float rolloff,
  52                                                             int filter_size, float alpha, float beta);
  53
  54   float                   d_alpha;
  55   float                   d_beta;
  56   float                   d_max_freq;
  57   float                   d_min_freq;
  58
  59   gr_fir_ccc*             d_filter_upper;
  60   gr_fir_ccc*             d_filter_lower;
  61   bool                    d_updated;
  62   float                   d_error;
  63   float                   d_freq;
  64   float                   d_phase;
  65
  66   /*!
  67    * Build the FLL
  68    * \param taps    (vector/list of gr_complex) The taps of the band-edge filter
  69    */
  70   gr_fll_band_edge_cc(float samps_per_sym, float rolloff,
  71                       int filter_size, float alpha, float beta);
  72
  73 public:
  74   ~gr_fll_band_edge_cc ();
  75
  76   /*!
  77    * Design the band-edge filter based on the number of samples per symbol,
  78    * filter rolloff factor, and the filter size
  79    * \param samps_per_sym    (float) Number of samples per symbol of signal
  80    * \param rolloff          (float) Rolloff factor of signal
  81    * \param filter_size      (int)   Size (in taps) of the filter
  82    */
  83   void design_filter(float samps_per_sym, float rolloff, int filter_size);
  84
  85   /*!
  86    * Set the alpha gainvalue
  87    * \param alpha    (float) new gain value
  88    */
  89   void set_alpha(float alpha);
  90
  91   /*!
  92    * Set the beta gain value
  93    * \param beta    (float) new gain value
  94    */
  95   void set_beta(float beta) { d_beta = beta; }
  96
  97   /*!
  98    * Print the taps to screen.
  99    */
 100   void print_taps();
 101
 102   int work (int noutput_items,
 103             gr_vector_const_void_star &input_items,
 104             gr_vector_void_star &output_items);
 105 };
 106
 107 #endif