Merge commit 'v3.3.0' into upstream
[debian/gnuradio] / gr-atsc / src / lib / atsc_equalizer.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 #ifndef INCLUDED_ATSC_EQUALIZER_H
23 #define INCLUDED_ATSC_EQUALIZER_H
24
25 #include <gr_sync_block.h>
26 #include <atsci_equalizer.h>
27
28 class atsc_equalizer;
29 typedef boost::shared_ptr<atsc_equalizer> atsc_equalizer_sptr;
30
31 atsc_equalizer_sptr atsc_make_equalizer();
32
33 /*!
34  * \brief ATSC equalizer (float,syminfo --> float,syminfo)
35  * \ingroup atsc
36  *
37  * first inputs are data samples, second inputs are tags.
38  * first outputs are equalized data samples, second outputs are tags.
39  */
40 class atsc_equalizer : public gr_sync_block
41 {
42   friend atsc_equalizer_sptr atsc_make_equalizer();
43
44   atsc_equalizer();
45
46 public:
47   void forecast (int noutput_items, gr_vector_int &ninput_items_required);
48
49   int work (int noutput_items,
50             gr_vector_const_void_star &input_items,
51             gr_vector_void_star &output_items);
52
53   void reset() { /* nop */ }
54
55   ~atsc_equalizer ();
56
57
58 protected:
59   atsci_equalizer       *d_equalizer;
60
61 };
62
63
64 #endif /* INCLUDED_ATSC_EQUALIZER_H */