Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_squelch_base_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_GR_SQUELCH_BASE_CC_H
24 #define INCLUDED_GR_SQUELCH_BASE_CC_H
25
26 #include <gr_block.h>
27
28 class gr_squelch_base_cc : public gr_block
29 {
30 private:
31   int    d_ramp;
32   int    d_ramped;
33   bool   d_gate;
34   double d_envelope;
35   enum { ST_MUTED, ST_ATTACK, ST_UNMUTED, ST_DECAY } d_state;
36
37 protected:
38   virtual void update_state(const gr_complex &sample) {};
39   virtual bool mute() const { return false; };
40
41 public:
42   gr_squelch_base_cc(const char *name, int ramp, bool gate);
43
44   int ramp() const { return d_ramp; }
45   void set_ramp(int ramp) { d_ramp = ramp; }
46   bool gate() const { return d_gate; }
47   void set_gate(bool gate) { d_gate = gate; }
48   bool unmuted() const { return (d_state == ST_UNMUTED || d_state == ST_ATTACK); }
49
50   virtual std::vector<float> squelch_range() const = 0;
51
52   int general_work (int noutput_items,
53                     gr_vector_int &ninput_items,
54                     gr_vector_const_void_star &input_items,
55                     gr_vector_void_star &output_items);
56 };
57
58 #endif /* INCLUDED_GR_SQUELCH_BASE_CC_H */