Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_glfsr_source_f.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007 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_GLFSR_SOURCE_F_H
24 #define INCLUDED_GR_GLFSR_SOURCE_F_H
25
26 #include <gr_sync_block.h>
27
28 class gri_glfsr;
29
30 class gr_glfsr_source_f;
31 typedef boost::shared_ptr<gr_glfsr_source_f> gr_glfsr_source_f_sptr;
32
33 gr_glfsr_source_f_sptr gr_make_glfsr_source_f(int degree, bool repeat=true, int mask=0, int seed=1);
34
35 /*!
36  * \brief Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0
37  * \ingroup source_blk
38  */
39 class gr_glfsr_source_f : public gr_sync_block 
40 {
41  private:
42   friend gr_glfsr_source_f_sptr
43   gr_make_glfsr_source_f(int degree, bool repeat, int mask, int seed);
44   
45   gri_glfsr *d_glfsr;
46
47   bool d_repeat;
48   unsigned int d_index;
49   unsigned int d_length;
50   
51   gr_glfsr_source_f(int degree, bool repeat, int mask, int seed);
52
53  public:
54
55   ~gr_glfsr_source_f();
56
57   int work(int noutput_items,
58            gr_vector_const_void_star &input_items,
59            gr_vector_void_star &output_items);
60
61   unsigned int period() const { return d_length; }
62   int mask() const;
63 };
64
65 #endif /* INCLUDED_GR_GLFSR_SOURCE_F_H */