git.gag.com Git - debian/gnuradio/blob - 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 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_COSTAS_LOOP_CC_H
  25 #define INCLUDED_GR_COSTAS_LOOP_CC_H
  26
  27 #include <gr_sync_block.h>
  28 #include <stdexcept>
  29 #include <fstream>
  30
  31
  32 /*! \brief A Costas loop carrier recovery module.
  33  * \ingroup sync_blk
  34  *
  35  *  The Costas loop locks to the center frequency of a signal and
  36  *  downconverts it to baseband. The second (order=2) order loop is
  37  *  used for BPSK where the real part of the output signal is the
  38  *  baseband BPSK signal and the imaginary part is the error
  39  *  signal. When order=4, it can be used for quadrature modulations
  40  *  where both I and Q (real and imaginary) are outputted.
  41  *
  42  *  More details can be found online:
  43  *
  44  *  J. Feigin, "Practical Costas loop design: Designing a simple and inexpensive
  45  *  BPSK Costas loop carrier recovery circuit," RF signal processing, pp. 20-36,
  46  *  2002.
  47  *
  48  *  http://rfdesign.com/images/archive/0102Feigin20.pdf
  49  *
  50  * \param alpha the loop gain used for phase adjustment
  51  * \param beta the loop gain for frequency adjustments
  52  * \param max_freq the maximum frequency deviation (radians/sample) the loop can handle
  53  * \param min_freq the minimum frequency deviation (radians/sample) the loop can handle
  54  * \param order the loop order, either 2 or 4
  55  */
  56 class gr_costas_loop_cc;
  57 typedef boost::shared_ptr<gr_costas_loop_cc> gr_costas_loop_cc_sptr;
  58
  59
  60 gr_costas_loop_cc_sptr
  61 gr_make_costas_loop_cc (float alpha, float beta,
  62                         float max_freq, float min_freq,
  63                         int order
  64                         ) throw (std::invalid_argument);
  65
  66
  67 /*!
  68  * \brief Carrier tracking PLL for QPSK
  69  * \ingroup sync_blk
  70  * input: complex; output: complex
  71  * <br>The Costas loop can have two output streams:
  72  *    stream 1 is the baseband I and Q;
  73  *    stream 2 is the normalized frequency of the loop
  74  *
  75  * \p order must be 2 or 4.
  76  */
  77 class gr_costas_loop_cc : public gr_sync_block
  78 {
  79   friend gr_costas_loop_cc_sptr gr_make_costas_loop_cc (float alpha, float beta,
  80                                                         float max_freq, float min_freq,
  81                                                         int order
  82                                                         ) throw (std::invalid_argument);
  83
  84   float d_alpha, d_beta, d_max_freq, d_min_freq, d_phase, d_freq;
  85   int d_order;
  86
  87   gr_costas_loop_cc (float alpha, float beta,
  88                      float max_freq, float min_freq,
  89                      int order
  90                      ) throw (std::invalid_argument);
  91
  92   /*! \brief the phase detector circuit for fourth-order loops
  93    *  \param sample complex sample
  94    *  \return the phase error
  95    */
  96   float phase_detector_4(gr_complex sample) const;    // for QPSK
  97
  98   /*! \brief the phase detector circuit for second-order loops
  99    *  \param sample a complex sample
 100    *  \return the phase error
 101    */
 102   float phase_detector_2(gr_complex sample) const;    // for BPSK
 103
 104
 105   float (gr_costas_loop_cc::*d_phase_detector)(gr_complex sample) const;
 106
 107 public:
 108
 109   /*! \brief set the first order gain
 110    *  \param alpha
 111    */
 112   void set_alpha(float alpha);
 113
 114   /*! \brief get the first order gain
 115    *
 116    */
 117   float alpha() const { return d_alpha; }
 118
 119   /*! \brief set the second order gain
 120    *  \param beta
 121    */
 122   void set_beta(float beta);
 123
 124   /*! \brief get the second order gain
 125    *
 126    */
 127   float beta() const { return d_beta; }
 128
 129   int work (int noutput_items,
 130             gr_vector_const_void_star &input_items,
 131             gr_vector_void_star &output_items);
 132
 133   /*! \brief returns the current NCO frequency in radians/sample
 134    *
 135    */
 136   float freq() const { return d_freq; }
 137 };
 138
 139 #endif