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

Minor formatting & wording

Browse Source
This commit is contained in:
Chris Cannam
2022-01-12 10:26:10 +00:00
parent 8faf25c479
commit 5a94067a50
1 changed files with 19 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -106,8 +106,8 @@ Rubber Band consists of:
## 2. Using the Rubber Band command-line tool ## 2. Using the Rubber Band command-line tool
The Rubber Band command-line tool builds as bin/rubberband. The basic The Rubber Band command-line tool builds as `bin/rubberband`. The
incantation is basic incantation is
``` ```
$ rubberband -t <timeratio> -p <pitchratio> <infile.wav> <outfile.wav> $ rubberband -t <timeratio> -p <pitchratio> <infile.wav> <outfile.wav>
@@ -119,8 +119,9 @@ For example,
$ rubberband -t 1.5 -p 2.0 test.wav output.wav $ rubberband -t 1.5 -p 2.0 test.wav output.wav
``` ```
stretches the file test.wav to 50% longer than its original duration, stretches the file `test.wav` to 50% longer than its original
shifts it up in pitch by one octave, and writes the output to output.wav. duration, shifts it up in pitch by one octave, and writes the output
to `output.wav`.
Several further options are available: run `rubberband -h` for help. Several further options are available: run `rubberband -h` for help.
In particular, different types of music may benefit from different In particular, different types of music may benefit from different
@@ -214,9 +215,9 @@ applicable.
### 4a. Building on Linux ### 4a. Building on Linux
For best results, and to ensure the command-line tool and plugins are Optionally, if you want the command-line tool and plugins to be built,
built, first install libsamplerate, libsndfile, and the LADSPA, LV2, first install libsndfile and the LADSPA, LV2, and Vamp plugin headers
and Vamp plugin headers so they can be found using `pkg-config`. Then so they can be found using `pkg-config`. Then
``` ```
$ meson build && ninja -C build $ meson build && ninja -C build
@@ -234,8 +235,8 @@ $ make -f otherbuilds/Makefile.linux
### 4b. Building on macOS ### 4b. Building on macOS
Ensure the Xcode command-line tools are installed, and ideally also Ensure the Xcode command-line tools are installed, and if you want the
install libsamplerate and libsndfile. command-line tool to be built, also install libsndfile.
To build for the default architecture: To build for the default architecture:
@@ -377,8 +378,8 @@ library code, please be sure to review the terms for those libraries
in `src/speex/COPYING` and `src/kissfft/COPYING` as applicable. in `src/speex/COPYING` and `src/kissfft/COPYING` as applicable.
If you are proposing to package Rubber Band for a Linux distribution, If you are proposing to package Rubber Band for a Linux distribution,
please select either the built-in FFT (simpler for you) or FFTW (a bit please select either the built-in FFT or FFTW, and either the built-in
faster) and use libsamplerate. resampler or libsamplerate.
#### FFT libraries supported #### FFT libraries supported
@@ -392,6 +393,13 @@ Built-in -Dfft=builtin -DUSE_BUILTIN_FFT
the Rubber Band GPL or the Rubber Band GPL or
commercial licence. commercial licence.
Accelerate -Dfft=vdsp -DHAVE_VDSP Default on macOS/iOS.
Best option on these platforms.
FFTW3 -Dfft=fftw -DHAVE_FFTW3 GPL.
A bit faster than built-in,
a bit slower than Accelerate.
KissFFT -Dfft=kissfft -DHAVE_KISSFFT KissFFT -Dfft=kissfft -DHAVE_KISSFFT
Single precision. Single precision.
Only indicated for use with Only indicated for use with
@@ -401,11 +409,6 @@ KissFFT -Dfft=kissfft -DHAVE_KISSFFT
either the Rubber Band GPL or either the Rubber Band GPL or
commercial licence. commercial licence.
Accelerate -Dfft=vdsp -DHAVE_VDSP Default on macOS/iOS.
Best option on these platforms.
FFTW3 -Dfft=fftw -DHAVE_FFTW3 GPL.
Intel IPP -Dfft=ipp -DHAVE_IPP Proprietary, can only be used with Intel IPP -Dfft=ipp -DHAVE_IPP Proprietary, can only be used with
Rubber Band commercial licence. Rubber Band commercial licence.
``` ```