Merge commit 'v3.3.0' into upstream
[debian/gnuradio] / gr-atsc / src / lib / GrAtscFPLL.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
24 #ifndef _GRATSCFPLL_H_
25 #define _GRATSCFPLL_H_
26
27 #include <gr_nco.h>
28 #include <gr_iir.h>
29 #include <gr_single_pole_iir.h>
30 #include <gr_agc.h>
31 #include <VrSigProc.h>
32 #include <stdio.h>
33 #include <atsci_diag_output.h>
34
35 /*!
36  * \brief ATSC FPLL (2nd Version)
37  *
38  * Used as follows:
39  *                         float              float
40  *  A/D --> GrFIRfilterFFF ----> GrAtscFPLL ----> 
41  *
42  * We use GrFIRfilterFFF to bandpass filter the signal of interest.
43  *
44  * This class accepts a single real input and produces a single real output
45  */
46
47 class GrAtscFPLL : public VrSigProc {
48  protected:
49
50   typedef float  iType;
51   typedef float  oType;
52   
53  public:
54
55   GrAtscFPLL (double a_initial_freq);
56   virtual ~GrAtscFPLL () {}
57
58   virtual const char *name () { return "GrAtscFPLL"; }
59
60   virtual void initialize ();
61
62   virtual int work (VrSampleRange output, void *o[],
63                     VrSampleRange inputs[], void *i[]);
64
65
66   // diagnostic routines
67   void set_initial_phase (double phase) { initial_phase = phase; }         // radians
68   void set_no_update (bool a_no_update) { debug_no_update = a_no_update; }
69
70
71  protected:
72
73   double                        initial_freq;
74   double                        initial_phase;
75   bool                          debug_no_update;
76   gr_nco<float,float>           nco;
77   gr_agc                        agc;    // automatic gain control
78   gr_single_pole_iir<float,float,float> afci;
79   gr_single_pole_iir<float,float,float> afcq;
80   
81 #ifdef _FPLL_DIAG_OUTPUT_
82   FILE                          *fp;
83 #endif
84
85 };
86
87
88 #endif // _GRATSCFPLL_H_