Wav File Sink: 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...")
 
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Write stream to a Microsoft PCM (pulse code modulated) (.wav) file (all versions of GNU Radio) and some other file formats 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.
Values must be floats within [-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 (''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).
: Path to the file to write to


; Param 2
; N Channels
: blah blah blah
: Number of audio channels
 
; Sample Rate
: Sample rate of the recording
 
; Output Format (GNU Radio 3.9 and later)
: choice of possible container/audio formats:
 
* WAV (old-school windows RIFF sound files)
* FLAC (lossless audio codec – probably a good choice for storage of actual audio data)
* Ogg file (Container for lossy compression – allows for choice of vorbis, or OPUS, as audio codec. Prefer OPUS. Very good quality.)
* 64-bit WAV ([https://en.wikipedia.org/wiki/RF64 RF64], used in broadcasting standards, to support massive multichannel files, and files > 4 GB)
 
; Bits per Samples (only WAV, FLAC, 64-bit WAV)
: Bit-depth of the recording.
: Rule of thumb: you don't need more than 2 + (audio SNR in dB)·2 bits of integer bitdepth to keep quantization noise below signal noise.
: "Float" always suffices, but is wasteful on size, if you're using "Double" without having written down a calculation why, you're doing it wrong


== 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.
[[File:Mic_to_OPUS.png]]
 
Non-GUI flow graph. Records a microphone to an OPUS-compressed .ogg file. Very handy.


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


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


; Header files
; Header files
Line 27: Line 45:


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


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

Latest revision as of 11:53, 26 June 2022

Write stream to a Microsoft PCM (pulse code modulated) (.wav) file (all versions of GNU Radio) and some other file formats that libsndfile supports (GNU Radio 3.9.0.0 and later):

Values must be floats within [-1;1].

Parameters

(R): Run-time adjustable

File (R)
Path to the file to write to
N Channels
Number of audio channels
Sample Rate
Sample rate of the recording
Output Format (GNU Radio 3.9 and later)
choice of possible container/audio formats:
  • WAV (old-school windows RIFF sound files)
  • FLAC (lossless audio codec – probably a good choice for storage of actual audio data)
  • Ogg file (Container for lossy compression – allows for choice of vorbis, or OPUS, as audio codec. Prefer OPUS. Very good quality.)
  • 64-bit WAV (RF64, used in broadcasting standards, to support massive multichannel files, and files > 4 GB)
Bits per Samples (only WAV, FLAC, 64-bit WAV)
Bit-depth of the recording.
Rule of thumb: you don't need more than 2 + (audio SNR in dB)·2 bits of integer bitdepth to keep quantization noise below signal noise.
"Float" always suffices, but is wasteful on size, if you're using "Double" without having written down a calculation why, you're doing it wrong

Example Flowgraph

Mic to OPUS.png

Non-GUI flow graph. Records a microphone to an OPUS-compressed .ogg file. Very handy.

Source Files

C++ files
wavfile_sink_impl.cc
wavfile_sink_impl.h
Header files
TODO
Public header files
wavfile_sink.h
Block definition
blocks_wavfile_sink.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=Wav_File_Sink&oldid=12352"