Merge commit 'v3.3.0' into upstream
[debian/gnuradio] / gr-atsc / src / lib / GrAtscFieldSyncCorrelator.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 _GRATSCFIELDSYNCCORRELATOR_H_
24 #define _GRATSCFIELDSYNCCORRELATOR_H_
25
26 #include <VrHistoryProc.h>
27
28 class atsci_fs_correlator;
29
30 /*!
31  * \brief ATSC field sync correlator (float --> float,float)
32  *
33  * first output is delayed version of input.
34  * second output is set of tags, one-for-one with first output.
35  *
36  * tag values are defined in atsci_sync_tag.h
37  */
38
39 class GrAtscFieldSyncCorrelator : public VrHistoryProc<float,float>
40 {
41
42 public:
43
44   GrAtscFieldSyncCorrelator ();
45   ~GrAtscFieldSyncCorrelator ();
46
47   const char *name () { return "GrAtscFieldSyncCorrelator"; }
48
49   int work (VrSampleRange output, void *o[],
50             VrSampleRange inputs[], void *i[]);
51
52 protected:
53   atsci_fs_correlator   *d_fsc;
54 };
55
56 #endif /* _GRATSCFIELDSYNCCORRELATOR_H_ */