git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/general/gr_stream_mux.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2006 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifndef INCLUDED_GR_STREAM_MUX_H
  24 #define INCLUDED_GR_STREAM_MUX_H
  25
  26
  27 #include <gr_block.h>
  28 #include <vector>
  29
  30 class gr_stream_mux;
  31 typedef boost::shared_ptr<gr_stream_mux> gr_stream_mux_sptr;
  32
  33 /*!
  34  * \brief Creates a stream muxing block to multiplex many streams into
  35  * one with a specified format.
  36  *
  37  * \param itemsize the item size of the stream
  38  * \param length   a vector (list/tuple) specifying the number of
  39  *                 items from each stream the mux together.
  40  *                 Warning: this requires that at least as many items
  41  *                 per stream are available or the system will wait
  42  *                 indefinitely for the items.
  43  *
  44  */
  45
  46 gr_stream_mux_sptr
  47 gr_make_stream_mux (size_t itemsize, const std::vector<int> &lengths);
  48
  49
  50 /*!
  51  * \brief Stream muxing block to multiplex many streams into
  52  * one with a specified format.
  53  *
  54  * Muxes N streams together producing an output stream that
  55  * contains N0 items from the first stream, N1 items from the second,
  56  * etc. and repeats:
  57  *
  58  * [N0, N1, N2, ..., Nm, N0, N1, ...]
  59  */
  60
  61 class gr_stream_mux : public gr_block
  62 {
  63   friend gr_stream_mux_sptr
  64     gr_make_stream_mux (size_t itemsize, const std::vector<int> &lengths);
  65
  66  protected:
  67    gr_stream_mux (size_t itemsize, const std::vector<int> &lengths);
  68
  69  private:
  70   size_t d_itemsize;
  71   unsigned int d_stream;    // index of currently selected stream
  72   int d_residual;           // number if items left to put into current stream
  73   gr_vector_int d_lengths;  // number if items to pack per stream
  74
  75   void increment_stream();
  76
  77  public:
  78   ~gr_stream_mux(void);
  79
  80  void forecast (int noutput_items, gr_vector_int &ninput_items_required);
  81
  82   int general_work(int noutput_items,
  83                    gr_vector_int &ninput_items,
  84                    gr_vector_const_void_star &input_items,
  85                    gr_vector_void_star &output_items);
  86
  87 };
  88
  89
  90 #endif