Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / filter / gr_filter_delay_fc.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 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_FILTER_DELAY_FC_H
24 #define INCLUDED_GR_FILTER_DELAY_FC_H
25
26 #include <gr_sync_block.h>
27 #include <gr_io_signature.h>
28 #include <gr_types.h>
29
30 class gr_filter_delay_fc;
31 typedef boost::shared_ptr<gr_filter_delay_fc> gr_filter_delay_fc_sptr;
32
33 // public constructor
34 gr_filter_delay_fc_sptr gr_make_filter_delay_fc (const std::vector<float> &taps);
35
36 class gr_fir_fff;
37
38 /*!
39  * \brief Filter-Delay Combination Block.
40  * \ingroup filter
41  *
42  * The block takes one or two float stream and outputs a complex
43  * stream. If only one float stream is input, the real output is
44  * a delayed version of this input and the imaginary output is the
45  * filtered output. If two floats are connected to the input, then
46  * the real output is the delayed version of the first input, and
47  * the imaginary output is the filtered output. The delay in the 
48  * real path accounts for the group delay introduced by the filter
49  * in the imaginary path. The filter taps needs to be calculated
50  * before initializing this block.
51  *
52  */
53 class gr_filter_delay_fc : public gr_sync_block
54 {
55  public:
56   ~gr_filter_delay_fc ();
57
58   int work (int noutput_items,
59             gr_vector_const_void_star &input_items,
60             gr_vector_void_star &output_items);
61
62  protected:
63   gr_filter_delay_fc (const std::vector<float> &taps);
64
65  private:
66   unsigned int  d_delay;
67   gr_fir_fff    *d_fir;
68
69   friend gr_filter_delay_fc_sptr gr_make_filter_delay_fc (const std::vector<float> &taps);
70 };
71
72 #endif /* INCLUDED_GR_FILTER_DELAY_FC_H */