filter: work on creating gr-filter top-level component.

Builds but does not bring in libgnuradio-fft.so symbols.
author: Tom Rondeau <trondeau@vt.edu> 2012-05-01 22:10:17 -0400
committer: Tom Rondeau <trondeau@vt.edu> 2012-05-01 22:10:17 -0400
commit: f64b971f34ab813f70b0680ec7ae02744343ef3c (patch)
tree: 4a1795690ba1628d0d71917a7dd14d6da92a79af /gr-filter/include
parent: a7afbf205a543967ee949f6b6409c2a295e6905d (diff)
5 files changed, 420 insertions, 0 deletions
diff --git a/gr-filter/include/filter/CMakeLists.txt b/gr-filter/include/filter/CMakeLists.txt
new file mode 100644
index 0000000000..a3c83f3dcc
--- /dev/null
+++ b/gr-filter/include/filter/CMakeLists.txt
@@ -0,0 +1,82 @@
+# Copyright 2012 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.
+
+########################################################################
+# generate helper scripts to expand templated files
+########################################################################
+include(GrPython)
+
+file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py "
+#!${PYTHON_EXECUTABLE}
+
+import sys, os, re
+sys.path.append('${GR_CORE_PYTHONPATH}')
+os.environ['srcdir'] = '${CMAKE_CURRENT_SOURCE_DIR}'
+os.chdir('${CMAKE_CURRENT_BINARY_DIR}')
+
+if __name__ == '__main__':
+    import build_utils
+   root, inp = sys.argv[1:3]
+    for sig in sys.argv[3:]:
+        name = re.sub ('X+', sig, root)
+        d = build_utils.standard_dict2(name, sig, 'filter')
+        build_utils.expand_template(d, inp)
+
+")
+
+macro(expand_h root)
+  #make a list of all the generated files
+  unset(expanded_files_h)
+  foreach(sig ${ARGN})
+    string(REGEX REPLACE "X+" ${sig} name ${root})
+    list(APPEND expanded_files_h ${CMAKE_CURRENT_BINARY_DIR}/${name}.h)
+  endforeach(sig)
+  
+  #create a command to generate the files
+  add_custom_command(
+    OUTPUT ${expanded_files_h}
+    DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${root}.h.t
+    COMMAND ${PYTHON_EXECUTABLE} ${PYTHON_DASH_B}
+    ${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py
+    ${root} ${root}.h.t ${ARGN}
+    )
+
+  #install rules for the generated h files
+  list(APPEND generated_includes ${expanded_files_h})
+endmacro(expand_h)
+
+########################################################################
+# Invoke macro to generate various sources
+#######################################################################
+#expand_h(fir_filter_XXX fff ccc ccf fcc fsf scc)
+
+#add_custom_target(filter_generated_includes DEPENDS
+#    ${generated_includes}
+#)
+
+########################################################################
+# Install header files
+########################################################################
+install(FILES
+    api.h
+    fir_filter_fff.h
+    DESTINATION ${GR_INCLUDE_DIR}/gnuradio/fft
+    COMPONENT "fft_devel"
+)
+
diff --git a/gr-filter/include/filter/api.h b/gr-filter/include/filter/api.h
new file mode 100644
index 0000000000..025b0bd4a7
--- /dev/null
+++ b/gr-filter/include/filter/api.h
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2012 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_FILTER_API_H
+#define INCLUDED_FILTER_API_H
+
+#include <gruel/attributes.h>
+
+#ifdef gnuradio_filter_EXPORTS
+#  define FILTER_API __GR_ATTR_EXPORT
+#else
+#  define FILTER_API __GR_ATTR_IMPORT
+#endif
+
+#endif /* INCLUDED_FILTER_API_H */
diff --git a/gr-filter/include/filter/fft.h b/gr-filter/include/filter/fft.h
new file mode 100644
index 0000000000..5cc2e21e81
--- /dev/null
+++ b/gr-filter/include/filter/fft.h
@@ -0,0 +1,195 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2003,2008,2012 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 _FFT_FFT_H_
+#define _FFT_FFT_H_
+
+/*
+ * Wrappers for FFTW single precision 1d dft
+ */
+
+#include <fft/api.h>
+#include <gr_complex.h>
+#include <boost/thread.hpp>
+
+namespace gr {
+  namespace fft {
+
+
+    /*! \brief Helper function for allocating complex fft buffers
+     */
+    gr_complex* malloc_complex(int size);
+
+    /*! \brief Helper function for allocating float fft buffers
+     */
+    float* malloc_float(int size);
+    
+    /*! \brief Helper function for freeing fft buffers
+     */
+    void free(void *b);
+
+    /*!
+     * \brief Export reference to planner mutex for those apps that
+     * want to use FFTW w/o using the fft_impl_fftw* classes.
+     */
+    class FFT_API planner {
+    public:
+      typedef boost::mutex::scoped_lock scoped_lock;
+      /*!
+       * Return reference to planner mutex
+       */
+      static boost::mutex &mutex();
+    };
+
+    /*!
+     * \brief FFT: complex in, complex out
+     * \ingroup misc
+     */
+    class FFT_API fft_complex {
+      int	      d_fft_size;
+      int         d_nthreads;
+      gr_complex *d_inbuf;
+      gr_complex *d_outbuf;
+      void	     *d_plan;
+
+    public:
+      fft_complex(int fft_size, bool forward = true, int nthreads=1);
+      virtual ~fft_complex();
+      
+      /*
+       * These return pointers to buffers owned by fft_impl_fft_complex
+       * into which input and output take place. It's done this way in
+       * order to ensure optimal alignment for SIMD instructions.
+       */
+      gr_complex *get_inbuf()  const { return d_inbuf; }
+      gr_complex *get_outbuf() const { return d_outbuf; }
+      
+      int inbuf_length()  const { return d_fft_size; }
+      int outbuf_length() const { return d_fft_size; }
+      
+      /*!
+       *  Set the number of threads to use for caclulation.
+       */
+      void set_nthreads(int n);
+      
+      /*!
+       *  Get the number of threads being used by FFTW
+       */
+      int nthreads() const { return d_nthreads; }
+      
+      /*!
+       * compute FFT. The input comes from inbuf, the output is placed in
+       * outbuf.
+       */
+      void execute();
+    };
+
+    /*!
+     * \brief FFT: real in, complex out
+     * \ingroup misc
+     */
+    class FFT_API fft_real_fwd {
+      int	  d_fft_size;
+      int         d_nthreads;
+      float	 *d_inbuf;
+      gr_complex *d_outbuf;
+      void	 *d_plan;
+
+    public:
+      fft_real_fwd (int fft_size, int nthreads=1);
+      virtual ~fft_real_fwd ();
+      
+      /*
+       * These return pointers to buffers owned by fft_impl_fft_real_fwd
+       * into which input and output take place. It's done this way in
+       * order to ensure optimal alignment for SIMD instructions.
+       */
+      float *get_inbuf()      const { return d_inbuf; }
+      gr_complex *get_outbuf() const { return d_outbuf; }
+      
+      int inbuf_length()  const { return d_fft_size; }
+      int outbuf_length() const { return d_fft_size / 2 + 1; }
+      
+      /*!
+       *  Set the number of threads to use for caclulation.
+       */
+      void set_nthreads(int n);
+      
+      /*!
+       *  Get the number of threads being used by FFTW
+       */
+      int nthreads() const { return d_nthreads; }
+      
+      /*!
+       * compute FFT. The input comes from inbuf, the output is placed in
+       * outbuf.
+       */
+      void execute();
+    };
+
+    /*!
+     * \brief FFT: complex in, float out
+     * \ingroup misc
+     */
+    class FFT_API fft_real_rev {
+      int	      d_fft_size;
+      int         d_nthreads;
+      gr_complex *d_inbuf;
+      float	     *d_outbuf;
+      void	     *d_plan;
+      
+    public:
+      fft_real_rev(int fft_size, int nthreads=1);
+      virtual ~fft_real_rev();
+      
+      /*
+       * These return pointers to buffers owned by fft_impl_fft_real_rev
+       * into which input and output take place. It's done this way in
+       * order to ensure optimal alignment for SIMD instructions.
+       */
+      gr_complex *get_inbuf() const { return d_inbuf; }
+      float *get_outbuf() const { return d_outbuf; }
+      
+      int inbuf_length()  const { return d_fft_size / 2 + 1; }
+      int outbuf_length() const { return d_fft_size; }
+      
+      /*!
+       *  Set the number of threads to use for caclulation.
+       */
+      void set_nthreads(int n);
+      
+      /*!
+       *  Get the number of threads being used by FFTW
+       */
+      int nthreads() const { return d_nthreads; }
+      
+      /*!
+       * compute FFT. The input comes from inbuf, the output is placed in
+       * outbuf.
+       */
+      void execute();
+    };
+
+  } /* namespace fft */
+} /*namespace gr */
+
+#endif /* _FFT_FFT_H_ */
diff --git a/gr-filter/include/filter/fft_vcc.h b/gr-filter/include/filter/fft_vcc.h
new file mode 100644
index 0000000000..561ae858d2
--- /dev/null
+++ b/gr-filter/include/filter/fft_vcc.h
@@ -0,0 +1,57 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2004,2007,2008,2012 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_FFT_FFT_VCC_H
+#define INCLUDED_FFT_FFT_VCC_H
+
+#include <fft/api.h>
+#include <gr_sync_block.h>
+
+namespace gr {
+  namespace fft {
+
+    class FFT_API fft_vcc : virtual public gr_sync_block
+    {
+    public:
+
+      // gr::fft::fft_vcc::sptr
+      typedef boost::shared_ptr<fft_vcc> sptr;
+
+      /*!
+       * \brief Compute forward or reverse FFT. complex vector in / complex vector out.
+       * \ingroup dft_blk
+       */
+      static FFT_API sptr make(int fft_size, bool forward,
+			       const std::vector<float> &window,
+			       bool shift=false, int nthreads=1);
+      
+      virtual void set_nthreads(int n) = 0;
+
+      virtual int nthreads() const = 0;
+
+      virtual bool set_window(const std::vector<float> &window) = 0;
+    };
+
+  } /* namespace fft */
+} /* namespace gr */
+
+#endif /* INCLUDED_FFT_FFT_VCC_H */
diff --git a/gr-filter/include/filter/fir_filter_fff.h b/gr-filter/include/filter/fir_filter_fff.h
new file mode 100644
index 0000000000..5b6d19b34f
--- /dev/null
+++ b/gr-filter/include/filter/fir_filter_fff.h
@@ -0,0 +1,53 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2004,2012 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 FILTER_FIR_FILTER_FFF_H
+#define	FILTER_FIR_FILTER_FFF_H
+
+#include <filter/api.h>
+#include <gr_sync_decimator.h>
+
+namespace gr {
+  namespace filter {
+
+    class FILTER_API fir_filter_fff : virtual public gr_sync_decimator
+    {
+    public:
+
+      // gr::filter::fir_filter_fff::sptr
+      typedef boost::shared_ptr<fir_filter_fff> sptr;
+
+      /*!
+       * \brief FIR filter with float input, float output, and float taps
+       * \ingroup filter_blk
+       */
+      static FILTER_API sptr make(int decimation,
+				  const std::vector<float> &taps);
+
+      virtual void set_taps (const std::vector<float> &taps) = 0;
+      virtual std::vector<float> taps () const = 0;
+    };
+
+  } /* namespace filter */
+} /* namespace gr */
+
+#endif /* FILTER_FIR_FILTER_FFF_H */
author	Tom Rondeau <trondeau@vt.edu>	2012-05-01 22:10:17 -0400
committer	Tom Rondeau <trondeau@vt.edu>	2012-05-01 22:10:17 -0400
commit	f64b971f34ab813f70b0680ec7ae02744343ef3c (patch)
tree	4a1795690ba1628d0d71917a7dd14d6da92a79af /gr-filter/include
parent	a7afbf205a543967ee949f6b6409c2a295e6905d (diff)