git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/general/gri_agc2_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 #ifndef _GRI_AGC2_CC_H_
  24 #define _GRI_AGC2_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 class gri_agc2_cc {
  34
  35  public:
  36   gri_agc2_cc (float attack_rate = 1e-1, float decay_rate = 1e-2, float reference = 1.0,
  37                float gain = 1.0, float max_gain = 0.0)
  38     : _attack_rate(attack_rate), _decay_rate(decay_rate), _reference(reference),
  39       _gain(gain), _max_gain(max_gain) {};
  40
  41   float decay_rate () const  { return _decay_rate; }
  42   float attack_rate () const { return _attack_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_decay_rate (float rate) { _decay_rate = rate; }
  48   void set_attack_rate (float rate) { _attack_rate = rate; }
  49   void set_reference (float reference) { _reference = reference; }
  50   void set_gain (float gain) { _gain = gain; }
  51   void set_max_gain(float max_gain) { _max_gain = max_gain; }
  52
  53   gr_complex scale (gr_complex input){
  54     gr_complex output = input * _gain;
  55
  56     float tmp = -_reference + sqrt(output.real()*output.real() +
  57                                    output.imag()*output.imag());
  58     float rate = _decay_rate;
  59     if((tmp) > _gain)
  60         rate = _attack_rate;
  61     _gain -= tmp*rate;
  62
  63 #if 0
  64     fprintf(stdout, "rate = %f\ttmp = %f\t gain = %f\n", rate, tmp, _gain);
  65 #endif
  66
  67     // Not sure about this; will blow up if _gain < 0 (happens when rates are too high),
  68     // but is this the solution?
  69     if (_gain < 0.0)
  70         _gain = 10e-5;
  71
  72     if (_max_gain > 0.0 && _gain > _max_gain)
  73        _gain = _max_gain;
  74     return output;
  75   }
  76
  77   void scaleN (gr_complex output[], const gr_complex input[], unsigned n){
  78     for (unsigned i = 0; i < n; i++)
  79       output[i] = scale (input[i]);
  80   }
  81
  82  protected:
  83   float _attack_rate;           // attack rate for fast changing signals
  84   float _decay_rate;            // decay rate for slow changing signals
  85   float _reference;             // reference value
  86   float _gain;                  // current gain
  87   float _max_gain;              // max allowable gain
  88 };
  89
  90 #endif /* _GRI_AGC2_CC_H_ */