<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>GNU Radio 3.2.2 C++ API: gr_clock_recovery_mm_ff.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2 --> <h1>gr_clock_recovery_mm_ff.h</h1><a href="gr__clock__recovery__mm__ff_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span> <a name="l00002"></a>00002 <span class="comment">/*</span> <a name="l00003"></a>00003 <span class="comment"> * Copyright 2004 Free Software Foundation, Inc.</span> <a name="l00004"></a>00004 <span class="comment"> *</span> <a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span> <a name="l00006"></a>00006 <span class="comment"> *</span> <a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span> <a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span> <a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span> <a name="l00010"></a>00010 <span class="comment"> * any later version.</span> <a name="l00011"></a>00011 <span class="comment"> *</span> <a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span> <a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span> <a name="l00016"></a>00016 <span class="comment"> *</span> <a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span> <a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span> <a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span> <a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span> <a name="l00021"></a>00021 <span class="comment"> */</span> <a name="l00022"></a>00022 <a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_GR_CLOCK_RECOVERY_MM_FF_H</span> <a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_CLOCK_RECOVERY_MM_FF_H</span> <a name="l00025"></a>00025 <span class="preprocessor"></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="gr__block_8h.html">gr_block.h</a>></span> <a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="gr__math_8h.html">gr_math.h</a>></span> <a name="l00028"></a>00028 <span class="preprocessor">#include <stdio.h></span> <a name="l00029"></a>00029 <a name="l00030"></a>00030 <span class="keyword">class </span><a class="code" href="classgri__mmse__fir__interpolator.html" title="Compute intermediate samples between signal samples x(k*Ts)This implements a Mininum...">gri_mmse_fir_interpolator</a>; <a name="l00031"></a>00031 <a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classgr__clock__recovery__mm__ff.html" title="Mueller and Müller (M&amp;M) based clock recovery block with float input, float...">gr_clock_recovery_mm_ff</a>; <a name="l00033"></a>00033 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_clock_recovery_mm_ff></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_clock_recovery_mm_ff_sptr</a>; <a name="l00034"></a>00034 <a name="l00035"></a>00035 <span class="comment">// public constructor</span> <a name="l00036"></a>00036 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_clock_recovery_mm_ff_sptr</a> <a name="l00037"></a>00037 <a class="code" href="gr__clock__recovery__mm__ff_8h.html#a0127e685840f6e9500e208b6f79432a9">gr_make_clock_recovery_mm_ff</a> (<span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a201960d91094177a8863ebdb03806c84">omega</a>, <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#afb24bea3a50e52fbae99db673c77b6e1">gain_omega</a>, <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a76e523017a5de71ff36e12b535d420d0">mu</a>, <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a206c735267d2adf3e5278de9aaba3e13">gain_mu</a>, <a name="l00038"></a>00038 <span class="keywordtype">float</span> omega_relative_limit=0.001); <a name="l00039"></a>00039 <span class="comment"></span> <a name="l00040"></a>00040 <span class="comment">/*!</span> <a name="l00041"></a>00041 <span class="comment"> * \brief Mueller and Müller (M&M) based clock recovery block with float input, float output.</span> <a name="l00042"></a>00042 <span class="comment"> * \ingroup sync_blk</span> <a name="l00043"></a>00043 <span class="comment"> *</span> <a name="l00044"></a>00044 <span class="comment"> * This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer.</span> <a name="l00045"></a>00045 <span class="comment"> *</span> <a name="l00046"></a>00046 <span class="comment"> * See "Digital Communication Receivers: Synchronization, Channel</span> <a name="l00047"></a>00047 <span class="comment"> * Estimation and Signal Processing" by Heinrich Meyr, Marc Moeneclaey, & Stefan Fechtel.</span> <a name="l00048"></a>00048 <span class="comment"> * ISBN 0-471-50275-8.</span> <a name="l00049"></a>00049 <span class="comment"> */</span> <a name="l00050"></a><a class="code" href="classgr__clock__recovery__mm__ff.html">00050</a> <span class="keyword">class </span><a class="code" href="classgr__clock__recovery__mm__ff.html" title="Mueller and Müller (M&amp;M) based clock recovery block with float input, float...">gr_clock_recovery_mm_ff</a> : <span class="keyword">public</span> <a class="code" href="classgr__block.html" title="The abstract base class for all &#39;terminal&#39; processing blocks.A signal processing...">gr_block</a> <a name="l00051"></a>00051 { <a name="l00052"></a>00052 <span class="keyword">public</span>: <a name="l00053"></a>00053 <a class="code" href="classgr__clock__recovery__mm__ff.html#a7b8d40e7648e04759a4d2159d874a9d3">~gr_clock_recovery_mm_ff</a> (); <a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#ac56914de0d3761f739feda64958b62d8" title="Estimate input requirements given output request.">forecast</a>(<span class="keywordtype">int</span> noutput_items, <a class="code" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items_required); <a name="l00055"></a>00055 <span class="keywordtype">int</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a7e8a022678f89fef38d13aa078230f93" title="compute output items from input items">general_work</a> (<span class="keywordtype">int</span> noutput_items, <a name="l00056"></a>00056 <a class="code" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items, <a name="l00057"></a>00057 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a name="l00058"></a>00058 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items); <a name="l00059"></a><a class="code" href="classgr__clock__recovery__mm__ff.html#a76e523017a5de71ff36e12b535d420d0">00059</a> <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a76e523017a5de71ff36e12b535d420d0">mu</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_mu;} <a name="l00060"></a><a class="code" href="classgr__clock__recovery__mm__ff.html#a201960d91094177a8863ebdb03806c84">00060</a> <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a201960d91094177a8863ebdb03806c84">omega</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_omega;} <a name="l00061"></a><a class="code" href="classgr__clock__recovery__mm__ff.html#a206c735267d2adf3e5278de9aaba3e13">00061</a> <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a206c735267d2adf3e5278de9aaba3e13">gain_mu</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_gain_mu;} <a name="l00062"></a><a class="code" href="classgr__clock__recovery__mm__ff.html#afb24bea3a50e52fbae99db673c77b6e1">00062</a> <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#afb24bea3a50e52fbae99db673c77b6e1">gain_omega</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_gain_omega;} <a name="l00063"></a>00063 <a name="l00064"></a><a class="code" href="classgr__clock__recovery__mm__ff.html#a639978675a6fc2be43a9590f2aa34898">00064</a> <span class="keywordtype">void</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a639978675a6fc2be43a9590f2aa34898">set_gain_mu</a> (<span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a206c735267d2adf3e5278de9aaba3e13">gain_mu</a>) { d_gain_mu = gain_mu; } <a name="l00065"></a><a class="code" href="classgr__clock__recovery__mm__ff.html#ac0eea43746feb2859f11e5a2c9b2077e">00065</a> <span class="keywordtype">void</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#ac0eea43746feb2859f11e5a2c9b2077e">set_gain_omega</a> (<span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#afb24bea3a50e52fbae99db673c77b6e1">gain_omega</a>) { d_gain_omega = gain_omega; } <a name="l00066"></a><a class="code" href="classgr__clock__recovery__mm__ff.html#a0c12eb61eb3d9433e6c5a45235a70a61">00066</a> <span class="keywordtype">void</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a0c12eb61eb3d9433e6c5a45235a70a61">set_mu</a> (<span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a76e523017a5de71ff36e12b535d420d0">mu</a>) { d_mu = mu; } <a name="l00067"></a><a class="code" href="classgr__clock__recovery__mm__ff.html#a6c1489ccd93bd98085697234d403eae9">00067</a> <span class="keywordtype">void</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a6c1489ccd93bd98085697234d403eae9">set_omega</a> (<span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a201960d91094177a8863ebdb03806c84">omega</a>){ <a name="l00068"></a>00068 d_omega = omega; <a name="l00069"></a>00069 d_min_omega = omega*(1.0 - d_omega_relative_limit); <a name="l00070"></a>00070 d_max_omega = omega*(1.0 + d_omega_relative_limit); <a name="l00071"></a>00071 d_omega_mid = 0.5*(d_min_omega+d_max_omega); <a name="l00072"></a>00072 } <a name="l00073"></a>00073 <a name="l00074"></a>00074 <span class="keyword">protected</span>: <a name="l00075"></a>00075 <a class="code" href="classgr__clock__recovery__mm__ff.html#af71a323118b12fa801323900aff1fd15">gr_clock_recovery_mm_ff</a> (<span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a201960d91094177a8863ebdb03806c84">omega</a>, <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#afb24bea3a50e52fbae99db673c77b6e1">gain_omega</a>, <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a76e523017a5de71ff36e12b535d420d0">mu</a>, <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a206c735267d2adf3e5278de9aaba3e13">gain_mu</a>, <a name="l00076"></a>00076 <span class="keywordtype">float</span> omega_relative_limit); <a name="l00077"></a>00077 <a name="l00078"></a>00078 <span class="keyword">private</span>: <a name="l00079"></a>00079 <span class="keywordtype">float</span> d_mu; <span class="comment">// fractional sample position [0.0, 1.0]</span> <a name="l00080"></a>00080 <span class="keywordtype">float</span> d_omega; <span class="comment">// nominal frequency</span> <a name="l00081"></a>00081 <span class="keywordtype">float</span> d_min_omega; <span class="comment">// minimum allowed omega </span> <a name="l00082"></a>00082 <span class="keywordtype">float</span> d_omega_mid; <span class="comment">// average omega</span> <a name="l00083"></a>00083 <span class="keywordtype">float</span> d_max_omega; <span class="comment">// maximum allowed omega</span> <a name="l00084"></a>00084 <span class="keywordtype">float</span> d_gain_omega; <span class="comment">// gain for adjusting omega</span> <a name="l00085"></a>00085 <span class="keywordtype">float</span> d_gain_mu; <span class="comment">// gain for adjusting mu</span> <a name="l00086"></a>00086 <span class="keywordtype">float</span> d_last_sample; <a name="l00087"></a>00087 <a class="code" href="classgri__mmse__fir__interpolator.html" title="Compute intermediate samples between signal samples x(k*Ts)This implements a Mininum...">gri_mmse_fir_interpolator</a> *d_interp; <a name="l00088"></a>00088 FILE *d_logfile; <a name="l00089"></a>00089 <span class="keywordtype">float</span> d_omega_relative_limit; <span class="comment">// used to compute min and max omega</span> <a name="l00090"></a>00090 <a name="l00091"></a>00091 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_clock_recovery_mm_ff_sptr</a> <a name="l00092"></a>00092 <a class="code" href="classgr__clock__recovery__mm__ff.html#acfcfac16be25539fd56b2a9b0db85867">gr_make_clock_recovery_mm_ff</a> (<span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a201960d91094177a8863ebdb03806c84">omega</a>, <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#afb24bea3a50e52fbae99db673c77b6e1">gain_omega</a>, <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a76e523017a5de71ff36e12b535d420d0">mu</a>, <span class="keywordtype">float</span> <a class="code" href="classgr__clock__recovery__mm__ff.html#a206c735267d2adf3e5278de9aaba3e13">gain_mu</a>, <a name="l00093"></a>00093 <span class="keywordtype">float</span> omega_relative_limit); <a name="l00094"></a>00094 }; <a name="l00095"></a>00095 <a name="l00096"></a>00096 <span class="preprocessor">#endif</span> </pre></div></div> <hr size="1"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> </body> </html>