doc/doxygen-3.4.0/atsci__reed__solomon_8h_source.html

00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2002 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022
00023 #ifndef _ATSC_REED_SOLOMON_H_
00024 #define _ATSC_REED_SOLOMON_H_
00025
00026 #include <atsc_types.h>
00027
00028 /*!
00029  * \brief ATSC Reed-Solomon encoder / decoder
00030  *
00031  * The t=10 (207,187) code described in ATSC standard A/53B.
00032  * See figure D5 on page 55.
00033  */
00034
00035 class atsci_reed_solomon {
00036
00037  public:
00038   atsci_reed_solomon();
00039   ~atsci_reed_solomon();
00040
00041   /*!
00042    * \brief Add RS error correction encoding
00043    */
00044   void encode (atsc_mpeg_packet_rs_encoded &out, const atsc_mpeg_packet_no_sync &in);
00045
00046   /*!
00047    * Decode RS encoded packet.
00048    * \returns a count of corrected symbols, or -1 if the block was uncorrectible.
00049    */
00050   int decode (atsc_mpeg_packet_no_sync &out, const atsc_mpeg_packet_rs_encoded &in);
00051
00052  private:
00053   void  *d_rs;
00054 };
00055
00056 #endif /* _ATSC_REED_SOLOMON_H_ */