GNU Radio 3.6.5.1 C++ API
gr_stream_mux.h
Go to the documentation of this file.
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_core_api.h>
28 #include <gr_block.h>
29 #include <vector>
30 
31 /*!
32  * \brief Creates a stream muxing block to multiplex many streams into
33  * one with a specified format.
34  *
35  * \param itemsize the item size of the stream
36  * \param length a vector (list/tuple) specifying the number of
37  * items from each stream the mux together.
38  * Warning: this requires that at least as many items
39  * per stream are available or the system will wait
40  * indefinitely for the items.
41  *
42  */
43 class gr_stream_mux;
45 
46 
47 
49 gr_make_stream_mux (size_t itemsize, const std::vector<int> &lengths);
50 
51 
52 /*!
53  * \brief Stream muxing block to multiplex many streams into
54  * one with a specified format.
55  *
56  * Muxes N streams together producing an output stream that
57  * contains N0 items from the first stream, N1 items from the second,
58  * etc. and repeats:
59  *
60  * [N0, N1, N2, ..., Nm, N0, N1, ...]
61  */
62 
64 {
66  gr_make_stream_mux (size_t itemsize, const std::vector<int> &lengths);
67 
68  protected:
69  gr_stream_mux (size_t itemsize, const std::vector<int> &lengths);
70 
71  private:
72  size_t d_itemsize;
73  unsigned int d_stream; // index of currently selected stream
74  int d_residual; // number if items left to put into current stream
75  gr_vector_int d_lengths; // number if items to pack per stream
76 
77  void increment_stream();
78 
79  public:
80  ~gr_stream_mux(void);
81 
82  void forecast (int noutput_items, gr_vector_int &ninput_items_required);
83 
84  int general_work(int noutput_items,
85  gr_vector_int &ninput_items,
86  gr_vector_const_void_star &input_items,
87  gr_vector_void_star &output_items);
88 
89 };
90 
91 
92 #endif