Updating all three PLL blocks to use new control_loop parent class.

9 files changed, 81 insertions, 76 deletions

diff --git a/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.cc b/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.cc
index 19ab316a1..583e0eb70 100644
--- a/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.cc
+++ b/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.cc
@@ -1,6 +1,6 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2006,2010 Free Software Foundation, Inc.
+ * Copyright 2006,2010,2011 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
@@ -30,22 +30,24 @@
 #include <math.h>
 #include <gr_math.h>
 
-#define M_TWOPI (2*M_PI)
+#ifndef M_TWOPI
+#define M_TWOPI (2.0f*M_PI)
+#endif
 
 gr_pll_carriertracking_cc_sptr
-gr_make_pll_carriertracking_cc (float alpha, float beta, float max_freq, float min_freq)
+gr_make_pll_carriertracking_cc (float loop_bw, float max_freq, float min_freq)
 {
-  return gnuradio::get_initial_sptr(new gr_pll_carriertracking_cc (alpha, beta, max_freq, min_freq));
+  return gnuradio::get_initial_sptr(new gr_pll_carriertracking_cc (loop_bw, max_freq, min_freq));
 }
 
-gr_pll_carriertracking_cc::gr_pll_carriertracking_cc (float alpha, float beta, float max_freq, float min_freq)
+gr_pll_carriertracking_cc::gr_pll_carriertracking_cc (float loop_bw,
+						      float max_freq,
+						      float min_freq)
   : gr_sync_block ("pll_carriertracking_cc",
 		   gr_make_io_signature (1, 1, sizeof (gr_complex)),
 		   gr_make_io_signature (1, 1, sizeof (gr_complex))),
-    d_alpha(alpha), d_beta(beta), 
-    d_max_freq(max_freq), d_min_freq(min_freq),
-    d_phase(0), d_freq((max_freq+min_freq)/2),
-    d_locksig(0),d_lock_threshold(0),d_squelch_enable(false)
+    gri_control_loop(loop_bw, max_freq, min_freq),
+    d_locksig(0), d_lock_threshold(0), d_squelch_enable(false)
 {
 }
 
@@ -72,7 +74,7 @@ gr_pll_carriertracking_cc::phase_detector(gr_complex sample,float ref_phase)
 bool
 gr_pll_carriertracking_cc::lock_detector(void)
 {
-    return (fabs(d_locksig) > d_lock_threshold);
+    return (fabsf(d_locksig) > d_lock_threshold);
 }
 
 bool
@@ -100,17 +102,16 @@ gr_pll_carriertracking_cc::work (int noutput_items,
   
   for (int i = 0; i < noutput_items; i++){
     error = phase_detector(iptr[i],d_phase);
-    
-    d_freq = d_freq + d_beta * error;
-    d_phase = mod_2pi(d_phase + d_freq + d_alpha * error);
-    
-    if (d_freq > d_max_freq)
-      d_freq = d_max_freq;
-    else if (d_freq < d_min_freq)
-      d_freq = d_min_freq;
-    gr_sincosf(d_phase,&t_imag,&t_real);
-    optr[i] = iptr[i] * gr_complex(t_real,-t_imag);
-    d_locksig = d_locksig * (1.0 - d_alpha) + d_alpha*(iptr[i].real() * t_real + iptr[i].imag() * t_imag);
+
+    advance_loop(error);
+    phase_wrap();
+    frequency_limit();
+
+    gr_sincosf(d_phase, &t_imag, &t_real);
+    optr[i] = iptr[i] * gr_complex(t_real, -t_imag);
+
+    d_locksig = d_locksig * (1.0 - d_alpha) + \
+      d_alpha*(iptr[i].real() * t_real + iptr[i].imag() * t_imag);
     
     if ((d_squelch_enable) && !lock_detector())
       optr[i] = 0;
diff --git a/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h b/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
index 195f06016..bcdf543a4 100644
--- a/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
+++ b/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
@@ -1,6 +1,6 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2004,206 Free Software Foundation, Inc.
+ * Copyright 2004,2006,2011 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
@@ -24,12 +24,14 @@
 #define INCLUDED_GR_PLL_CARRIERTRACKING_CC_H
 
 #include <gr_sync_block.h>
+#include <gri_control_loop.h>
 
 class gr_pll_carriertracking_cc;
 typedef boost::shared_ptr<gr_pll_carriertracking_cc> gr_pll_carriertracking_cc_sptr;
 
-gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float alpha, float beta,
-					       float max_freq, float min_freq);
+gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float loop_bw,
+							       float max_freq,
+							       float min_freq);
 /*!
  * \brief Implements a PLL which locks to the input frequency and outputs the 
  * input signal mixed with that carrier.
@@ -41,19 +43,20 @@ gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float alpha, floa
  * the input and outputs that signal, downconverted to DC
  * 
  * All settings max_freq and min_freq are in terms of radians per sample, 
- * NOT HERTZ.  Alpha is the phase gain (first order, units of radians per radian) 
- * and beta is the frequency gain (second order, units of radians per sample per radian)
+ * NOT HERTZ.  The loop bandwidth determins the lock range and should be set
+ * around pi/200 -- 2pi/100.
  * \sa gr_pll_freqdet_cf, gr_pll_carriertracking_cc
  */
 
