Merge commit 'v3.3.0' into upstream
[debian/gnuradio] / gr-atsc / src / lib / GrAtscSegSymSyncImpl.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 #ifndef _GRATSCSEGSYMSYNCIMPL_H_
23 #define _GRATSCSEGSYMSYNCIMPL_H_
24
25 #include <GrAtscSegSymSync.h>
26 #include <atsci_sssr.h>
27
28
29 /*!
30  * \brief concrete implementation of GrAtscSegSymSync
31  *
32  * This class implements data segment sync tracking and symbol timing
33  * using a variation of the method described in
34  * "ATSC/VSB Tutorial - Receiver Technology" by Wayne E. Bretl of
35  * Zenith, pgs 41-45.
36  */
37
38 class GrAtscSegSymSyncImpl : public GrAtscSegSymSync {
39
40   atsci_sssr            d_sssr;
41   atsci_interpolator    d_interp;
42   VrSampleIndex         d_next_input;
43   double                d_rx_clock_to_symbol_freq;      // nominal ratio
44
45 public:
46
47   // the standard methods...
48   
49   GrAtscSegSymSyncImpl (double nominal_ratio_of_rx_clock_to_symbol_freq);
50   virtual ~GrAtscSegSymSyncImpl ();
51
52   virtual const char *name () { return "GrAtscSegSymSyncImpl"; }
53
54   virtual int forecast (VrSampleRange output,
55                         VrSampleRange inputs[]);
56
57   virtual int work (VrSampleRange output, void *o[],
58                     VrSampleRange inputs[], void *i[]);
59
60   void pre_initialize ();
61   
62
63   // reset on channel change
64
65   virtual void reset ();
66
67 };
68
69 #endif /* _GRATSCSEGSYMSYNCIMPL_H_ */