ref: 24198a162462b644de3e6e6783d433346d877dd3
parent: 986c04cc23d6310d5da15e8f5767232a4571abde
author: Paul Brossier <piem@piem.org>
date: Wed Oct 24 14:45:19 EDT 2018
[effects] improve pitchscale documentation
--- a/src/effects/pitchshift.h
+++ b/src/effects/pitchshift.h
@@ -81,6 +81,8 @@
\param o pitch shifting object as returned by new_aubio_pitchshift()
\param pitchscale new pitch scale of the pitch shifting object
+ pitchscale is a frequency ratio. It should be in the range [0.25, 4].
+
\return 0 if successfull, non-zero otherwise
*/
--- a/src/effects/timestretch.h
+++ b/src/effects/timestretch.h
@@ -141,6 +141,8 @@
\param o time stretching object as returned by new_aubio_timestretch()
\param pitchscale new pitch scale of the time stretching object
+ pitchscale is a frequency ratio. It should be in the range [0.25, 4].
+
\return 0 if successfull, non-zero otherwise
*/