GNU Radio 3.5.3.2 C++ API
gr_stream_mux.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2006 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_STREAM_MUX_H
00024 #define INCLUDED_GR_STREAM_MUX_H
00025 
00026 
00027 #include <gr_core_api.h>
00028 #include <gr_block.h>
00029 #include <vector>
00030 
00031 /*!
00032  * \brief Creates a stream muxing block to multiplex many streams into
00033  * one with a specified format.
00034  * \ingroup converter_blk
00035  *
00036  * \param itemsize the item size of the stream
00037  * \param length   a vector (list/tuple) specifying the number of
00038  *                 items from each stream the mux together.
00039  *                 Warning: this requires that at least as many items
00040  *                 per stream are available or the system will wait
00041  *                 indefinitely for the items.
00042  *
00043  */
00044 class gr_stream_mux;
00045 typedef boost::shared_ptr<gr_stream_mux> gr_stream_mux_sptr;
00046 
00047 
00048 
00049 GR_CORE_API gr_stream_mux_sptr 
00050 gr_make_stream_mux (size_t itemsize, const std::vector<int> &lengths);
00051 
00052 
00053 /*!
00054  * \brief Stream muxing block to multiplex many streams into
00055  * one with a specified format.
00056  * 
00057  * Muxes N streams together producing an output stream that
00058  * contains N0 items from the first stream, N1 items from the second,
00059  * etc. and repeats:
00060  *
00061  * [N0, N1, N2, ..., Nm, N0, N1, ...]
00062  */
00063 
00064 class GR_CORE_API gr_stream_mux : public gr_block
00065 {
00066   friend GR_CORE_API gr_stream_mux_sptr
00067     gr_make_stream_mux (size_t itemsize, const std::vector<int> &lengths);
00068   
00069  protected:
00070    gr_stream_mux (size_t itemsize, const std::vector<int> &lengths);
00071 
00072  private:
00073   size_t d_itemsize;
00074   unsigned int d_stream;    // index of currently selected stream
00075   int d_residual;           // number if items left to put into current stream
00076   gr_vector_int d_lengths;  // number if items to pack per stream
00077  
00078   void increment_stream();
00079 
00080  public:
00081   ~gr_stream_mux(void);
00082 
00083  void forecast (int noutput_items, gr_vector_int &ninput_items_required);
00084 
00085   int general_work(int noutput_items,
00086                    gr_vector_int &ninput_items,
00087                    gr_vector_const_void_star &input_items,
00088                    gr_vector_void_star &output_items);
00089 
00090 };
00091 
00092 
00093 #endif