Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_simple_squelch_cc.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 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 #ifndef INCLUDED_GR_SIMPLE_SQUELCH_CC_H
23 #define INCLUDED_GR_SIMPLE_SQUELCH_CC_H
24
25 #include <gr_sync_block.h>
26 #include <gr_single_pole_iir.h>
27
28 class gr_simple_squelch_cc;
29 typedef boost::shared_ptr<gr_simple_squelch_cc> gr_simple_squelch_cc_sptr;
30
31 gr_simple_squelch_cc_sptr
32 gr_make_simple_squelch_cc (double threshold_db, double alpha = 0.0001);
33
34 /*!
35  * \brief simple squelch block based on average signal power and threshold in dB.
36  * \ingroup level_blk
37  */
38 class gr_simple_squelch_cc : public gr_sync_block
39 {
40   double                                        d_threshold;
41   gr_single_pole_iir<double,double,double>      d_iir;
42   bool                                          d_unmuted;
43
44   friend gr_simple_squelch_cc_sptr
45   gr_make_simple_squelch_cc (double threshold_db, double alpha);
46
47   gr_simple_squelch_cc (double threshold_db, double alpha);
48
49 public:
50   ~gr_simple_squelch_cc ();
51
52   int work (int noutput_items,
53             gr_vector_const_void_star &input_items,
54             gr_vector_void_star &output_items);
55
56   bool unmuted () const { return d_unmuted; }
57
58   void set_alpha (double alpha);
59   void set_threshold (double decibels);
60
61   double threshold() const;
62   std::vector<float> squelch_range() const;
63
64 };
65
66 #endif /* INCLUDED_GR_SIMPLE_SQUELCH_CC_H */