Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_rms_cf.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005 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 #ifndef INCLUDED_GR_RMS_CF_H
23 #define INCLUDED_GR_RMS_CF_H
24
25 #include <gr_sync_block.h>
26 #include <gr_single_pole_iir.h>
27
28 class gr_rms_cf;
29 typedef boost::shared_ptr<gr_rms_cf> gr_rms_cf_sptr;
30
31 gr_rms_cf_sptr
32 gr_make_rms_cf (double alpha = 0.0001);
33
34 /*!
35  * \brief RMS average power
36  */
37 class gr_rms_cf : public gr_sync_block
38 {
39   gr_single_pole_iir<double,double,double>      d_iir;
40   bool                                          d_unmuted;
41
42   friend gr_rms_cf_sptr
43   gr_make_rms_cf (double alpha);
44
45   gr_rms_cf (double alpha);
46
47 public:
48   ~gr_rms_cf ();
49
50   int work (int noutput_items,
51             gr_vector_const_void_star &input_items,
52             gr_vector_void_star &output_items);
53
54   bool unmuted () const { return d_unmuted; }
55
56   void set_alpha (double alpha);
57 };
58
59 #endif /* INCLUDED_GR_RMS_CF_H */