File Source: 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...")
 
m (Unbracket bare URL(s). There is good reason not to disguise the links, and readers should be able to see the filename without hovering.)
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Reads raw data values in binary format from the specified file. This file can be a file that was captured using a [[File Sink]] block, generated with a computer program or saved from an audio editor such as Audacity (using suitable RAW format options).  
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.


== 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>


; Param 1 (''R'')
; File (''R'')
: 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).
: Filename of binary file. <b>Note:</b> The file MUST be on the local computer.
The file size must not be less than 8 bytes, otherwise it gives the following error: "RuntimeError: file is too small"
 
; Output Type
: Because a binary file does not store information about what type of data is in it, we have to tell GNU Radio the format.
 
; Repeat (''R'')
: Whether or not to repeat the signal, once the end of the file is reached
 
; Add Begin Tag (''R'')
: Key of a tag to add to the first sample of the stream, and if Repeat is true, the first sample of each repeated copy.  The provided expression must create a PMT.  For example, <code>pmt.intern("example_key")</code> will create a key that represents the string <code>"example_key"</code>.  See [[Polymorphic_Types_(PMTs)]] and [[Stream_Tags]] for more information.


; Param 2
; Offset
: blah blah blah
: Start offset samples/items after the beginning of the file
 
; Length
: Read only this number of items beginning from offset(offset+len). 0 will read until the end of the file.


== 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 can be found at https://github.com/gnuradio/gnuradio/blob/master/gr-dtv/examples/dvbt_rx_8k.grc.
 
[[File:Dvbt_rx_8k_fg.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/file_source_impl.cc


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/file_source_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/file_source.h


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

Latest revision as of 08:43, 27 April 2023

Reads raw data values in binary format from the specified file. This file can be a file that was captured using a File Sink block, generated with a computer program or saved from an audio editor such as Audacity (using suitable RAW format options).

Parameters

(R): Run-time adjustable

File (R)
Filename of binary file. Note: The file MUST be on the local computer.

The file size must not be less than 8 bytes, otherwise it gives the following error: "RuntimeError: file is too small"

Output Type
Because a binary file does not store information about what type of data is in it, we have to tell GNU Radio the format.
Repeat (R)
Whether or not to repeat the signal, once the end of the file is reached
Add Begin Tag (R)
Key of a tag to add to the first sample of the stream, and if Repeat is true, the first sample of each repeated copy. The provided expression must create a PMT. For example, pmt.intern("example_key") will create a key that represents the string "example_key". See Polymorphic_Types_(PMTs) and Stream_Tags for more information.
Offset
Start offset samples/items after the beginning of the file
Length
Read only this number of items beginning from offset(offset+len). 0 will read until the end of the file.

Example Flowgraph

This flowgraph can be found at https://github.com/gnuradio/gnuradio/blob/master/gr-dtv/examples/dvbt_rx_8k.grc.

Dvbt rx 8k fg.png

Source Files

C++ files
https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/file_source_impl.cc
Header files
https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/file_source_impl.h
Public header files
https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/include/gnuradio/blocks/file_source.h
Block definition
https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_file_source.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=File_Source&oldid=13100"