blocks: moving vco/nco bases to gr-blocks.

author: Tom Rondeau <trondeau@vt.edu> 2013-03-08 08:57:46 -0500
committer: Tom Rondeau <trondeau@vt.edu> 2013-03-08 09:23:44 -0500
commit: 4389b769891283face9aa397bd4d736f478e97e4 (patch)
tree: 255aaaabba7075dfe2595170682ef2596fd93367 /gr-blocks/include
parent: 42f8854f6d13de7e3f142f3f80233066a032d627 (diff)
5 files changed, 384 insertions, 0 deletions
diff --git a/gr-blocks/include/blocks/CMakeLists.txt b/gr-blocks/include/blocks/CMakeLists.txt
index 91d1ee4289..8ffbdf0b19 100644
--- a/gr-blocks/include/blocks/CMakeLists.txt
+++ b/gr-blocks/include/blocks/CMakeLists.txt
@@ -104,6 +104,8 @@ install(FILES
     fxpt_nco.h
     fxpt_vco.h
     log2_const.h
+    nco.h
+    vco.h
     add_ff.h
     bin_statistics_f.h
     burst_tagger.h
@@ -169,6 +171,7 @@ install(FILES
     tuntap_pdu.h
     uchar_to_float.h
     unpack_k_bits_bb.h
+    vco_f.h
     vector_to_stream.h
     vector_to_streams.h
     DESTINATION ${GR_INCLUDE_DIR}/gnuradio/blocks
diff --git a/gr-blocks/include/blocks/fxpt_nco.h b/gr-blocks/include/blocks/fxpt_nco.h
index ea266552b3..0faa731763 100644
--- a/gr-blocks/include/blocks/fxpt_nco.h
+++ b/gr-blocks/include/blocks/fxpt_nco.h
@@ -77,6 +77,7 @@ namespace gr {
         d_phase += d_phase_inc;
       }
 
+      //! increment current phase angle n times
       void step(int n) {
         d_phase += d_phase_inc * n;
       }
diff --git a/gr-blocks/include/blocks/nco.h b/gr-blocks/include/blocks/nco.h
new file mode 100644
index 0000000000..e6658a3572
--- /dev/null
+++ b/gr-blocks/include/blocks/nco.h
@@ -0,0 +1,210 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2002,2013 Free Software Foundation, Inc.
+ *
+ * This file is part of GNU Radio
+ *
+ * GNU Radio is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * GNU Radio is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GNU Radio; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef _GR_NCO_H_
+#define _GR_NCO_H_
+
+#include <vector>
+#include <gr_sincos.h>
+#include <cmath>
+#include <gr_complex.h>
+
+namespace gr {
+  namespace blocks {
+
+    /*!
+     * \brief base class template for Numerically Controlled Oscillator (NCO)
+     * \ingroup misc
+     *
+     * Calculate sine and cosine based on the current phase. This
+     * class has multiple ways to calculate sin/cos and when
+     * requensting a range will increment the phase based on a
+     * frequency, which can be set using set_freq. Similar interfaces
+     * to the fxpt_vco can also be used to set or adjust the current
+     * phase.
+     *
+     * \sa fxpt_nco.h for fixed-point implementation.
+     */
+    template<class o_type, class i_type>
+    class nco
+    {
+    public:
+      nco() : phase(0), phase_inc(0) {}
+
+      virtual ~nco() {}
+
+      //! Set the current phase \p angle in radians 
+      void set_phase(double angle) {
+        phase = angle;
+      }
+
+      //! Update the current phase in radians by \p delta_phase
+      void adjust_phase(double delta_phase) {
+        phase += delta_phase;
+      }
+
+      //! angle_rate is in radians / step
+      void set_freq(double angle_rate) {
+        phase_inc = angle_rate;
+      }
+
+      //! angle_rate is a delta in radians / step
+      void adjust_freq(double delta_angle_rate) {
+        phase_inc += delta_angle_rate;
+      }
+
+      //! increment current phase angle
+      void step()
+      {
+        phase += phase_inc;
+        if(fabs (phase) > M_PI) {
+
+          while(phase > M_PI)
+            phase -= 2*M_PI;
+
+          while(phase < -M_PI)
+            phase += 2*M_PI;
+        }
+      }
+
+      //! increment current phase angle n times
+      void step(int n)
+      {
+        phase += phase_inc * n;
+        if(fabs (phase) > M_PI) {
+
+          while(phase > M_PI)
+            phase -= 2*M_PI;
+
+          while(phase < -M_PI)
+            phase += 2*M_PI;
+        }
+      }
+
+      //! units are radians / step
+      double get_phase() const { return phase; }
+      double get_freq() const { return phase_inc; }
+
+      //! compute sin and cos for current phase angle
+      void sincos(float *sinx, float *cosx) const;
+
+      //! compute cos or sin for current phase angle
+      float cos() const { return std::cos (phase); }
+      float sin() const { return std::sin (phase); }
+
+      //! compute a block at a time
+      void sin(float *output, int noutput_items, double ampl = 1.0);
+      void cos(float *output, int noutput_items, double ampl = 1.0);
+      void sincos(gr_complex *output, int noutput_items, double ampl = 1.0);
+      void sin(short *output, int noutput_items, double ampl = 1.0);
+      void cos(short *output, int noutput_items, double ampl = 1.0);
+      void sin(int *output, int noutput_items, double ampl = 1.0);
+      void cos(int *output, int noutput_items, double ampl = 1.0);
+
+    protected:
+      double phase;
+      double phase_inc;
+    };
+
+    template<class o_type, class i_type>
+    void
+    nco<o_type,i_type>::sincos(float *sinx, float *cosx) const
+    {
+      gr_sincosf(phase, sinx, cosx);
+    }
+
+    template<class o_type, class i_type>
+    void
+    nco<o_type,i_type>::sin(float *output, int noutput_items, double ampl)
+    {
+      for(int i = 0; i < noutput_items; i++) {
+        output[i] = (float)(sin() * ampl);
+        step();
+      }
+    }
+
+    template<class o_type, class i_type>
+    void
+    nco<o_type,i_type>::cos(float *output, int noutput_items, double ampl)
+    {
+      for(int i = 0; i < noutput_items; i++){
+        output[i] = (float)(cos() * ampl);
+        step();
+      }
+    }
+
+    template<class o_type, class i_type>
+    void
+    nco<o_type,i_type>::sin(short *output, int noutput_items, double ampl)
+    {
+      for(int i = 0; i < noutput_items; i++) {
+        output[i] = (short)(sin() * ampl);
+        step();
+      }
+    }
+
+    template<class o_type, class i_type>
+    void
+    nco<o_type,i_type>::cos(short *output, int noutput_items, double ampl)
+    {
+      for(int i = 0; i < noutput_items; i++) {
+        output[i] = (short)(cos() * ampl);
+        step();
+      }
+    }
+
+    template<class o_type, class i_type>
+    void
+    nco<o_type,i_type>::sin(int *output, int noutput_items, double ampl)
+    {
+      for(int i = 0; i < noutput_items; i++) {
+        output[i] = (int)(sin() * ampl);
+        step();
+      }
+    }
+
+    template<class o_type, class i_type>
+    void
+    nco<o_type,i_type>::cos(int *output, int noutput_items, double ampl)
+    {
+      for(int i = 0; i < noutput_items; i++) {
+        output[i] = (int)(cos() * ampl);
+        step();
+      }
+    }
+
+    template<class o_type, class i_type>
+    void
+    nco<o_type,i_type>::sincos(gr_complex *output, int noutput_items, double ampl)
+    {
+      for(int i = 0; i < noutput_items; i++) {
+        float cosx, sinx;
+        sincos(&sinx, &cosx);
+        output[i] = gr_complex(cosx * ampl, sinx * ampl);
+        step();
+      }
+    }
+
+  } /* namespace blocks */
+} /* namespace gr */
+
+#endif /* _NCO_H_ */
diff --git a/gr-blocks/include/blocks/vco.h b/gr-blocks/include/blocks/vco.h
new file mode 100644
index 0000000000..4417d588ae
--- /dev/null
+++ b/gr-blocks/include/blocks/vco.h
@@ -0,0 +1,113 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2005,2013 Free Software Foundation, Inc.
+ *
+ * This file is part of GNU Radio
+ *
+ * GNU Radio is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * GNU Radio is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GNU Radio; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef _GR_VCO_H_
+#define _GR_VCO_H_
+
+#include <vector>
+#include <gr_sincos.h>
+#include <cmath>
+#include <gr_complex.h>
+
+namespace gr {
+  namespace blocks {
+
+    /*!
+     * \brief base class template for Voltage Controlled Oscillator (VCO)
+     * \ingroup misc
+     *
+     * Simple calculations of sine and cosine. Set the phase using
+     * set_phase or adjust it by some delta using adjust_phase. Sine
+     * and cosine can be retrieved together with sincos(sinx, cosx)
+     * where sinx and cosx are the returned values at the current
+     * phase. They can be retrieved individually using either sin() or
+     * cos().
+     *
+     * \sa fxpt_nco.h for fixed-point implementation.
+     */
+
+    template<class o_type, class i_type>
+    class vco
+    {
+    public:
+      vco() : d_phase(0) {}
+
+      virtual ~vco() {}
+
+      //! Set the current phase \p angle in radians 
+      void set_phase(double angle) {
+        d_phase = angle;
+      }
+
+      //! Update the current phase in radians by \p delta_phase
+      void adjust_phase(double delta_phase) {
+        d_phase += delta_phase;
+        if(fabs(d_phase) > M_PI) {
+
+          while(d_phase > M_PI)
+            d_phase -= 2*M_PI;
+
+          while(d_phase < -M_PI)
+            d_phase += 2*M_PI;
+        }
+      }
+
+      //! Get the current phase in radians
+      double get_phase() const { return d_phase; }
+
+      //! compute sin and cos for current phase angle
+      void sincos(float *sinx, float *cosx) const;
+
+      //! compute cos or sin for current phase angle
+      float cos() const { return std::cos(d_phase); }
+      float sin() const { return std::sin(d_phase); }
+
+      //! compute a block at a time
+      void cos(float *output, const float *input, int noutput_items,
+               double k, double ampl = 1.0);
+
+    protected:
+      double d_phase;
+    };
+
+    template<class o_type, class i_type>
+    void
+    vco<o_type,i_type>::sincos(float *sinx, float *cosx) const
+    {
+      gr_sincosf(d_phase, sinx, cosx);
+    }
+
+    template<class o_type, class i_type>
+    void
+    vco<o_type,i_type>::cos(float *output, const float *input, int noutput_items,
+                            double k, double ampl)
+    {
+      for(int i = 0; i < noutput_items; i++) {
+        output[i] = cos() * ampl;
+        adjust_phase(input[i] * k);
+      }
+    }
+
+  } /* namespace blocks */
+} /* namespace gr */
+
+#endif /* _VCO_H_ */
diff --git a/gr-blocks/include/blocks/vco_f.h b/gr-blocks/include/blocks/vco_f.h
new file mode 100644
index 0000000000..0a5bf97d1f
--- /dev/null
+++ b/gr-blocks/include/blocks/vco_f.h
@@ -0,0 +1,57 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2005,2013 Free Software Foundation, Inc.
+ *
+ * This file is part of GNU Radio
+ *
+ * GNU Radio is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * GNU Radio is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GNU Radio; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef INCLUDED_GR_VCO_F_H
+#define INCLUDED_GR_VCO_F_H
+
+#include <blocks/api.h>
+#include <gr_sync_block.h>
+
+namespace gr {
+  namespace blocks {
+
+    /*!
+     * \brief VCO - Voltage controlled oscillator
+     * \ingroup misc
+     *
+     * input: float stream of control voltages; output: float oscillator output
+     */
+    class BLOCKS_API vco_f : virtual public gr_sync_block
+    {
+    public:
+      // gr::blocks::vco_f::sptr
+      typedef boost::shared_ptr<vco_f> sptr;
+
+      /*!
+       * \brief VCO - Voltage controlled oscillator
+       *
+       * \param sampling_rate sampling rate (Hz)
+       * \param sensitivity units are radians/sec/volt
+       * \param amplitude output amplitude
+       */
+      static sptr make(double sampling_rate, double sensitivity, double amplitude);
+    };
+
+  } /* namespace blocks */
+} /* namespace gr */
+
+#endif /* INCLUDED_GR_VCO_F_H */
author	Tom Rondeau <trondeau@vt.edu>	2013-03-08 08:57:46 -0500
committer	Tom Rondeau <trondeau@vt.edu>	2013-03-08 09:23:44 -0500
commit	4389b769891283face9aa397bd4d736f478e97e4 (patch)
tree	255aaaabba7075dfe2595170682ef2596fd93367 /gr-blocks/include
parent	42f8854f6d13de7e3f142f3f80233066a032d627 (diff)