Merge branch 'master' into next

Conflicts: gnuradio-runtime/include/gr_logger.h gr-digital/lib/packet_headergenerator_bb_impl.cc gr-digital/python/ofdm_txrx.py gr-digital/python/qa_ofdm_txrx.py gr-digital/python/qa_packet_headergenerator_bb.py gr-uhd/examples/python/usrp_spectrum_sense.py
author: Tom Rondeau <trondeau@vt.edu> 2013-04-01 12:42:34 -0400
committer: Tom Rondeau <trondeau@vt.edu> 2013-04-01 12:42:34 -0400
commit: 2a525ac04bcb0a70d193bddf9ba1018a99484904 (patch)
tree: d55538ecb7fb9a0e006df239ccbd93b8bab3ed20 /gr-digital
parent: fbd74560b72196fba9de8c6d01378b0715df758a (diff)
parent: 888c07f2510c49b5100223121ee02d9faea287d9 (diff)
14 files changed, 96 insertions, 55 deletions
diff --git a/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h b/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
index 68e8b7ad9f..de74d325ad 100644
--- a/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
+++ b/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
@@ -42,7 +42,7 @@ namespace gr {
      public:
       typedef boost::shared_ptr<ofdm_frame_equalizer_vcvc> sptr;
 
-      /*
+      /*!
        * \param equalizer The equalizer object that will do the actual work
        * \param len_tag_key Length tag key
        * \param propagate_channel_state If true, the channel state after the last symbol
diff --git a/gr-digital/include/digital/packet_header_default.h b/gr-digital/include/digital/packet_header_default.h
index a4158e728c..d69a0f30a6 100644
--- a/gr-digital/include/digital/packet_header_default.h
+++ b/gr-digital/include/digital/packet_header_default.h
@@ -30,9 +30,19 @@ namespace gr {
   namespace digital {
 
     /*!
-     * \brief <+description of block+>
+     * \brief Default header formatter for digital packet transmission.
      * \ingroup digital
      *
+     * For bursty/packetized digital transmission, packets are usually prepended
+     * with a packet header, containing the number of bytes etc.
+     * This class is not a block, but a tool to create these packet header.
+     *
+     * This is a default packet header (see header_formatter()) for a description
+     * on the header format). To create other header, derive packet header creator
+     * classes from this function.
+     *
+     * gr::digital::packet_headergenerator_bb uses header generators derived from
+     * this class to create packet headers from data streams.
      */
     class DIGITAL_API packet_header_default : public boost::enable_shared_from_this<gr::digital::packet_header_default>
     {
@@ -53,7 +63,8 @@ namespace gr {
       long header_len() { return d_header_len; };
       pmt::pmt_t len_tag_key() { return d_len_tag_key; };
 
-      /* \brief Encodes the header information in the given tags into bits and places them into \p out
+      /*!
+       * \brief Encodes the header information in the given tags into bits and places them into \p out
        *
        * Uses the following header format:
        * Bits 0-11: The packet length (what was stored in the tag with key \p len_tag_key)
@@ -70,7 +81,8 @@ namespace gr {
 	  const std::vector<gr_tag_t> &tags=std::vector<gr_tag_t>()
       );
 
-      /* \brief Inverse function to header_formatter().
+      /*!
+       * \brief Inverse function to header_formatter().
        *
        * Reads the bit stream in \in and writes a corresponding tag into \p tags.
        *
diff --git a/gr-digital/include/digital/packet_header_ofdm.h b/gr-digital/include/digital/packet_header_ofdm.h
index 6c3453ed1d..9f70900b49 100644
--- a/gr-digital/include/digital/packet_header_ofdm.h
+++ b/gr-digital/include/digital/packet_header_ofdm.h
@@ -48,7 +48,8 @@ namespace gr {
 		      int bits_per_sym=1);
       ~packet_header_ofdm();
 
-      /* \brief Inverse function to header_formatter().
+      /*!
+       * \brief Inverse function to header_formatter().
        *
        * Does the same as packet_header_default::header_parser(), but
        * adds another tag that stores the number of OFDM symbols in the
@@ -72,8 +73,8 @@ namespace gr {
 
      protected:
       pmt::pmt_t d_frame_len_tag_key;
-      const std::vector<std::vector<int> > d_occupied_carriers; //! Which carriers/symbols carry data
-      int d_syms_per_set; //! Helper variable: Total number of elements in d_occupied_carriers
+      const std::vector<std::vector<int> > d_occupied_carriers; //!< Which carriers/symbols carry data
+      int d_syms_per_set; //!< Helper variable: Total number of elements in d_occupied_carriers
     };
 
   } // namespace digital
diff --git a/gr-digital/include/digital/packet_headergenerator_bb.h b/gr-digital/include/digital/packet_headergenerator_bb.h
index 8d92bf84ed..cec860fd55 100644
--- a/gr-digital/include/digital/packet_headergenerator_bb.h
+++ b/gr-digital/include/digital/packet_headergenerator_bb.h
@@ -33,18 +33,33 @@ namespace gr {
      * \brief Generates a header for a tagged, streamed packet.
      * \ingroup digital
      *
-     * Input: A tagged stream. The first element must have a tag with the key
-     *        specified in len_tag_key, which hold the exact number of elements
-     *        in the PDU.
-     * Output: An tagged stream of length header_len. The output is determined
-     *         by a header formatter.
+     * Input: A tagged stream. This is consumed entirely, it is not appended
+     *        to the output stream.
+     * Output: An tagged stream containing the header. The details on the header
+     *         are set in a header formatter object (of type packet_header_default
+     *         or a subclass thereof). If only a number of bits is specified, a
+     *         default header is generated (see packet_header_default).
      */
     class DIGITAL_API packet_headergenerator_bb : virtual public gr_tagged_stream_block
     {
      public:
       typedef boost::shared_ptr<packet_headergenerator_bb> sptr;
 
-      static sptr make(const packet_header_default::sptr &header_formatter);
+      /* \param header_formatter A header formatter object.
+       * \param len_tag_key Length tag key. Note that for header generation,
+       *                    it is irrelevant which tag names are set in the
+       *                    formatter object, only this value is relevant!
+       */
+      static sptr make(
+	  const packet_header_default::sptr &header_formatter,
+	  const std::string &len_tag_key="packet_len"
+      );
+
+      /* \param header_len If this value is given, a packet_header_default
+       *                   object is used to generate the header. This is
+       *                   the number of bits per header.
+       * \param len_tag_key Length tag key.
+       */
       static sptr make(
 	   long header_len,
 	   const std::string &len_tag_key = "packet_len");
diff --git a/gr-digital/include/digital/packet_headerparser_b.h b/gr-digital/include/digital/packet_headerparser_b.h
index a3db069cbd..2dc6a80717 100644
--- a/gr-digital/include/digital/packet_headerparser_b.h
+++ b/gr-digital/include/digital/packet_headerparser_b.h
@@ -35,7 +35,11 @@ namespace gr {
      *
      * In a sense, this is the inverse block to packet_headergenerator_bb.
      * The difference is, the parsed header is not output as a stream,
-     * but as a message.
+     * but as a PMT dictionary, which is published to message port with
+     * the id "header_data".
+     * The dictionary consists of the tags created by the header formatter
+     * object. You should be able to use the exact same formatter object
+     * as used on the Tx side in the packet_headergenerator_bb.
      *
      * If only a header length is given, this block uses the default header
      * format.
diff --git a/gr-digital/lib/header_payload_demux_impl.h b/gr-digital/lib/header_payload_demux_impl.h
index ceab9a8629..dc8cc7883a 100644
--- a/gr-digital/lib/header_payload_demux_impl.h
+++ b/gr-digital/lib/header_payload_demux_impl.h
@@ -30,17 +30,17 @@ namespace gr {
     class header_payload_demux_impl : public header_payload_demux
     {
      private:
-      int d_header_len; //! Number of bytes per header
-      int d_items_per_symbol; //! Bytes per symbol
-      int d_gi; //! Bytes per guard interval
-      pmt::pmt_t d_len_tag_key; //! Key of length tag
-      pmt::pmt_t d_trigger_tag_key; //! Key of trigger tag (if used)
-      bool d_output_symbols; //! If true, output is symbols, not items
-      size_t d_itemsize; //! Bytes per item
-      bool d_uses_trigger_tag; //! If a trigger tag is used
-      int d_ninput_items_reqd; //! Helper for forecast()
-      int d_state; //! Current read state
-      int d_remaining_symbols; //! When in payload or header state, the number of symbols still to transmit
+      int d_header_len; //!< Number of bytes per header
+      int d_items_per_symbol; //!< Bytes per symbol
+      int d_gi; //!< Bytes per guard interval
+      pmt::pmt_t d_len_tag_key; //!< Key of length tag
+      pmt::pmt_t d_trigger_tag_key; //!< Key of trigger tag (if used)
+      bool d_output_symbols; //!< If true, output is symbols, not items
+      size_t d_itemsize; //!< Bytes per item
+      bool d_uses_trigger_tag; //!< If a trigger tag is used
+      int d_ninput_items_reqd; //!< Helper for forecast()
+      int d_state; //!< Current read state
+      int d_remaining_symbols; //!< When in payload or header state, the number of symbols still to transmit
 
       // Helpers to make the state machine more readable
 
diff --git a/gr-digital/lib/ofdm_frame_equalizer_vcvc_impl.h b/gr-digital/lib/ofdm_frame_equalizer_vcvc_impl.h
index 803874713f..f86451e839 100644
--- a/gr-digital/lib/ofdm_frame_equalizer_vcvc_impl.h
+++ b/gr-digital/lib/ofdm_frame_equalizer_vcvc_impl.h
@@ -36,7 +36,7 @@ namespace gr {
       std::vector<gr_complex> d_channel_state;
 
      protected:
-      // This aren't really necessary, so let's override them with nuthin'
+      // These aren't really necessary, so let's override them with nuthin'
       void remove_length_tags(const std::vector<std::vector<gr_tag_t> > &tags) {};
       void update_length_tags(int n_produced, int n_ports) {};
 
diff --git a/gr-digital/lib/ofdm_serializer_vcc_impl.h b/gr-digital/lib/ofdm_serializer_vcc_impl.h
index ef2f1c83b1..4f750eac71 100644
--- a/gr-digital/lib/ofdm_serializer_vcc_impl.h
+++ b/gr-digital/lib/ofdm_serializer_vcc_impl.h
@@ -30,16 +30,17 @@ namespace gr {
     class ofdm_serializer_vcc_impl : public ofdm_serializer_vcc
     {
      private:
-      int d_fft_len; //! FFT length
-      std::vector<std::vector<int> > d_occupied_carriers; //! Which carriers/symbols carry data
-      pmt::pmt_t d_packet_len_tag_key; //! Key of the length tag
-      pmt::pmt_t d_out_len_tag_key; //! Key of the length tag
-      const int d_symbols_skipped; //! Start position in d_occupied_carriers
-      int d_curr_set; //! Current position in d_occupied_carriers
+      int d_fft_len; //!< FFT length
+      std::vector<std::vector<int> > d_occupied_carriers; //!< Which carriers/symbols carry data
+      pmt::pmt_t d_packet_len_tag_key; //!< Key of the length tag
+      pmt::pmt_t d_out_len_tag_key; //!< Key of the length tag
+      const int d_symbols_skipped; //!< Start position in d_occupied_carriers
+      int d_curr_set; //!< Current position in d_occupied_carriers
       int d_symbols_per_set;
 
      protected:
-      /* Calculate the number of scalar complex symbols given a number of
+      /*!
+       * Calculate the number of scalar complex symbols given a number of
        * OFDM symbols.
        */
       int calculate_output_stream_length(const gr_vector_int &ninput_items);
diff --git a/gr-digital/lib/packet_headergenerator_bb_impl.cc b/gr-digital/lib/packet_headergenerator_bb_impl.cc
index bcfaf6b63d..3232858148 100644
--- a/gr-digital/lib/packet_headergenerator_bb_impl.cc
+++ b/gr-digital/lib/packet_headergenerator_bb_impl.cc
@@ -23,6 +23,7 @@
 #include "config.h"
 #endif
 
+#include <boost/format.hpp>
 #include <gr_io_signature.h>
 #include "packet_headergenerator_bb_impl.h"
 
@@ -30,9 +31,12 @@ namespace gr {
   namespace digital {
 
     packet_headergenerator_bb::sptr
-    packet_headergenerator_bb::make(const packet_header_default::sptr &header_formatter)
+    packet_headergenerator_bb::make(
+	const packet_header_default::sptr &header_formatter,
+	const std::string &len_tag_key
+    )
     {
-      return gnuradio::get_initial_sptr (new packet_headergenerator_bb_impl(header_formatter));
+      return gnuradio::get_initial_sptr (new packet_headergenerator_bb_impl(header_formatter, len_tag_key));
     }
 
 
@@ -45,25 +49,23 @@ namespace gr {
       const packet_header_default::sptr header_formatter(
 	  new packet_header_default(header_len, len_tag_key)
       );
-      return gnuradio::get_initial_sptr (new packet_headergenerator_bb_impl(header_formatter));
+      return gnuradio::get_initial_sptr (new packet_headergenerator_bb_impl(header_formatter, len_tag_key));
     }
 
 
     packet_headergenerator_bb_impl::packet_headergenerator_bb_impl(
-		    const gr::digital::packet_header_default::sptr &header_formatter
+		    const gr::digital::packet_header_default::sptr &header_formatter,
+		    const std::string &len_tag_key
 		    )
       : gr_tagged_stream_block("packet_headergenerator_bb_impl",
 		       gr_make_io_signature(1, 1, sizeof (char)),
 		       gr_make_io_signature(1, 1, sizeof (char)),
-		       pmt::symbol_to_string(header_formatter->len_tag_key())),
-	    d_formatter(header_formatter),
-	    d_input_size(1),
-	    d_header_len(header_formatter->header_len()),
-	    d_len_tag_value(pmt::from_long(d_header_len))
+		       len_tag_key),
+	    d_formatter(header_formatter)
     {
-      set_output_multiple(d_header_len);
+      set_output_multiple(d_formatter->header_len());
       // This is the worst case rate, because we don't know the true value, of course
-      set_relative_rate(d_header_len);
+      set_relative_rate(d_formatter->header_len());
       set_tag_propagation_policy(TPP_DONT);
     }
 
@@ -79,10 +81,11 @@ namespace gr {
     {
       unsigned char *out = (unsigned char *) output_items[0];
       if (!d_formatter->header_formatter(ninput_items[0], out)) {
+	GR_LOG_FATAL(d_logger, boost::format("header_formatter() returned false (this shouldn't happen). Offending header started at %1%") % nitems_read(0));
 	throw std::runtime_error("header formatter returned false.");
       }
 
-      return d_header_len;
+      return d_formatter->header_len();
     }
 
   } /* namespace digital */
diff --git a/gr-digital/lib/packet_headergenerator_bb_impl.h b/gr-digital/lib/packet_headergenerator_bb_impl.h
index 7d2494cf8b..ce60fdf76c 100644
--- a/gr-digital/lib/packet_headergenerator_bb_impl.h
+++ b/gr-digital/lib/packet_headergenerator_bb_impl.h
@@ -31,16 +31,16 @@ namespace gr {
     {
      private:
       gr::digital::packet_header_default::sptr d_formatter;
-      int d_input_size;
-      int d_header_len;
-      pmt::pmt_t d_len_tag_value;
 
      public:
-      packet_headergenerator_bb_impl(const packet_header_default::sptr &header_formatter);
+      packet_headergenerator_bb_impl(
+	  const packet_header_default::sptr &header_formatter,
+	  const std::string &len_tag_key
+      );
       ~packet_headergenerator_bb_impl();
 
       void remove_length_tags(const std::vector<std::vector<gr_tag_t> > &tags) {};
-      int calculate_output_stream_length(const gr_vector_int &ninput_items) { return d_header_len; };
+      int calculate_output_stream_length(const gr_vector_int &ninput_items) { return d_formatter->header_len(); };
 
       int work(int noutput_items,
 	  gr_vector_int &ninput_items,
diff --git a/gr-digital/lib/packet_headerparser_b_impl.cc b/gr-digital/lib/packet_headerparser_b_impl.cc
index 825cfa3d86..60e1fdef0b 100644
--- a/gr-digital/lib/packet_headerparser_b_impl.cc
+++ b/gr-digital/lib/packet_headerparser_b_impl.cc
@@ -23,6 +23,7 @@
 #include "config.h"
 #endif
 
+#include <boost/format.hpp>
 #include <gr_io_signature.h>
 #include "packet_headerparser_b_impl.h"
 
@@ -73,6 +74,7 @@ namespace gr {
 
       std::vector<gr_tag_t> tags;
       if (!d_header_formatter->header_parser(in, tags)) {
+	GR_LOG_INFO(d_logger, boost::format("Detected an invalid packet at item %1%") % nitems_read(0));
 	message_port_pub(msg_port_id, pmt::PMT_F);
       } else {
 	pmt::pmt_t dict(pmt::make_dict());
diff --git a/gr-digital/python/ofdm_txrx.py b/gr-digital/python/ofdm_txrx.py
index 190354e262..37c4086cc3 100644
--- a/gr-digital/python/ofdm_txrx.py
+++ b/gr-digital/python/ofdm_txrx.py
@@ -128,10 +128,10 @@ class ofdm_tx(gr.hier_block2):
             self.sync_words.append(self.sync_word2)
         crc = digital.crc32_bb(False, self.frame_length_tag_key)
         formatter_object = digital.packet_header_ofdm(
-            occupied_carriers, 1, self.frame_length_tag_key, self.frame_length_tag_key, "",
-            bps_header
+            occupied_carriers=occupied_carriers, n_syms=1,
+            bits_per_sym=self.bps_header
         )
-        header_gen = digital.packet_headergenerator_bb(formatter_object.base())
+        header_gen = digital.packet_headergenerator_bb(formatter_object.base(), self.frame_length_tag_key)
         header_payload_mux = blocks.tagged_stream_mux(gr.sizeof_gr_complex*1, self.frame_length_tag_key)
         self.connect(self, crc, header_gen, header_mod, (header_payload_mux, 0))
         payload_constellation = _get_constellation(bps_payload)
diff --git a/gr-digital/python/qa_ofdm_txrx.py b/gr-digital/python/qa_ofdm_txrx.py
index 963fca850c..15c5b90fe9 100755
--- a/gr-digital/python/qa_ofdm_txrx.py
+++ b/gr-digital/python/qa_ofdm_txrx.py
@@ -21,9 +21,12 @@
 # 
 
 import numpy
+import random
 from gnuradio import gr, gr_unittest
 import digital_swig as digital
 import blocks_swig as blocks
+from ofdm_txrx import ofdm_tx, ofdm_rx
+from utils import  tagged_streams
 
 class test_ofdm_txrx (gr_unittest.TestCase):
 
diff --git a/gr-digital/python/qa_packet_headergenerator_bb.py b/gr-digital/python/qa_packet_headergenerator_bb.py
index 43659c604d..0f42c33a51 100755
--- a/gr-digital/python/qa_packet_headergenerator_bb.py
+++ b/gr-digital/python/qa_packet_headergenerator_bb.py
@@ -110,7 +110,7 @@ class qa_packet_headergenerator_bb (gr_unittest.TestCase):
         tag3.value = pmt.from_long(4)
         src = blocks.vector_source_b(data, False, 1, (tag1, tag2, tag3))
         formatter_object = digital.packet_header_default(12, tagname)
-        header = digital.packet_headergenerator_bb(formatter_object.formatter())
+        header = digital.packet_headergenerator_bb(formatter_object.formatter(), tagname)
         sink = blocks.vector_sink_b()
         self.tb.connect(src, header, sink)
         self.tb.run()
@@ -142,7 +142,7 @@ class qa_packet_headergenerator_bb (gr_unittest.TestCase):
         formatter_object = digital.packet_header_ofdm(occupied_carriers, 1, tagname)
         self.assertEqual(formatter_object.header_len(), 6)
         self.assertEqual(pmt.symbol_to_string(formatter_object.len_tag_key()), tagname)
-        header = digital.packet_headergenerator_bb(formatter_object.formatter())
+        header = digital.packet_headergenerator_bb(formatter_object.formatter(), tagname)
         sink = blocks.vector_sink_b()
         self.tb.connect(src, header, sink)
         self.tb.run()
author	Tom Rondeau <trondeau@vt.edu>	2013-04-01 12:42:34 -0400
committer	Tom Rondeau <trondeau@vt.edu>	2013-04-01 12:42:34 -0400
commit	2a525ac04bcb0a70d193bddf9ba1018a99484904 (patch)
tree	d55538ecb7fb9a0e006df239ccbd93b8bab3ed20 /gr-digital
parent	fbd74560b72196fba9de8c6d01378b0715df758a (diff)
parent	888c07f2510c49b5100223121ee02d9faea287d9 (diff)