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

Provide proper support for R2/R3 choice through command line options in utility

Browse Source
This commit is contained in:
Chris Cannam
2022-06-15 11:31:35 +01:00
parent 55b76c75ef
commit f3dfada888
2 changed files with 158 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

198
main/main.cpp
View File

@@ -103,7 +103,10 @@ int main(int argc, char **argv)
bool together = false; bool together = false;
bool crispchanged = false; bool crispchanged = false;
int crispness = -1; int crispness = -1;
bool faster = false;
bool finer = false;
bool help = false; bool help = false;
bool fullHelp = false;
bool version = false; bool version = false;
bool quiet = false; bool quiet = false;
@@ -128,11 +131,17 @@ int main(int argc, char **argv)
bool ignoreClipping = false; bool ignoreClipping = false;
std::string myName(argv[0]);
bool isR3 = (myName.size() > 3 &&
myName.substr(myName.size() - 3, 3) == "-r3");
while (1) { while (1) {
int optionIndex = 0; int optionIndex = 0;
static struct option longOpts[] = { static struct option longOpts[] = {
{ "help", 0, 0, 'h' }, { "help", 0, 0, 'h' },
{ "full-help", 0, 0, 'H' },
{ "version", 0, 0, 'V' }, { "version", 0, 0, 'V' },
{ "time", 1, 0, 't' }, { "time", 1, 0, 't' },
{ "tempo", 1, 0, 'T' }, { "tempo", 1, 0, 'T' },
@@ -148,10 +157,10 @@ int main(int argc, char **argv)
{ "formant", 0, 0, 'F' }, { "formant", 0, 0, 'F' },
{ "no-threads", 0, 0, '0' }, { "no-threads", 0, 0, '0' },
{ "no-transients", 0, 0, '1' }, { "no-transients", 0, 0, '1' },
{ "no-lamination", 0, 0, '2' }, { "no-lamination", 0, 0, '.' },
{ "centre-focus", 0, 0, '7' }, { "centre-focus", 0, 0, '7' },
{ "window-long", 0, 0, '3' }, { "window-long", 0, 0, '>' },
{ "window-short", 0, 0, '4' }, { "window-short", 0, 0, '<' },
{ "bl-transients", 0, 0, '8' }, { "bl-transients", 0, 0, '8' },
{ "detector-perc", 0, 0, '5' }, { "detector-perc", 0, 0, '5' },
{ "detector-soft", 0, 0, '6' }, { "detector-soft", 0, 0, '6' },
@@ -163,16 +172,19 @@ int main(int argc, char **argv)
{ "freqmap", 1, 0, 'Q' }, { "freqmap", 1, 0, 'Q' },
{ "pitchmap", 1, 0, 'C' }, { "pitchmap", 1, 0, 'C' },
{ "ignore-clipping", 0, 0, 'i' }, { "ignore-clipping", 0, 0, 'i' },
{ "fast", 0, 0, '2' },
{ "fine", 0, 0, '3' },
{ 0, 0, 0, 0 } { 0, 0, 0, 0 }
}; };
c = getopt_long(argc, argv, c = getopt_long(argc, argv,
"t:p:d:RLPFc:f:T:D:qhVM:", "t:p:d:RLPFc:f:T:D:qhHVM:23",
longOpts, &optionIndex); longOpts, &optionIndex);
if (c == -1) break; if (c == -1) break;
switch (c) { switch (c) {
case 'h': help = true; break; case 'h': help = true; break;
case 'H': fullHelp = true; break;
case 'V': version = true; break; case 'V': version = true; break;
case 't': ratio *= atof(optarg); haveRatio = true; break; case 't': ratio *= atof(optarg); haveRatio = true; break;
case 'T': ratio *= tempo_convert(optarg); haveRatio = true; break; case 'T': ratio *= tempo_convert(optarg); haveRatio = true; break;
@@ -187,9 +199,9 @@ int main(int argc, char **argv)
case '0': threading = 1; break; case '0': threading = 1; break;
case '@': threading = 2; break; case '@': threading = 2; break;
case '1': transients = NoTransients; crispchanged = true; break; case '1': transients = NoTransients; crispchanged = true; break;
case '2': lamination = false; crispchanged = true; break; case '.': lamination = false; crispchanged = true; break;
case '3': longwin = true; crispchanged = true; break; case '>': longwin = true; crispchanged = true; break;
case '4': shortwin = true; crispchanged = true; break; case '<': shortwin = true; crispchanged = true; break;
case '5': detector = PercussiveDetector; crispchanged = true; break; case '5': detector = PercussiveDetector; crispchanged = true; break;
case '6': detector = SoftDetector; crispchanged = true; break; case '6': detector = SoftDetector; crispchanged = true; break;
case '7': together = true; break; case '7': together = true; break;
@@ -202,6 +214,8 @@ int main(int argc, char **argv)
case 'Q': freqMapFile = optarg; freqOrPitchMapSpecified = true; break; case 'Q': freqMapFile = optarg; freqOrPitchMapSpecified = true; break;
case 'C': pitchMapFile = optarg; freqOrPitchMapSpecified = true; break; case 'C': pitchMapFile = optarg; freqOrPitchMapSpecified = true; break;
case 'i': ignoreClipping = true; break; case 'i': ignoreClipping = true; break;
case '2': faster = true; break;
case '3': finer = true; break;
default: help = true; break; default: help = true; break;
} }
} }
@@ -220,15 +234,15 @@ int main(int argc, char **argv)
realtime = true; realtime = true;
} }
if (help || !haveRatio || optind + 2 != argc) { if (help || fullHelp || !haveRatio || optind + 2 != argc) {
cerr << endl; cerr << endl;
cerr << "Rubber Band" << endl; cerr << "Rubber Band" << endl;
cerr << "An audio time-stretching and pitch-shifting library and utility program." << endl; cerr << "An audio time-stretching and pitch-shifting library and utility program." << endl;
cerr << "Copyright 2007-2022 Particular Programs Ltd." << endl; cerr << "Copyright 2007-2022 Particular Programs Ltd." << endl;
cerr << endl; cerr << endl;
cerr << " Usage: " << argv[0] << " [options] <infile.wav> <outfile.wav>" << endl; cerr << " Usage: " << myName << " [options] <infile.wav> <outfile.wav>" << endl;
cerr << endl; cerr << endl;
cerr << "You must specify at least one of the following time and pitch ratio options." << endl; cerr << "You must specify at least one of the following time and pitch ratio options:" << endl;
cerr << endl; cerr << endl;
cerr << " -t<X>, --time <X> Stretch to X times original duration, or" << endl; cerr << " -t<X>, --time <X> Stretch to X times original duration, or" << endl;
cerr << " -T<X>, --tempo <X> Change tempo by multiple X (same as --time 1/X), or" << endl; cerr << " -T<X>, --tempo <X> Change tempo by multiple X (same as --time 1/X), or" << endl;
@@ -239,7 +253,7 @@ int main(int argc, char **argv)
cerr << " -f<X>, --frequency <X> Change frequency by multiple X" << endl; cerr << " -f<X>, --frequency <X> Change frequency by multiple X" << endl;
cerr << endl; cerr << endl;
cerr << "The following options provide ways of making the time and frequency ratios" << endl; cerr << "The following options provide ways of making the time and frequency ratios" << endl;
cerr << "change during the audio." << endl; cerr << "change during the audio:" << endl;
cerr << endl; cerr << endl;
cerr << " -M<F>, --timemap <F> Use file F as the source for time map" << endl; cerr << " -M<F>, --timemap <F> Use file F as the source for time map" << endl;
cerr << endl; cerr << endl;
@@ -267,55 +281,86 @@ int main(int argc, char **argv)
cerr << " lists frequency multipliers rather than pitch offsets (like the difference" << endl; cerr << " lists frequency multipliers rather than pitch offsets (like the difference" << endl;
cerr << " between pitch and frequency options above)." << endl; cerr << " between pitch and frequency options above)." << endl;
cerr << endl; cerr << endl;
cerr << "The following options provide a simple way to adjust the sound. See below" << endl; cerr << "The following options affect the sound manipulation and quality:" << endl;
cerr << "for more details." << endl; cerr << endl;
cerr << " -2, --fast Use the R2 (faster) engine" << endl;
cerr << endl;
cerr << " This is the default (for backward compatibility) when this tool is invoked" << endl;
cerr << " as \"rubberband\". It was the only engine available in versions prior to v3.0." << endl;
cerr << endl;
cerr << " -3, --fine Use the R3 (finer) engine" << endl;
cerr << endl;
cerr << " This is the default when this tool is invoked as \"rubberband-r3\". It almost" << endl;
cerr << " always produces better results than the R2 engine, but with significantly" << endl;
cerr << " higher CPU load." << endl;
cerr << endl; cerr << endl;
cerr << " -c<N>, --crisp <N> Crispness (N = 0,1,2,3,4,5,6); default 5 (see below)" << endl;
cerr << " -F, --formant Enable formant preservation when pitch shifting" << endl; cerr << " -F, --formant Enable formant preservation when pitch shifting" << endl;
cerr << endl; cerr << endl;
cerr << "The remaining options fine-tune the processing mode and stretch algorithm." << endl; cerr << " This option attempts to keep the formant envelope unchanged when changing" << endl;
cerr << "These are mostly included for test purposes; the default settings and standard" << endl; cerr << " the pitch, retaining the original timbre of vocals and instruments in a" << endl;
cerr << "crispness parameter are intended to provide the best sounding set of options" << endl; cerr << " recognisable way." << endl;
cerr << "for most situations. The default is to use none of these options." << endl;
cerr << endl; cerr << endl;
cerr << " -R, --realtime Select realtime mode (implies --no-threads)." << endl; if (fullHelp || !isR3) {
cerr << " This utility does not do realtime stream processing;" << endl; cerr << " -c<N>, --crisp <N> Crispness (N = 0,1,2,3,4,5,6); default 5" << endl;
cerr << " the option merely selects realtime mode for the" << endl; cerr << endl;
cerr << " stretcher it uses" << endl; cerr << " This option only has an effect when using the R2 (faster) engine. See below" << endl;
cerr << " --no-threads No extra threads regardless of CPU and channel count" << endl; cerr << " for details of the different levels." << endl;
cerr << " --threads Assume multi-CPU even if only one CPU is identified" << endl; cerr << endl;
cerr << " --no-transients Disable phase resynchronisation at transients" << endl; }
cerr << " --bl-transients Band-limit phase resync to extreme frequencies" << endl; if (fullHelp) {
cerr << " --no-lamination Disable phase lamination" << endl; cerr << "The remaining options fine-tune the processing mode and stretch algorithm." << endl;
cerr << " --window-long Use longer processing window (actual size may vary)" << endl; cerr << "These are mostly included for test purposes; the default settings and standard" << endl;
cerr << " --window-short Use shorter processing window" << endl; cerr << "crispness parameter are intended to provide the best sounding set of options" << endl;
cerr << " --smoothing Apply window presum and time-domain smoothing" << endl; cerr << "for most situations. The default is to use none of these options." << endl;
cerr << " --detector-perc Use percussive transient detector (as in pre-1.5)" << endl; cerr << endl;
cerr << " --detector-soft Use soft transient detector" << endl; cerr << " -R, --realtime Select realtime mode (implies --no-threads)." << endl;
cerr << " --pitch-hq In RT mode, use a slower, higher quality pitch shift" << endl; cerr << " This utility does not do realtime stream processing;" << endl;
cerr << " --centre-focus Preserve focus of centre material in stereo" << endl; cerr << " the option merely selects realtime mode for the" << endl;
cerr << " (at a cost in width and individual channel quality)" << endl; cerr << " stretcher it uses" << endl;
cerr << " --ignore-clipping Ignore clipping at output; the default is to restart" << endl; cerr << " --no-threads No extra threads regardless of CPU and channel count" << endl;
cerr << " with reduced gain if clipping occurs" << endl; cerr << " --threads Assume multi-CPU even if only one CPU is identified" << endl;
cerr << " -L, --loose [Accepted for compatibility but ignored; always off]" << endl; cerr << " --no-transients Disable phase resynchronisation at transients" << endl;
cerr << " -P, --precise [Accepted for compatibility but ignored; always on]" << endl; cerr << " --bl-transients Band-limit phase resync to extreme frequencies" << endl;
cerr << " --no-lamination Disable phase lamination" << endl;
cerr << " --window-long Use longer processing window (actual size may vary)" << endl;
cerr << " --window-short Use shorter processing window" << endl;
cerr << " --smoothing Apply window presum and time-domain smoothing" << endl;
cerr << " --detector-perc Use percussive transient detector (as in pre-1.5)" << endl;
cerr << " --detector-soft Use soft transient detector" << endl;
cerr << " --pitch-hq In RT mode, use a slower, higher quality pitch shift" << endl;
cerr << " --centre-focus Preserve focus of centre material in stereo" << endl;
cerr << " (at a cost in width and individual channel quality)" << endl;
cerr << " --ignore-clipping Ignore clipping at output; the default is to restart" << endl;
cerr << " with reduced gain if clipping occurs" << endl;
cerr << " -L, --loose [Accepted for compatibility but ignored; always off]" << endl;
cerr << " -P, --precise [Accepted for compatibility but ignored; always on]" << endl;
cerr << endl;
cerr << " -d<N>, --debug <N> Select debug level (N = 0,1,2,3); default 0, full 3" << endl;
cerr << " (N.B. debug level 3 includes audible ticks in output)" << endl;
cerr << endl;
}
cerr << "The following options are for output control and administration:" << endl;
cerr << endl; cerr << endl;
cerr << " -d<N>, --debug <N> Select debug level (N = 0,1,2,3); default 0, full 3" << endl;
cerr << " (N.B. debug level 3 includes audible ticks in output)" << endl;
cerr << " -q, --quiet Suppress progress output" << endl; cerr << " -q, --quiet Suppress progress output" << endl;
cerr << endl;
cerr << " -V, --version Show version number and exit" << endl; cerr << " -V, --version Show version number and exit" << endl;
cerr << " -h, --help Show this help" << endl; cerr << " -h, --help Show the normal help output" << endl;
cerr << endl; cerr << " -H, --full-help Show the full help output" << endl;
cerr << "\"Crispness\" levels:" << endl;
cerr << " -c 0 equivalent to --no-transients --no-lamination --window-long" << endl;
cerr << " -c 1 equivalent to --detector-soft --no-lamination --window-long (for piano)" << endl;
cerr << " -c 2 equivalent to --no-transients --no-lamination" << endl;
cerr << " -c 3 equivalent to --no-transients" << endl;
cerr << " -c 4 equivalent to --bl-transients" << endl;
cerr << " -c 5 default processing options" << endl;
cerr << " -c 6 equivalent to --no-lamination --window-short (may be good for drums)" << endl;
cerr << endl; cerr << endl;
if (fullHelp) {
cerr << "\"Crispness\" levels:" << endl;
cerr << " -c 0 equivalent to --no-transients --no-lamination --window-long" << endl;
cerr << " -c 1 equivalent to --detector-soft --no-lamination --window-long (for piano)" << endl;
cerr << " -c 2 equivalent to --no-transients --no-lamination" << endl;
cerr << " -c 3 equivalent to --no-transients" << endl;
cerr << " -c 4 equivalent to --bl-transients" << endl;
cerr << " -c 5 default processing options" << endl;
cerr << " -c 6 equivalent to --no-lamination --window-short (may be good for drums)" << endl;
cerr << endl;
} else {
cerr << "Numerous other options are available, mostly for tuning the behaviour of" << endl;
cerr << "the R2 engine. Run \"" << myName << " --full-help\" for details." << endl;
cerr << endl;
}
return 2; return 2;
} }
@@ -324,6 +369,23 @@ int main(int argc, char **argv)
return 1; return 1;
} }
if (faster && finer) {
cerr << "WARNING: Both fast (R2) and fine (R3) engines selected, will use default for" << endl;
cerr << " this tool (" << (isR3 ? "fine" : "fast") << ")" << endl;
faster = false;
finer = false;
}
if (isR3) {
if (!faster) {
finer = true;
}
} else {
if (!finer) {
faster = true;
}
}
if (crispness >= 0 && crispchanged) { if (crispness >= 0 && crispchanged) {
cerr << "WARNING: Both crispness option and transients, lamination or window options" << endl; cerr << "WARNING: Both crispness option and transients, lamination or window options" << endl;
cerr << " provided -- crispness will override these other options" << endl; cerr << " provided -- crispness will override these other options" << endl;
@@ -352,17 +414,22 @@ int main(int argc, char **argv)
}; };
if (!quiet) { if (!quiet) {
cerr << "Using crispness level: " << crispness << " ("; if (finer) {
switch (crispness) { cerr << "Using R3 (finer) engine" << endl;
case 0: cerr << "Mushy"; break; } else {
case 1: cerr << "Piano"; break; cerr << "Using R2 (faster) engine" << endl;
case 2: cerr << "Smooth"; break; cerr << "Using crispness level: " << crispness << " (";
case 3: cerr << "Balanced multitimbral mixture"; break; switch (crispness) {
case 4: cerr << "Unpitched percussion with stable notes"; break; case 0: cerr << "Mushy"; break;
case 5: cerr << "Crisp monophonic instrumental"; break; case 1: cerr << "Piano"; break;
case 6: cerr << "Unpitched solo percussion"; break; case 2: cerr << "Smooth"; break;
case 3: cerr << "Balanced multitimbral mixture"; break;
case 4: cerr << "Unpitched percussion with stable notes"; break;
case 5: cerr << "Crisp monophonic instrumental"; break;
case 6: cerr << "Unpitched solo percussion"; break;
}
cerr << ")" << endl;
} }
cerr << ")" << endl;
} }
std::map<size_t, size_t> timeMap; std::map<size_t, size_t> timeMap;
@@ -502,10 +569,9 @@ int main(int argc, char **argv)
} }
RubberBandStretcher::Options options = 0; RubberBandStretcher::Options options = 0;
if (finer) {
//!!! options = RubberBandStretcher::OptionEngineFiner;
cerr << "\n\n\n\n\n*** WARNING - THIS IS A TEST VERSION ONLY\n\n\n\n\n" << endl; }
options = RubberBandStretcher::OptionEngineFiner;
if (realtime) options |= RubberBandStretcher::OptionProcessRealTime; if (realtime) options |= RubberBandStretcher::OptionProcessRealTime;
if (!lamination) options |= RubberBandStretcher::OptionPhaseIndependent; if (!lamination) options |= RubberBandStretcher::OptionPhaseIndependent;

