Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_bytes_to_syms.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 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_GR_BYTES_TO_SYMS_H
23 #define INCLUDED_GR_BYTES_TO_SYMS_H
24
25 #include <gr_sync_interpolator.h>
26
27 class gr_bytes_to_syms;
28 typedef boost::shared_ptr<gr_bytes_to_syms> gr_bytes_to_syms_sptr;
29
30 gr_bytes_to_syms_sptr gr_make_bytes_to_syms ();
31
32 /*!
33  * \brief Convert stream of bytes to stream of +/- 1 symbols
34  * \ingroup converter_blk
35  *
36  * input: stream of bytes; output: stream of float
37  *
38  * This block is deprecated.
39  *
40  * The combination of gr_packed_to_unpacked_bb followed by
41  * gr_chunks_to_symbols_bf or gr_chunks_to_symbols_bc handles the
42  * general case of mapping from a stream of bytes into arbitrary float
43  * or complex symbols.
44  *
45  * \sa gr_packed_to_unpacked_bb, gr_unpacked_to_packed_bb,
46  * \sa gr_chunks_to_symbols_bf, gr_chunks_to_symbols_bc.
47  */
48 class gr_bytes_to_syms : public gr_sync_interpolator
49 {
50   friend gr_bytes_to_syms_sptr gr_make_bytes_to_syms ();
51
52   gr_bytes_to_syms ();
53
54  public:
55   int work (int noutput_items,
56             gr_vector_const_void_star &input_items,
57             gr_vector_void_star &output_items);
58 };
59
60 #endif /* INCLUDED_GR_BYTES_TO_SYMS_H */