GNU Radio 3.5.1 C++ API
atsci_reed_solomon.h
Go to the documentation of this file.
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_api.h>
00027 #include <atsc_types.h>
00028 
00029 /*!
00030  * \brief ATSC Reed-Solomon encoder / decoder
00031  *
00032  * The t=10 (207,187) code described in ATSC standard A/53B.
00033  * See figure D5 on page 55.
00034  */
00035 
00036 class ATSC_API atsci_reed_solomon {
00037 
00038  public:
00039   atsci_reed_solomon();
00040   ~atsci_reed_solomon();
00041 
00042   /*!
00043    * \brief Add RS error correction encoding
00044    */
00045   void encode (atsc_mpeg_packet_rs_encoded &out, const atsc_mpeg_packet_no_sync &in);
00046 
00047   /*!
00048    * Decode RS encoded packet.
00049    * \returns a count of corrected symbols, or -1 if the block was uncorrectible.
00050    */
00051   int decode (atsc_mpeg_packet_no_sync &out, const atsc_mpeg_packet_rs_encoded &in);
00052 
00053  private:
00054   void  *d_rs;
00055 };
00056 
00057 #endif /* _ATSC_REED_SOLOMON_H_ */