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

Update docs

Browse Source
This commit is contained in:
Chris Cannam
2022-09-02 16:35:35 +01:00
parent 8ee381efe6
commit f4115e63fa
1 changed files with 23 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
rubberband/RubberBandStretcher.h
View File

@@ -262,26 +262,32 @@ public:
* situation where \c OptionThreadingAuto would do so, except omit * situation where \c OptionThreadingAuto would do so, except omit
* the check for multiple CPUs and instead assume it to be true. * the check for multiple CPUs and instead assume it to be true.
* *
* 7. Flags prefixed \c OptionWindow control the window size for * 7. Flags prefixed \c OptionWindow influence the window size for
* FFT processing in the R2 engine. (The window size actually * FFT processing. In the R2 engine these affect the resulting
* used will depend on many factors, but it can be influenced.) * sound quality but have relatively little effect on processing
* These options currently have no effect when using the R3 * speed. With the R3 engine they can dramatically affect
* engine, but they may do in the future - so code written to use * processing speed as well as output quality. These options may
* R3 now is recommended to use the default. These options may
* not be changed after construction. * not be changed after construction.
* *
* \li \c OptionWindowStandard - Use the default window size. * \li \c OptionWindowStandard - Use the default window size.
* The actual size will vary depending on other parameters. * The actual size will vary depending on other parameters.
* This option is expected to produce better results than the * This option is expected to produce better results than the
* other window options in most situations. * other window options in most situations. In the R3 engine
* this causes the engine's full multi-resolution processing
* scheme to be used.
* *
* \li \c OptionWindowShort - Use a shorter window. This may * \li \c OptionWindowShort - Use a shorter window. With the R2
* result in crisper sound for audio that depends strongly on * engine this may result in crisper sound for audio that
* its timing qualities. * depends strongly on its timing qualities. With the R3 engine,
* this causes the engine to be restricted to a single window
* size, resulting in both dramatically faster processing and
* lower latency than OptionWindowStandard, but at the expense
* of some sound quality.
* *
* \li \c OptionWindowLong - Use a longer window. This is * \li \c OptionWindowLong - Use a longer window. With the R2
* likely to result in a smoother sound at the expense of * engine this is likely to result in a smoother sound at the
* clarity and timing. * expense of clarity and timing. The R3 engine currently
* ignores this option, treating it like OptionWindowStandard.
* *
* 8. Flags prefixed \c OptionSmoothing control the use of * 8. Flags prefixed \c OptionSmoothing control the use of
* window-presum FFT and time-domain smoothing in the R2 * window-presum FFT and time-domain smoothing in the R2
@@ -331,10 +337,10 @@ public:
* \li \c OptionPitchHighConsistency - Use a method that * \li \c OptionPitchHighConsistency - Use a method that
* supports dynamic pitch changes without discontinuities, * supports dynamic pitch changes without discontinuities,
* including when crossing the 1.0 pitch scale. This may cost * including when crossing the 1.0 pitch scale. This may cost
* more in CPU than the other two options, especially when the * more in CPU than the default, especially when the pitch scale
* pitch scale is exactly 1.0. You should use this option * is exactly 1.0. You should use this option whenever you wish
* whenever you wish to support dynamically changing pitch * to support dynamically changing pitch shift during
* shifts during processing. * processing.
* *
* 11. Flags prefixed \c OptionChannels control the method used * 11. Flags prefixed \c OptionChannels control the method used
* for processing two-channel stereo audio. These have different, * for processing two-channel stereo audio. These have different,