Page 1 of 1
Documentation of SoundTouch Library
Posted: Sat Jun 29, 2019 4:28 pm
by eheilner
In the documentation of the SoundTouch Library - which is here:
https://wiki.audacityteam.org/wiki/SoundTouch - could we add a little note at the end of the third paragraph? Anything along these lines would be fine:
Note: While the SBSMS algorithm will preserve the overall loudness of the original track, please note that peak levels of some waveforms may be substantially higher.
Thank you!
Re: Documentation of SoundTouch Library
Posted: Sun Jun 30, 2019 10:45 pm
by steve
eheilner wrote: ↑Sat Jun 29, 2019 4:28 pm
please note that peak levels of some waveforms may be substantially higher.
I think that if we did that, then by the same rationale there would need to be similar warning for all other effects that may cause the peak level to change (which is most of them).
Re: Documentation of SoundTouch Library
Posted: Tue Jul 02, 2019 1:52 am
by eheilner
Then suggest a generic Effects page that you can link to - and add links to this page from the individual effects as needed.
E.g., something along these lines:
For additional information would send you to a page that had this info.
OR - at a minimum - add some sort of obvious warning in the Index of Effects, Generators, Analyzers and Tools
Re: Documentation of SoundTouch Library
Posted: Thu Jul 04, 2019 10:26 am
by waxcylinder
eheilner wrote: ↑Tue Jul 02, 2019 1:52 am
... add some sort of obvious warning in the Index of Effects, Generators, Analyzers and Tools
This is precisely what I am considering.
There is no rush, as I can only edit the alpha Manual for the upcoming 2.3.3 version. We cannot edit the Manuals for released Audacity versions.
But this is duly noted.
Peter.
Re: Documentation of SoundTouch Library
Posted: Wed Jul 10, 2019 4:32 pm
by eheilner
Thanks for following up on this.
Re: Documentation of SoundTouch Library
Posted: Thu Jul 11, 2019 11:07 am
by waxcylinder
Re: Documentation of SoundTouch Library
Posted: Sat Jul 13, 2019 8:35 pm
by eheilner
Thanks again Peter. I realize (as Steve implied earlier) that putting the warning in the Wiki is sort of a "slippery slope", since most effects can have unanticipated side effects. But - at least for this end user - that is the best place, since it is easily overlooked in the Effects & Analyzers menu pages.