Doc updates

This commit is contained in:
Chris Cannam
2024-10-25 17:23:38 +01:00
parent cdde17c3dc
commit 8c4dc5cbb0
3 changed files with 12 additions and 11 deletions

View File

@@ -31,7 +31,7 @@ PROJECT_NAME = "Rubber Band Library"
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
# if some version control system is used. # if some version control system is used.
PROJECT_NUMBER = 3.3.0 PROJECT_NUMBER = 4.0.0
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put. # base path where the generated documentation will be put.

View File

@@ -51,9 +51,10 @@ namespace RubberBand
* Band Library designed for applications that need to perform * Band Library designed for applications that need to perform
* pitch-shifting only, without time-stretching, and to do so in a * pitch-shifting only, without time-stretching, and to do so in a
* straightforward block-by-block process with the shortest available * straightforward block-by-block process with the shortest available
* processing delay. * processing delay. For the more general interface, see
* RubberBand::RubberBandStretcher.
* *
* RubberBandLiveShifter has a much simpler API than the general * RubberBandLiveShifter has a much simpler API than
* RubberBandStretcher. Its process function, called * RubberBandStretcher. Its process function, called
* RubberBandLiveShifter::shift(), accepts a fixed number of sample * RubberBandLiveShifter::shift(), accepts a fixed number of sample
* frames on each call and always returns exactly the same number of * frames on each call and always returns exactly the same number of
@@ -61,12 +62,12 @@ namespace RubberBand
* process/available/retrieve call sequence that RubberBandStretcher * process/available/retrieve call sequence that RubberBandStretcher
* requires as a result of its variable output rate. * requires as a result of its variable output rate.
* *
* The number of frames RubberBandLiveShifter::shift() accepts and * The number of frames accepted by and returned from
* returns is not under the caller's control: it always requires * RubberBandLiveShifter::shift() are not under the caller's control:
* exactly the number given by RubberBandLiveShifter::getBlockSize(). * they must always be exactly the number given by
* However, that number is fixed for the lifetime of the shifter, so * RubberBandLiveShifter::getBlockSize(). But this number is fixed for
* it only needs to be queried once and then fixed-size buffers may be * the lifetime of the shifter, so it only needs to be queried once
* passed. * after construction and then fixed-size buffers may be used.
* *
* Using RubberBandLiveShifter also gives a shorter processing delay * Using RubberBandLiveShifter also gives a shorter processing delay
* than a typical buffering setup using RubberBandStretcher, making it * than a typical buffering setup using RubberBandStretcher, making it

View File

@@ -56,13 +56,13 @@ namespace RubberBand
* The primary Rubber Band Library API is contained in the class * The primary Rubber Band Library API is contained in the class
* RubberBand::RubberBandStretcher. This class can perform both pitch * RubberBand::RubberBandStretcher. This class can perform both pitch
* shifting and time stretching and supports every feature of the * shifting and time stretching and supports every feature of the
* library. A simpler, more limited alternative API that supports only * library. A simpler, more limited API that supports only
* pitch-shifting can be found in RubberBand::RubberBandLiveShifter. * pitch-shifting can be found in RubberBand::RubberBandLiveShifter.
* *
* RubberBandStretcher supports two processing modes, offline and * RubberBandStretcher supports two processing modes, offline and
* real-time, and two processing "engines", known as the R2 or Faster * real-time, and two processing "engines", known as the R2 or Faster
* engine and the R3 or Finer engine. The choices of processing mode * engine and the R3 or Finer engine. The choices of processing mode
* and engine are fixed on construction: see * and engine are fixed on construction: see the constructor
* RubberBandStretcher::RubberBandStretcher. The two engines work * RubberBandStretcher::RubberBandStretcher. The two engines work
* identically in API terms, and both of them support both offline and * identically in API terms, and both of them support both offline and
* real-time modes as described below. * real-time modes as described below.