Changes in src/effects/pitchshift.h [683d52f5:124acfb]

File:

• src/effects/pitchshift.h (modified) (3 diffs)

src/effects/pitchshift.h

@@ -46 +46 @@
 
 */
-void aubio_pitchshift_do (aubio_pitchshift_t * o, const fvec_t * in, fvec_t * out);
+void aubio_pitchshift_do (aubio_pitchshift_t * o, const fvec_t * in,
+        fvec_t * out);
 
 /** deletion of the pitch shifting object
@@ -82 +83 @@
   \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
 
 */
-uint_t aubio_pitchshift_set_pitchscale (aubio_pitchshift_t * o, smpl_t pitchscale);
+uint_t aubio_pitchshift_set_pitchscale (aubio_pitchshift_t * o,
+        smpl_t pitchscale);
 
 /** get the pitchscale of the pitch shifting object
@@ -99 +103 @@
 
   \param o pitch shifting object as returned by new_aubio_pitchshift()
-  \param transpose new pitch transposition of the pitch shifting object, expressed
-  in semitones (should be in the range [-24;+24])
+  \param transpose new pitch transposition of the pitch shifting object,
+  expressed in semitones (should be in the range [-24;+24])
 
   \return 0 if successfull, non-zero otherwise
 
 */
-uint_t aubio_pitchshift_set_transpose (aubio_pitchshift_t * o, smpl_t transpose);
+uint_t aubio_pitchshift_set_transpose (aubio_pitchshift_t * o,
+        smpl_t transpose);
 
 /** get the transposition of the pitch shifting object, in semitones