Wavfile Sink: Header docstring still only mentions PCM, but we do all of libsnd

[marcusmueller]

What happened?

wavfile_sink.h still says

gnuradio/gr-blocks/include/gnuradio/blocks/wavfile_source.h

Line 21 in d25a59c

* \brief Read stream from a Microsoft PCM (.wav) file, output floats

Also, Check gr_make_wavfile_source() for extra info. is utterly meaningless (and would not be much better if this was still GNU Radio 3.6, where such a function might have still existed).

same for …_source.h

Now, starting since 3.9.0.0, we do all the formats that libsndfile can handle.

Fix

• Remove https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/include/gnuradio/blocks/wavfile_source.h#L26
• replace the \brief … sentence with "Write samples to an audio file (uncompressed or compressed)"
• Add the list of supported audio containers from the wiki page to the \details section
• Replace all occurences of "wav file header" in the comments with "audio file metadata" or similar
• Apply the above to wavfile_sink.h as well

System Information

OS: –
GR Installation Method: –

GNU Radio Version

3.11-git (main)

Specific Version

3.9.0.0 and later

Steps to Reproduce the Problem

reading the docstrings

Relevant log output

No response

[drmpeg]

I wouldn't say all of libsndfile. There are many other formats that are not being selected. Here's the complete list (scroll down to File Open Function):

https://libsndfile.github.io/libsndfile/api.html

Some formats that may be useful are Matlab/Octave and MP3 (which has just been added).

[marcusmueller]

yes, this remains outstanding and a good first issue, sadly Harshiit never came back.