Merge commit 'v3.3.0' into upstream
[debian/gnuradio] / gr-atsc / src / lib / interleaver_fifo.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2002 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 _INTERLEAVER_FIFO_H_
24 #define _INTERLEAVER_FIFO_H_
25
26
27 #include <interleaver_fifo.h>
28 #include <string.h>
29 #include <strings.h>
30
31 /*!
32  * \brief template class for interleaver fifo
33  */
34
35 template<class symbol_type>
36 class interleaver_fifo {
37  public:
38
39   interleaver_fifo (unsigned int size);
40   ~interleaver_fifo ();
41
42   //! reset interleaver (flushes contents and resets commutator)
43   void reset ();
44   
45   //! stuff a symbol into the fifo and return the oldest
46   symbol_type stuff (symbol_type input){
47     if (m_size == 0)
48       return input;
49
50     symbol_type retval = m_fifo[m_position];
51     m_fifo[m_position] = input;
52     m_position++;
53     if (m_position >= m_size)
54       m_position = 0;
55
56     return retval;
57   }
58
59 protected:
60   unsigned int  m_size;
61   unsigned int  m_position;
62   symbol_type   *m_fifo;
63 };
64
65 template<class symbol_type>
66 interleaver_fifo<symbol_type>::interleaver_fifo (unsigned int size)
67 {
68   m_size = size;
69   m_position = 0;
70   m_fifo = new symbol_type[size];
71   memset (m_fifo, 0, m_size * sizeof (symbol_type));
72 }
73
74 template<class symbol_type>
75 interleaver_fifo<symbol_type>::~interleaver_fifo ()
76 {
77   delete [] m_fifo;
78 }
79
80 template<class symbol_type> void
81 interleaver_fifo<symbol_type>::reset ()
82 {
83   m_position = 0;
84   memset (m_fifo, 0, m_size * sizeof (symbol_type));
85 }
86
87 #endif /* _INTERLEAVER_FIFO_H_ */