diff --git a/Doxyfile b/Doxyfile index f084e33..9072839 100644 --- a/Doxyfile +++ b/Doxyfile @@ -31,7 +31,7 @@ PROJECT_NAME = "Rubber Band Library" # This could be handy for archiving the generated documentation or # 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) # base path where the generated documentation will be put. diff --git a/rubberband/RubberBandLiveShifter.h b/rubberband/RubberBandLiveShifter.h index 8081195..e809666 100644 --- a/rubberband/RubberBandLiveShifter.h +++ b/rubberband/RubberBandLiveShifter.h @@ -51,9 +51,10 @@ namespace RubberBand * Band Library designed for applications that need to perform * pitch-shifting only, without time-stretching, and to do so in a * 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 * RubberBandLiveShifter::shift(), accepts a fixed number of sample * 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 * requires as a result of its variable output rate. * - * The number of frames RubberBandLiveShifter::shift() accepts and - * returns is not under the caller's control: it always requires - * exactly the number given by RubberBandLiveShifter::getBlockSize(). - * However, that number is fixed for the lifetime of the shifter, so - * it only needs to be queried once and then fixed-size buffers may be - * passed. + * The number of frames accepted by and returned from + * RubberBandLiveShifter::shift() are not under the caller's control: + * they must always be exactly the number given by + * RubberBandLiveShifter::getBlockSize(). But this number is fixed for + * the lifetime of the shifter, so it only needs to be queried once + * after construction and then fixed-size buffers may be used. * * Using RubberBandLiveShifter also gives a shorter processing delay * than a typical buffering setup using RubberBandStretcher, making it diff --git a/rubberband/RubberBandStretcher.h b/rubberband/RubberBandStretcher.h index 295677c..b938ea9 100644 --- a/rubberband/RubberBandStretcher.h +++ b/rubberband/RubberBandStretcher.h @@ -56,13 +56,13 @@ namespace RubberBand * The primary Rubber Band Library API is contained in the class * RubberBand::RubberBandStretcher. This class can perform both pitch * 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. * * RubberBandStretcher supports two processing modes, offline and * real-time, and two processing "engines", known as the R2 or Faster * 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 * identically in API terms, and both of them support both offline and * real-time modes as described below.