Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_agc_ff.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005,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 INCLUDED_GR_AGC_FF_H
24 #define INCLUDED_GR_AGC_FF_H
25
26 #include <gr_sync_block.h>
27 #include <gri_agc_ff.h>
28 class gr_agc_ff;
29 typedef boost::shared_ptr<gr_agc_ff> gr_agc_ff_sptr;
30
31 gr_agc_ff_sptr
32 gr_make_agc_ff (float rate = 1e-4, float reference = 1.0, 
33                 float gain = 1.0, float max_gain = 0.0);
34
35 /*!
36  * \brief high performance Automatic Gain Control class
37  * \ingroup level_blk
38  *
39  * Power is approximated by absolute value
40  */
41
42 class gr_agc_ff : public gr_sync_block, public gri_agc_ff
43 {
44   friend gr_agc_ff_sptr gr_make_agc_ff (float rate, float reference, 
45                                         float gain, float max_gain);
46   gr_agc_ff (float rate, float reference, float gain, float max_gain);
47
48  public:
49   virtual int work (int noutput_items,
50                     gr_vector_const_void_star &input_items,
51                     gr_vector_void_star &output_items);
52 };
53
54 #endif /* INCLUDED_GR_FLOAT_AGC_FF_H */