Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / filter / gr_goertzel_fc.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_GOERTZEL_FC_H
24 #define INCLUDED_GR_GOERTZEL_FC_H
25
26 #include <gri_goertzel.h>
27 #include <gr_sync_decimator.h>
28
29 class gr_goertzel_fc;
30 typedef boost::shared_ptr<gr_goertzel_fc> gr_goertzel_fc_sptr;
31
32 // public constructor
33 gr_goertzel_fc_sptr gr_make_goertzel_fc(int rate, int len, float freq);
34
35 /*!
36  * \brief Goertzel single-bin DFT calculation.
37  * \ingroup filter
38  */
39 class gr_goertzel_fc : public gr_sync_decimator
40 {
41 private:
42   friend gr_goertzel_fc_sptr gr_make_goertzel_fc (int rate, int len, float freq);
43
44   gr_goertzel_fc(int rate, int len, float freq);
45   gri_goertzel d_goertzel;
46   int          d_len;
47
48 public:
49   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_GOERTZEL_FC_H */
55