blocks: added gr::blocks::keep_one_in_n

9 files changed, 332 insertions, 0 deletions

diff --git a/gr-blocks/grc/blocks_block_tree.xml b/gr-blocks/grc/blocks_block_tree.xml
index dfbe88b05..37cd2fc4d 100644
--- a/gr-blocks/grc/blocks_block_tree.xml
+++ b/gr-blocks/grc/blocks_block_tree.xml
@@ -75,5 +75,6 @@
 	        <name>Stream Operations (New) </name>
 		<block>blocks_deinterleave.xml</block>
 		<block>blocks_interleave.xml</block>
+		<block>blocks_keep_one_in_n.xml</block>
 	</cat>
 </cat>
diff --git a/gr-blocks/grc/blocks_keep_one_in_n.xml b/gr-blocks/grc/blocks_keep_one_in_n.xml
new file mode 100644
index 000000000..4289a984f
--- /dev/null
+++ b/gr-blocks/grc/blocks_keep_one_in_n.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0"?>
+<!--
+###################################################
+##Keep 1 in N
+###################################################
+ -->
+<block>
+	<name>Keep 1 in N</name>
+	<key>blocks_keep_one_in_n</key>
+	<import>from gnuradio import blocks</import>
+	<make>blocks.keep_one_in_n($type.size*$vlen, $n)</make>
+	<callback>set_n($n)</callback>
+	<param>
+		<name>Type</name>
+		<key>type</key>
+		<type>enum</type>
+		<option>
+			<name>Complex</name>
+			<key>complex</key>
+			<opt>size:gr.sizeof_gr_complex</opt>
+		</option>
+		<option>
+			<name>Float</name>
+			<key>float</key>
+			<opt>size:gr.sizeof_float</opt>
+		</option>
+		<option>
+			<name>Int</name>
+			<key>int</key>
+			<opt>size:gr.sizeof_int</opt>
+		</option>
+		<option>
+			<name>Short</name>
+			<key>short</key>
+			<opt>size:gr.sizeof_short</opt>
+		</option>
+		<option>
+			<name>Byte</name>
+			<key>byte</key>
+			<opt>size:gr.sizeof_char</opt>
+		</option>
+	</param>
+	<param>
+		<name>N</name>
+		<key>n</key>
+		<value>1</value>
+		<type>int</type>
+	</param>
+	<param>
+		<name>Vec Length</name>
+		<key>vlen</key>
+		<value>1</value>
+		<type>int</type>
+	</param>
+	<check>$n &gt; 0</check>
+	<check>$vlen &gt; 0</check>
+	<sink>
+		<name>in</name>
+		<type>$type</type>
+		<vlen>$vlen</vlen>
+	</sink>
+	<source>
+		<name>out</name>
+		<type>$type</type>
+		<vlen>$vlen</vlen>
+	</source>
+</block>
diff --git a/gr-blocks/include/blocks/CMakeLists.txt b/gr-blocks/include/blocks/CMakeLists.txt
index a8a1c5a62..5b4c0e437 100644
--- a/gr-blocks/include/blocks/CMakeLists.txt
+++ b/gr-blocks/include/blocks/CMakeLists.txt
@@ -109,6 +109,7 @@ install(FILES
     int_to_float.h
     interleave.h
     interleaved_short_to_complex.h
+    keep_one_in_n.h
     multiply_cc.h
     multiply_ff.h
     multiply_conjugate_cc.h
diff --git a/gr-blocks/include/blocks/keep_one_in_n.h b/gr-blocks/include/blocks/keep_one_in_n.h
new file mode 100644
index 000000000..c48784994
--- /dev/null
+++ b/gr-blocks/include/blocks/keep_one_in_n.h
@@ -0,0 +1,51 @@
+/* -*- c++ -*- */
+/*
+ * 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_BLOCKS_KEEP_ONE_IN_N_H
+#define INCLUDED_BLOCKS_KEEP_ONE_IN_N_H
+
+#include <blocks/api.h>
+#include <gr_block.h>
+
+namespace gr {
+  namespace blocks {
+
+    /*!
+     * \brief decimate a stream, keeping one item out of every n.
+     * \ingroup slicedice_blk
+     */
+    class BLOCKS_API keep_one_in_n : virtual public gr_block
+    {
+    public:
+      
+      // gr::blocks::keep_one_in_n::sptr
+      typedef boost::shared_ptr<keep_one_in_n> sptr;
+
+      static sptr make(size_t itemsize, int n);
+
+      virtual void set_n(int n) = 0;
+    };
+
+  } /* namespace blocks */
+} /* namespace gr */
+
+#endif /* INCLUDED_BLOCKS_KEEP_ONE_IN_N_H */
diff --git a/gr-blocks/lib/CMakeLists.txt b/gr-blocks/lib/CMakeLists.txt
index f224330d4..1e34b544f 100644
--- a/gr-blocks/lib/CMakeLists.txt
+++ b/gr-blocks/lib/CMakeLists.txt
@@ -146,6 +146,7 @@ list(APPEND gr_blocks_sources
     interleave_impl.cc
     interleaved_short_array_to_complex.cc
     interleaved_short_to_complex_impl.cc
+    keep_one_in_n_impl.cc
     multiply_cc_impl.cc
     multiply_ff_impl.cc
     multiply_conjugate_cc_impl.cc
diff --git a/gr-blocks/lib/keep_one_in_n_impl.cc b/gr-blocks/lib/keep_one_in_n_impl.cc
new file mode 100644
index 000000000..7ab6dc14d
--- /dev/null
+++ b/gr-blocks/lib/keep_one_in_n_impl.cc
@@ -0,0 +1,109 @@
+/* -*- c++ -*- */
+/*
+ * 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.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "keep_one_in_n_impl.h"
+#include <gr_io_signature.h>
+
+namespace gr {
+  namespace blocks {
+
+    keep_one_in_n::sptr keep_one_in_n::make(size_t itemsize, int n)
+    {
+      return gnuradio::get_initial_sptr(new keep_one_in_n_impl(itemsize, n));
+    }
+
+    keep_one_in_n_impl::keep_one_in_n_impl(size_t itemsize, int n)
+      : gr_block("keep_one_in_n",
+		 gr_make_io_signature (1, 1, itemsize),
+		 gr_make_io_signature (1, 1, itemsize)),
+	d_count(n)
+    {
+      // To avoid bad behavior with using set_relative_rate in this block with
+      // VERY large values of n, we will keep track of things ourselves. Using
+      // this to turn off automatic tag propagation, which will be handled
+      // locally in general_work().
+      set_tag_propagation_policy(TPP_DONT);
+
+      set_n(n);
+    }
+
+    void
+    keep_one_in_n_impl::set_n(int n)
+    {
+      if (n < 1)
+	n = 1;
+      
+      d_n = n;
+      d_count = n;
+
+      // keep our internal understanding of the relative rate of this block
+      // don't set the relative rate, though, and we will handle our own
+      // tag propagation.
+      d_decim_rate = 1.0/(float)d_n;
+    }
+
+    int
+    keep_one_in_n_impl::general_work(int noutput_items,
+				     gr_vector_int &ninput_items,
+				     gr_vector_const_void_star &input_items,
+				     gr_vector_void_star &output_items)
+    {
+      const char *in = (const char *) input_items[0];
+      char *out = (char *) output_items[0];
+      
+      size_t item_size = input_signature ()->sizeof_stream_item (0);
+      int	    ni = 0;
+      int	    no = 0;
+
+      while (ni < ninput_items[0] && no < noutput_items){
+	d_count--;
+	if (d_count <= 0){
+	  memcpy (out, in, item_size);		// copy 1 item
+	  out += item_size;
+	  no++;
+	  d_count = d_n;
+	}
+	in += item_size;
+	ni++;
+      }
+
+      // Because we have set TPP_DONT, we have to propagate the tags here manually.
+      // Adjustment of the tag sample value is done using the float d_decim_rate.
+      std::vector<gr_tag_t> tags;
+      std::vector<gr_tag_t>::iterator t;
+      get_tags_in_range(tags, 0, nitems_read(0), nitems_read(0)+ni);
+      for(t = tags.begin(); t != tags.end(); t++) {
+	gr_tag_t new_tag = *t;
+	new_tag.offset *= d_decim_rate;
+	add_item_tag(0, new_tag);
+      }
+
+      consume_each (ni);
+      return no;
+    }
+
+  } /* namespace blocks */
+} /* namespace gr */
diff --git a/gr-blocks/lib/keep_one_in_n_impl.h b/gr-blocks/lib/keep_one_in_n_impl.h
new file mode 100644
index 000000000..1588fb1a6
--- /dev/null
+++ b/gr-blocks/lib/keep_one_in_n_impl.h
@@ -0,0 +1,53 @@
+
+/* -*- c++ -*- */
+/*
+ * 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_KEEP_ONE_IN_N_IMPL_H
+#define INCLUDED_KEEP_ONE_IN_N_IMPL_H
+
+#include <blocks/keep_one_in_n.h>
+
+namespace gr {
+  namespace blocks {
+
+    class BLOCKS_API keep_one_in_n_impl : public keep_one_in_n
+    {
+      int   d_n;
+      int   d_count;
+      float d_decim_rate;
+
+    public:
+      keep_one_in_n_impl(size_t itemsize,int n);
+
+      int general_work(int noutput_items,
+		       gr_vector_int &ninput_items,
+		       gr_vector_const_void_star &input_items,
+		       gr_vector_void_star &output_items);
+      
+      void set_n(int n);
+    };
+
+  } /* namespace blocks */
+} /* namespace gr */
+   
+
+#endif /* INCLUDED_KEEP_ONE_IN_N_IMPL_H */
diff --git a/gr-blocks/python/qa_keep_one_in_n.py b/gr-blocks/python/qa_keep_one_in_n.py
new file mode 100755
index 000000000..8c5f44b84
--- /dev/null
+++ b/gr-blocks/python/qa_keep_one_in_n.py
@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+#
+# 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.
+#
+
+from gnuradio import gr, gr_unittest
+import blocks_swig
+
+class test_keep_one_in_n(gr_unittest.TestCase):
+
+    def setUp (self):
+        self.tb = gr.top_block ()
+
+    def tearDown (self):
+        self.tb = None
+
+    def test_001(self):
+        src_data = (1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
+        expected_data = (5, 10)
+        src = gr.vector_source_b(src_data);
+        op = blocks_swig.keep_one_in_n(gr.sizeof_char, 5)
+        dst = gr.vector_sink_b()
+        self.tb.connect(src, op, dst)
+        self.tb.run()
+        self.assertEqual(dst.data(), expected_data)
+
+
+if __name__ == '__main__':
+    gr_unittest.run(test_keep_one_in_n, "test_integrate.xml")
diff --git a/gr-blocks/swig/blocks_swig.i b/gr-blocks/swig/blocks_swig.i
index 108232e0f..ea3071805 100644
--- a/gr-blocks/swig/blocks_swig.i
+++ b/gr-blocks/swig/blocks_swig.i
@@ -73,6 +73,7 @@
 #include "blocks/integrate_cc.h"
 #include "blocks/interleave.h"
 #include "blocks/interleaved_short_to_complex.h"
+#include "blocks/keep_one_in_n.h"
 #include "blocks/multiply_ss.h"
 #include "blocks/multiply_ii.h"
 #include "blocks/multiply_ff.h"
@@ -150,6 +151,7 @@
 %include "blocks/integrate_cc.h"
 %include "blocks/interleave.h"
 %include "blocks/interleaved_short_to_complex.h"
+%include "blocks/keep_one_in_n.h"
 %include "blocks/multiply_ss.h"
 %include "blocks/multiply_ii.h"
 %include "blocks/multiply_ff.h"
@@ -226,6 +228,7 @@ GR_SWIG_BLOCK_MAGIC2(blocks, integrate_ff);
 GR_SWIG_BLOCK_MAGIC2(blocks, integrate_cc);
 GR_SWIG_BLOCK_MAGIC2(blocks, interleave);
 GR_SWIG_BLOCK_MAGIC2(blocks, interleaved_short_to_complex);
+GR_SWIG_BLOCK_MAGIC2(blocks, keep_one_in_n);
 GR_SWIG_BLOCK_MAGIC2(blocks, multiply_ss);
 GR_SWIG_BLOCK_MAGIC2(blocks, multiply_ii);
 GR_SWIG_BLOCK_MAGIC2(blocks, multiply_ff);