From 8a4d2a8231566e7e3399a6547b11fd22f9d1d115 Mon Sep 17 00:00:00 2001 From: Chris Cannam Date: Fri, 5 Feb 2016 15:02:51 +0000 Subject: [PATCH] Better docs on input format --- rubberband/RubberBandStretcher.h | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/rubberband/RubberBandStretcher.h b/rubberband/RubberBandStretcher.h index cba1cd2..b680e8c 100644 --- a/rubberband/RubberBandStretcher.h +++ b/rubberband/RubberBandStretcher.h @@ -551,9 +551,11 @@ public: * blocks in individual study() calls, or as a single large block. * * "input" should point to de-interleaved audio data with one - * float array per channel. "samples" supplies the number of - * audio sample frames available in "input". If "samples" is - * zero, "input" may be NULL. + * float array per channel. Sample values are conventionally + * expected to be in the range -1.0f to +1.0f. "samples" supplies + * the number of audio sample frames available in "input" (that + * is, the number of possibly multi-channel frames rather than of + * individual samples). If "samples" is zero, "input" may be NULL. * * Set "final" to true if this is the last block of data that will * be provided to study() before the first process() call. @@ -564,6 +566,13 @@ public: * Provide a block of "samples" sample frames for processing. * See also getSamplesRequired() and setMaxProcessSize(). * + * "input" should point to de-interleaved audio data with one + * float array per channel. Sample values are conventionally + * expected to be in the range -1.0f to +1.0f. "samples" supplies + * the number of audio sample frames available in "input" (that + * is, the number of possibly multi-channel frames rather than of + * individual samples). + * * Set "final" to true if this is the last block of input data. */ void process(const float *const *input, size_t samples, bool final);