3 * Copyright 2004 Free Software Foundation, Inc.
5 * This file is part of GNU Radio
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)
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.
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.
23 #ifndef INCLUDED_GR_CLOCK_RECOVERY_MM_CC_H
24 #define INCLUDED_GR_CLOCK_RECOVERY_MM_CC_H
27 #include <gr_complex.h>
30 class gri_mmse_fir_interpolator_cc;
32 class gr_clock_recovery_mm_cc;
33 typedef boost::shared_ptr<gr_clock_recovery_mm_cc> gr_clock_recovery_mm_cc_sptr;
36 gr_clock_recovery_mm_cc_sptr
37 gr_make_clock_recovery_mm_cc (float omega, float gain_omega, float mu, float gain_mu,
38 float omega_relative_limit=0.001);
41 * \brief Mueller and Müller (M&M) based clock recovery block with complex input, complex output.
44 * This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer.
45 * The complex version here is based on:
46 * Modified Mueller and Muller clock recovery circuit
48 * G. R. Danesfahani, T.G. Jeans, "Optimisation of modified Mueller and Muller
49 * algorithm," Electronics Letters, Vol. 31, no. 13, 22 June 1995, pp. 1032 - 1033.
51 class gr_clock_recovery_mm_cc : public gr_block
54 ~gr_clock_recovery_mm_cc ();
55 void forecast(int noutput_items, gr_vector_int &ninput_items_required);
56 int general_work (int noutput_items,
57 gr_vector_int &ninput_items,
58 gr_vector_const_void_star &input_items,
59 gr_vector_void_star &output_items);
60 float mu() const { return d_mu;}
61 float omega() const { return d_omega;}
62 float gain_mu() const { return d_gain_mu;}
63 float gain_omega() const { return d_gain_omega;}
64 void set_verbose (bool verbose) { d_verbose = verbose; }
66 void set_gain_mu (float gain_mu) { d_gain_mu = gain_mu; }
67 void set_gain_omega (float gain_omega) { d_gain_omega = gain_omega; }
68 void set_mu (float mu) { d_mu = mu; }
69 void set_omega (float omega) {
71 d_min_omega = omega*(1.0 - d_omega_relative_limit);
72 d_max_omega = omega*(1.0 + d_omega_relative_limit);
73 d_omega_mid = 0.5*(d_min_omega+d_max_omega);
77 gr_clock_recovery_mm_cc (float omega, float gain_omega, float mu, float gain_mu,
78 float omega_relative_limi);
84 float d_min_omega; // minimum allowed omega
85 float d_max_omega; // maximum allowed omeg
86 float d_omega_relative_limit; // used to compute min and max omega
89 gr_complex d_last_sample;
90 gri_mmse_fir_interpolator_cc *d_interp;
101 gr_complex slicer_0deg (gr_complex sample);
102 gr_complex slicer_45deg (gr_complex sample);
104 friend gr_clock_recovery_mm_cc_sptr
105 gr_make_clock_recovery_mm_cc (float omega, float gain_omega, float mu, float gain_mu,
106 float omega_relative_limit);