Houston, we have a trunk.
[debian/gnuradio] / gr-atsc / src / lib / atsci_reed_solomon.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 _ATSC_REED_SOLOMON_H_
24 #define _ATSC_REED_SOLOMON_H_
25
26 #include <atsc_types.h>
27
28 /*!
29  * \brief ATSC Reed-Solomon encoder / decoder
30  *
31  * The t=10 (207,187) code described in ATSC standard A/53B.
32  * See figure D5 on page 55.
33  */
34
35 class atsci_reed_solomon {
36
37  public:
38   atsci_reed_solomon();
39   ~atsci_reed_solomon();
40
41   /*!
42    * \brief Add RS error correction encoding
43    */
44   void encode (atsc_mpeg_packet_rs_encoded &out, const atsc_mpeg_packet_no_sync &in);
45
46   /*!
47    * Decode RS encoded packet.
48    * \returns a count of corrected symbols, or -1 if the block was uncorrectible.
49    */
50   int decode (atsc_mpeg_packet_no_sync &out, const atsc_mpeg_packet_rs_encoded &in);
51
52  private:
53   void  *d_rs;
54 };
55
56 #endif /* _ATSC_REED_SOLOMON_H_ */