Wav 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...")
 
(add "See Also" section w. refs to Wav file sink, file {sink,source})
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
It reads audio stream from a Microsoft PCM (pulse code modulated) (.wav) file (all versions of GNU Radio) and every other file format that [http://libsndfile.github.io/libsndfile/formats.html ''libsndfile''] supports (GNU Radio 3.9.0.0 and later).
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.
Its output is a float stream.
 
Unless called otherwise, the values are inside the range of [-1:1].


== 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
: 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).
: Path to the .wav file to be read


; Param 2
; Repeat
: blah blah blah
: Repeat playback of the file when end is reached
 
; N Channels
: Number of audio channels to output


== 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 a Wav File Source block producing pre-recorded radioteletype signals.
 
[[File:Test0624.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/wavfile_source_impl.cc]


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


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_wavfile_source.block.yml]
 
== See also ==
 
* [[Wav_File_Sink|Wav File Sink]] for info on how to write audio files
* [[File_Source|File Source]] for info how to read raw files
* [[File_Sink|File Sink]] for info how to write raw files

Latest revision as of 10:34, 26 June 2022

It reads audio stream from a Microsoft PCM (pulse code modulated) (.wav) file (all versions of GNU Radio) and every other file format that libsndfile supports (GNU Radio 3.9.0.0 and later).

Its output is a float stream.

Unless called otherwise, the values are inside the range of [-1:1].

Parameters

(R): Run-time adjustable

File
Path to the .wav file to be read
Repeat
Repeat playback of the file when end is reached
N Channels
Number of audio channels to output

Example Flowgraph

This flowgraph shows a Wav File Source block producing pre-recorded radioteletype signals.

Test0624.png

Source Files

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]

See also