annotate src/vamp-hostsdk/PluginHostAdapter.cpp @ 259:7d678f889789 vamp-plugin-sdk-v2.0pre1

...
author cannam
date Fri, 14 Nov 2008 13:53:32 +0000
parents 7b90fe049d04
children 4454843ff384
rev   line source
cannam@1 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
cannam@1 2
cannam@1 3 /*
cannam@1 4 Vamp
cannam@1 5
cannam@1 6 An API for audio analysis and feature extraction plugins.
cannam@1 7
cannam@1 8 Centre for Digital Music, Queen Mary, University of London.
cannam@1 9 Copyright 2006 Chris Cannam.
cannam@1 10
cannam@1 11 Permission is hereby granted, free of charge, to any person
cannam@1 12 obtaining a copy of this software and associated documentation
cannam@1 13 files (the "Software"), to deal in the Software without
cannam@1 14 restriction, including without limitation the rights to use, copy,
cannam@1 15 modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@1 16 of the Software, and to permit persons to whom the Software is
cannam@1 17 furnished to do so, subject to the following conditions:
cannam@1 18
cannam@1 19 The above copyright notice and this permission notice shall be
cannam@1 20 included in all copies or substantial portions of the Software.
cannam@1 21
cannam@1 22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@1 23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@1 24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@6 25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@1 26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@1 27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@1 28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@1 29
cannam@1 30 Except as contained in this notice, the names of the Centre for
cannam@1 31 Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@1 32 shall not be used in advertising or otherwise to promote the sale,
cannam@1 33 use or other dealings in this Software without prior written
cannam@1 34 authorization.
cannam@1 35 */
cannam@1 36
cannam@230 37 #include <vamp-hostsdk/PluginHostAdapter.h>
cannam@130 38 #include <cstdlib>
cannam@1 39
cannam@234 40 #if ( VAMP_SDK_MAJOR_VERSION != 2 || VAMP_SDK_MINOR_VERSION != 0 )
cannam@234 41 #error Incorrect Vamp SDK header included (not the expected 2.0 SDK)
cannam@234 42 #endif
cannam@234 43
cannam@1 44 namespace Vamp
cannam@1 45 {
cannam@1 46
cannam@1 47 PluginHostAdapter::PluginHostAdapter(const VampPluginDescriptor *descriptor,
cannam@1 48 float inputSampleRate) :
cannam@1 49 Plugin(inputSampleRate),
cannam@1 50 m_descriptor(descriptor)
cannam@1 51 {
cannam@15 52 // std::cerr << "PluginHostAdapter::PluginHostAdapter (plugin = " << descriptor->name << ")" << std::endl;
cannam@1 53 m_handle = m_descriptor->instantiate(m_descriptor, inputSampleRate);
cannam@15 54 if (!m_handle) {
cannam@15 55 // std::cerr << "WARNING: PluginHostAdapter: Plugin instantiation failed for plugin " << m_descriptor->name << std::endl;
cannam@15 56 }
cannam@1 57 }
cannam@1 58
cannam@1 59 PluginHostAdapter::~PluginHostAdapter()
cannam@1 60 {
cannam@15 61 // std::cerr << "PluginHostAdapter::~PluginHostAdapter (plugin = " << m_descriptor->name << ")" << std::endl;
cannam@1 62 if (m_handle) m_descriptor->cleanup(m_handle);
cannam@1 63 }
cannam@1 64
cannam@32 65 std::vector<std::string>
cannam@32 66 PluginHostAdapter::getPluginPath()
cannam@32 67 {
cannam@32 68 std::vector<std::string> path;
cannam@32 69 std::string envPath;
cannam@32 70
cannam@32 71 char *cpath = getenv("VAMP_PATH");
cannam@32 72 if (cpath) envPath = cpath;
cannam@32 73
cannam@32 74 #ifdef _WIN32
cannam@32 75 #define PATH_SEPARATOR ';'
cannam@32 76 #define DEFAULT_VAMP_PATH "%ProgramFiles%\\Vamp Plugins"
cannam@32 77 #else
cannam@32 78 #define PATH_SEPARATOR ':'
cannam@32 79 #ifdef __APPLE__
cannam@35 80 #define DEFAULT_VAMP_PATH "$HOME/Library/Audio/Plug-Ins/Vamp:/Library/Audio/Plug-Ins/Vamp"
cannam@32 81 #else
cannam@35 82 #define DEFAULT_VAMP_PATH "$HOME/vamp:$HOME/.vamp:/usr/local/lib/vamp:/usr/lib/vamp"
cannam@32 83 #endif
cannam@32 84 #endif
cannam@32 85
cannam@32 86 if (envPath == "") {
cannam@32 87 envPath = DEFAULT_VAMP_PATH;
cannam@32 88 char *chome = getenv("HOME");
cannam@32 89 if (chome) {
cannam@32 90 std::string home(chome);
cannam@32 91 std::string::size_type f;
cannam@32 92 while ((f = envPath.find("$HOME")) != std::string::npos &&
cannam@32 93 f < envPath.length()) {
cannam@32 94 envPath.replace(f, 5, home);
cannam@32 95 }
cannam@32 96 }
cannam@32 97 #ifdef _WIN32
cannam@32 98 char *cpfiles = getenv("ProgramFiles");
cannam@259 99 if (!cpfiles) cpfiles = (char *)"C:\\Program Files";
cannam@32 100 std::string pfiles(cpfiles);
cannam@32 101 std::string::size_type f;
cannam@32 102 while ((f = envPath.find("%ProgramFiles%")) != std::string::npos &&
cannam@32 103 f < envPath.length()) {
cannam@32 104 envPath.replace(f, 14, pfiles);
cannam@32 105 }
cannam@32 106 #endif
cannam@32 107 }
cannam@32 108
cannam@32 109 std::string::size_type index = 0, newindex = 0;
cannam@32 110
cannam@32 111 while ((newindex = envPath.find(PATH_SEPARATOR, index)) < envPath.size()) {
cannam@32 112 path.push_back(envPath.substr(index, newindex - index));
cannam@32 113 index = newindex + 1;
cannam@32 114 }
cannam@32 115
cannam@32 116 path.push_back(envPath.substr(index));
cannam@32 117
cannam@32 118 return path;
cannam@32 119 }
cannam@32 120
cannam@1 121 bool
cannam@1 122 PluginHostAdapter::initialise(size_t channels,
cannam@1 123 size_t stepSize,
cannam@1 124 size_t blockSize)
cannam@1 125 {
cannam@1 126 if (!m_handle) return false;
cannam@1 127 return m_descriptor->initialise(m_handle, channels, stepSize, blockSize) ?
cannam@1 128 true : false;
cannam@1 129 }
cannam@1 130
cannam@1 131 void
cannam@1 132 PluginHostAdapter::reset()
cannam@1 133 {
cannam@197 134 if (!m_handle) {
cannam@197 135 // std::cerr << "PluginHostAdapter::reset: no handle" << std::endl;
cannam@197 136 return;
cannam@197 137 }
cannam@197 138 // std::cerr << "PluginHostAdapter::reset(" << m_handle << ")" << std::endl;
cannam@1 139 m_descriptor->reset(m_handle);
cannam@1 140 }
cannam@1 141
cannam@1 142 PluginHostAdapter::InputDomain
cannam@1 143 PluginHostAdapter::getInputDomain() const
cannam@1 144 {
cannam@1 145 if (m_descriptor->inputDomain == vampFrequencyDomain) {
cannam@1 146 return FrequencyDomain;
cannam@1 147 } else {
cannam@1 148 return TimeDomain;
cannam@1 149 }
cannam@1 150 }
cannam@1 151
cannam@50 152 unsigned int
cannam@50 153 PluginHostAdapter::getVampApiVersion() const
cannam@50 154 {
cannam@50 155 return m_descriptor->vampApiVersion;
cannam@50 156 }
cannam@50 157
cannam@1 158 std::string
cannam@49 159 PluginHostAdapter::getIdentifier() const
cannam@49 160 {
cannam@49 161 return m_descriptor->identifier;
cannam@49 162 }
cannam@49 163
cannam@49 164 std::string
cannam@1 165 PluginHostAdapter::getName() const
cannam@1 166 {
cannam@1 167 return m_descriptor->name;
cannam@1 168 }
cannam@1 169
cannam@1 170 std::string
cannam@1 171 PluginHostAdapter::getDescription() const
cannam@1 172 {
cannam@1 173 return m_descriptor->description;
cannam@1 174 }
cannam@1 175
cannam@1 176 std::string
cannam@1 177 PluginHostAdapter::getMaker() const
cannam@1 178 {
cannam@1 179 return m_descriptor->maker;
cannam@1 180 }
cannam@1 181
cannam@1 182 int
cannam@1 183 PluginHostAdapter::getPluginVersion() const
cannam@1 184 {
cannam@1 185 return m_descriptor->pluginVersion;
cannam@1 186 }
cannam@1 187
cannam@1 188 std::string
cannam@1 189 PluginHostAdapter::getCopyright() const
cannam@1 190 {
cannam@1 191 return m_descriptor->copyright;
cannam@1 192 }
cannam@1 193
cannam@1 194 PluginHostAdapter::ParameterList
cannam@1 195 PluginHostAdapter::getParameterDescriptors() const
cannam@1 196 {
cannam@1 197 ParameterList list;
cannam@1 198 for (unsigned int i = 0; i < m_descriptor->parameterCount; ++i) {
cannam@1 199 const VampParameterDescriptor *spd = m_descriptor->parameters[i];
cannam@1 200 ParameterDescriptor pd;
cannam@49 201 pd.identifier = spd->identifier;
cannam@1 202 pd.name = spd->name;
cannam@1 203 pd.description = spd->description;
cannam@1 204 pd.unit = spd->unit;
cannam@1 205 pd.minValue = spd->minValue;
cannam@1 206 pd.maxValue = spd->maxValue;
cannam@1 207 pd.defaultValue = spd->defaultValue;
cannam@1 208 pd.isQuantized = spd->isQuantized;
cannam@1 209 pd.quantizeStep = spd->quantizeStep;
cannam@9 210 if (pd.isQuantized && spd->valueNames) {
cannam@9 211 for (unsigned int j = 0; spd->valueNames[j]; ++j) {
cannam@9 212 pd.valueNames.push_back(spd->valueNames[j]);
cannam@9 213 }
cannam@9 214 }
cannam@1 215 list.push_back(pd);
cannam@1 216 }
cannam@1 217 return list;
cannam@1 218 }
cannam@1 219
cannam@1 220 float
cannam@1 221 PluginHostAdapter::getParameter(std::string param) const
cannam@1 222 {
cannam@1 223 if (!m_handle) return 0.0;
cannam@1 224
cannam@1 225 for (unsigned int i = 0; i < m_descriptor->parameterCount; ++i) {
cannam@49 226 if (param == m_descriptor->parameters[i]->identifier) {
cannam@1 227 return m_descriptor->getParameter(m_handle, i);
cannam@1 228 }
cannam@1 229 }
cannam@1 230
cannam@1 231 return 0.0;
cannam@1 232 }
cannam@1 233
cannam@1 234 void
cannam@1 235 PluginHostAdapter::setParameter(std::string param,
cannam@1 236 float value)
cannam@1 237 {
cannam@1 238 if (!m_handle) return;
cannam@1 239
cannam@1 240 for (unsigned int i = 0; i < m_descriptor->parameterCount; ++i) {
cannam@49 241 if (param == m_descriptor->parameters[i]->identifier) {
cannam@1 242 m_descriptor->setParameter(m_handle, i, value);
cannam@1 243 return;
cannam@1 244 }
cannam@1 245 }
cannam@1 246 }
cannam@1 247
cannam@1 248 PluginHostAdapter::ProgramList
cannam@1 249 PluginHostAdapter::getPrograms() const
cannam@1 250 {
cannam@1 251 ProgramList list;
cannam@1 252
cannam@1 253 for (unsigned int i = 0; i < m_descriptor->programCount; ++i) {
cannam@1 254 list.push_back(m_descriptor->programs[i]);
cannam@1 255 }
cannam@1 256
cannam@1 257 return list;
cannam@1 258 }
cannam@1 259
cannam@1 260 std::string
cannam@1 261 PluginHostAdapter::getCurrentProgram() const
cannam@1 262 {
cannam@1 263 if (!m_handle) return "";
cannam@1 264
cannam@1 265 int pn = m_descriptor->getCurrentProgram(m_handle);
cannam@1 266 return m_descriptor->programs[pn];
cannam@1 267 }
cannam@1 268
cannam@1 269 void
cannam@1 270 PluginHostAdapter::selectProgram(std::string program)
cannam@1 271 {
cannam@1 272 if (!m_handle) return;
cannam@1 273
cannam@1 274 for (unsigned int i = 0; i < m_descriptor->programCount; ++i) {
cannam@1 275 if (program == m_descriptor->programs[i]) {
cannam@1 276 m_descriptor->selectProgram(m_handle, i);
cannam@1 277 return;
cannam@1 278 }
cannam@1 279 }
cannam@1 280 }
cannam@1 281
cannam@1 282 size_t
cannam@1 283 PluginHostAdapter::getPreferredStepSize() const
cannam@1 284 {
cannam@1 285 if (!m_handle) return 0;
cannam@1 286 return m_descriptor->getPreferredStepSize(m_handle);
cannam@1 287 }
cannam@1 288
cannam@1 289 size_t
cannam@1 290 PluginHostAdapter::getPreferredBlockSize() const
cannam@1 291 {
cannam@1 292 if (!m_handle) return 0;
cannam@1 293 return m_descriptor->getPreferredBlockSize(m_handle);
cannam@1 294 }
cannam@1 295
cannam@26 296 size_t
cannam@26 297 PluginHostAdapter::getMinChannelCount() const
cannam@26 298 {
cannam@26 299 if (!m_handle) return 0;
cannam@26 300 return m_descriptor->getMinChannelCount(m_handle);
cannam@26 301 }
cannam@26 302
cannam@26 303 size_t
cannam@26 304 PluginHostAdapter::getMaxChannelCount() const
cannam@26 305 {
cannam@26 306 if (!m_handle) return 0;
cannam@26 307 return m_descriptor->getMaxChannelCount(m_handle);
cannam@26 308 }
cannam@26 309
cannam@1 310 PluginHostAdapter::OutputList
cannam@1 311 PluginHostAdapter::getOutputDescriptors() const
cannam@1 312 {
cannam@1 313 OutputList list;
cannam@15 314 if (!m_handle) {
cannam@15 315 // std::cerr << "PluginHostAdapter::getOutputDescriptors: no handle " << std::endl;
cannam@15 316 return list;
cannam@15 317 }
cannam@1 318
cannam@1 319 unsigned int count = m_descriptor->getOutputCount(m_handle);
cannam@1 320
cannam@1 321 for (unsigned int i = 0; i < count; ++i) {
cannam@1 322 VampOutputDescriptor *sd = m_descriptor->getOutputDescriptor(m_handle, i);
cannam@1 323 OutputDescriptor d;
cannam@49 324 d.identifier = sd->identifier;
cannam@1 325 d.name = sd->name;
cannam@1 326 d.description = sd->description;
cannam@1 327 d.unit = sd->unit;
cannam@9 328 d.hasFixedBinCount = sd->hasFixedBinCount;
cannam@9 329 d.binCount = sd->binCount;
cannam@240 330 if (d.hasFixedBinCount && sd->binNames) {
cannam@9 331 for (unsigned int j = 0; j < sd->binCount; ++j) {
cannam@9 332 d.binNames.push_back(sd->binNames[j] ? sd->binNames[j] : "");
cannam@9 333 }
cannam@1 334 }
cannam@1 335 d.hasKnownExtents = sd->hasKnownExtents;
cannam@1 336 d.minValue = sd->minValue;
cannam@1 337 d.maxValue = sd->maxValue;
cannam@1 338 d.isQuantized = sd->isQuantized;
cannam@1 339 d.quantizeStep = sd->quantizeStep;
cannam@1 340
cannam@1 341 switch (sd->sampleType) {
cannam@1 342 case vampOneSamplePerStep:
cannam@1 343 d.sampleType = OutputDescriptor::OneSamplePerStep; break;
cannam@1 344 case vampFixedSampleRate:
cannam@1 345 d.sampleType = OutputDescriptor::FixedSampleRate; break;
cannam@1 346 case vampVariableSampleRate:
cannam@1 347 d.sampleType = OutputDescriptor::VariableSampleRate; break;
cannam@1 348 }
cannam@1 349
cannam@1 350 d.sampleRate = sd->sampleRate;
cannam@1 351
cannam@192 352 if (m_descriptor->vampApiVersion >= 2) {
cannam@192 353 d.hasDuration = sd->hasDuration;
cannam@192 354 } else {
cannam@192 355 d.hasDuration = false;
cannam@192 356 }
cannam@192 357
cannam@1 358 list.push_back(d);
cannam@1 359
cannam@1 360 m_descriptor->releaseOutputDescriptor(sd);
cannam@1 361 }
cannam@1 362
cannam@1 363 return list;
cannam@1 364 }
cannam@1 365
cannam@1 366 PluginHostAdapter::FeatureSet
cannam@47 367 PluginHostAdapter::process(const float *const *inputBuffers,
cannam@47 368 RealTime timestamp)
cannam@1 369 {
cannam@1 370 FeatureSet fs;
cannam@1 371 if (!m_handle) return fs;
cannam@1 372
cannam@1 373 int sec = timestamp.sec;
cannam@1 374 int nsec = timestamp.nsec;
cannam@1 375
cannam@12 376 VampFeatureList *features = m_descriptor->process(m_handle,
cannam@1 377 inputBuffers,
cannam@1 378 sec, nsec);
cannam@1 379
cannam@1 380 convertFeatures(features, fs);
cannam@1 381 m_descriptor->releaseFeatureSet(features);
cannam@1 382 return fs;
cannam@1 383 }
cannam@1 384
cannam@1 385 PluginHostAdapter::FeatureSet
cannam@1 386 PluginHostAdapter::getRemainingFeatures()
cannam@1 387 {
cannam@1 388 FeatureSet fs;
cannam@1 389 if (!m_handle) return fs;
cannam@1 390
cannam@12 391 VampFeatureList *features = m_descriptor->getRemainingFeatures(m_handle);
cannam@1 392
cannam@1 393 convertFeatures(features, fs);
cannam@1 394 m_descriptor->releaseFeatureSet(features);
cannam@1 395 return fs;
cannam@1 396 }
cannam@1 397
cannam@1 398 void
cannam@12 399 PluginHostAdapter::convertFeatures(VampFeatureList *features,
cannam@1 400 FeatureSet &fs)
cannam@1 401 {
cannam@7 402 if (!features) return;
cannam@7 403
cannam@12 404 unsigned int outputs = m_descriptor->getOutputCount(m_handle);
cannam@12 405
cannam@12 406 for (unsigned int i = 0; i < outputs; ++i) {
cannam@1 407
cannam@12 408 VampFeatureList &list = features[i];
cannam@1 409
cannam@1 410 if (list.featureCount > 0) {
cannam@1 411
cannam@108 412 Feature feature;
cannam@168 413 feature.values.reserve(list.features[0].v1.valueCount);
cannam@108 414
cannam@1 415 for (unsigned int j = 0; j < list.featureCount; ++j) {
cannam@108 416
cannam@168 417 feature.hasTimestamp = list.features[j].v1.hasTimestamp;
cannam@168 418 feature.timestamp = RealTime(list.features[j].v1.sec,
cannam@168 419 list.features[j].v1.nsec);
cannam@168 420 feature.hasDuration = false;
cannam@1 421
cannam@167 422 if (m_descriptor->vampApiVersion >= 2) {
cannam@168 423 unsigned int j2 = j + list.featureCount;
cannam@168 424 feature.hasDuration = list.features[j2].v2.hasDuration;
cannam@168 425 feature.duration = RealTime(list.features[j2].v2.durationSec,
cannam@168 426 list.features[j2].v2.durationNsec);
cannam@167 427 }
cannam@167 428
cannam@168 429 for (unsigned int k = 0; k < list.features[j].v1.valueCount; ++k) {
cannam@168 430 feature.values.push_back(list.features[j].v1.values[k]);
cannam@1 431 }
cannam@7 432
cannam@168 433 if (list.features[j].v1.label) {
cannam@168 434 feature.label = list.features[j].v1.label;
cannam@7 435 }
cannam@1 436
cannam@1 437 fs[i].push_back(feature);
cannam@108 438
cannam@168 439 if (list.features[j].v1.valueCount > 0) {
cannam@108 440 feature.values.clear();
cannam@108 441 }
cannam@108 442
cannam@168 443 if (list.features[j].v1.label) {
cannam@108 444 feature.label = "";
cannam@108 445 }
cannam@1 446 }
cannam@1 447 }
cannam@1 448 }
cannam@1 449 }
cannam@1 450
cannam@1 451 }