Stream Mux: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
(Fix typo)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Stream muxing block to multiplex many streams into one with a specified format.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.


As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
Muxes N streams together producing an output stream that contains N0 items from the first stream, N1 items from the second, etc. and repeats:
        [N0, N1, N2, ..., Nm, N0, N1, ...]


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


; Param 1 (''R'')
; Lengths
: Description of parameter, provide any tips or recommended values. Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
: A vector (list/tuple) specifying the number of items from each stream the mux together. Warning: this requires that at least as many items per stream are available or the system will wait indefinitely for the items.


; Param 2
; Num inputs
: blah blah blah
: Number of input streams.


== Example Flowgraph ==
== Example Flowgraph ==


Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI.  Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.
This flowgraph shows the Stream Mux block muxing 2 input streams into an output stream with <tt>lengths = [3, 2]</tt>.
 
The block will take 3 items from the first stream, 2 items from the second stream, and repeat. Notice that tags are preserved.
 
 
[[File:Stream_mux_demo_flowgraph.png|800px]]
 
[[File:Stream_mux_demo_exec.png|800px]]


== Source Files ==
== Source Files ==


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/stream_mux_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/stream_mux_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/include/gnuradio/blocks/stream_mux.h]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_stream_mux.block.yml]

Latest revision as of 14:59, 29 October 2020

Stream muxing block to multiplex many streams into one with a specified format.

Muxes N streams together producing an output stream that contains N0 items from the first stream, N1 items from the second, etc. and repeats: 

       [N0, N1, N2, ..., Nm, N0, N1, ...]

Parameters

Lengths
A vector (list/tuple) specifying the number of items from each stream the mux together. Warning: this requires that at least as many items per stream are available or the system will wait indefinitely for the items.
Num inputs
Number of input streams.

Example Flowgraph

This flowgraph shows the Stream Mux block muxing 2 input streams into an output stream with lengths = [3, 2].

The block will take 3 items from the first stream, 2 items from the second stream, and repeat. Notice that tags are preserved.


Stream mux demo flowgraph.png

Stream mux demo exec.png

Source Files

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]
Retrieved from "https://wiki.gnuradio.org/index.php?title=Stream_Mux&oldid=7669"