annotate src/vamp-plugin-sdk-2.5/host/vamp-simple-host.cpp @ 169:223a55898ab9 tip default

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