Imported Upstream version 3.0.4
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_ctcss_squelch_ff.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 INCLUDED_GR_CTCSS_SQUELCH_FF_H
24 #define INCLUDED_GR_CTCSS_SQUELCH_FF_H
25
26 #include <gr_squelch_base_ff.h>
27 #include <gri_goertzel.h>
28
29 class gr_ctcss_squelch_ff;
30 typedef boost::shared_ptr<gr_ctcss_squelch_ff> gr_ctcss_squelch_ff_sptr;
31
32 gr_ctcss_squelch_ff_sptr 
33 gr_make_ctcss_squelch_ff(int rate, float freq, float level=0.01, int len=0, int ramp=0, bool gate=false);
34
35 /*!
36  * \brief gate or zero output if ctcss tone not present
37  * \ingroup block
38  */
39 class gr_ctcss_squelch_ff : public gr_squelch_base_ff
40 {
41 private:
42   float d_freq;
43   float d_level;
44   int   d_len;
45   bool  d_mute;
46      
47   gri_goertzel d_goertzel_l;
48   gri_goertzel d_goertzel_c;
49   gri_goertzel d_goertzel_r;
50
51   friend gr_ctcss_squelch_ff_sptr gr_make_ctcss_squelch_ff(int rate, float freq, float level, int len, int ramp, bool gate);
52   gr_ctcss_squelch_ff(int rate, float freq, float level, int len, int ramp, bool gate);
53
54   int find_tone(float freq);
55
56 protected:
57   virtual void update_state(const float &in);
58   virtual bool mute() const { return d_mute; }
59   
60 public:
61   std::vector<float> squelch_range() const;
62   float level() const { return d_level; }
63   void set_level(float level) { d_level = level; }
64   int len() const { return d_len; }
65 };
66
67 #endif /* INCLUDED_GR_CTCSS_SQUELCH_FF_H */