-class gr_pll_carriertracking_cc : public gr_sync_block
+class gr_pll_carriertracking_cc : public gr_sync_block, public gri_control_loop
 {
-  friend gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float alpha, float beta,
-							float max_freq, float min_freq);
+  friend gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float loop_bw,
+									float max_freq,
+									float min_freq);
 
-  float d_alpha,d_beta,d_max_freq,d_min_freq,d_phase,d_freq,d_locksig,d_lock_threshold;
+  float d_locksig,d_lock_threshold;
   bool d_squelch_enable;
-  gr_pll_carriertracking_cc (float alpha, float beta, float max_freq, float min_freq);
+  gr_pll_carriertracking_cc (float loop_bw, float max_freq, float min_freq);
 
   int work (int noutput_items,
 	    gr_vector_const_void_star &input_items,
diff --git a/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.i b/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.i
index 3e84fccbe..d309111b2 100644
--- a/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.i
+++ b/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.i
@@ -1,6 +1,6 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2005 Free Software Foundation, Inc.
+ * Copyright 2005,2011 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
@@ -23,13 +23,14 @@
 GR_SWIG_BLOCK_MAGIC(gr,pll_carriertracking_cc);
 
 gr_pll_carriertracking_cc_sptr
-gr_make_pll_carriertracking_cc (float alpha, float beta, 
-				float max_freq, float min_freq);
+gr_make_pll_carriertracking_cc (float loop_bw, 
+				float max_freq,
+				float min_freq);
 
-class gr_pll_carriertracking_cc : public gr_sync_block
+class gr_pll_carriertracking_cc : public gr_sync_block, public gri_control_loop
 {
  private:
-  gr_pll_carriertracking_cc (float alpha, float beta, float max_freq, float min_freq);
+  gr_pll_carriertracking_cc (float loop_bw, float max_freq, float min_freq);
  public:
   bool lock_detector(void);
   bool  squelch_enable(bool);
diff --git a/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.cc b/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.cc
index 1f17f2afc..0ae773e6e 100644
--- a/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.cc
+++ b/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.cc
@@ -1,6 +1,6 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2004,2010 Free Software Foundation, Inc.
+ * Copyright 2004,2010,2011 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
@@ -20,8 +20,6 @@
  * Boston, MA 02110-1301, USA.
  */
 
-// WARNING: this file is machine generated.  Edits will be over written
-
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -31,21 +29,21 @@
 #include <math.h>
 #include <gr_math.h>
 
-#define M_TWOPI (2*M_PI)
+#ifndef M_TWOPI
+#define M_TWOPI (2.0f*M_PI)
+#endif
 
 gr_pll_freqdet_cf_sptr
-gr_make_pll_freqdet_cf (float alpha, float beta, float max_freq, float min_freq)
+gr_make_pll_freqdet_cf (float loop_bw, float max_freq, float min_freq)
 {
-  return gnuradio::get_initial_sptr(new gr_pll_freqdet_cf (alpha, beta, max_freq, min_freq));
+  return gnuradio::get_initial_sptr(new gr_pll_freqdet_cf (loop_bw, max_freq, min_freq));
 }
 
-gr_pll_freqdet_cf::gr_pll_freqdet_cf (float alpha, float beta, float max_freq, float min_freq)
+gr_pll_freqdet_cf::gr_pll_freqdet_cf (float loop_bw, float max_freq, float min_freq)
   : gr_sync_block ("pll_freqdet_cf",
 		   gr_make_io_signature (1, 1, sizeof (gr_complex)),
 		   gr_make_io_signature (1, 1, sizeof (float))),
-    d_alpha(alpha), d_beta(beta), 
-    d_max_freq(max_freq), d_min_freq(min_freq),
-    d_phase(0), d_freq((max_freq+min_freq)/2)
+    gri_control_loop(loop_bw, max_freq, min_freq)    
 {
 }
 
@@ -70,8 +68,8 @@ gr_pll_freqdet_cf::phase_detector(gr_complex sample,float ref_phase)
 
 int
 gr_pll_freqdet_cf::work (int noutput_items,
-		   gr_vector_const_void_star &input_items,
-		   gr_vector_void_star &output_items)
+			 gr_vector_const_void_star &input_items,
+			 gr_vector_void_star &output_items)
 {
   const gr_complex *iptr = (gr_complex *) input_items[0];
   float *optr = (float *) output_items[0];
@@ -82,13 +80,10 @@ gr_pll_freqdet_cf::work (int noutput_items,
   while (size-- > 0) {
     error = phase_detector(*iptr++,d_phase);
     
-    d_freq = d_freq + d_beta * error;
-    d_phase = mod_2pi(d_phase + d_freq + d_alpha * error);
-    
-    if (d_freq > d_max_freq)
-      d_freq = d_max_freq;
-    else if (d_freq < d_min_freq)
-      d_freq = d_min_freq;
+    advance_loop(error);
+    phase_wrap();
+    frequency_limit();
+
     *optr++ = d_freq;
   }
   return noutput_items;
diff --git a/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h b/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
index 0581c8724..0da9fc5c7 100644
--- a/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
+++ b/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
@@ -1,6 +1,6 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2004 Free Software Foundation, Inc.
+ * Copyright 2004,2011 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
@@ -24,12 +24,14 @@
 #define INCLUDED_GR_PLL_FREQDET_CF_H
 
 #include <gr_sync_block.h>
+#include <gri_control_loop.h>
 
 class gr_pll_freqdet_cf;
 typedef boost::shared_ptr<gr_pll_freqdet_cf> gr_pll_freqdet_cf_sptr;
 
-gr_pll_freqdet_cf_sptr gr_make_pll_freqdet_cf (float alpha, float beta,
-					       float max_freq, float min_freq);
+gr_pll_freqdet_cf_sptr gr_make_pll_freqdet_cf (float loop_bw,
+					       float max_freq,
+					       float min_freq);
 /*!
  * \brief Implements a PLL which locks to the input frequency and outputs 
  * an estimate of that frequency.  Useful for FM Demod.
@@ -40,24 +42,24 @@ gr_pll_freqdet_cf_sptr gr_make_pll_freqdet_cf (float alpha, float beta,
  * This PLL locks onto a [possibly noisy] reference carrier on
  * the input and outputs an estimate of that frequency in radians per sample.
  * All settings max_freq and min_freq are in terms of radians per sample, 
- * NOT HERTZ.  Alpha is the phase gain (first order, units of radians per radian) 
- * and beta is the frequency gain (second order, units of radians per sample per radian)
+ * NOT HERTZ.  The loop bandwidth determins the lock range and should be set
+ * around pi/200 -- 2pi/100.
  * \sa gr_pll_refout_cc, gr_pll_carriertracking_cc
  */
 
-class gr_pll_freqdet_cf : public gr_sync_block
+class gr_pll_freqdet_cf : public gr_sync_block, public gri_control_loop
 {
-  friend gr_pll_freqdet_cf_sptr gr_make_pll_freqdet_cf (float alpha, float beta,
-							float max_freq, float min_freq);
+  friend gr_pll_freqdet_cf_sptr gr_make_pll_freqdet_cf (float loop_bw,
+							float max_freq,
+							float min_freq);
 
-  float d_alpha,d_beta,d_max_freq,d_min_freq,d_phase,d_freq;
-  gr_pll_freqdet_cf (float alpha, float beta, float max_freq, float min_freq);
+  float mod_2pi (float in);
+  gr_pll_freqdet_cf (float loop_bw, float max_freq, float min_freq);
 
   int work (int noutput_items,
 	    gr_vector_const_void_star &input_items,
 	    gr_vector_void_star &output_items);
 private:
-  float mod_2pi (float in);
   float phase_detector(gr_complex sample,float ref_phase);
 };
 
diff --git a/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.i b/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.i
index b730f037a..f93e6e37e 100644
--- a/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.i
+++ b/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.i
@@ -1,6 +1,6 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2005 Free Software Foundation, Inc.
+ * Copyright 2005,2011 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
@@ -22,11 +22,12 @@
 
 GR_SWIG_BLOCK_MAGIC(gr,pll_freqdet_cf)
 
-  gr_pll_freqdet_cf_sptr gr_make_pll_freqdet_cf (float alpha, float beta, 
-						 float max_freq, float min_freq);
+  gr_pll_freqdet_cf_sptr gr_make_pll_freqdet_cf (float loop_bw, 
+						 float max_freq,
+						 float min_freq);
 
-class gr_pll_freqdet_cf : public gr_sync_block
+class gr_pll_freqdet_cf : public gr_sync_block, public gri_control_loop
 {
  private:
-  gr_pll_freqdet_cf (float alpha, float beta, float max_freq, float min_freq);
+  gr_pll_freqdet_cf (float loop_bw, float max_freq, float min_freq);
 };
diff --git a/gnuradio-core/src/lib/general/gr_pll_refout_cc.cc b/gnuradio-core/src/lib/general/gr_pll_refout_cc.cc
index 8968cd3f1..2b480fcf1 100644
--- a/gnuradio-core/src/lib/general/gr_pll_refout_cc.cc
+++ b/gnuradio-core/src/lib/general/gr_pll_refout_cc.cc
@@ -30,7 +30,9 @@
 #include <math.h>
 #include <gr_math.h>
 
-#define M_TWOPI (2*M_PI)
+#ifndef M_TWOPI
+#define M_TWOPI (2.0f*M_PI)
+#endif
 
 gr_pll_refout_cc_sptr
 gr_make_pll_refout_cc (float loop_bw, float max_freq, float min_freq)
diff --git a/gnuradio-core/src/lib/general/gr_pll_refout_cc.h b/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
index 226ca8f9e..d3e45882b 100644
--- a/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
+++ b/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
@@ -42,8 +42,8 @@ gr_pll_refout_cc_sptr gr_make_pll_refout_cc (float loop_bw,
  * aligned to it.
  * 
  * All settings max_freq and min_freq are in terms of radians per sample, 
- * NOT HERTZ.  Alpha is the phase gain (first order, units of radians per radian) 
- * and beta is the frequency gain (second order, units of radians per sample per radian)
+ * NOT HERTZ.  The loop bandwidth determins the lock range and should be set
+ * around pi/200 -- 2pi/100.
  * \sa gr_pll_freqdet_cf, gr_pll_carriertracking_cc
  */
 class gr_pll_refout_cc : public gr_sync_block, public gri_control_loop
diff --git a/gnuradio-core/src/lib/general/gri_control_loop.cc b/gnuradio-core/src/lib/general/gri_control_loop.cc
index d84b47493..affdeefc9 100644
--- a/gnuradio-core/src/lib/general/gri_control_loop.cc
+++ b/gnuradio-core/src/lib/general/gri_control_loop.cc
@@ -70,9 +70,9 @@ void
 gri_control_loop::frequency_limit()
 {  
   if (d_freq > d_max_freq)
-    d_freq = d_min_freq;
+    d_freq = d_max_freq;
   else if (d_freq < d_min_freq)
-    d_freq = d_max_freq;  
+    d_freq = d_min_freq;  
 }
 
 /*******************************************************************