Documentation issue in WavAudioFormat

[pdesantis]

The docs for WavAudioFormat::createWriterFor say:

numberOfChannels: the number of channels - this must be either 1 or 2, and the choice will depend on the results of canDoMono() and canDoStereo()

However, it seems to work just fine when passing in a number greater than 2. Is the documentation old, or am I just lucky that it works?

https://docs.juce.com/master/classWavAudioFormat.html#a989d29b8ca1c28389700f0e5ee17b3ee

[mcmartin]

WavAudioFormat supports more than mono and stereo since https://github.com/WeAreROLI/JUCE/commit/7ca5ad001e0c603020f90425dfadec467b7b4649 (JUCE 5.1.0), so you’re not just lucky

You should prefer using the overload of createWriterFor which takes the channelLayout as an AudioChannelSet to be more explicit.

WavAudioFormat::createWriterFor actually doesn’t have its own documentation, but “inherits” the documentation from AudioFormat::createWriterFor, which it implements. I guess that documentation should be updated a bit.

[daniel]

It goes even further back, 2011 it was extended to four formats: mono / stereo / 5.0 / 5.1

Added RF64 support to WavAudioFormat. Extended some of the audio source classes to support 64-bit sample indices.

And was touched in the meantime another time to add more formats…
If the OP wants to find out such things: Clicking on “Blame” is a great function in git

[pdesantis]

Thanks for the help! I created a pull request to fix this:

Documentation - Update AudioFormat::createWriterFor

Is that the proper way to go about this? I see the README mentions

We don’t accept third party GitHub pull requests directly due to copyright restrictions

[mcmartin]

It is indeed the right way to go about this. What is mentioned on the README means that the JUCE team won’t merge your pull request directly, but they do welcome patches!

[ed95]

Thanks for reporting:

Updated the documentation of AudioFormat::createWriterFor()

[BobBrownConsulting]

Is there a reason 7.1 SDDS was selected as the default for 8 channels rather than 7.1?

I’m trying to figure out how to rewrite “standard” 7.1 WAV files.

See this post for more details:

Please implement CoreAudioFormat::createWriterFor()

I’m looking at exporting a wav file for “standard” 7.1 and NOT 7.1 SDDS. It look likes like the WavAudioFormat does not support the AudioChannelSet::create7point1. Looking at WavAudioFormat::isChannelLayoutSupported it range checks the channel types to be between AudioChannelSet::left and AudioChannelSet::topRearRight. The 7.1 channel set contains leftSurroundRear and rightSurroundRear which are out of that range. Is there a fundamental issue with "fmt " extension that prevents using those cha…