git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/general/gri_agc_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 2, 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 #ifndef INCLUDED_GRI_AGC_CC_H
  24 #define INCLUDED_GRI_AGC_CC_H
  25
  26 #include <math.h>
  27
  28 /*!
  29  * \brief high performance Automatic Gain Control class
  30  *
  31  * For Power the absolute value of the complex number is used.
  32  */
  33
  34 class gri_agc_cc {
  35
  36  public:
  37   gri_agc_cc (float rate = 1e-4, float reference = 1.0,
  38               float gain = 1.0, float max_gain = 0.0)
  39     : _rate(rate), _reference(reference),
  40       _gain(gain), _max_gain(max_gain) {};
  41
  42   float rate () const      { return _rate; }
  43   float reference () const { return _reference; }
  44   float gain () const      { return _gain;  }
  45   float max_gain() const   { return _max_gain; }
  46
  47   void set_rate (float rate) { _rate = rate; }
  48   void set_reference (float reference) { _reference = reference; }
  49   void set_gain (float gain) { _gain = gain; }
  50   void set_max_gain(float max_gain) { _max_gain = max_gain; }
  51
  52   gr_complex scale (gr_complex input){
  53     gr_complex output = input * _gain;
  54
  55     _gain +=  _rate * (_reference - sqrt(output.real()*output.real() +
  56                                          output.imag()*output.imag()));
  57     if (_max_gain > 0.0 && _gain > _max_gain)
  58        _gain = _max_gain;
  59     return output;
  60   }
  61
  62   void scaleN (gr_complex output[], const gr_complex input[], unsigned n){
  63     for (unsigned i = 0; i < n; i++)
  64       output[i] = scale (input[i]);
  65   }
  66
  67  protected:
  68   float _rate;                  // adjustment rate
  69   float _reference;             // reference value
  70   float _gain;                  // current gain
  71   float _max_gain;              // max allowable gain
  72 };
  73
  74 #endif /* INCLUDED_GRI_AGC_CC_H */