Skip to content

Commit

Permalink
Doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
cannam committed Oct 25, 2024
1 parent cdde17c commit 8c4dc5c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
17 changes: 9 additions & 8 deletions rubberband/RubberBandLiveShifter.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,22 +51,23 @@ 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
* sample frames. This is in contrast to the
* 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
Expand Down
4 changes: 2 additions & 2 deletions rubberband/RubberBandStretcher.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 8c4dc5c

Please sign in to comment.