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 class gr_costas_loop_cc;
  32 typedef boost::shared_ptr<gr_costas_loop_cc> gr_costas_loop_cc_sptr;
  33
  34 /*! \brief A Costas loop carrier recovery module.
  35  *
  36  *  The Costas loop locks to the center frequency of a signal and
  37  *  downconverts it to baseband. The second (order=2) order loop is
  38  *  used for BPSK where the real part of the output signal is the
  39  *  baseband BPSK signal and the imaginary part is the error
  40  *  signal. When order=4, it can be used for quadrature modulations
  41  *  where both I and Q (real and imaginary) are outputted.
  42  *
  43  *  More details can be found online:
  44  *
  45  *  J. Feigin, "Practical Costas loop design: Designing a simple and inexpensive
  46  *  BPSK Costas loop carrier recovery circuit," RF signal processing, pp. 20-36,
  47  *  2002.
  48  *
  49  *  http://rfdesign.com/images/archive/0102Feigin20.pdf
  50  *
  51  * \param alpha the loop gain used for phase adjustment
  52  * \param beta the loop gain for frequency adjustments
  53  * \param max_freq the maximum frequency deviation (normalized frequency) the loop can handle
  54  * \param min_freq the minimum frequency deviation (normalized frequency) the loop can handle
  55  * \param order the loop order, either 2 or 4
  56  */
  57 gr_costas_loop_cc_sptr
  58 gr_make_costas_loop_cc (float alpha, float beta,
  59                         float max_freq, float min_freq,
  60                         int order
  61                         ) throw (std::invalid_argument);
  62
  63
  64 /*!
  65  * \brief Carrier tracking PLL for QPSK
  66  * \ingroup block
  67  * input: complex; output: complex
  68  * <br>The Costas loop can have two output streams:
  69  *    stream 1 is the baseband I and Q;
  70  *    stream 2 is the normalized frequency of the loop
  71  *
  72  * \p order must be 2 or 4.
  73  */
  74 class gr_costas_loop_cc : public gr_sync_block
  75 {
  76   friend gr_costas_loop_cc_sptr gr_make_costas_loop_cc (float alpha, float beta,
  77                                                         float max_freq, float min_freq,
  78                                                         int order
  79                                                         ) throw (std::invalid_argument);
  80
  81   float d_alpha, d_beta, d_max_freq, d_min_freq, d_phase, d_freq;
  82   int d_order;
  83
  84   gr_costas_loop_cc (float alpha, float beta,
  85                      float max_freq, float min_freq,
  86                      int order
  87                      ) throw (std::invalid_argument);
  88
  89   /*! \brief the phase detector circuit for fourth-order loops
  90    *  \param sample complex sample
  91    *  \return the phase error
  92    */
  93   float phase_detector_4(gr_complex sample) const;    // for QPSK
  94
  95   /*! \breif the phase detector circuit for second-order loops
  96    *  \param a complex sample
  97    *  \return the phase error
  98    */
  99   float phase_detector_2(gr_complex sample) const;    // for BPSK
 100
 101
 102   float (gr_costas_loop_cc::*d_phase_detector)(gr_complex sample) const;
 103
 104 public:
 105
 106   int work (int noutput_items,
 107             gr_vector_const_void_star &input_items,
 108             gr_vector_void_star &output_items);
 109 };
 110
 111 #endif