Houston, we have a trunk.
[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 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., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, 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
30 /*!
31  * \brief template class for interleaver fifo
32  */
33
34 template<class symbol_type>
35 class interleaver_fifo {
36  public:
37
38   interleaver_fifo (unsigned int size);
39   ~interleaver_fifo ();
40
41   //! reset interleaver (flushes contents and resets commutator)
42   void reset ();
43   
44   //! stuff a symbol into the fifo and return the oldest
45   symbol_type stuff (symbol_type input){
46     if (m_size == 0)
47       return input;
48
49     symbol_type retval = m_fifo[m_position];
50     m_fifo[m_position] = input;
51     m_position++;
52     if (m_position >= m_size)
53       m_position = 0;
54
55     return retval;
56   }
57
58 protected:
59   unsigned int  m_size;
60   unsigned int  m_position;
61   symbol_type   *m_fifo;
62 };
63
64 template<class symbol_type>
65 interleaver_fifo<symbol_type>::interleaver_fifo (unsigned int size)
66 {
67   m_size = size;
68   m_position = 0;
69   m_fifo = new symbol_type[size];
70   memset (m_fifo, 0, m_size * sizeof (symbol_type));
71 }
72
73 template<class symbol_type>
74 interleaver_fifo<symbol_type>::~interleaver_fifo ()
75 {
76   delete [] m_fifo;
77 }
78
79 template<class symbol_type> void
80 interleaver_fifo<symbol_type>::reset ()
81 {
82   m_position = 0;
83   memset (m_fifo, 0, m_size * sizeof (symbol_type));
84 }
85
86 #endif /* _INTERLEAVER_FIFO_H_ */