david/librubberband
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Better docs on input format

Browse Source
This commit is contained in:
Chris Cannam
2016-02-05 15:02:51 +00:00
parent 176a84b550
commit 8a4d2a8231
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
rubberband/RubberBandStretcher.h
View File

@@ -551,9 +551,11 @@ public:
* blocks in individual study() calls, or as a single large block. * blocks in individual study() calls, or as a single large block.
* *
* "input" should point to de-interleaved audio data with one * "input" should point to de-interleaved audio data with one
* float array per channel. "samples" supplies the number of * float array per channel. Sample values are conventionally
* audio sample frames available in "input". If "samples" is * expected to be in the range -1.0f to +1.0f. "samples" supplies
* zero, "input" may be NULL. * 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 * Set "final" to true if this is the last block of data that will
* be provided to study() before the first process() call. * be provided to study() before the first process() call.
@@ -564,6 +566,13 @@ public:
* Provide a block of "samples" sample frames for processing. * Provide a block of "samples" sample frames for processing.
* See also getSamplesRequired() and setMaxProcessSize(). * 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. * Set "final" to true if this is the last block of input data.
*/ */
void process(const float *const *input, size_t samples, bool final); void process(const float *const *input, size_t samples, bool final);