Editing File Meta Sink

Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
Write stream to file with meta-data headers.
+
[[Category:Stub Docs]]
 +
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.
  
These files represent data as binary information in between meta-data headers. The headers contain information about the type of data and properties of the data in the next segment of samples.
+
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
The information includes:
 
*  rx_rate (double): sample rate of data.
 
*  rx_time (uint64_t, double): time stamp of first sample in segment.
 
*  size (uint32_t): item size in bytes.
 
*  type (::gr_file_types as int32_t): data type.
 
*  cplx (bool): Is data complex?
 
*  strt (uint64_t): Starting byte of data in this segment.
 
*  bytes (uint64_t): Size in bytes of data in this segment.
 
 
 
Tags can be sent to the file to update the information, which will create a new header. Headers are found by searching from the first header (at position 0 in the file) and reading where the data segment starts plus the data segment size. Following will either be a new header or EOF.
 
  
 
== Parameters ==
 
== Parameters ==
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
  
; File (''R'')
+
; Param 1 (''R'')
: Name of file to write data to.
+
: 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).
 
 
; Sample Rate
 
: Sample rate of data. If sample rate will be set by a tag, such as rx_tag from a UHD source, this is basically ignored.
 
 
 
; Relative_rate
 
: Rate chance from source of sample rate tag to sink.
 
 
 
; Max Seg. size
 
: Length of a single segment before the header is repeated (in items).
 
 
 
; Extra dict.
 
: A PMT dictionary of extra information.
 
 
 
; Detached header
 
: Set to true to store the header info in a separate file (named filename.hdr)
 
  
; Unbuffered (''R'')
+
; Param 2
: If new samples are flushed to file at the end of each call to the work function
+
: blah blah blah
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 45: Line 21:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/file_sink_impl.cc]
+
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/file_sink_base.cc]
 
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/file_sink_impl.h]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/include/gnuradio/blocks/file_meta_sink.h]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_file_meta_sink.block.yml]
+
: [https://github.com/gnuradio/gnuradio TODO]

Please note that all contributions to GNU Radio are considered to be released under the Creative Commons Attribution-ShareAlike (see GNU Radio:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)