31
meson.build
View File

@@ -2,7 +2,7 @@
project( project(
'Rubber Band Library', 'Rubber Band Library',
'c', 'cpp', 'c', 'cpp',
version: '3.0.0', version: '3.0.0-pre',
license: 'GPL-2.0-or-later', license: 'GPL-2.0-or-later',
default_options: [ default_options: [
'cpp_std=c++11', 'cpp_std=c++11',
@@ -448,6 +448,7 @@ if cpp.get_id() == 'msvc'
endif endif
rubberband_library_name = 'rubberband' rubberband_library_name = 'rubberband'
rubberband_program_name = 'rubberband-program' rubberband_program_name = 'rubberband-program'
rubberband_program_name_r3 = 'rubberband-program-r3'
rubberband_ladspa_name = 'ladspa-rubberband' rubberband_ladspa_name = 'ladspa-rubberband'
rubberband_lv2_name = 'lv2-rubberband' rubberband_lv2_name = 'lv2-rubberband'
rubberband_vamp_name = 'vamp-rubberband' rubberband_vamp_name = 'vamp-rubberband'
@@ -457,6 +458,7 @@ else
rubberband_library_name = 'rubberband' rubberband_library_name = 'rubberband'
rubberband_dynamic_name = 'rubberband' rubberband_dynamic_name = 'rubberband'
rubberband_program_name = 'rubberband' rubberband_program_name = 'rubberband'
rubberband_program_name_r3 = 'rubberband-r3'
rubberband_ladspa_name = 'ladspa-rubberband' rubberband_ladspa_name = 'ladspa-rubberband'
rubberband_lv2_name = 'lv2-rubberband' rubberband_lv2_name = 'lv2-rubberband'
rubberband_vamp_name = 'vamp-rubberband' rubberband_vamp_name = 'vamp-rubberband'
@@ -686,8 +688,8 @@ else
endif endif
if have_sndfile if have_sndfile
target_summary += { 'Command-line utility': [ true, 'Name: ' + rubberband_program_name ] } message('Will build command-line utilities')
message('Will build command-line utility') target_summary += { 'Command-line utility (R2)': [ true, 'Name: ' + rubberband_program_name ] }
rubberband_program = executable( rubberband_program = executable(
rubberband_program_name, rubberband_program_name,
program_sources, program_sources,
@@ -705,9 +707,28 @@ if have_sndfile
], ],
install: true, install: true,
) )
target_summary += { 'Command-line utility (R3)': [ true, 'Name: ' + rubberband_program_name_r3 ] }
rubberband_program_r3 = executable(
rubberband_program_name_r3,
program_sources,
include_directories: general_include_dirs,
cpp_args: general_compile_args,
c_args: general_compile_args,
link_args: [
arch_flags,
feature_libraries,
],
dependencies: [
rubberband_objlib_dep,
general_dependencies,
sndfile_dep,
],
install: true,
)
else else
target_summary += { 'Command-line utility': false } message('Not building command-line utilities: libsndfile dependency not found')
message('Not building command-line utility: libsndfile dependency not found') target_summary += { 'Command-line utility (R2)': false }
target_summary += { 'Command-line utility (R3)': false }
endif endif
if have_boost_unit_test if have_boost_unit_test