annotate runner/main.cpp @ 127:f0df07da6f46

Update version, add --minversion flag
author Chris Cannam
date Thu, 09 Oct 2014 12:56:55 +0100
parents 685e5cf3cb1d
children 6b62bae0af33
rev   line source
Chris@0 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@0 2
Chris@0 3 /*
Chris@0 4 Sonic Annotator
Chris@0 5 A utility for batch feature extraction from audio files.
Chris@0 6 Mark Levy, Chris Sutton and Chris Cannam, Queen Mary, University of London.
Chris@0 7 Copyright 2007-2008 QMUL.
Chris@0 8
Chris@0 9 This program is free software; you can redistribute it and/or
Chris@0 10 modify it under the terms of the GNU General Public License as
Chris@0 11 published by the Free Software Foundation; either version 2 of the
Chris@0 12 License, or (at your option) any later version. See the file
Chris@0 13 COPYING included with this distribution for more information.
Chris@0 14 */
Chris@0 15
Chris@0 16 #include <vector>
Chris@0 17 #include <string>
Chris@0 18 #include <iostream>
Chris@0 19
Chris@0 20 #include <QCoreApplication>
Chris@0 21 #include <QSettings>
Chris@0 22 #include <QStringList>
Chris@0 23 #include <QString>
Chris@0 24 #include <QFileInfo>
Chris@0 25 #include <QDir>
Chris@45 26 #include <QSet>
Chris@0 27
Chris@0 28 using std::cout;
Chris@0 29 using std::cerr;
Chris@0 30 using std::endl;
Chris@0 31 using std::vector;
Chris@0 32 using std::string;
Chris@0 33
Chris@2 34 #include "../version.h"
Chris@2 35
Chris@0 36 #include "base/Exceptions.h"
Chris@0 37 #include "base/TempDirectory.h"
Chris@111 38 #include "base/ProgressPrinter.h"
Chris@0 39
Chris@0 40 #include "data/fileio/AudioFileReaderFactory.h"
Chris@0 41 #include "data/fileio/PlaylistFileReader.h"
Chris@0 42
Chris@0 43 #include "transform/Transform.h"
Chris@0 44 #include "transform/TransformFactory.h"
Chris@0 45
Chris@0 46 #include "FeatureExtractionManager.h"
Chris@0 47 #include "transform/FeatureWriter.h"
Chris@0 48 #include "FeatureWriterFactory.h"
Chris@0 49
Chris@0 50 #include "rdf/RDFTransformFactory.h"
Chris@0 51
Chris@0 52 #include <vamp-hostsdk/PluginSummarisingAdapter.h>
Chris@0 53
Chris@0 54 #ifdef HAVE_FFTW3
Chris@0 55 #include <fftw3.h>
Chris@0 56 #endif
Chris@0 57
Chris@0 58 // Desired options:
Chris@0 59 //
Chris@0 60 // * output preference:
Chris@0 61 // - all data in one file
Chris@0 62 // - one file per input file
Chris@0 63 // - one file per input file per transform
Chris@0 64 // - (any use for: one file per transform?)
Chris@0 65 //
Chris@0 66 // * output location:
Chris@0 67 // - same directory as input file
Chris@0 68 // - current directory
Chris@0 69 //
Chris@0 70 // * output filename:
Chris@0 71 // - based on input (obvious choice for one file per input file modes)
Chris@0 72 // - specified on command line (obvious choice for all in one file mode)
Chris@0 73 //
Chris@0 74 // * output format: one or more of
Chris@0 75 // - RDF
Chris@0 76 // - AudioDB
Chris@0 77 // - Vamp Simple Host format
Chris@0 78 // - CSV
Chris@0 79 //
Chris@0 80 // * input handling:
Chris@0 81 // - run each transform on each input file separately
Chris@0 82 // - provide all input files to the same transform, one per channel
Chris@0 83 //
Chris@0 84 // * format-specific options:
Chris@0 85 // - RDF format: fancy/plain RDF
Chris@0 86 // - CSV format: separator, timestamp type
Chris@0 87 // note: do the output file/location also count as format-specific options?
Chris@0 88 // an output writer that wrote to a database would have different options...
Chris@0 89 //
Chris@0 90 // * debug level and progress output
Chris@0 91 //
Chris@0 92 // * other potential options:
Chris@0 93 // - ignore version mismatches in Transform specifications
Chris@0 94 // - sample rate: force a given rate; use file rate instead of rate in
Chris@0 95 // Transform spec
Chris@0 96 //
Chris@0 97 // * other potential instructions:
Chris@0 98 // - write out a skeleton Transform file for a specified plugin
Chris@0 99 // - write out skeleton RDF for a plugin library (i.e. do the job of
Chris@0 100 // RDF template_generator)
Chris@0 101 // - verify that RDF for a plugin library matches the plugin
Chris@0 102 //
Chris@0 103 // MAYBE:
Chris@0 104 // * transform(s) to run:
Chris@0 105 // - supply transform file names on command line
Chris@0 106 // - use all transforms found in a given directory?
Chris@0 107 //
Chris@0 108 // MAYBE:
Chris@0 109 // * input files to transform:
Chris@0 110 // - supply file names or URIs on command line
Chris@0 111 // - use all files in a given directory or tree
Chris@0 112
Chris@0 113 static QString
Chris@0 114 wrap(QString s, int len, int pfx = 0)
Chris@0 115 {
Chris@0 116 QString ws;
Chris@0 117 QStringList sl(s.split(' '));
Chris@0 118 int i = 0, c = 0;
Chris@0 119 while (i < sl.size()) {
Chris@0 120 int wl = sl[i].length();
Chris@0 121 if (c + wl < len) {
Chris@0 122 if (c > 0) {
Chris@0 123 ws += ' ';
Chris@0 124 ++c;
Chris@0 125 }
Chris@0 126 } else {
Chris@0 127 if (c > 0) {
Chris@0 128 ws += '\n';
Chris@0 129 for (int j = 0; j < pfx; ++j) ws += ' ';
Chris@0 130 c = 0;
Chris@0 131 }
Chris@0 132 }
Chris@0 133 ws += sl[i];
Chris@0 134 c += wl;
Chris@0 135 ++i;
Chris@0 136 }
Chris@0 137 return ws;
Chris@0 138 }
Chris@0 139
Chris@127 140 static bool
Chris@127 141 isVersionNewerThan(QString a, QString b) // from VersionTester in svapp
Chris@127 142 {
Chris@127 143 QRegExp re("[._-]");
Chris@127 144 QStringList alist = a.split(re, QString::SkipEmptyParts);
Chris@127 145 QStringList blist = b.split(re, QString::SkipEmptyParts);
Chris@127 146 int ae = alist.size();
Chris@127 147 int be = blist.size();
Chris@127 148 int e = std::max(ae, be);
Chris@127 149 for (int i = 0; i < e; ++i) {
Chris@127 150 int an = 0, bn = 0;
Chris@127 151 if (i < ae) {
Chris@127 152 an = alist[i].toInt();
Chris@127 153 if (an == 0 && alist[i] != "0") {
Chris@127 154 an = -1; // non-numeric field -> "-pre1" etc
Chris@127 155 }
Chris@127 156 }
Chris@127 157 if (i < be) {
Chris@127 158 bn = blist[i].toInt();
Chris@127 159 if (bn == 0 && blist[i] != "0") {
Chris@127 160 bn = -1;
Chris@127 161 }
Chris@127 162 }
Chris@127 163 if (an < bn) return false;
Chris@127 164 if (an > bn) return true;
Chris@127 165 }
Chris@127 166 return false;
Chris@127 167 }
Chris@127 168
Chris@127 169 static int
Chris@127 170 checkMinVersion(QString myname, QString v)
Chris@127 171 {
Chris@127 172 if (v == RUNNER_VERSION) {
Chris@127 173 return 0;
Chris@127 174 } else if (isVersionNewerThan(RUNNER_VERSION, v)) {
Chris@127 175 return 0;
Chris@127 176 } else {
Chris@127 177 cerr << myname << ": version "
Chris@127 178 << RUNNER_VERSION << " is less than requested min version "
Chris@127 179 << v << ", failing" << endl;
Chris@127 180 return 1;
Chris@127 181 }
Chris@127 182 }
Chris@127 183
Chris@125 184 void printUsage(QString myname)
Chris@0 185 {
Chris@0 186 cerr << endl;
Chris@2 187 cerr << "Sonic Annotator v" << RUNNER_VERSION << endl;
Chris@0 188 cerr << "A utility for batch feature extraction from audio files." << endl;
Chris@0 189 cerr << "Mark Levy, Chris Sutton and Chris Cannam, Queen Mary, University of London." << endl;
Chris@95 190 cerr << "Copyright 2007-2014 Queen Mary, University of London." << endl;
Chris@0 191 cerr << endl;
Chris@0 192 cerr << "This program is free software. You may redistribute copies of it under the" << endl;
Chris@0 193 cerr << "terms of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>." << endl;
Chris@0 194 cerr << "This program is supplied with NO WARRANTY, to the extent permitted by law." << endl;
Chris@0 195 cerr << endl;
Chris@125 196 cerr << "Usage: " << endl;
Chris@127 197 cerr << " " << myname
Chris@125 198 << " [-mrnf] -t transform.ttl [..] -w <writer> [..] <audio> [..]" << endl;
Chris@127 199 cerr << " " << myname
Chris@125 200 << " [-mrnf] -T translist.txt [..] -w <writer> [..] <audio> [..]" << endl;
Chris@127 201 cerr << " " << myname
Chris@125 202 << " [-mrnf] -d <plugin> [..] -w <writer> [..] <audio> [...]" << endl;
Chris@127 203 cerr << " " << myname
Chris@0 204 << " -s <transform>" << endl;
Chris@127 205 cerr << " " << myname
Chris@46 206 << " [-lhv]" << endl;
Chris@0 207 cerr << endl;
Chris@0 208 cerr << "Where <audio> is an audio file or URL to use as input: either a local file" << endl;
Chris@125 209 cerr << "path, local \"file://\" URL, or remote \"http://\" or \"ftp://\" URL;" << endl;
Chris@125 210 cerr << "and <plugin> is a plugin output identified as vamp:libname:plugin:output." << endl;
Chris@0 211 cerr << endl;
Chris@125 212 }
Chris@125 213
Chris@125 214 void printHelp(QString myname)
Chris@125 215 {
Chris@125 216 printUsage(myname);
Chris@0 217
Chris@0 218 QString extensions = AudioFileReaderFactory::getKnownExtensions();
Chris@0 219 QStringList extlist = extensions.split(" ", QString::SkipEmptyParts);
Chris@0 220 if (!extlist.empty()) {
Chris@0 221 cerr << "The following audio file extensions are recognised:" << endl;
Chris@0 222 cerr << " ";
Chris@0 223 int c = 2;
Chris@0 224 for (int i = 0; i < extlist.size(); ++i) {
Chris@0 225 QString ext = extlist[i];
Chris@0 226 if (ext.startsWith("*.")) ext = ext.right(ext.length()-2);
Chris@0 227 c += ext.length() + 2;
Chris@0 228 if (c >= 80) {
Chris@0 229 cerr << "\n ";
Chris@0 230 c -= 78;
Chris@0 231 }
Chris@127 232 cerr << ext;
Chris@0 233 if (i + 1 == extlist.size()) cerr << ".";
Chris@0 234 else cerr << ", ";
Chris@0 235 }
Chris@0 236 cerr << endl;
Chris@0 237 }
Chris@0 238
Chris@0 239 cerr << "Playlist files in M3U format are also supported." << endl;
Chris@0 240 cerr << endl;
Chris@125 241
Chris@0 242 cerr << "Transformation options:" << endl;
Chris@0 243 cerr << endl;
Chris@0 244 cerr << " -t, --transform <T> Apply transform described in transform file <T> to" << endl;
Chris@0 245 cerr << " all input audio files. You may supply this option" << endl;
Chris@0 246 cerr << " multiple times. You must supply this option or -T at" << endl;
Chris@0 247 cerr << " least once for any work to be done. Transform format" << endl;
Chris@125 248 cerr << " may be SV transform XML or Vamp transform RDF/Turtle." << endl;
Chris@125 249 cerr << " See documentation for examples." << endl;
Chris@0 250 cerr << endl;
Chris@0 251 cerr << " -T, --transforms <T> Apply all transforms described in transform files" << endl;
Chris@0 252 cerr << " whose names are listed in text file <T>. You may supply" << endl;
Chris@0 253 cerr << " this option multiple times." << endl;
Chris@0 254 cerr << endl;
Chris@0 255 cerr << " -d, --default <I> Apply the default transform for transform id <I>. This" << endl;
Chris@0 256 cerr << " is equivalent to generating a skeleton transform for this" << endl;
Chris@0 257 cerr << " id (using the -s option, below) and then applying that," << endl;
Chris@0 258 cerr << " unmodified, with the -t option in the normal way. Note" << endl;
Chris@0 259 cerr << " that the results may vary as the implementation's default" << endl;
Chris@0 260 cerr << " processing parameters are not guaranteed. Do not use" << endl;
Chris@0 261 cerr << " this in production systems. You may supply this option" << endl;
Chris@0 262 cerr << " multiple times, and mix it with -t and -T." << endl;
Chris@0 263 cerr << endl;
Chris@0 264 cerr << " -w, --writer <W> Write output using writer type <W>." << endl;
Chris@0 265 cerr << " Supported writer types are: ";
Chris@125 266 set<string> writers = FeatureWriterFactory::getWriterTags();
Chris@0 267 for (set<string>::const_iterator i = writers.begin();
Chris@0 268 i != writers.end(); ) {
Chris@0 269 cerr << *i;
Chris@0 270 if (++i != writers.end()) cerr << ", ";
Chris@0 271 else cerr << ".";
Chris@0 272 }
Chris@0 273 cerr << endl;
Chris@0 274 cerr << " You may supply this option multiple times. You must" << endl;
Chris@0 275 cerr << " supply this option at least once for any work to be done." << endl;
Chris@0 276 cerr << endl;
Chris@0 277 cerr << " -S, --summary <S> In addition to the result features, write summary feature" << endl;
Chris@0 278 cerr << " of summary type <S>." << endl;
Chris@125 279 cerr << " Supported summary types are min, max, mean, median, mode," << endl;
Chris@0 280 cerr << " sum, variance, sd, count." << endl;
Chris@0 281 cerr << " You may supply this option multiple times." << endl;
Chris@0 282 cerr << endl;
Chris@0 283 cerr << " --summary-only Write only summary features; do not write the regular" << endl;
Chris@0 284 cerr << " result features." << endl;
Chris@0 285 cerr << endl;
Chris@0 286 cerr << " --segments <A>,<B>[,...]" << endl;
Chris@0 287 cerr << " Summarise in segments, with segment boundaries" << endl;
Chris@0 288 cerr << " at A, B, ... seconds." << endl;
Chris@0 289 cerr << endl;
Chris@0 290 cerr << " -m, --multiplex If multiple input audio files are given, use mono" << endl;
Chris@0 291 cerr << " mixdowns of all files as the input channels for a single" << endl;
Chris@0 292 cerr << " invocation of each transform, instead of running the" << endl;
Chris@106 293 cerr << " transform against all files separately. The first file" << endl;
Chris@106 294 cerr << " will be used for output reference name and sample rate." << endl;
Chris@0 295 cerr << endl;
Chris@0 296 cerr << " -r, --recursive If any of the <audio> arguments is found to be a local" << endl;
Chris@0 297 cerr << " directory, search the tree starting at that directory" << endl;
Chris@0 298 cerr << " for all supported audio files and take all of those as" << endl;
Chris@0 299 cerr << " input instead." << endl;
Chris@0 300 cerr << endl;
Chris@116 301 cerr << " -n, --normalise Normalise input audio files to signal absolute max = 1.f." << endl;
Chris@116 302 cerr << endl;
Chris@21 303 cerr << " -f, --force Continue with subsequent files following an error." << endl;
Chris@21 304 cerr << endl;
Chris@0 305 cerr << "Housekeeping options:" << endl;
Chris@0 306 cerr << endl;
Chris@0 307 cerr << " -l, --list List all known transform ids to standard output." << endl;
Chris@0 308 cerr << endl;
Chris@0 309 cerr << " -s, --skeleton <I> Generate a skeleton transform file for transform id <I>" << endl;
Chris@0 310 cerr << " and write it to standard output." << endl;
Chris@0 311 cerr << endl;
Chris@46 312 cerr << " -v, --version Show the version number and exit." << endl;
Chris@127 313 cerr << endl;
Chris@127 314 cerr << " --minversion <V> Exit with successful return code if the version of" << endl;
Chris@127 315 cerr << " " << myname << " is at least <V>, failure otherwise." << endl;
Chris@127 316 cerr << " For scripts that depend on certain option support." << endl;
Chris@127 317 cerr << endl;
Chris@125 318 cerr << " -h, --help Show help." << endl;
Chris@0 319
Chris@0 320 cerr << endl;
Chris@46 321 cerr << "If no -w (or --writer) options are supplied, either the -l -s -v or -h option" << endl;
Chris@46 322 cerr << "(or long equivalent) must be given instead." << endl;
Chris@0 323
Chris@0 324 for (set<string>::const_iterator i = writers.begin();
Chris@0 325 i != writers.end(); ++i) {
Chris@0 326 FeatureWriter *w = FeatureWriterFactory::createWriter(*i);
Chris@0 327 if (!w) {
Chris@0 328 cerr << " (Internal error: failed to create writer of this type)" << endl;
Chris@0 329 continue;
Chris@0 330 }
Chris@0 331 FeatureWriter::ParameterList params = w->getSupportedParameters();
Chris@0 332 delete w;
Chris@0 333 if (params.empty()) {
Chris@0 334 continue;
Chris@0 335 }
Chris@0 336 cerr << endl;
Chris@0 337 cerr << "Additional options for writer type \"" << *i << "\":" << endl;
Chris@0 338 cerr << endl;
Chris@0 339 for (FeatureWriter::ParameterList::const_iterator j = params.begin();
Chris@0 340 j != params.end(); ++j) {
Chris@0 341 cerr << " --" << *i << "-" << j->name << " ";
Chris@0 342 int spaceage = 16 - int(i->length()) - int(j->name.length());
Chris@0 343 if (j->hasArg) { cerr << "<X> "; spaceage -= 4; }
Chris@0 344 for (int k = 0; k < spaceage; ++k) cerr << " ";
Chris@0 345 QString s(j->description.c_str());
Chris@0 346 s = wrap(s, 56, 22);
Chris@127 347 cerr << s << endl;
Chris@0 348 }
Chris@0 349 }
Chris@0 350
Chris@0 351 cerr << endl;
Chris@0 352 }
Chris@0 353
Chris@0 354 void
Chris@0 355 listTransforms()
Chris@0 356 {
Chris@0 357 TransformList transforms =
Chris@0 358 TransformFactory::getInstance()->getAllTransformDescriptions();
Chris@0 359
Chris@0 360 for (TransformList::const_iterator iter = transforms.begin();
Chris@0 361 iter != transforms.end(); ++iter) {
Chris@0 362 const TransformDescription &transform = *iter;
Chris@0 363 if (transform.type == TransformDescription::Analysis) {
Chris@127 364 cout << transform.identifier << endl;
Chris@0 365 }
Chris@0 366 }
Chris@0 367 }
Chris@0 368
Chris@0 369 void
Chris@0 370 printSkeleton(QString id)
Chris@0 371 {
Chris@0 372 Transform transform =
Chris@0 373 TransformFactory::getInstance()->getDefaultTransformFor(id);
Chris@0 374 cout << "@prefix xsd: <http://www.w3.org/2001/XMLSchema#> ." << endl
Chris@0 375 << "@prefix vamp: <http://purl.org/ontology/vamp/> ." << endl
Chris@0 376 << "@prefix : <#> ." << endl << endl;
Chris@0 377 QString rdf = RDFTransformFactory::writeTransformToRDF
Chris@0 378 (transform, ":transform");
Chris@127 379 cout << rdf;
Chris@0 380 }
Chris@0 381
Chris@0 382 void
Chris@0 383 findSourcesRecursive(QString dirname, QStringList &addTo, int &found)
Chris@0 384 {
Chris@0 385 QDir dir(dirname);
Chris@0 386
Chris@0 387 QString printable = dir.dirName().left(20);
Chris@127 388 cerr << "\rScanning \"" << printable << "\"..."
Chris@127 389 << QString(" ").left(20 - printable.length())
Chris@0 390 << " [" << found << " audio file(s)]";
Chris@0 391
Chris@0 392 QString extensions = AudioFileReaderFactory::getKnownExtensions();
Chris@0 393 QStringList extlist = extensions.split(" ", QString::SkipEmptyParts);
Chris@0 394
Chris@0 395 QStringList files = dir.entryList
Chris@0 396 (extlist, QDir::Files | QDir::Readable);
Chris@0 397 for (int i = 0; i < files.size(); ++i) {
Chris@0 398 addTo.push_back(dir.filePath(files[i]));
Chris@0 399 ++found;
Chris@0 400 }
Chris@0 401
Chris@0 402 QStringList subdirs = dir.entryList
Chris@0 403 (QStringList(), QDir::Dirs | QDir::NoSymLinks | QDir::NoDotAndDotDot);
Chris@0 404 for (int i = 0; i < subdirs.size(); ++i) {
Chris@0 405 findSourcesRecursive(dir.filePath(subdirs[i]), addTo, found);
Chris@0 406 }
Chris@0 407 }
Chris@0 408
Chris@111 409 QStringList
Chris@111 410 expandPlaylists(QStringList sources)
Chris@111 411 {
Chris@111 412 QStringList expanded;
Chris@111 413 foreach (QString path, sources) {
Chris@111 414 if (QFileInfo(path).suffix().toLower() == "m3u") {
Chris@111 415 ProgressPrinter retrievalProgress("Opening playlist file...");
Chris@111 416 FileSource source(path, &retrievalProgress);
Chris@111 417 if (!source.isAvailable()) {
Chris@117 418 // Don't fail or throw an exception here, just keep
Chris@117 419 // the file in the list -- it will be tested again
Chris@117 420 // when adding it as a source and that's the proper
Chris@117 421 // time to fail. All we're concluding here is that it
Chris@117 422 // isn't a valid playlist
Chris@117 423 expanded.push_back(path);
Chris@117 424 continue;
Chris@111 425 }
Chris@111 426 source.waitForData();
Chris@111 427 PlaylistFileReader reader(source);
Chris@111 428 if (reader.isOK()) {
Chris@111 429 vector<QString> files = reader.load();
Chris@111 430 for (int i = 0; i < (int)files.size(); ++i) {
Chris@111 431 expanded.push_back(files[i]);
Chris@111 432 }
Chris@111 433 }
Chris@111 434 } else {
Chris@111 435 // not a playlist
Chris@111 436 expanded.push_back(path);
Chris@111 437 }
Chris@111 438 }
Chris@111 439 return expanded;
Chris@111 440 }
Chris@0 441
Chris@0 442 int main(int argc, char **argv)
Chris@0 443 {
Chris@0 444 QCoreApplication application(argc, argv);
Chris@0 445
Chris@0 446 QCoreApplication::setOrganizationName("QMUL");
Chris@0 447 QCoreApplication::setOrganizationDomain("qmul.ac.uk");
Chris@0 448 QCoreApplication::setApplicationName("Sonic Annotator");
Chris@0 449
Chris@0 450 QStringList args = application.arguments();
Chris@0 451 set<string> requestedWriterTags;
Chris@0 452 set<string> requestedTransformFiles;
Chris@0 453 set<string> requestedTransformListFiles;
Chris@0 454 set<string> requestedDefaultTransforms;
Chris@0 455 set<string> requestedSummaryTypes;
Chris@21 456 bool force = false;
Chris@106 457 bool multiplex = false;
Chris@0 458 bool recursive = false;
Chris@116 459 bool normalise = false;
Chris@0 460 bool list = false;
Chris@0 461 bool summaryOnly = false;
Chris@0 462 QString skeletonFor = "";
Chris@127 463 QString minVersion = "";
Chris@0 464 QString myname = args[0];
Chris@0 465 myname = QFileInfo(myname).baseName();
Chris@0 466 QStringList otherArgs;
Chris@0 467 Vamp::HostExt::PluginSummarisingAdapter::SegmentBoundaries boundaries;
Chris@0 468
Chris@0 469 QString helpStr = myname + ": use -h or --help option for help";
Chris@0 470
Chris@0 471 for (int i = 1; i < args.size(); ++i) {
Chris@0 472
Chris@0 473 QString arg = args[i];
Chris@0 474 bool last = ((i + 1) == args.size());
Chris@0 475
Chris@0 476 if (arg == "-h" || arg == "--help" || arg == "-?") {
Chris@125 477 printHelp(myname);
Chris@125 478 return 0;
Chris@0 479 }
Chris@0 480
Chris@46 481 if (arg == "-v" || arg == "--version") {
Chris@46 482 std::cout << RUNNER_VERSION << std::endl;
Chris@46 483 return 0;
Chris@46 484 }
Chris@46 485
Chris@0 486 if (arg == "-w" || arg == "--writer") {
Chris@0 487 if (last || args[i+1].startsWith("-")) {
Chris@127 488 cerr << myname << ": argument expected for \""
Chris@127 489 << arg << "\" option" << endl;
Chris@127 490 cerr << helpStr << endl;
Chris@0 491 exit(2);
Chris@0 492 } else {
Chris@0 493 string tag = args[++i].toStdString();
Chris@0 494 if (requestedWriterTags.find(tag) != requestedWriterTags.end()) {
Chris@127 495 cerr << myname << ": NOTE: duplicate specification of writer type \"" << tag << "\" ignored" << endl;
Chris@0 496 } else {
Chris@0 497 requestedWriterTags.insert(tag);
Chris@0 498 }
Chris@0 499 continue;
Chris@0 500 }
Chris@0 501 } else if (arg == "-t" || arg == "--transform") {
Chris@0 502 if (last || args[i+1].startsWith("-")) {
Chris@127 503 cerr << myname << ": argument expected for \""
Chris@127 504 << arg << "\" option" << endl;
Chris@127 505 cerr << helpStr << endl;
Chris@0 506 exit(2);
Chris@0 507 } else {
Chris@0 508 string transform = args[++i].toStdString();
Chris@0 509 if (requestedTransformFiles.find(transform) !=
Chris@0 510 requestedTransformFiles.end()) {
Chris@127 511 cerr << myname << ": NOTE: duplicate specification of transform file \"" << transform << "\" ignored" << endl;
Chris@0 512 } else {
Chris@0 513 requestedTransformFiles.insert(transform);
Chris@0 514 }
Chris@0 515 continue;
Chris@0 516 }
Chris@0 517 } else if (arg == "-T" || arg == "--transforms") {
Chris@0 518 if (last || args[i+1].startsWith("-")) {
Chris@127 519 cerr << myname << ": argument expected for \""
Chris@127 520 << arg << "\" option" << endl;
Chris@127 521 cerr << helpStr << endl;
Chris@0 522 exit(2);
Chris@0 523 } else {
Chris@0 524 string transform = args[++i].toStdString();
Chris@0 525 if (requestedTransformListFiles.find(transform) !=
Chris@0 526 requestedTransformListFiles.end()) {
Chris@127 527 cerr << myname << ": NOTE: duplicate specification of transform list file \"" << transform << "\" ignored" << endl;
Chris@0 528 } else {
Chris@0 529 requestedTransformListFiles.insert(transform);
Chris@0 530 }
Chris@0 531 continue;
Chris@0 532 }
Chris@0 533 } else if (arg == "-d" || arg == "--default") {
Chris@0 534 if (last || args[i+1].startsWith("-")) {
Chris@127 535 cerr << myname << ": argument expected for \""
Chris@127 536 << arg << "\" option" << endl;
Chris@127 537 cerr << helpStr << endl;
Chris@0 538 exit(2);
Chris@0 539 } else {
Chris@0 540 string deft = args[++i].toStdString();
Chris@0 541 if (requestedDefaultTransforms.find(deft) !=
Chris@0 542 requestedDefaultTransforms.end()) {
Chris@127 543 cerr << myname << ": NOTE: duplicate specification of default transform \"" << deft << "\" ignored" << endl;
Chris@0 544 } else {
Chris@0 545 requestedDefaultTransforms.insert(deft);
Chris@0 546 }
Chris@0 547 continue;
Chris@0 548 }
Chris@0 549 } else if (arg == "-S" || arg == "--summary") {
Chris@0 550 if (last || args[i+1].startsWith("-")) {
Chris@127 551 cerr << myname << ": argument expected for \""
Chris@127 552 << arg << "\" option" << endl;
Chris@127 553 cerr << helpStr << endl;
Chris@0 554 exit(2);
Chris@0 555 } else {
Chris@0 556 string summary = args[++i].toStdString();
Chris@0 557 requestedSummaryTypes.insert(summary);
Chris@0 558 continue;
Chris@0 559 }
Chris@0 560 } else if (arg == "--summary-only") {
Chris@0 561 summaryOnly = true;
Chris@0 562 continue;
Chris@0 563 } else if (arg == "--segments") {
Chris@0 564 if (last) {
Chris@127 565 cerr << myname << ": argument expected for \""
Chris@127 566 << arg << "\" option" << endl;
Chris@127 567 cerr << helpStr << endl;
Chris@0 568 exit(2);
Chris@0 569 } else {
Chris@0 570 string segmentSpec = args[++i].toStdString();
Chris@0 571 QStringList segmentStrs = QString(segmentSpec.c_str()).split(',');
Chris@0 572 for (int j = 0; j < segmentStrs.size(); ++j) {
Chris@0 573 bool good = false;
Chris@0 574 boundaries.insert(Vamp::RealTime::fromSeconds
Chris@0 575 (segmentStrs[j].toDouble(&good)));
Chris@0 576 if (!good) {
Chris@127 577 cerr << myname << ": segment boundaries must be numeric" << endl;
Chris@127 578 cerr << helpStr << endl;
Chris@0 579 exit(2);
Chris@0 580 }
Chris@0 581 }
Chris@0 582 }
Chris@0 583 } else if (arg == "-m" || arg == "--multiplex") {
Chris@0 584 multiplex = true;
Chris@0 585 continue;
Chris@0 586 } else if (arg == "-r" || arg == "--recursive") {
Chris@0 587 recursive = true;
Chris@0 588 continue;
Chris@116 589 } else if (arg == "-n" || arg == "--normalise") {
Chris@116 590 normalise = true;
Chris@116 591 continue;
Chris@21 592 } else if (arg == "-f" || arg == "--force") {
Chris@21 593 force = true;
Chris@21 594 continue;
Chris@0 595 } else if (arg == "-l" || arg == "--list") {
Chris@0 596 list = true;
Chris@0 597 continue;
Chris@127 598 } else if (arg == "--minversion") {
Chris@127 599 if (last || args[i+1].startsWith("-")) {
Chris@127 600 cerr << myname << ": usage: "
Chris@127 601 << myname << " " << arg << " <version>" << endl;
Chris@127 602 cerr << helpStr << endl;
Chris@127 603 exit(2);
Chris@127 604 }
Chris@127 605 minVersion = args[++i];
Chris@127 606 continue;
Chris@0 607 } else if (arg == "-s" || arg == "--skeleton") {
Chris@0 608 if (last || args[i+1].startsWith("-")) {
Chris@127 609 cerr << myname << ": usage: "
Chris@127 610 << myname << " " << arg
Chris@0 611 << " <transform>" << endl;
Chris@127 612 cerr << helpStr << endl;
Chris@0 613 exit(2);
Chris@0 614 } else {
Chris@0 615 skeletonFor = args[++i];
Chris@0 616 continue;
Chris@0 617 }
Chris@0 618 } else {
Chris@0 619 otherArgs.push_back(args[i]);
Chris@0 620 }
Chris@0 621 }
Chris@0 622
Chris@0 623 if (list) {
Chris@0 624 if (!requestedWriterTags.empty() || skeletonFor != "") {
Chris@127 625 cerr << helpStr << endl;
Chris@0 626 exit(2);
Chris@0 627 }
Chris@0 628 listTransforms();
Chris@0 629 exit(0);
Chris@0 630 }
Chris@0 631 if (skeletonFor != "") {
Chris@0 632 if (!requestedWriterTags.empty()) {
Chris@127 633 cerr << helpStr << endl;
Chris@0 634 exit(2);
Chris@0 635 }
Chris@0 636 printSkeleton(skeletonFor);
Chris@0 637 exit(0);
Chris@0 638 }
Chris@127 639 if (minVersion != "") {
Chris@127 640 if (!requestedWriterTags.empty()) {
Chris@127 641 cerr << helpStr << endl;
Chris@127 642 exit(2);
Chris@127 643 }
Chris@127 644 exit(checkMinVersion(myname, minVersion));
Chris@127 645 }
Chris@0 646
Chris@0 647 if (requestedTransformFiles.empty() &&
Chris@0 648 requestedTransformListFiles.empty() &&
Chris@0 649 requestedDefaultTransforms.empty()) {
Chris@127 650 cerr << myname
Chris@0 651 << ": no transform(s) specified" << endl;
Chris@127 652 cerr << helpStr << endl;
Chris@0 653 exit(2);
Chris@0 654 }
Chris@0 655
Chris@0 656 if (requestedWriterTags.empty()) {
Chris@127 657 cerr << myname
Chris@0 658 << ": no writer(s) specified" << endl;
Chris@127 659 cerr << helpStr << endl;
Chris@0 660 exit(2);
Chris@0 661 }
Chris@0 662
Chris@0 663 if (!boundaries.empty()) {
Chris@0 664 if (requestedSummaryTypes.empty()) {
Chris@127 665 cerr << myname
Chris@0 666 << ": summary segment boundaries provided, but no summary type specified"
Chris@0 667 << endl;
Chris@127 668 cerr << helpStr << endl;
Chris@0 669 exit(2);
Chris@0 670 }
Chris@0 671 }
Chris@0 672
Chris@20 673 QSettings settings;
Chris@20 674
Chris@0 675 #ifdef HAVE_FFTW3
Chris@0 676 settings.beginGroup("FFTWisdom");
Chris@0 677 QString wisdom = settings.value("wisdom").toString();
Chris@0 678 if (wisdom != "") {
Chris@0 679 fftw_import_wisdom_from_string(wisdom.toLocal8Bit().data());
Chris@0 680 }
Chris@0 681 settings.endGroup();
Chris@0 682 #endif
Chris@0 683
Chris@20 684 settings.beginGroup("RDF");
Chris@20 685 if (!settings.contains("rdf-indices")) {
Chris@20 686 QStringList list;
Chris@20 687 list << "http://www.vamp-plugins.org/rdf/plugins/index.txt";
Chris@20 688 settings.setValue("rdf-indices", list);
Chris@20 689 }
Chris@20 690 settings.endGroup();
Chris@20 691
Chris@0 692 FeatureExtractionManager manager;
Chris@0 693
Chris@116 694 manager.setNormalise(normalise);
Chris@116 695
Chris@0 696 if (!requestedSummaryTypes.empty()) {
Chris@0 697 if (!manager.setSummaryTypes(requestedSummaryTypes,
Chris@0 698 boundaries)) {
Chris@127 699 cerr << myname
Chris@0 700 << ": failed to set requested summary types" << endl;
Chris@0 701 exit(1);
Chris@0 702 }
Chris@0 703 }
Chris@102 704
Chris@102 705 manager.setSummariesOnly(summaryOnly);
Chris@116 706
Chris@0 707 vector<FeatureWriter *> writers;
Chris@0 708
Chris@0 709 for (set<string>::const_iterator i = requestedWriterTags.begin();
Chris@0 710 i != requestedWriterTags.end(); ++i) {
Chris@0 711
Chris@0 712 FeatureWriter *writer = FeatureWriterFactory::createWriter(*i);
Chris@0 713
Chris@0 714 if (!writer) {
Chris@127 715 cerr << myname << ": unknown feature writer \""
Chris@0 716 << *i << "\"" << endl;
Chris@127 717 cerr << helpStr << endl;
Chris@0 718 exit(2);
Chris@0 719 }
Chris@0 720
Chris@0 721 map<string, string> writerArgs;
Chris@0 722 FeatureWriter::ParameterList pl(writer->getSupportedParameters());
Chris@0 723
Chris@95 724 for (int k = 0; k < (int)pl.size(); ++k) {
Chris@0 725
Chris@0 726 string argbase = pl[k].name;
Chris@0 727 QString literal = QString("--%1-%2")
Chris@0 728 .arg(i->c_str()).arg(argbase.c_str());
Chris@0 729
Chris@95 730 for (int j = 0; j < (int)otherArgs.size(); ) {
Chris@0 731
Chris@0 732 if (otherArgs[j] != literal) {
Chris@0 733 ++j;
Chris@0 734 continue;
Chris@0 735 }
Chris@0 736
Chris@0 737 otherArgs.removeAt(j);
Chris@0 738
Chris@0 739 if (pl[k].hasArg) {
Chris@0 740 if (j < otherArgs.size()) {
Chris@0 741 writerArgs[argbase] = otherArgs[j].toStdString();
Chris@0 742 otherArgs.removeAt(j);
Chris@0 743 } else {
Chris@127 744 cerr << myname << ": "
Chris@0 745 << "argument required for \""
Chris@127 746 << literal << "\" option"
Chris@0 747 << endl;
Chris@127 748 cerr << helpStr << endl;
Chris@0 749 exit(2);
Chris@0 750 }
Chris@0 751 } else {
Chris@0 752 writerArgs[argbase] = "";
Chris@0 753 }
Chris@0 754 }
Chris@0 755 }
Chris@0 756
Chris@0 757 writer->setParameters(writerArgs);
Chris@0 758
Chris@0 759 writers.push_back(writer);
Chris@0 760 }
Chris@0 761
Chris@0 762 for (int i = 0; i < otherArgs.size(); ++i) {
Chris@0 763 if (otherArgs[i].startsWith("-")) {
Chris@127 764 cerr << myname << ": unknown option \""
Chris@127 765 << otherArgs[i] << "\"" << endl;
Chris@127 766 cerr << helpStr << endl;
Chris@0 767 exit(2);
Chris@0 768 }
Chris@0 769 }
Chris@0 770
Chris@0 771 if (otherArgs.empty()) {
Chris@127 772 cerr << myname << ": no input(s) specified" << endl;
Chris@127 773 cerr << helpStr << endl;
Chris@0 774 exit(2);
Chris@0 775 }
Chris@0 776
Chris@0 777 for (set<string>::const_iterator i = requestedTransformListFiles.begin();
Chris@0 778 i != requestedTransformListFiles.end(); ++i) {
Chris@0 779 PlaylistFileReader reader(i->c_str());
Chris@0 780 if (reader.isOK()) {
Chris@0 781 vector<QString> files = reader.load();
Chris@95 782 for (int j = 0; j < (int)files.size(); ++j) {
Chris@0 783 requestedTransformFiles.insert(files[j].toStdString());
Chris@0 784 }
Chris@0 785 } else {
Chris@127 786 cerr << myname << ": failed to read template list file \"" << *i << "\"" << endl;
Chris@0 787 exit(2);
Chris@0 788 }
Chris@0 789 }
Chris@0 790
Chris@0 791 QStringList sources;
Chris@0 792 if (!recursive) {
Chris@0 793 sources = otherArgs;
Chris@0 794 } else {
Chris@0 795 for (QStringList::const_iterator i = otherArgs.begin();
Chris@0 796 i != otherArgs.end(); ++i) {
Chris@0 797 if (QDir(*i).exists()) {
Chris@0 798 cerr << "Directory found and recursive flag set, scanning for audio files..." << endl;
Chris@0 799 int found = 0;
Chris@0 800 findSourcesRecursive(*i, sources, found);
Chris@0 801 cerr << "\rDone, found " << found << " supported audio file(s) " << endl;
Chris@0 802 } else {
Chris@0 803 sources.push_back(*i);
Chris@0 804 }
Chris@0 805 }
Chris@0 806 }
Chris@0 807
Chris@111 808 sources = expandPlaylists(sources);
Chris@117 809
Chris@28 810 bool good = true;
Chris@45 811 QSet<QString> badSources;
Chris@28 812
Chris@0 813 for (QStringList::const_iterator i = sources.begin();
Chris@0 814 i != sources.end(); ++i) {
Chris@0 815 try {
Chris@106 816 manager.addSource(*i, multiplex);
Chris@22 817 } catch (const std::exception &e) {
Chris@45 818 badSources.insert(*i);
Chris@21 819 cerr << "ERROR: Failed to process file \"" << i->toStdString()
Chris@21 820 << "\": " << e.what() << endl;
Chris@22 821 if (force) {
Chris@22 822 // print a note only if we have more files to process
Chris@22 823 QStringList::const_iterator j = i;
Chris@22 824 if (++j != sources.end()) {
Chris@22 825 cerr << "NOTE: \"--force\" option was provided, continuing (more errors may occur)" << endl;
Chris@22 826 }
Chris@22 827 } else {
Chris@45 828 cerr << "NOTE: If you want to continue with processing any further files after an" << endl
Chris@45 829 << "error like this, use the --force option" << endl;
Chris@28 830 good = false;
Chris@22 831 break;
Chris@22 832 }
Chris@0 833 }
Chris@0 834 }
Chris@45 835
Chris@45 836 if (good) {
Chris@45 837
Chris@45 838 bool haveFeatureExtractor = false;
Chris@45 839
Chris@45 840 for (set<string>::const_iterator i = requestedTransformFiles.begin();
Chris@45 841 i != requestedTransformFiles.end(); ++i) {
Chris@45 842 if (manager.addFeatureExtractorFromFile(i->c_str(), writers)) {
Chris@45 843 haveFeatureExtractor = true;
Chris@120 844 } else {
Chris@120 845 cerr << "ERROR: Failed to add feature extractor from transform file \"" << *i << "\"" << endl;
Chris@120 846 good = false;
Chris@45 847 }
Chris@45 848 }
Chris@45 849
Chris@45 850 for (set<string>::const_iterator i = requestedDefaultTransforms.begin();
Chris@45 851 i != requestedDefaultTransforms.end(); ++i) {
Chris@45 852 if (manager.addDefaultFeatureExtractor(i->c_str(), writers)) {
Chris@45 853 haveFeatureExtractor = true;
Chris@120 854 } else {
Chris@120 855 cerr << "ERROR: Failed to add default feature extractor for transform \"" << *i << "\"" << endl;
Chris@120 856 good = false;
Chris@45 857 }
Chris@45 858 }
Chris@45 859
Chris@45 860 if (!haveFeatureExtractor) {
Chris@127 861 cerr << myname << ": no feature extractors added" << endl;
Chris@45 862 good = false;
Chris@45 863 }
Chris@45 864 }
Chris@45 865
Chris@45 866 if (good) {
Chris@106 867 QStringList goodSources;
Chris@106 868 foreach (QString source, sources) {
Chris@106 869 if (!badSources.contains(source)) {
Chris@106 870 goodSources.push_back(source);
Chris@106 871 }
Chris@106 872 }
Chris@106 873 if (multiplex) {
Chris@45 874 try {
Chris@106 875 manager.extractFeaturesMultiplexed(goodSources);
Chris@45 876 } catch (const std::exception &e) {
Chris@106 877 cerr << "ERROR: Feature extraction failed: "
Chris@106 878 << e.what() << endl;
Chris@106 879 }
Chris@106 880 } else {
Chris@106 881 for (QStringList::const_iterator i = goodSources.begin();
Chris@106 882 i != goodSources.end(); ++i) {
Chris@106 883 std::cerr << "Extracting features for: \"" << i->toStdString()
Chris@106 884 << "\"" << std::endl;
Chris@106 885 try {
Chris@112 886 manager.extractFeatures(*i);
Chris@106 887 } catch (const std::exception &e) {
Chris@106 888 cerr << "ERROR: Feature extraction failed for \""
Chris@106 889 << i->toStdString() << "\": " << e.what() << endl;
Chris@106 890 if (force) {
Chris@106 891 // print a note only if we have more files to process
Chris@106 892 QStringList::const_iterator j = i;
Chris@106 893 if (++j != sources.end()) {
Chris@106 894 cerr << "NOTE: \"--force\" option was provided, continuing (more errors may occur)" << endl;
Chris@106 895 }
Chris@106 896 } else {
Chris@106 897 cerr << "NOTE: If you want to continue with processing any further files after an" << endl
Chris@106 898 << "error like this, use the --force option" << endl;
Chris@106 899 good = false;
Chris@106 900 break;
Chris@45 901 }
Chris@45 902 }
Chris@45 903 }
Chris@45 904 }
Chris@45 905 }
Chris@0 906
Chris@95 907 for (int i = 0; i < (int)writers.size(); ++i) delete writers[i];
Chris@0 908
Chris@0 909 #ifdef HAVE_FFTW3
Chris@0 910 settings.beginGroup("FFTWisdom");
Chris@0 911 char *cwisdom = fftw_export_wisdom_to_string();
Chris@0 912 if (cwisdom) {
Chris@0 913 settings.setValue("wisdom", cwisdom);
Chris@0 914 fftw_free(cwisdom);
Chris@0 915 }
Chris@0 916 settings.endGroup();
Chris@0 917 #endif
Chris@0 918
Chris@0 919 TempDirectory::getInstance()->cleanup();
Chris@0 920
Chris@28 921 if (good) return 0;
Chris@28 922 else return 1;
Chris@0 923 }
Chris@0 924
Chris@0 925