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 2, 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 <gr_frame.h>
  29 #include <vector>
  30
  31 class gr_stream_mux;
  32 typedef boost::shared_ptr<gr_stream_mux> gr_stream_mux_sptr;
  33
  34 /*!
  35  * \brief Creates a stream muxing block to multiplex many streams into
  36  * one with a specified format.
  37  *
  38  * \param itemsize the item size of the stream
  39  * \param length   a vector (list/tuple) specifying the number of
  40  *                 items from each stream the mux together.
  41  *                 Warning: this requires that at least as many items
  42  *                 per stream are available or the system will wait
  43  *                 indefinitely for the items.
  44  *
  45  */
  46
  47 gr_stream_mux_sptr
  48 gr_make_stream_mux (size_t itemsize, const std::vector<int> &lengths);
  49
  50
  51 /*!
  52  * \brief Stream muxing block to multiplex many streams into
  53  * one with a specified format.
  54  *
  55  * Muxes N streams together producing an output stream that
  56  * contains N0 items from the first stream, N1 items from the second,
  57  * etc. and repeats:
  58  *
  59  * [N0, N1, N2, ..., Nm, N0, N1, ...]
  60  */
  61
  62 class gr_stream_mux : public gr_block
  63 {
  64   friend gr_stream_mux_sptr
  65     gr_make_stream_mux (size_t itemsize, const std::vector<int> &lengths);
  66
  67  protected:
  68    gr_stream_mux (size_t itemsize, const std::vector<int> &lengths);
  69  private:
  70    size_t d_itemsize;
  71    unsigned int d_stream;
  72    int d_residual;
  73    int d_times;
  74    int d_unconsume;
  75    //gr_vector_int d_unconsume;
  76    gr_vector_int d_lengths;
  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