annotate src/vamp-plugin-sdk-2.4/host/vamp-simple-host.cpp @ 97:efb4b8187266

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