annotate src/vamp-plugin-sdk-2.5/host/vamp-simple-host.cpp @ 23:619f715526df sv_v2.1

Update Vamp plugin SDK to 2.5
author Chris Cannam
date Thu, 09 May 2013 10:52:46 +0100
parents
children
rev   line source
Chris@23 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@23 2
Chris@23 3 /*
Chris@23 4 Vamp
Chris@23 5
Chris@23 6 An API for audio analysis and feature extraction plugins.
Chris@23 7
Chris@23 8 Centre for Digital Music, Queen Mary, University of London.
Chris@23 9 Copyright 2006 Chris Cannam, copyright 2007-2008 QMUL.
Chris@23 10
Chris@23 11 Permission is hereby granted, free of charge, to any person
Chris@23 12 obtaining a copy of this software and associated documentation
Chris@23 13 files (the "Software"), to deal in the Software without
Chris@23 14 restriction, including without limitation the rights to use, copy,
Chris@23 15 modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@23 16 of the Software, and to permit persons to whom the Software is
Chris@23 17 furnished to do so, subject to the following conditions:
Chris@23 18
Chris@23 19 The above copyright notice and this permission notice shall be
Chris@23 20 included in all copies or substantial portions of the Software.
Chris@23 21
Chris@23 22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@23 23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@23 24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@23 25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
Chris@23 26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@23 27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@23 28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@23 29
Chris@23 30 Except as contained in this notice, the names of the Centre for
Chris@23 31 Digital Music; Queen Mary, University of London; and Chris Cannam
Chris@23 32 shall not be used in advertising or otherwise to promote the sale,
Chris@23 33 use or other dealings in this Software without prior written
Chris@23 34 authorization.
Chris@23 35 */
Chris@23 36
Chris@23 37
Chris@23 38 /*
Chris@23 39 * This "simple" Vamp plugin host is no longer as simple as it was; it
Chris@23 40 * now has a lot of options and includes a lot of code to handle the
Chris@23 41 * various useful listing modes it supports.
Chris@23 42 *
Chris@23 43 * However, the runPlugin function still contains a reasonable
Chris@23 44 * implementation of a fairly generic Vamp plugin host capable of
Chris@23 45 * evaluating a given output on a given plugin for a sound file read
Chris@23 46 * via libsndfile.
Chris@23 47 */
Chris@23 48
Chris@23 49 #include <vamp-hostsdk/PluginHostAdapter.h>
Chris@23 50 #include <vamp-hostsdk/PluginInputDomainAdapter.h>
Chris@23 51 #include <vamp-hostsdk/PluginLoader.h>
Chris@23 52
Chris@23 53 #include <iostream>
Chris@23 54 #include <fstream>
Chris@23 55 #include <set>
Chris@23 56 #include <sndfile.h>
Chris@23 57
Chris@23 58 #include <cstring>
Chris@23 59 #include <cstdlib>
Chris@23 60
Chris@23 61 #include "system.h"
Chris@23 62
Chris@23 63 #include <cmath>
Chris@23 64
Chris@23 65 using namespace std;
Chris@23 66
Chris@23 67 using Vamp::Plugin;
Chris@23 68 using Vamp::PluginHostAdapter;
Chris@23 69 using Vamp::RealTime;
Chris@23 70 using Vamp::HostExt::PluginLoader;
Chris@23 71 using Vamp::HostExt::PluginWrapper;
Chris@23 72 using Vamp::HostExt::PluginInputDomainAdapter;
Chris@23 73
Chris@23 74 #define HOST_VERSION "1.5"
Chris@23 75
Chris@23 76 enum Verbosity {
Chris@23 77 PluginIds,
Chris@23 78 PluginOutputIds,
Chris@23 79 PluginInformation,
Chris@23 80 PluginInformationDetailed
Chris@23 81 };
Chris@23 82
Chris@23 83 void printFeatures(int, int, int, Plugin::FeatureSet, ofstream *, bool frames);
Chris@23 84 void transformInput(float *, size_t);
Chris@23 85 void fft(unsigned int, bool, double *, double *, double *, double *);
Chris@23 86 void printPluginPath(bool verbose);
Chris@23 87 void printPluginCategoryList();
Chris@23 88 void enumeratePlugins(Verbosity);
Chris@23 89 void listPluginsInLibrary(string soname);
Chris@23 90 int runPlugin(string myname, string soname, string id, string output,
Chris@23 91 int outputNo, string inputFile, string outfilename, bool frames);
Chris@23 92
Chris@23 93 void usage(const char *name)
Chris@23 94 {
Chris@23 95 cerr << "\n"
Chris@23 96 << name << ": A command-line host for Vamp audio analysis plugins.\n\n"
Chris@23 97 "Centre for Digital Music, Queen Mary, University of London.\n"
Chris@23 98 "Copyright 2006-2009 Chris Cannam and QMUL.\n"
Chris@23 99 "Freely redistributable; published under a BSD-style license.\n\n"
Chris@23 100 "Usage:\n\n"
Chris@23 101 " " << name << " [-s] pluginlibrary[." << PLUGIN_SUFFIX << "]:plugin[:output] file.wav [-o out.txt]\n"
Chris@23 102 " " << name << " [-s] pluginlibrary[." << PLUGIN_SUFFIX << "]:plugin file.wav [outputno] [-o out.txt]\n\n"
Chris@23 103 " -- Load plugin id \"plugin\" from \"pluginlibrary\" and run it on the\n"
Chris@23 104 " audio data in \"file.wav\", retrieving the named \"output\", or output\n"
Chris@23 105 " number \"outputno\" (the first output by default) and dumping it to\n"
Chris@23 106 " standard output, or to \"out.txt\" if the -o option is given.\n\n"
Chris@23 107 " \"pluginlibrary\" should be a library name, not a file path; the\n"
Chris@23 108 " standard Vamp library search path will be used to locate it. If\n"
Chris@23 109 " a file path is supplied, the directory part(s) will be ignored.\n\n"
Chris@23 110 " If the -s option is given, results will be labelled with the audio\n"
Chris@23 111 " sample frame at which they occur. Otherwise, they will be labelled\n"
Chris@23 112 " with time in seconds.\n\n"
Chris@23 113 " " << name << " -l\n"
Chris@23 114 " " << name << " --list\n\n"
Chris@23 115 " -- List the plugin libraries and Vamp plugins in the library search path\n"
Chris@23 116 " in a verbose human-readable format.\n\n"
Chris@23 117 " " << name << " --list-full\n\n"
Chris@23 118 " -- List all data reported by all the Vamp plugins in the library search\n"
Chris@23 119 " path in a very verbose human-readable format.\n\n"
Chris@23 120 " " << name << " --list-ids\n\n"
Chris@23 121 " -- List the plugins in the search path in a terse machine-readable format,\n"
Chris@23 122 " in the form vamp:soname:identifier.\n\n"
Chris@23 123 " " << name << " --list-outputs\n\n"
Chris@23 124 " -- List the outputs for plugins in the search path in a machine-readable\n"
Chris@23 125 " format, in the form vamp:soname:identifier:output.\n\n"
Chris@23 126 " " << name << " --list-by-category\n\n"
Chris@23 127 " -- List the plugins as a plugin index by category, in a machine-readable\n"
Chris@23 128 " format. The format may change in future releases.\n\n"
Chris@23 129 " " << name << " -p\n\n"
Chris@23 130 " -- Print out the Vamp library search path.\n\n"
Chris@23 131 " " << name << " -v\n\n"
Chris@23 132 " -- Display version information only.\n"
Chris@23 133 << endl;
Chris@23 134 exit(2);
Chris@23 135 }
Chris@23 136
Chris@23 137 int main(int argc, char **argv)
Chris@23 138 {
Chris@23 139 char *scooter = argv[0];
Chris@23 140 char *name = 0;
Chris@23 141 while (scooter && *scooter) {
Chris@23 142 if (*scooter == '/' || *scooter == '\\') name = ++scooter;
Chris@23 143 else ++scooter;
Chris@23 144 }
Chris@23 145 if (!name || !*name) name = argv[0];
Chris@23 146
Chris@23 147 if (argc < 2) usage(name);
Chris@23 148
Chris@23 149 if (argc == 2) {
Chris@23 150
Chris@23 151 if (!strcmp(argv[1], "-v")) {
Chris@23 152
Chris@23 153 cout << "Simple Vamp plugin host version: " << HOST_VERSION << endl
Chris@23 154 << "Vamp API version: " << VAMP_API_VERSION << endl
Chris@23 155 << "Vamp SDK version: " << VAMP_SDK_VERSION << endl;
Chris@23 156 return 0;
Chris@23 157
Chris@23 158 } else if (!strcmp(argv[1], "-l") || !strcmp(argv[1], "--list")) {
Chris@23 159
Chris@23 160 printPluginPath(true);
Chris@23 161 enumeratePlugins(PluginInformation);
Chris@23 162 return 0;
Chris@23 163
Chris@23 164 } else if (!strcmp(argv[1], "--list-full")) {
Chris@23 165
Chris@23 166 enumeratePlugins(PluginInformationDetailed);
Chris@23 167 return 0;
Chris@23 168
Chris@23 169 } else if (!strcmp(argv[1], "-p")) {
Chris@23 170
Chris@23 171 printPluginPath(false);
Chris@23 172 return 0;
Chris@23 173
Chris@23 174 } else if (!strcmp(argv[1], "--list-ids")) {
Chris@23 175
Chris@23 176 enumeratePlugins(PluginIds);
Chris@23 177 return 0;
Chris@23 178
Chris@23 179 } else if (!strcmp(argv[1], "--list-outputs")) {
Chris@23 180
Chris@23 181 enumeratePlugins(PluginOutputIds);
Chris@23 182 return 0;
Chris@23 183
Chris@23 184 } else if (!strcmp(argv[1], "--list-by-category")) {
Chris@23 185
Chris@23 186 printPluginCategoryList();
Chris@23 187 return 0;
Chris@23 188
Chris@23 189 } else usage(name);
Chris@23 190 }
Chris@23 191
Chris@23 192 if (argc < 3) usage(name);
Chris@23 193
Chris@23 194 bool useFrames = false;
Chris@23 195
Chris@23 196 int base = 1;
Chris@23 197 if (!strcmp(argv[1], "-s")) {
Chris@23 198 useFrames = true;
Chris@23 199 base = 2;
Chris@23 200 }
Chris@23 201
Chris@23 202 string soname = argv[base];
Chris@23 203 string wavname = argv[base+1];
Chris@23 204 string plugid = "";
Chris@23 205 string output = "";
Chris@23 206 int outputNo = -1;
Chris@23 207 string outfilename;
Chris@23 208
Chris@23 209 if (argc >= base+3) {
Chris@23 210
Chris@23 211 int idx = base+2;
Chris@23 212
Chris@23 213 if (isdigit(*argv[idx])) {
Chris@23 214 outputNo = atoi(argv[idx++]);
Chris@23 215 }
Chris@23 216
Chris@23 217 if (argc == idx + 2) {
Chris@23 218 if (!strcmp(argv[idx], "-o")) {
Chris@23 219 outfilename = argv[idx+1];
Chris@23 220 } else usage(name);
Chris@23 221 } else if (argc != idx) {
Chris@23 222 (usage(name));
Chris@23 223 }
Chris@23 224 }
Chris@23 225
Chris@23 226 cerr << endl << name << ": Running..." << endl;
Chris@23 227
Chris@23 228 cerr << "Reading file: \"" << wavname << "\", writing to ";
Chris@23 229 if (outfilename == "") {
Chris@23 230 cerr << "standard output" << endl;
Chris@23 231 } else {
Chris@23 232 cerr << "\"" << outfilename << "\"" << endl;
Chris@23 233 }
Chris@23 234
Chris@23 235 string::size_type sep = soname.find(':');
Chris@23 236
Chris@23 237 if (sep != string::npos) {
Chris@23 238 plugid = soname.substr(sep + 1);
Chris@23 239 soname = soname.substr(0, sep);
Chris@23 240
Chris@23 241 sep = plugid.find(':');
Chris@23 242 if (sep != string::npos) {
Chris@23 243 output = plugid.substr(sep + 1);
Chris@23 244 plugid = plugid.substr(0, sep);
Chris@23 245 }
Chris@23 246 }
Chris@23 247
Chris@23 248 if (plugid == "") {
Chris@23 249 usage(name);
Chris@23 250 }
Chris@23 251
Chris@23 252 if (output != "" && outputNo != -1) {
Chris@23 253 usage(name);
Chris@23 254 }
Chris@23 255
Chris@23 256 if (output == "" && outputNo == -1) {
Chris@23 257 outputNo = 0;
Chris@23 258 }
Chris@23 259
Chris@23 260 return runPlugin(name, soname, plugid, output, outputNo,
Chris@23 261 wavname, outfilename, useFrames);
Chris@23 262 }
Chris@23 263
Chris@23 264
Chris@23 265 int runPlugin(string myname, string soname, string id,
Chris@23 266 string output, int outputNo, string wavname,
Chris@23 267 string outfilename, bool useFrames)
Chris@23 268 {
Chris@23 269 PluginLoader *loader = PluginLoader::getInstance();
Chris@23 270
Chris@23 271 PluginLoader::PluginKey key = loader->composePluginKey(soname, id);
Chris@23 272
Chris@23 273 SNDFILE *sndfile;
Chris@23 274 SF_INFO sfinfo;
Chris@23 275 memset(&sfinfo, 0, sizeof(SF_INFO));
Chris@23 276
Chris@23 277 sndfile = sf_open(wavname.c_str(), SFM_READ, &sfinfo);
Chris@23 278 if (!sndfile) {
Chris@23 279 cerr << myname << ": ERROR: Failed to open input file \""
Chris@23 280 << wavname << "\": " << sf_strerror(sndfile) << endl;
Chris@23 281 return 1;
Chris@23 282 }
Chris@23 283
Chris@23 284 ofstream *out = 0;
Chris@23 285 if (outfilename != "") {
Chris@23 286 out = new ofstream(outfilename.c_str(), ios::out);
Chris@23 287 if (!*out) {
Chris@23 288 cerr << myname << ": ERROR: Failed to open output file \""
Chris@23 289 << outfilename << "\" for writing" << endl;
Chris@23 290 delete out;
Chris@23 291 return 1;
Chris@23 292 }
Chris@23 293 }
Chris@23 294
Chris@23 295 Plugin *plugin = loader->loadPlugin
Chris@23 296 (key, sfinfo.samplerate, PluginLoader::ADAPT_ALL_SAFE);
Chris@23 297 if (!plugin) {
Chris@23 298 cerr << myname << ": ERROR: Failed to load plugin \"" << id
Chris@23 299 << "\" from library \"" << soname << "\"" << endl;
Chris@23 300 sf_close(sndfile);
Chris@23 301 if (out) {
Chris@23 302 out->close();
Chris@23 303 delete out;
Chris@23 304 }
Chris@23 305 return 1;
Chris@23 306 }
Chris@23 307
Chris@23 308 cerr << "Running plugin: \"" << plugin->getIdentifier() << "\"..." << endl;
Chris@23 309
Chris@23 310 // Note that the following would be much simpler if we used a
Chris@23 311 // PluginBufferingAdapter as well -- i.e. if we had passed
Chris@23 312 // PluginLoader::ADAPT_ALL to loader->loadPlugin() above, instead
Chris@23 313 // of ADAPT_ALL_SAFE. Then we could simply specify our own block
Chris@23 314 // size, keep the step size equal to the block size, and ignore
Chris@23 315 // the plugin's bleatings. However, there are some issues with
Chris@23 316 // using a PluginBufferingAdapter that make the results sometimes
Chris@23 317 // technically different from (if effectively the same as) the
Chris@23 318 // un-adapted plugin, so we aren't doing that here. See the
Chris@23 319 // PluginBufferingAdapter documentation for details.
Chris@23 320
Chris@23 321 int blockSize = plugin->getPreferredBlockSize();
Chris@23 322 int stepSize = plugin->getPreferredStepSize();
Chris@23 323
Chris@23 324 if (blockSize == 0) {
Chris@23 325 blockSize = 1024;
Chris@23 326 }
Chris@23 327 if (stepSize == 0) {
Chris@23 328 if (plugin->getInputDomain() == Plugin::FrequencyDomain) {
Chris@23 329 stepSize = blockSize/2;
Chris@23 330 } else {
Chris@23 331 stepSize = blockSize;
Chris@23 332 }
Chris@23 333 } else if (stepSize > blockSize) {
Chris@23 334 cerr << "WARNING: stepSize " << stepSize << " > blockSize " << blockSize << ", resetting blockSize to ";
Chris@23 335 if (plugin->getInputDomain() == Plugin::FrequencyDomain) {
Chris@23 336 blockSize = stepSize * 2;
Chris@23 337 } else {
Chris@23 338 blockSize = stepSize;
Chris@23 339 }
Chris@23 340 cerr << blockSize << endl;
Chris@23 341 }
Chris@23 342 int overlapSize = blockSize - stepSize;
Chris@23 343 sf_count_t currentStep = 0;
Chris@23 344 int finalStepsRemaining = max(1, (blockSize / stepSize) - 1); // at end of file, this many part-silent frames needed after we hit EOF
Chris@23 345
Chris@23 346 int channels = sfinfo.channels;
Chris@23 347
Chris@23 348 float *filebuf = new float[blockSize * channels];
Chris@23 349 float **plugbuf = new float*[channels];
Chris@23 350 for (int c = 0; c < channels; ++c) plugbuf[c] = new float[blockSize + 2];
Chris@23 351
Chris@23 352 cerr << "Using block size = " << blockSize << ", step size = "
Chris@23 353 << stepSize << endl;
Chris@23 354
Chris@23 355 // The channel queries here are for informational purposes only --
Chris@23 356 // a PluginChannelAdapter is being used automatically behind the
Chris@23 357 // scenes, and it will take case of any channel mismatch
Chris@23 358
Chris@23 359 int minch = plugin->getMinChannelCount();
Chris@23 360 int maxch = plugin->getMaxChannelCount();
Chris@23 361 cerr << "Plugin accepts " << minch << " -> " << maxch << " channel(s)" << endl;
Chris@23 362 cerr << "Sound file has " << channels << " (will mix/augment if necessary)" << endl;
Chris@23 363
Chris@23 364 Plugin::OutputList outputs = plugin->getOutputDescriptors();
Chris@23 365 Plugin::OutputDescriptor od;
Chris@23 366
Chris@23 367 int returnValue = 1;
Chris@23 368 int progress = 0;
Chris@23 369
Chris@23 370 RealTime rt;
Chris@23 371 PluginWrapper *wrapper = 0;
Chris@23 372 RealTime adjustment = RealTime::zeroTime;
Chris@23 373
Chris@23 374 if (outputs.empty()) {
Chris@23 375 cerr << "ERROR: Plugin has no outputs!" << endl;
Chris@23 376 goto done;
Chris@23 377 }
Chris@23 378
Chris@23 379 if (outputNo < 0) {
Chris@23 380
Chris@23 381 for (size_t oi = 0; oi < outputs.size(); ++oi) {
Chris@23 382 if (outputs[oi].identifier == output) {
Chris@23 383 outputNo = oi;
Chris@23 384 break;
Chris@23 385 }
Chris@23 386 }
Chris@23 387
Chris@23 388 if (outputNo < 0) {
Chris@23 389 cerr << "ERROR: Non-existent output \"" << output << "\" requested" << endl;
Chris@23 390 goto done;
Chris@23 391 }
Chris@23 392
Chris@23 393 } else {
Chris@23 394
Chris@23 395 if (int(outputs.size()) <= outputNo) {
Chris@23 396 cerr << "ERROR: Output " << outputNo << " requested, but plugin has only " << outputs.size() << " output(s)" << endl;
Chris@23 397 goto done;
Chris@23 398 }
Chris@23 399 }
Chris@23 400
Chris@23 401 od = outputs[outputNo];
Chris@23 402 cerr << "Output is: \"" << od.identifier << "\"" << endl;
Chris@23 403
Chris@23 404 if (!plugin->initialise(channels, stepSize, blockSize)) {
Chris@23 405 cerr << "ERROR: Plugin initialise (channels = " << channels
Chris@23 406 << ", stepSize = " << stepSize << ", blockSize = "
Chris@23 407 << blockSize << ") failed." << endl;
Chris@23 408 goto done;
Chris@23 409 }
Chris@23 410
Chris@23 411 wrapper = dynamic_cast<PluginWrapper *>(plugin);
Chris@23 412 if (wrapper) {
Chris@23 413 // See documentation for
Chris@23 414 // PluginInputDomainAdapter::getTimestampAdjustment
Chris@23 415 PluginInputDomainAdapter *ida =
Chris@23 416 wrapper->getWrapper<PluginInputDomainAdapter>();
Chris@23 417 if (ida) adjustment = ida->getTimestampAdjustment();
Chris@23 418 }
Chris@23 419
Chris@23 420 // Here we iterate over the frames, avoiding asking the numframes in case it's streaming input.
Chris@23 421 do {
Chris@23 422
Chris@23 423 int count;
Chris@23 424
Chris@23 425 if ((blockSize==stepSize) || (currentStep==0)) {
Chris@23 426 // read a full fresh block
Chris@23 427 if ((count = sf_readf_float(sndfile, filebuf, blockSize)) < 0) {
Chris@23 428 cerr << "ERROR: sf_readf_float failed: " << sf_strerror(sndfile) << endl;
Chris@23 429 break;
Chris@23 430 }
Chris@23 431 if (count != blockSize) --finalStepsRemaining;
Chris@23 432 } else {
Chris@23 433 // otherwise shunt the existing data down and read the remainder.
Chris@23 434 memmove(filebuf, filebuf + (stepSize * channels), overlapSize * channels * sizeof(float));
Chris@23 435 if ((count = sf_readf_float(sndfile, filebuf + (overlapSize * channels), stepSize)) < 0) {
Chris@23 436 cerr << "ERROR: sf_readf_float failed: " << sf_strerror(sndfile) << endl;
Chris@23 437 break;
Chris@23 438 }
Chris@23 439 if (count != stepSize) --finalStepsRemaining;
Chris@23 440 count += overlapSize;
Chris@23 441 }
Chris@23 442
Chris@23 443 for (int c = 0; c < channels; ++c) {
Chris@23 444 int j = 0;
Chris@23 445 while (j < count) {
Chris@23 446 plugbuf[c][j] = filebuf[j * sfinfo.channels + c];
Chris@23 447 ++j;
Chris@23 448 }
Chris@23 449 while (j < blockSize) {
Chris@23 450 plugbuf[c][j] = 0.0f;
Chris@23 451 ++j;
Chris@23 452 }
Chris@23 453 }
Chris@23 454
Chris@23 455 rt = RealTime::frame2RealTime(currentStep * stepSize, sfinfo.samplerate);
Chris@23 456
Chris@23 457 printFeatures
Chris@23 458 (RealTime::realTime2Frame(rt + adjustment, sfinfo.samplerate),
Chris@23 459 sfinfo.samplerate, outputNo, plugin->process(plugbuf, rt),
Chris@23 460 out, useFrames);
Chris@23 461
Chris@23 462 if (sfinfo.frames > 0){
Chris@23 463 int pp = progress;
Chris@23 464 progress = lrintf((float(currentStep * stepSize) / sfinfo.frames) * 100.f);
Chris@23 465 if (progress != pp && out) {
Chris@23 466 cerr << "\r" << progress << "%";
Chris@23 467 }
Chris@23 468 }
Chris@23 469
Chris@23 470 ++currentStep;
Chris@23 471
Chris@23 472 } while (finalStepsRemaining > 0);
Chris@23 473
Chris@23 474 if (out) cerr << "\rDone" << endl;
Chris@23 475
Chris@23 476 rt = RealTime::frame2RealTime(currentStep * stepSize, sfinfo.samplerate);
Chris@23 477
Chris@23 478 printFeatures(RealTime::realTime2Frame(rt + adjustment, sfinfo.samplerate),
Chris@23 479 sfinfo.samplerate, outputNo,
Chris@23 480 plugin->getRemainingFeatures(), out, useFrames);
Chris@23 481
Chris@23 482 returnValue = 0;
Chris@23 483
Chris@23 484 done:
Chris@23 485 delete plugin;
Chris@23 486 if (out) {
Chris@23 487 out->close();
Chris@23 488 delete out;
Chris@23 489 }
Chris@23 490 sf_close(sndfile);
Chris@23 491 return returnValue;
Chris@23 492 }
Chris@23 493
Chris@23 494 void
Chris@23 495 printFeatures(int frame, int sr, int output,
Chris@23 496 Plugin::FeatureSet features, ofstream *out, bool useFrames)
Chris@23 497 {
Chris@23 498 for (unsigned int i = 0; i < features[output].size(); ++i) {
Chris@23 499
Chris@23 500 if (useFrames) {
Chris@23 501
Chris@23 502 int displayFrame = frame;
Chris@23 503
Chris@23 504 if (features[output][i].hasTimestamp) {
Chris@23 505 displayFrame = RealTime::realTime2Frame
Chris@23 506 (features[output][i].timestamp, sr);
Chris@23 507 }
Chris@23 508
Chris@23 509 (out ? *out : cout) << displayFrame;
Chris@23 510
Chris@23 511 if (features[output][i].hasDuration) {
Chris@23 512 displayFrame = RealTime::realTime2Frame
Chris@23 513 (features[output][i].duration, sr);
Chris@23 514 (out ? *out : cout) << "," << displayFrame;
Chris@23 515 }
Chris@23 516
Chris@23 517 (out ? *out : cout) << ":";
Chris@23 518
Chris@23 519 } else {
Chris@23 520
Chris@23 521 RealTime rt = RealTime::frame2RealTime(frame, sr);
Chris@23 522
Chris@23 523 if (features[output][i].hasTimestamp) {
Chris@23 524 rt = features[output][i].timestamp;
Chris@23 525 }
Chris@23 526
Chris@23 527 (out ? *out : cout) << rt.toString();
Chris@23 528
Chris@23 529 if (features[output][i].hasDuration) {
Chris@23 530 rt = features[output][i].duration;
Chris@23 531 (out ? *out : cout) << "," << rt.toString();
Chris@23 532 }
Chris@23 533
Chris@23 534 (out ? *out : cout) << ":";
Chris@23 535 }
Chris@23 536
Chris@23 537 for (unsigned int j = 0; j < features[output][i].values.size(); ++j) {
Chris@23 538 (out ? *out : cout) << " " << features[output][i].values[j];
Chris@23 539 }
Chris@23 540 (out ? *out : cout) << " " << features[output][i].label;
Chris@23 541
Chris@23 542 (out ? *out : cout) << endl;
Chris@23 543 }
Chris@23 544 }
Chris@23 545
Chris@23 546 void
Chris@23 547 printPluginPath(bool verbose)
Chris@23 548 {
Chris@23 549 if (verbose) {
Chris@23 550 cout << "\nVamp plugin search path: ";
Chris@23 551 }
Chris@23 552
Chris@23 553 vector<string> path = PluginHostAdapter::getPluginPath();
Chris@23 554 for (size_t i = 0; i < path.size(); ++i) {
Chris@23 555 if (verbose) {
Chris@23 556 cout << "[" << path[i] << "]";
Chris@23 557 } else {
Chris@23 558 cout << path[i] << endl;
Chris@23 559 }
Chris@23 560 }
Chris@23 561
Chris@23 562 if (verbose) cout << endl;
Chris@23 563 }
Chris@23 564
Chris@23 565 static
Chris@23 566 string
Chris@23 567 header(string text, int level)
Chris@23 568 {
Chris@23 569 string out = '\n' + text + '\n';
Chris@23 570 for (size_t i = 0; i < text.length(); ++i) {
Chris@23 571 out += (level == 1 ? '=' : level == 2 ? '-' : '~');
Chris@23 572 }
Chris@23 573 out += '\n';
Chris@23 574 return out;
Chris@23 575 }
Chris@23 576
Chris@23 577 void
Chris@23 578 enumeratePlugins(Verbosity verbosity)
Chris@23 579 {
Chris@23 580 PluginLoader *loader = PluginLoader::getInstance();
Chris@23 581
Chris@23 582 if (verbosity == PluginInformation) {
Chris@23 583 cout << "\nVamp plugin libraries found in search path:" << endl;
Chris@23 584 }
Chris@23 585
Chris@23 586 vector<PluginLoader::PluginKey> plugins = loader->listPlugins();
Chris@23 587 typedef multimap<string, PluginLoader::PluginKey>
Chris@23 588 LibraryMap;
Chris@23 589 LibraryMap libraryMap;
Chris@23 590
Chris@23 591 for (size_t i = 0; i < plugins.size(); ++i) {
Chris@23 592 string path = loader->getLibraryPathForPlugin(plugins[i]);
Chris@23 593 libraryMap.insert(LibraryMap::value_type(path, plugins[i]));
Chris@23 594 }
Chris@23 595
Chris@23 596 string prevPath = "";
Chris@23 597 int index = 0;
Chris@23 598
Chris@23 599 for (LibraryMap::iterator i = libraryMap.begin();
Chris@23 600 i != libraryMap.end(); ++i) {
Chris@23 601
Chris@23 602 string path = i->first;
Chris@23 603 PluginLoader::PluginKey key = i->second;
Chris@23 604
Chris@23 605 if (path != prevPath) {
Chris@23 606 prevPath = path;
Chris@23 607 index = 0;
Chris@23 608 if (verbosity == PluginInformation) {
Chris@23 609 cout << "\n " << path << ":" << endl;
Chris@23 610 } else if (verbosity == PluginInformationDetailed) {
Chris@23 611 string::size_type ki = i->second.find(':');
Chris@23 612 string text = "Library \"" + i->second.substr(0, ki) + "\"";
Chris@23 613 cout << "\n" << header(text, 1);
Chris@23 614 }
Chris@23 615 }
Chris@23 616
Chris@23 617 Plugin *plugin = loader->loadPlugin(key, 48000);
Chris@23 618 if (plugin) {
Chris@23 619
Chris@23 620 char c = char('A' + index);
Chris@23 621 if (c > 'Z') c = char('a' + (index - 26));
Chris@23 622
Chris@23 623 PluginLoader::PluginCategoryHierarchy category =
Chris@23 624 loader->getPluginCategory(key);
Chris@23 625 string catstr;
Chris@23 626 if (!category.empty()) {
Chris@23 627 for (size_t ci = 0; ci < category.size(); ++ci) {
Chris@23 628 if (ci > 0) catstr += " > ";
Chris@23 629 catstr += category[ci];
Chris@23 630 }
Chris@23 631 }
Chris@23 632
Chris@23 633 if (verbosity == PluginInformation) {
Chris@23 634
Chris@23 635 cout << " [" << c << "] [v"
Chris@23 636 << plugin->getVampApiVersion() << "] "
Chris@23 637 << plugin->getName() << ", \""
Chris@23 638 << plugin->getIdentifier() << "\"" << " ["
Chris@23 639 << plugin->getMaker() << "]" << endl;
Chris@23 640
Chris@23 641 if (catstr != "") {
Chris@23 642 cout << " > " << catstr << endl;
Chris@23 643 }
Chris@23 644
Chris@23 645 if (plugin->getDescription() != "") {
Chris@23 646 cout << " - " << plugin->getDescription() << endl;
Chris@23 647 }
Chris@23 648
Chris@23 649 } else if (verbosity == PluginInformationDetailed) {
Chris@23 650
Chris@23 651 cout << header(plugin->getName(), 2);
Chris@23 652 cout << " - Identifier: "
Chris@23 653 << key << endl;
Chris@23 654 cout << " - Plugin Version: "
Chris@23 655 << plugin->getPluginVersion() << endl;
Chris@23 656 cout << " - Vamp API Version: "
Chris@23 657 << plugin->getVampApiVersion() << endl;
Chris@23 658 cout << " - Maker: \""
Chris@23 659 << plugin->getMaker() << "\"" << endl;
Chris@23 660 cout << " - Copyright: \""
Chris@23 661 << plugin->getCopyright() << "\"" << endl;
Chris@23 662 cout << " - Description: \""
Chris@23 663 << plugin->getDescription() << "\"" << endl;
Chris@23 664 cout << " - Input Domain: "
Chris@23 665 << (plugin->getInputDomain() == Vamp::Plugin::TimeDomain ?
Chris@23 666 "Time Domain" : "Frequency Domain") << endl;
Chris@23 667 cout << " - Default Step Size: "
Chris@23 668 << plugin->getPreferredStepSize() << endl;
Chris@23 669 cout << " - Default Block Size: "
Chris@23 670 << plugin->getPreferredBlockSize() << endl;
Chris@23 671 cout << " - Minimum Channels: "
Chris@23 672 << plugin->getMinChannelCount() << endl;
Chris@23 673 cout << " - Maximum Channels: "
Chris@23 674 << plugin->getMaxChannelCount() << endl;
Chris@23 675
Chris@23 676 } else if (verbosity == PluginIds) {
Chris@23 677 cout << "vamp:" << key << endl;
Chris@23 678 }
Chris@23 679
Chris@23 680 Plugin::OutputList outputs =
Chris@23 681 plugin->getOutputDescriptors();
Chris@23 682
Chris@23 683 if (verbosity == PluginInformationDetailed) {
Chris@23 684
Chris@23 685 Plugin::ParameterList params = plugin->getParameterDescriptors();
Chris@23 686 for (size_t j = 0; j < params.size(); ++j) {
Chris@23 687 Plugin::ParameterDescriptor &pd(params[j]);
Chris@23 688 cout << "\nParameter " << j+1 << ": \"" << pd.name << "\"" << endl;
Chris@23 689 cout << " - Identifier: " << pd.identifier << endl;
Chris@23 690 cout << " - Description: \"" << pd.description << "\"" << endl;
Chris@23 691 if (pd.unit != "") {
Chris@23 692 cout << " - Unit: " << pd.unit << endl;
Chris@23 693 }
Chris@23 694 cout << " - Range: ";
Chris@23 695 cout << pd.minValue << " -> " << pd.maxValue << endl;
Chris@23 696 cout << " - Default: ";
Chris@23 697 cout << pd.defaultValue << endl;
Chris@23 698 if (pd.isQuantized) {
Chris@23 699 cout << " - Quantize Step: "
Chris@23 700 << pd.quantizeStep << endl;
Chris@23 701 }
Chris@23 702 if (!pd.valueNames.empty()) {
Chris@23 703 cout << " - Value Names: ";
Chris@23 704 for (size_t k = 0; k < pd.valueNames.size(); ++k) {
Chris@23 705 if (k > 0) cout << ", ";
Chris@23 706 cout << "\"" << pd.valueNames[k] << "\"";
Chris@23 707 }
Chris@23 708 cout << endl;
Chris@23 709 }
Chris@23 710 }
Chris@23 711
Chris@23 712 if (outputs.empty()) {
Chris@23 713 cout << "\n** Note: This plugin reports no outputs!" << endl;
Chris@23 714 }
Chris@23 715 for (size_t j = 0; j < outputs.size(); ++j) {
Chris@23 716 Plugin::OutputDescriptor &od(outputs[j]);
Chris@23 717 cout << "\nOutput " << j+1 << ": \"" << od.name << "\"" << endl;
Chris@23 718 cout << " - Identifier: " << od.identifier << endl;
Chris@23 719 cout << " - Description: \"" << od.description << "\"" << endl;
Chris@23 720 if (od.unit != "") {
Chris@23 721 cout << " - Unit: " << od.unit << endl;
Chris@23 722 }
Chris@23 723 if (od.hasFixedBinCount) {
Chris@23 724 cout << " - Default Bin Count: " << od.binCount << endl;
Chris@23 725 }
Chris@23 726 if (!od.binNames.empty()) {
Chris@23 727 bool have = false;
Chris@23 728 for (size_t k = 0; k < od.binNames.size(); ++k) {
Chris@23 729 if (od.binNames[k] != "") {
Chris@23 730 have = true; break;
Chris@23 731 }
Chris@23 732 }
Chris@23 733 if (have) {
Chris@23 734 cout << " - Bin Names: ";
Chris@23 735 for (size_t k = 0; k < od.binNames.size(); ++k) {
Chris@23 736 if (k > 0) cout << ", ";
Chris@23 737 cout << "\"" << od.binNames[k] << "\"";
Chris@23 738 }
Chris@23 739 cout << endl;
Chris@23 740 }
Chris@23 741 }
Chris@23 742 if (od.hasKnownExtents) {
Chris@23 743 cout << " - Default Extents: ";
Chris@23 744 cout << od.minValue << " -> " << od.maxValue << endl;
Chris@23 745 }
Chris@23 746 if (od.isQuantized) {
Chris@23 747 cout << " - Quantize Step: "
Chris@23 748 << od.quantizeStep << endl;
Chris@23 749 }
Chris@23 750 cout << " - Sample Type: "
Chris@23 751 << (od.sampleType ==
Chris@23 752 Plugin::OutputDescriptor::OneSamplePerStep ?
Chris@23 753 "One Sample Per Step" :
Chris@23 754 od.sampleType ==
Chris@23 755 Plugin::OutputDescriptor::FixedSampleRate ?
Chris@23 756 "Fixed Sample Rate" :
Chris@23 757 "Variable Sample Rate") << endl;
Chris@23 758 if (od.sampleType !=
Chris@23 759 Plugin::OutputDescriptor::OneSamplePerStep) {
Chris@23 760 cout << " - Default Rate: "
Chris@23 761 << od.sampleRate << endl;
Chris@23 762 }
Chris@23 763 cout << " - Has Duration: "
Chris@23 764 << (od.hasDuration ? "Yes" : "No") << endl;
Chris@23 765 }
Chris@23 766 }
Chris@23 767
Chris@23 768 if (outputs.size() > 1 || verbosity == PluginOutputIds) {
Chris@23 769 for (size_t j = 0; j < outputs.size(); ++j) {
Chris@23 770 if (verbosity == PluginInformation) {
Chris@23 771 cout << " (" << j << ") "
Chris@23 772 << outputs[j].name << ", \""
Chris@23 773 << outputs[j].identifier << "\"" << endl;
Chris@23 774 if (outputs[j].description != "") {
Chris@23 775 cout << " - "
Chris@23 776 << outputs[j].description << endl;
Chris@23 777 }
Chris@23 778 } else if (verbosity == PluginOutputIds) {
Chris@23 779 cout << "vamp:" << key << ":" << outputs[j].identifier << endl;
Chris@23 780 }
Chris@23 781 }
Chris@23 782 }
Chris@23 783
Chris@23 784 ++index;
Chris@23 785
Chris@23 786 delete plugin;
Chris@23 787 }
Chris@23 788 }
Chris@23 789
Chris@23 790 if (verbosity == PluginInformation ||
Chris@23 791 verbosity == PluginInformationDetailed) {
Chris@23 792 cout << endl;
Chris@23 793 }
Chris@23 794 }
Chris@23 795
Chris@23 796 void
Chris@23 797 printPluginCategoryList()
Chris@23 798 {
Chris@23 799 PluginLoader *loader = PluginLoader::getInstance();
Chris@23 800
Chris@23 801 vector<PluginLoader::PluginKey> plugins = loader->listPlugins();
Chris@23 802
Chris@23 803 set<string> printedcats;
Chris@23 804
Chris@23 805 for (size_t i = 0; i < plugins.size(); ++i) {
Chris@23 806
Chris@23 807 PluginLoader::PluginKey key = plugins[i];
Chris@23 808
Chris@23 809 PluginLoader::PluginCategoryHierarchy category =
Chris@23 810 loader->getPluginCategory(key);
Chris@23 811
Chris@23 812 Plugin *plugin = loader->loadPlugin(key, 48000);
Chris@23 813 if (!plugin) continue;
Chris@23 814
Chris@23 815 string catstr = "";
Chris@23 816
Chris@23 817 if (category.empty()) catstr = '|';
Chris@23 818 else {
Chris@23 819 for (size_t j = 0; j < category.size(); ++j) {
Chris@23 820 catstr += category[j];
Chris@23 821 catstr += '|';
Chris@23 822 if (printedcats.find(catstr) == printedcats.end()) {
Chris@23 823 std::cout << catstr << std::endl;
Chris@23 824 printedcats.insert(catstr);
Chris@23 825 }
Chris@23 826 }
Chris@23 827 }
Chris@23 828
Chris@23 829 std::cout << catstr << key << ":::" << plugin->getName() << ":::" << plugin->getMaker() << ":::" << plugin->getDescription() << std::endl;
Chris@23 830 }
Chris@23 831 }
Chris@23 832