From 24198a162462b644de3e6e6783d433346d877dd3 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Wed, 24 Oct 2018 18:45:19 +0200 Subject: [PATCH] [effects] improve pitchscale documentation --- src/effects/pitchshift.h | 2 ++ src/effects/timestretch.h | 2 ++ 2 files changed, 4 insertions(+) diff --git a/src/effects/pitchshift.h b/src/effects/pitchshift.h index c27eed7a..8abf0585 100644 --- a/src/effects/pitchshift.h +++ b/src/effects/pitchshift.h @@ -81,6 +81,8 @@ uint_t aubio_pitchshift_get_latency (aubio_pitchshift_t * o); \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 */ diff --git a/src/effects/timestretch.h b/src/effects/timestretch.h index 960fb30d..8320b539 100644 --- a/src/effects/timestretch.h +++ b/src/effects/timestretch.h @@ -141,6 +141,8 @@ smpl_t aubio_timestretch_get_stretch (aubio_timestretch_t * o); \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 */ -- 2.11.0