blocks: moving tag_debug block to gr-blocks.

author: Tom Rondeau <trondeau@vt.edu> 2013-03-06 16:54:20 -0500
committer: Tom Rondeau <trondeau@vt.edu> 2013-03-06 16:54:20 -0500
commit: dc44e9b9d9bc0b6cd88cafe88efb5bcb0fe8ab64 (patch)
tree: 0355fe948c6c939f1c5c92409a1efddb6468a12f
parent: 9cfd03bd98693e62c6898f18d90d5d08f4d5c102 (diff)
9 files changed, 388 insertions, 0 deletions
diff --git a/gr-blocks/grc/blocks_block_tree.xml b/gr-blocks/grc/blocks_block_tree.xml
index e5db82115b..76b32c35e5 100644
--- a/gr-blocks/grc/blocks_block_tree.xml
+++ b/gr-blocks/grc/blocks_block_tree.xml
@@ -40,6 +40,7 @@
 	        <name>Sinks (New)</name>
 		<block>blocks_file_meta_sink</block>
 		<block>blocks_tagged_stream_to_pdu</block>
+		<block>blocks_tag_debug</block>
 		<block>blocks_message_sink</block>
 	</cat>
 	<cat>
diff --git a/gr-blocks/grc/blocks_tag_debug.xml b/gr-blocks/grc/blocks_tag_debug.xml
new file mode 100644
index 0000000000..929e53afed
--- /dev/null
+++ b/gr-blocks/grc/blocks_tag_debug.xml
@@ -0,0 +1,82 @@
+<?xml version="1.0"?>
+<!--
+###################################################
+## Tag Debug
+###################################################
+ -->
+<block>
+	<name>Tag Debug</name>
+	<key>blocks_tag_debug</key>
+	<import>from gnuradio import blocks</import>
+	<make>blocks.tag_debug($type.size*$vlen, $name)</make>
+	<callback>set_display($display)</callback>
+	<param>
+		<name>Input 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>Name</name>
+		<key>name</key>
+		<type>string</type>
+	</param>
+	<param>
+		<name>Num Inputs</name>
+		<key>num_inputs</key>
+		<value>1</value>
+		<type>int</type>
+	</param>
+	<param>
+		<name>Vec Length</name>
+		<key>vlen</key>
+		<value>1</value>
+		<type>int</type>
+	</param>
+	<param>
+		<name>Display</name>
+		<key>display</key>
+		<value>True</value>
+		<type>bool</type>
+		<option>
+			<name>On</name>
+			<key>True</key>
+		</option>
+		<option>
+			<name>Off</name>
+			<key>False</key>
+		</option>
+	</param>
+	<check>$num_inputs &gt;= 1</check>
+	<check>$vlen &gt; 0</check>
+	<sink>
+		<name>in</name>
+		<type>$type</type>
+		<vlen>$vlen</vlen>
+		<nports>$num_inputs</nports>
+	</sink>
+</block>
diff --git a/gr-blocks/include/blocks/CMakeLists.txt b/gr-blocks/include/blocks/CMakeLists.txt
index a223731cb0..79f095d265 100644
--- a/gr-blocks/include/blocks/CMakeLists.txt
+++ b/gr-blocks/include/blocks/CMakeLists.txt
@@ -156,6 +156,7 @@ install(FILES
     streams_to_stream.h
     streams_to_vector.h
     stretch_ff.h
+    tag_debug.h
     tagged_stream_to_pdu.h
     threshold_ff.h
     throttle.h
diff --git a/gr-blocks/include/blocks/tag_debug.h b/gr-blocks/include/blocks/tag_debug.h
new file mode 100644
index 0000000000..9d27a26ecd
--- /dev/null
+++ b/gr-blocks/include/blocks/tag_debug.h
@@ -0,0 +1,80 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2012-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_TAG_DEBUG_H
+#define INCLUDED_GR_TAG_DEBUG_H
+
+#include <blocks/api.h>
+#include <gr_sync_block.h>
+
+namespace gr {
+  namespace blocks {
+
+    /*!
+     * \brief Bit bucket that prints out any tag received.
+     * \ingroup sink_blk
+     *
+     * This block collects all tags sent to it on all input ports and
+     * displays them to stdout in a formatted way. The \p name
+     * parameter is used to identify which debug sink generated the
+     * tag, so when connecting a block to this debug sink, an
+     * appropriate name is something that identifies the input block.
+     *
+     * This block otherwise acts as a NULL sink in that items from the
+     * input stream are ignored. It is designed to be able to attach
+     * to any block and watch all tags streaming out of that block for
+     * debugging purposes.
+     *
+     * The tags from the last call to this work function are stored
+     * and can be retrieved using the function 'current_tags'.
+     */
+    class BLOCKS_API tag_debug : virtual public gr_sync_block
+    {
+    public:
+      // gr::blocks::tag_debug::sptr
+      typedef boost::shared_ptr<tag_debug> sptr;
+
+      /*!
+       * Build a tag debug block
+       *
+       * \param sizeof_stream_item size of the items in the incoming stream.
+       * \param name name to identify which debug sink generated the info.
+       */
+      static sptr make(size_t sizeof_stream_item,
+                       const std::string &name);
+
+      /*!
+       * \brief Returns a vector of gr_tag_t items as of the last call to
+       * work.
+       */
+      virtual std::vector<gr_tag_t> current_tags() = 0;
+
+      /*!
+       * \brief Set the display of tags to stdout on/off.
+       */
+      virtual void set_display(bool d) = 0;
+    };
+
+  } /* namespace blocks */
+} /* namespace gr */
+
+#endif /* INCLUDED_GR_TAG_DEBUG_H */
diff --git a/gr-blocks/lib/CMakeLists.txt b/gr-blocks/lib/CMakeLists.txt
index c575f4215e..27b4e233a6 100644
--- a/gr-blocks/lib/CMakeLists.txt
+++ b/gr-blocks/lib/CMakeLists.txt
@@ -180,6 +180,7 @@ list(APPEND gr_blocks_sources
     pack_k_bits_bb_impl.cc
     patterned_interleaver_impl.cc
     pdu.cc
+    tag_debug_impl.cc
     pdu_to_tagged_stream_impl.cc
     peak_detector2_fb_impl.cc
     regenerate_bb_impl.cc
diff --git a/gr-blocks/lib/tag_debug_impl.cc b/gr-blocks/lib/tag_debug_impl.cc
new file mode 100644
index 0000000000..a216879637
--- /dev/null
+++ b/gr-blocks/lib/tag_debug_impl.cc
@@ -0,0 +1,118 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2012-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.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "tag_debug_impl.h"
+#include <gr_io_signature.h>
+#include <iostream>
+#include <iomanip>
+
+namespace gr {
+  namespace blocks {
+
+    tag_debug::sptr
+    tag_debug::make(size_t sizeof_stream_item,
+                    const std::string &name)
+    {
+      return gnuradio::get_initial_sptr
+        (new tag_debug_impl(sizeof_stream_item, name));
+    }
+
+    tag_debug_impl::tag_debug_impl(size_t sizeof_stream_item,
+                                   const std::string &name)
+      : gr_sync_block("tag_debug",
+                      gr_make_io_signature(1, -1, sizeof_stream_item),
+                      gr_make_io_signature(0, 0, 0)),
+        d_name(name), d_display(true)
+    {
+    }
+
+    tag_debug_impl::~tag_debug_impl()
+    {
+    }
+
+    std::vector<gr_tag_t>
+    tag_debug_impl::current_tags()
+    {
+      gruel::scoped_lock l(d_mutex);
+      return d_tags;
+    }
+
+    void
+    tag_debug_impl::set_display(bool d)
+    {
+      gruel::scoped_lock l(d_mutex);
+      d_display = d;
+    }
+
+    int
+    tag_debug_impl::work(int noutput_items,
+                         gr_vector_const_void_star &input_items,
+                         gr_vector_void_star &output_items)
+    {
+      gruel::scoped_lock l(d_mutex);
+
+      std::stringstream sout;
+      if(d_display) {
+        sout << std::endl
+             << "----------------------------------------------------------------------";
+        sout << std::endl << "Tag Debug: " << d_name << std::endl;
+      }
+
+      uint64_t abs_N, end_N;
+      for(size_t i = 0; i < input_items.size(); i++) {
+        abs_N = nitems_read(i);
+        end_N = abs_N + (uint64_t)(noutput_items);
+
+        d_tags.clear();
+        get_tags_in_range(d_tags, i, abs_N, end_N);
+
+        if(d_display) {
+          sout << "Input Stream: " << std::setw(2) << std::setfill('0') 
+               << i << std::setfill(' ') << std::endl;
+          for(d_tags_itr = d_tags.begin(); d_tags_itr != d_tags.end(); d_tags_itr++) {
+            sout << std::setw(10) << "Offset: " << d_tags_itr->offset
+                 << std::setw(10) << "Source: " 
+                 << (pmt::pmt_is_symbol(d_tags_itr->srcid) ? pmt::pmt_symbol_to_string(d_tags_itr->srcid) : "n/a")
+                 << std::setw(10) << "Key: " << pmt::pmt_symbol_to_string(d_tags_itr->key)
+                 << std::setw(10) << "Value: ";
+            sout << d_tags_itr->value << std::endl;
+          }
+        }
+      }
+
+      if(d_display) {
+        sout << "----------------------------------------------------------------------";
+        sout << std::endl;
+
+        if(d_tags.size() > 0)
+          std::cout << sout.str();
+      }
+
+      return noutput_items;
+    }
+
+  } /* namespace blocks */
+} /* namespace gr */
diff --git a/gr-blocks/lib/tag_debug_impl.h b/gr-blocks/lib/tag_debug_impl.h
new file mode 100644
index 0000000000..988d0e1103
--- /dev/null
+++ b/gr-blocks/lib/tag_debug_impl.h
@@ -0,0 +1,58 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2012-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_TAG_DEBUG_IMPL_H
+#define INCLUDED_GR_TAG_DEBUG_IMPL_H
+
+#include <blocks/tag_debug.h>
+#include <gruel/thread.h>
+#include <stddef.h>
+
+namespace gr {
+  namespace blocks {
+
+    class tag_debug_impl : public tag_debug
+    {
+    private:
+      std::string d_name;
+      std::vector<gr_tag_t> d_tags;
+      std::vector<gr_tag_t>::iterator d_tags_itr;
+      bool d_display;
+      gruel::mutex d_mutex;
+
+    public:
+      tag_debug_impl(size_t sizeof_stream_item, const std::string &name);
+      ~tag_debug_impl();
+
+      std::vector<gr_tag_t> current_tags();
+
+      void set_display(bool d);
+
+      int work(int noutput_items,
+               gr_vector_const_void_star &input_items,
+               gr_vector_void_star &output_items);
+    };
+
+  } /* namespace blocks */
+} /* namespace gr */
+
+#endif /* INCLUDED_GR_TAG_DEBUG_IMPL_H */
diff --git a/gr-blocks/python/qa_tag_debug.py b/gr-blocks/python/qa_tag_debug.py
new file mode 100755
index 0000000000..ad85daebcc
--- /dev/null
+++ b/gr-blocks/python/qa_tag_debug.py
@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+#
+# Copyright 2012-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.
+#
+
+from gnuradio import gr, gr_unittest
+import blocks_swig as blocks
+
+class test_tag_debug(gr_unittest.TestCase):
+
+    def setUp(self):
+        self.tb = gr.top_block()
+
+    def tearDown(self):
+        self.tb = None
+
+    def test_001(self):
+        # Just run some data through and make sure it doesn't puke.
+        src_data = (1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
+        src = gr.vector_source_i(src_data)
+        op = blocks.tag_debug(gr.sizeof_int, "tag QA")
+        self.tb.connect(src, op)
+        self.tb.run()
+        x = op.current_tags()
+
+if __name__ == '__main__':
+    gr_unittest.run(test_tag_debug, "test_tag_debug.xml")
diff --git a/gr-blocks/swig/blocks_swig.i b/gr-blocks/swig/blocks_swig.i
index bd34351b95..456eccc194 100644
--- a/gr-blocks/swig/blocks_swig.i
+++ b/gr-blocks/swig/blocks_swig.i
@@ -162,6 +162,7 @@
 #include "blocks/sub_ss.h"
 #include "blocks/sub_ii.h"
 #include "blocks/sub_cc.h"
+#include "blocks/tag_debug.h"
 #include "blocks/tagged_stream_to_pdu.h"
 #include "blocks/threshold_ff.h"
 #include "blocks/throttle.h"
@@ -284,6 +285,7 @@
 %include "blocks/packed_to_unpacked_ss.h"
 %include "blocks/packed_to_unpacked_ii.h"
 %include "blocks/patterned_interleaver.h"
+%include "blocks/tag_debug.h"
 %include "blocks/pdu_to_tagged_stream.h"
 %include "blocks/peak_detector_fb.h"
 %include "blocks/peak_detector_ib.h"
@@ -457,6 +459,7 @@ GR_SWIG_BLOCK_MAGIC2(blocks, sub_ff);
 GR_SWIG_BLOCK_MAGIC2(blocks, sub_ss);
 GR_SWIG_BLOCK_MAGIC2(blocks, sub_ii);
 GR_SWIG_BLOCK_MAGIC2(blocks, sub_cc);
+GR_SWIG_BLOCK_MAGIC2(blocks, tag_debug);
 GR_SWIG_BLOCK_MAGIC2(blocks, tagged_stream_to_pdu);
 GR_SWIG_BLOCK_MAGIC2(blocks, threshold_ff);
 GR_SWIG_BLOCK_MAGIC2(blocks, throttle);
author	Tom Rondeau <trondeau@vt.edu>	2013-03-06 16:54:20 -0500
committer	Tom Rondeau <trondeau@vt.edu>	2013-03-06 16:54:20 -0500
commit	dc44e9b9d9bc0b6cd88cafe88efb5bcb0fe8ab64 (patch)
tree	0355fe948c6c939f1c5c92409a1efddb6468a12f
parent	9cfd03bd98693e62c6898f18d90d5d08f4d5c102 (diff)