git.gag.com Git - debian/gnuradio/blob - gr-atsc/src/lib/GrAtscSegSymSync.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 _GRATSCSEGSYMSYNC_H_
  24 #define _GRATSCSEGSYMSYNC_H_
  25
  26 #include <VrDecimatingSigProc.h>
  27
  28 /*!
  29  * \brief ATSC SegSymSync
  30  *
  31  * Abstract class that establishes symbol timing and synchronizes
  32  * with data segment boundaries.
  33  *
  34  * Takes a single stream of floats as the input and
  35  * produces two streams as output.  The first stream is the data samples
  36  * and is of type float.  The second stream is the tags, and is of type syminfo.
  37  *
  38  * The current GNU Radio interface doesn't currently support different
  39  * types on the input ports (or output ports for that matter), but
  40  * since they are the same size, it works.
  41  */
  42
  43 #include <atsci_syminfo.h>
  44
  45 class GrAtscSegSymSync : public VrDecimatingSigProc<float,float> {
  46
  47 public:
  48
  49   GrAtscSegSymSync ();
  50   ~GrAtscSegSymSync ();
  51
  52   /*!
  53    * \brief reset bit timing loop on channel change
  54    */
  55   virtual void reset () = 0;
  56
  57   /*!
  58    * \brief create an instance of GrAtscSegSymSync
  59    */
  60   static GrAtscSegSymSync *create (double nominal_ratio_of_rx_clock_to_symbol_freq);
  61
  62 };
  63
  64 #endif // _GRATSCSEGSYMSYNC_H_