annotate src/MatchVampPlugin.cpp @ 213:2fcd1c14f0f6

Default scale of 150 seems a reasonable cautious value
author Chris Cannam
date Fri, 27 Feb 2015 14:27:34 +0000
parents 082ff90f1c82
children ccdadbdd80df
rev   line source
cannam@0 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
cannam@0 2
cannam@0 3 /*
cannam@0 4 Vamp feature extraction plugin using the MATCH audio alignment
cannam@0 5 algorithm.
cannam@0 6
cannam@0 7 Centre for Digital Music, Queen Mary, University of London.
cannam@0 8 This file copyright 2007 Simon Dixon, Chris Cannam and QMUL.
cannam@0 9
cannam@0 10 This program is free software; you can redistribute it and/or
cannam@0 11 modify it under the terms of the GNU General Public License as
cannam@0 12 published by the Free Software Foundation; either version 2 of the
cannam@0 13 License, or (at your option) any later version. See the file
cannam@0 14 COPYING included with this distribution for more information.
cannam@0 15 */
cannam@0 16
cannam@0 17 #include "MatchVampPlugin.h"
cannam@0 18
cannam@0 19 #include "Matcher.h"
Chris@74 20 #include "MatchFeatureFeeder.h"
Chris@74 21 #include "FeatureExtractor.h"
cannam@0 22 #include "Path.h"
cannam@0 23
cannam@0 24 #include <vamp/vamp.h>
cannam@0 25 #include <vamp-sdk/PluginAdapter.h>
cannam@0 26 #include <vamp-sdk/RealTime.h>
cannam@0 27
cannam@0 28 #include <vector>
cannam@0 29 #include <algorithm>
cannam@0 30
cannam@0 31 //static int extant = 0;
cannam@0 32
cannam@0 33 #ifdef _WIN32
cannam@0 34 HANDLE
cannam@0 35 MatchVampPlugin::m_serialisingMutex;
cannam@0 36 #else
cannam@0 37 pthread_mutex_t
cannam@0 38 MatchVampPlugin::m_serialisingMutex;
cannam@0 39 #endif
cannam@0 40
cannam@0 41 bool
cannam@0 42 MatchVampPlugin::m_serialisingMutexInitialised = false;
cannam@0 43
Chris@10 44 // We want to ensure our freq map / crossover bin in Matcher.cpp are
Chris@10 45 // always valid with a fixed FFT length in seconds, so must reject low
Chris@10 46 // sample rates
Chris@10 47 static float sampleRateMin = 5000.f;
Chris@10 48
Chris@52 49 static float defaultStepTime = 0.020f;
Chris@15 50
cannam@0 51 MatchVampPlugin::MatchVampPlugin(float inputSampleRate) :
cannam@0 52 Plugin(inputSampleRate),
Chris@52 53 m_stepSize(int(inputSampleRate * defaultStepTime + 0.001)),
Chris@15 54 m_stepTime(defaultStepTime),
Chris@16 55 m_blockSize(2048),
cannam@0 56 m_serialise(false),
cannam@0 57 m_begin(true),
Chris@17 58 m_locked(false),
Chris@138 59 m_smooth(false),
Chris@74 60 m_frameNo(0),
Chris@113 61 m_params(defaultStepTime),
Chris@113 62 m_defaultParams(defaultStepTime),
Chris@38 63 m_feParams(inputSampleRate, m_blockSize),
Chris@103 64 m_defaultFeParams(inputSampleRate, m_blockSize),
Chris@161 65 m_secondReferenceFrequency(m_defaultFeParams.referenceFrequency),
Chris@103 66 m_fcParams(),
Chris@143 67 m_defaultFcParams(),
Chris@143 68 m_dParams(),
Chris@143 69 m_defaultDParams()
cannam@0 70 {
Chris@10 71 if (inputSampleRate < sampleRateMin) {
Chris@10 72 std::cerr << "MatchVampPlugin::MatchVampPlugin: input sample rate "
Chris@10 73 << inputSampleRate << " < min supported rate "
Chris@10 74 << sampleRateMin << ", plugin will refuse to initialise"
Chris@10 75 << std::endl;
Chris@10 76 }
Chris@10 77
cannam@0 78 if (!m_serialisingMutexInitialised) {
cannam@0 79 m_serialisingMutexInitialised = true;
cannam@0 80 #ifdef _WIN32
cannam@0 81 m_serialisingMutex = CreateMutex(NULL, FALSE, NULL);
cannam@0 82 #else
cannam@0 83 pthread_mutex_init(&m_serialisingMutex, 0);
cannam@0 84 #endif
cannam@0 85 }
cannam@0 86
Chris@107 87 m_pipeline = 0;
cannam@0 88 // std::cerr << "MatchVampPlugin::MatchVampPlugin(" << this << "): extant = " << ++extant << std::endl;
cannam@0 89 }
cannam@0 90
cannam@0 91 MatchVampPlugin::~MatchVampPlugin()
cannam@0 92 {
cannam@0 93 // std::cerr << "MatchVampPlugin::~MatchVampPlugin(" << this << "): extant = " << --extant << std::endl;
cannam@0 94
Chris@107 95 delete m_pipeline;
cannam@0 96
cannam@0 97 if (m_locked) {
cannam@0 98 #ifdef _WIN32
cannam@0 99 ReleaseMutex(m_serialisingMutex);
cannam@0 100 #else
cannam@0 101 pthread_mutex_unlock(&m_serialisingMutex);
cannam@0 102 #endif
cannam@0 103 m_locked = false;
cannam@0 104 }
cannam@0 105 }
cannam@0 106
cannam@0 107 string
cannam@0 108 MatchVampPlugin::getIdentifier() const
cannam@0 109 {
cannam@0 110 return "match";
cannam@0 111 }
cannam@0 112
cannam@0 113 string
cannam@0 114 MatchVampPlugin::getName() const
cannam@0 115 {
cannam@0 116 return "Match Performance Aligner";
cannam@0 117 }
cannam@0 118
cannam@0 119 string
cannam@0 120 MatchVampPlugin::getDescription() const
cannam@0 121 {
cannam@0 122 return "Calculate alignment between two performances in separate channel inputs";
cannam@0 123 }
cannam@0 124
cannam@0 125 string
cannam@0 126 MatchVampPlugin::getMaker() const
cannam@0 127 {
cannam@0 128 return "Simon Dixon (plugin by Chris Cannam)";
cannam@0 129 }
cannam@0 130
cannam@0 131 int
cannam@0 132 MatchVampPlugin::getPluginVersion() const
cannam@0 133 {
Chris@137 134 return 3;
cannam@0 135 }
cannam@0 136
cannam@0 137 string
cannam@0 138 MatchVampPlugin::getCopyright() const
cannam@0 139 {
cannam@0 140 return "GPL";
cannam@0 141 }
cannam@0 142
cannam@0 143 MatchVampPlugin::ParameterList
cannam@0 144 MatchVampPlugin::getParameterDescriptors() const
cannam@0 145 {
cannam@0 146 ParameterList list;
cannam@0 147
cannam@0 148 ParameterDescriptor desc;
Chris@18 149
Chris@162 150 desc.identifier = "freq1";
Chris@162 151 desc.name = "Tuning frequency of first input";
Chris@162 152 desc.description = "Tuning frequency (concert A) for the reference audio.";
Chris@162 153 desc.minValue = 220.0;
Chris@162 154 desc.maxValue = 880.0;
Chris@188 155 desc.defaultValue = float(m_defaultFeParams.referenceFrequency);
Chris@162 156 desc.isQuantized = false;
Chris@162 157 desc.unit = "Hz";
Chris@162 158 list.push_back(desc);
Chris@162 159
Chris@162 160 desc.identifier = "freq2";
Chris@162 161 desc.name = "Tuning frequency of second input";
Chris@162 162 desc.description = "Tuning frequency (concert A) for the other audio.";
Chris@162 163 desc.minValue = 220.0;
Chris@162 164 desc.maxValue = 880.0;
Chris@188 165 desc.defaultValue = float(m_defaultFeParams.referenceFrequency);
Chris@162 166 desc.isQuantized = false;
Chris@162 167 desc.unit = "Hz";
Chris@162 168 list.push_back(desc);
Chris@162 169
Chris@177 170 desc.identifier = "minfreq";
Chris@177 171 desc.name = "Minimum frequency";
Chris@177 172 desc.description = "Minimum frequency to include in features.";
Chris@177 173 desc.minValue = 0.0;
Chris@188 174 desc.maxValue = float(m_inputSampleRate / 4.f);
Chris@188 175 desc.defaultValue = float(m_defaultFeParams.minFrequency);
Chris@177 176 desc.isQuantized = false;
Chris@177 177 desc.unit = "Hz";
Chris@177 178 list.push_back(desc);
Chris@177 179
Chris@177 180 desc.identifier = "maxfreq";
Chris@177 181 desc.name = "Maximum frequency";
Chris@177 182 desc.description = "Maximum frequency to include in features.";
Chris@177 183 desc.minValue = 1000.0;
Chris@188 184 desc.maxValue = float(m_inputSampleRate / 2.f);
Chris@188 185 desc.defaultValue = float(m_defaultFeParams.maxFrequency);
Chris@177 186 desc.isQuantized = false;
Chris@177 187 desc.unit = "Hz";
Chris@177 188 list.push_back(desc);
Chris@177 189
Chris@162 190 desc.unit = "";
Chris@162 191
Chris@162 192 desc.identifier = "usechroma";
Chris@162 193 desc.name = "Feature type";
Chris@162 194 desc.description = "Whether to use warped spectrogram or chroma frequency map";
cannam@0 195 desc.minValue = 0;
cannam@0 196 desc.maxValue = 1;
Chris@162 197 desc.defaultValue = m_defaultFeParams.useChromaFrequencyMap ? 1 : 0;
Chris@162 198 desc.isQuantized = true;
Chris@162 199 desc.quantizeStep = 1;
Chris@162 200 desc.valueNames.clear();
Chris@162 201 desc.valueNames.push_back("Spectral");
Chris@162 202 desc.valueNames.push_back("Chroma");
Chris@162 203 list.push_back(desc);
Chris@162 204
Chris@162 205 desc.valueNames.clear();
Chris@162 206
Chris@162 207 desc.identifier = "usespecdiff";
Chris@162 208 desc.name = "Use feature difference";
Chris@162 209 desc.description = "Whether to use half-wave rectified feature-to-feature difference instead of straight spectral or chroma feature";
Chris@162 210 desc.minValue = 0;
Chris@162 211 desc.maxValue = 1;
Chris@188 212 desc.defaultValue = float(m_defaultFcParams.order);
cannam@0 213 desc.isQuantized = true;
cannam@0 214 desc.quantizeStep = 1;
cannam@0 215 list.push_back(desc);
cannam@0 216
Chris@18 217 desc.identifier = "framenorm";
Chris@162 218 desc.name = "Frame normalisation";
Chris@162 219 desc.description = "Type of normalisation to use for features";
Chris@18 220 desc.minValue = 0;
Chris@18 221 desc.maxValue = 2;
Chris@188 222 desc.defaultValue = float(m_defaultFcParams.norm);
Chris@18 223 desc.isQuantized = true;
Chris@18 224 desc.quantizeStep = 1;
Chris@18 225 desc.valueNames.clear();
Chris@18 226 desc.valueNames.push_back("None");
Chris@162 227 desc.valueNames.push_back("Sum to 1");
Chris@162 228 desc.valueNames.push_back("Long-term average");
Chris@18 229 list.push_back(desc);
Chris@18 230 desc.valueNames.clear();
Chris@188 231 desc.defaultValue = float(m_defaultFcParams.silenceThreshold);
Chris@151 232
Chris@156 233 desc.identifier = "metric";
Chris@156 234 desc.name = "Distance metric";
Chris@156 235 desc.description = "Metric for distance calculations.";
Chris@156 236 desc.minValue = 0;
Chris@157 237 desc.maxValue = 2;
Chris@188 238 desc.defaultValue = float(m_defaultDParams.metric);
Chris@156 239 desc.isQuantized = true;
Chris@156 240 desc.quantizeStep = 1;
Chris@156 241 desc.valueNames.clear();
Chris@157 242 desc.valueNames.push_back("Manhattan");
Chris@156 243 desc.valueNames.push_back("Euclidean");
Chris@156 244 desc.valueNames.push_back("Cosine");
Chris@156 245 list.push_back(desc);
Chris@156 246 desc.valueNames.clear();
Chris@156 247
Chris@162 248 desc.identifier = "distnorm";
Chris@162 249 desc.name = "Distance normalisation";
Chris@162 250 desc.description = "Type of normalisation to use for distance metric";
Chris@162 251 desc.minValue = 0;
Chris@162 252 desc.maxValue = 2;
Chris@188 253 desc.defaultValue = float(m_defaultDParams.norm);
Chris@162 254 desc.isQuantized = true;
Chris@162 255 desc.quantizeStep = 1;
Chris@162 256 desc.valueNames.clear();
Chris@162 257 desc.valueNames.push_back("None");
Chris@162 258 desc.valueNames.push_back("Sum of frames");
Chris@162 259 desc.valueNames.push_back("Log sum of frames");
Chris@162 260 list.push_back(desc);
Chris@162 261 desc.valueNames.clear();
Chris@162 262
Chris@198 263 #ifdef USE_COMPACT_TYPES
Chris@198 264 desc.identifier = "scale";
Chris@198 265 desc.name = "Distance scale";
Chris@198 266 desc.description = "Scale factor to use when mapping distance metric into byte range for storage";
Chris@198 267 desc.minValue = 1;
Chris@198 268 desc.maxValue = 1000;
Chris@198 269 desc.defaultValue = float(m_defaultDParams.scale);
Chris@198 270 desc.isQuantized = false;
Chris@198 271 list.push_back(desc);
Chris@198 272 #endif
Chris@198 273
Chris@162 274 desc.identifier = "silencethreshold";
Chris@162 275 desc.name = "Silence threshold";
Chris@162 276 desc.description = "Total frame energy threshold below which a feature will be regarded as silent";
Chris@162 277 desc.minValue = 0;
Chris@165 278 desc.maxValue = 0.1f;
Chris@188 279 desc.defaultValue = float(m_defaultFcParams.silenceThreshold);
Chris@162 280 desc.isQuantized = false;
Chris@162 281 list.push_back(desc);
Chris@162 282
Chris@151 283 desc.identifier = "noise";
Chris@162 284 desc.name = "Add noise";
Chris@151 285 desc.description = "Whether to mix in a small constant white noise term when calculating feature distance. This can improve alignment against sources containing cleanly synthesised audio.";
Chris@151 286 desc.minValue = 0;
Chris@151 287 desc.maxValue = 1;
Chris@188 288 desc.defaultValue = float(m_defaultDParams.noise);
Chris@151 289 desc.isQuantized = true;
Chris@151 290 desc.quantizeStep = 1;
Chris@151 291 list.push_back(desc);
Chris@136 292
Chris@25 293 desc.identifier = "gradientlimit";
Chris@162 294 desc.name = "Gradient limit";
Chris@18 295 desc.description = "Limit of number of frames that will be accepted from one source without a frame from the other source being accepted";
Chris@18 296 desc.minValue = 1;
Chris@18 297 desc.maxValue = 10;
Chris@188 298 desc.defaultValue = float(m_defaultParams.maxRunCount);
Chris@18 299 desc.isQuantized = true;
Chris@18 300 desc.quantizeStep = 1;
Chris@18 301 list.push_back(desc);
Chris@18 302
Chris@25 303 desc.identifier = "zonewidth";
Chris@162 304 desc.name = "Search zone width";
Chris@25 305 desc.description = "Width of the search zone (error margin) either side of the ongoing match position, in seconds";
Chris@25 306 desc.minValue = 1;
Chris@25 307 desc.maxValue = 60;
Chris@188 308 desc.defaultValue = float(m_defaultParams.blockTime);
Chris@25 309 desc.isQuantized = true;
Chris@25 310 desc.quantizeStep = 1;
Chris@25 311 desc.unit = "s";
Chris@25 312 list.push_back(desc);
Chris@25 313
Chris@83 314 desc.identifier = "diagonalweight";
Chris@162 315 desc.name = "Diagonal weight";
Chris@83 316 desc.description = "Weight applied to cost of diagonal step relative to horizontal or vertical step. The default of 2.0 is good for gross tracking of quite different performances; closer to 1.0 produces a smoother path for performances more similar in tempo";
Chris@83 317 desc.minValue = 1.0;
Chris@86 318 desc.maxValue = 2.0;
Chris@188 319 desc.defaultValue = float(m_defaultParams.diagonalWeight);
Chris@83 320 desc.isQuantized = false;
Chris@83 321 desc.unit = "";
Chris@83 322 list.push_back(desc);
Chris@83 323
Chris@32 324 desc.identifier = "smooth";
Chris@162 325 desc.name = "Use path smoothing";
Chris@138 326 desc.description = "Smooth the path by replacing steps with diagonals. (This was enabled by default in earlier versions of the MATCH plugin, but the default now is to produce an un-smoothed path.)";
Chris@32 327 desc.minValue = 0;
Chris@32 328 desc.maxValue = 1;
Chris@138 329 desc.defaultValue = 0;
Chris@32 330 desc.isQuantized = true;
Chris@32 331 desc.quantizeStep = 1;
Chris@32 332 desc.unit = "";
Chris@32 333 list.push_back(desc);
Chris@32 334
Chris@162 335 desc.identifier = "serialise";
Chris@162 336 desc.name = "Serialise plugin invocations";
Chris@162 337 desc.description = "Reduce potential memory load at the expense of multiprocessor performance by serialising multi-threaded plugin runs";
Chris@162 338 desc.minValue = 0;
Chris@162 339 desc.maxValue = 1;
Chris@162 340 desc.defaultValue = 0;
Chris@162 341 desc.isQuantized = true;
Chris@162 342 desc.quantizeStep = 1;
Chris@161 343 list.push_back(desc);
Chris@161 344
cannam@0 345 return list;
cannam@0 346 }
cannam@0 347
cannam@0 348 float
cannam@0 349 MatchVampPlugin::getParameter(std::string name) const
cannam@0 350 {
cannam@0 351 if (name == "serialise") {
cannam@0 352 return m_serialise ? 1.0 : 0.0;
Chris@18 353 } else if (name == "framenorm") {
Chris@188 354 return float(m_fcParams.norm);
Chris@18 355 } else if (name == "distnorm") {
Chris@188 356 return float(m_dParams.norm);
Chris@18 357 } else if (name == "usespecdiff") {
Chris@188 358 return float(m_fcParams.order);
Chris@18 359 } else if (name == "usechroma") {
Chris@38 360 return m_feParams.useChromaFrequencyMap ? 1.0 : 0.0;
Chris@25 361 } else if (name == "gradientlimit") {
Chris@188 362 return float(m_params.maxRunCount);
Chris@83 363 } else if (name == "diagonalweight") {
Chris@188 364 return float(m_params.diagonalWeight);
Chris@25 365 } else if (name == "zonewidth") {
Chris@188 366 return float(m_params.blockTime);
Chris@32 367 } else if (name == "smooth") {
Chris@32 368 return m_smooth ? 1.0 : 0.0;
Chris@136 369 } else if (name == "silencethreshold") {
Chris@188 370 return float(m_fcParams.silenceThreshold);
Chris@156 371 } else if (name == "metric") {
Chris@188 372 return float(m_dParams.metric);
Chris@151 373 } else if (name == "noise") {
Chris@151 374 return m_dParams.noise;
Chris@198 375 } else if (name == "scale") {
Chris@198 376 return float(m_dParams.scale);
Chris@161 377 } else if (name == "freq1") {
Chris@188 378 return float(m_feParams.referenceFrequency);
Chris@161 379 } else if (name == "freq2") {
Chris@188 380 return float(m_secondReferenceFrequency);
Chris@177 381 } else if (name == "minfreq") {
Chris@188 382 return float(m_feParams.minFrequency);
Chris@177 383 } else if (name == "maxfreq") {
Chris@188 384 return float(m_feParams.maxFrequency);
cannam@0 385 }
Chris@18 386
cannam@0 387 return 0.0;
cannam@0 388 }
cannam@0 389
cannam@0 390 void
cannam@0 391 MatchVampPlugin::setParameter(std::string name, float value)
cannam@0 392 {
cannam@0 393 if (name == "serialise") {
cannam@0 394 m_serialise = (value > 0.5);
Chris@18 395 } else if (name == "framenorm") {
Chris@188 396 m_fcParams.norm = FeatureConditioner::Normalisation(int(value + 0.1));
Chris@18 397 } else if (name == "distnorm") {
Chris@188 398 m_dParams.norm = DistanceMetric::DistanceNormalisation(int(value + 0.1));
Chris@18 399 } else if (name == "usespecdiff") {
Chris@188 400 m_fcParams.order = FeatureConditioner::OutputOrder(int(value + 0.1));
Chris@18 401 } else if (name == "usechroma") {
Chris@38 402 m_feParams.useChromaFrequencyMap = (value > 0.5);
Chris@25 403 } else if (name == "gradientlimit") {
Chris@18 404 m_params.maxRunCount = int(value + 0.1);
Chris@83 405 } else if (name == "diagonalweight") {
Chris@83 406 m_params.diagonalWeight = value;
Chris@25 407 } else if (name == "zonewidth") {
Chris@25 408 m_params.blockTime = value;
Chris@32 409 } else if (name == "smooth") {
Chris@32 410 m_smooth = (value > 0.5);
Chris@136 411 } else if (name == "silencethreshold") {
Chris@136 412 m_fcParams.silenceThreshold = value;
Chris@156 413 } else if (name == "metric") {
Chris@188 414 m_dParams.metric = DistanceMetric::Metric(int(value + 0.1));
Chris@151 415 } else if (name == "noise") {
Chris@188 416 m_dParams.noise = DistanceMetric::NoiseAddition(int(value + 0.1));
Chris@198 417 } else if (name == "scale") {
Chris@198 418 m_dParams.scale = value;
Chris@161 419 } else if (name == "freq1") {
Chris@161 420 m_feParams.referenceFrequency = value;
Chris@161 421 } else if (name == "freq2") {
Chris@161 422 m_secondReferenceFrequency = value;
Chris@177 423 } else if (name == "minfreq") {
Chris@177 424 m_feParams.minFrequency = value;
Chris@177 425 } else if (name == "maxfreq") {
Chris@177 426 m_feParams.maxFrequency = value;
cannam@0 427 }
cannam@0 428 }
cannam@0 429
cannam@0 430 size_t
cannam@0 431 MatchVampPlugin::getPreferredStepSize() const
cannam@0 432 {
Chris@52 433 return int(m_inputSampleRate * defaultStepTime + 0.001);
cannam@0 434 }
cannam@0 435
cannam@0 436 size_t
cannam@0 437 MatchVampPlugin::getPreferredBlockSize() const
cannam@0 438 {
Chris@15 439 return 2048;
cannam@0 440 }
cannam@0 441
cannam@0 442 void
Chris@17 443 MatchVampPlugin::createMatchers()
cannam@0 444 {
Chris@17 445 m_params.hopTime = m_stepTime;
Chris@38 446 m_feParams.fftSize = m_blockSize;
Chris@107 447
Chris@161 448 m_pipeline = new MatchPipeline(m_feParams, m_fcParams, m_dParams, m_params,
Chris@161 449 m_secondReferenceFrequency);
cannam@0 450 }
cannam@0 451
cannam@0 452 bool
cannam@0 453 MatchVampPlugin::initialise(size_t channels, size_t stepSize, size_t blockSize)
cannam@0 454 {
Chris@10 455 if (m_inputSampleRate < sampleRateMin) {
Chris@10 456 std::cerr << "MatchVampPlugin::MatchVampPlugin: input sample rate "
Chris@10 457 << m_inputSampleRate << " < min supported rate "
Chris@10 458 << sampleRateMin << std::endl;
Chris@10 459 return false;
Chris@10 460 }
cannam@0 461 if (channels < getMinChannelCount() ||
cannam@0 462 channels > getMaxChannelCount()) return false;
cannam@1 463 if (stepSize > blockSize/2 ||
cannam@0 464 blockSize != getPreferredBlockSize()) return false;
Chris@15 465
Chris@188 466 m_stepSize = int(stepSize);
Chris@15 467 m_stepTime = float(stepSize) / m_inputSampleRate;
Chris@188 468 m_blockSize = int(blockSize);
Chris@15 469
Chris@15 470 createMatchers();
cannam@0 471 m_begin = true;
cannam@0 472 m_locked = false;
Chris@15 473
cannam@0 474 return true;
cannam@0 475 }
cannam@0 476
cannam@0 477 void
cannam@0 478 MatchVampPlugin::reset()
cannam@0 479 {
Chris@107 480 delete m_pipeline;
Chris@107 481 m_pipeline = 0;
Chris@74 482 m_frameNo = 0;
cannam@6 483 createMatchers();
cannam@6 484 m_begin = true;
cannam@6 485 m_locked = false;
cannam@0 486 }
cannam@0 487
cannam@0 488 MatchVampPlugin::OutputList
cannam@0 489 MatchVampPlugin::getOutputDescriptors() const
cannam@0 490 {
cannam@0 491 OutputList list;
cannam@0 492
Chris@52 493 float outRate = 1.0f / m_stepTime;
cannam@0 494
cannam@0 495 OutputDescriptor desc;
cannam@0 496 desc.identifier = "path";
cannam@0 497 desc.name = "Path";
cannam@0 498 desc.description = "Alignment path";
cannam@0 499 desc.unit = "";
cannam@0 500 desc.hasFixedBinCount = true;
cannam@0 501 desc.binCount = 1;
cannam@0 502 desc.hasKnownExtents = false;
cannam@0 503 desc.isQuantized = true;
cannam@0 504 desc.quantizeStep = 1;
cannam@0 505 desc.sampleType = OutputDescriptor::VariableSampleRate;
cannam@0 506 desc.sampleRate = outRate;
Chris@180 507 m_pathOutNo = int(list.size());
cannam@0 508 list.push_back(desc);
cannam@0 509
cannam@0 510 desc.identifier = "a_b";
cannam@0 511 desc.name = "A-B Timeline";
cannam@0 512 desc.description = "Timing in performance B corresponding to moments in performance A";
cannam@0 513 desc.unit = "sec";
cannam@0 514 desc.hasFixedBinCount = true;
cannam@0 515 desc.binCount = 1;
cannam@0 516 desc.hasKnownExtents = false;
cannam@0 517 desc.isQuantized = false;
cannam@0 518 desc.sampleType = OutputDescriptor::VariableSampleRate;
cannam@0 519 desc.sampleRate = outRate;
Chris@180 520 m_abOutNo = int(list.size());
cannam@0 521 list.push_back(desc);
cannam@0 522
cannam@0 523 desc.identifier = "b_a";
cannam@0 524 desc.name = "B-A Timeline";
cannam@0 525 desc.description = "Timing in performance A corresponding to moments in performance B";
cannam@0 526 desc.unit = "sec";
cannam@0 527 desc.hasFixedBinCount = true;
cannam@0 528 desc.binCount = 1;
cannam@0 529 desc.hasKnownExtents = false;
cannam@0 530 desc.isQuantized = false;
cannam@0 531 desc.sampleType = OutputDescriptor::VariableSampleRate;
cannam@0 532 desc.sampleRate = outRate;
Chris@180 533 m_baOutNo = int(list.size());
cannam@0 534 list.push_back(desc);
cannam@0 535
cannam@0 536 desc.identifier = "a_b_divergence";
cannam@0 537 desc.name = "A-B Divergence";
cannam@0 538 desc.description = "Difference between timings in performances A and B";
cannam@0 539 desc.unit = "sec";
cannam@0 540 desc.hasFixedBinCount = true;
cannam@0 541 desc.binCount = 1;
cannam@0 542 desc.hasKnownExtents = false;
cannam@0 543 desc.isQuantized = false;
cannam@0 544 desc.sampleType = OutputDescriptor::VariableSampleRate;
cannam@0 545 desc.sampleRate = outRate;
Chris@180 546 m_abDivOutNo = int(list.size());
cannam@0 547 list.push_back(desc);
cannam@0 548
cannam@0 549 desc.identifier = "a_b_temporatio";
cannam@0 550 desc.name = "A-B Tempo Ratio";
cannam@0 551 desc.description = "Ratio of tempi between performances A and B";
cannam@0 552 desc.unit = "";
cannam@0 553 desc.hasFixedBinCount = true;
cannam@0 554 desc.binCount = 1;
cannam@0 555 desc.hasKnownExtents = false;
cannam@0 556 desc.isQuantized = false;
cannam@0 557 desc.sampleType = OutputDescriptor::VariableSampleRate;
cannam@0 558 desc.sampleRate = outRate;
Chris@180 559 m_abRatioOutNo = int(list.size());
cannam@0 560 list.push_back(desc);
cannam@0 561
Chris@38 562 int featureSize = FeatureExtractor(m_feParams).getFeatureSize();
Chris@38 563
Chris@15 564 desc.identifier = "a_features";
Chris@140 565 desc.name = "Raw A Features";
Chris@15 566 desc.description = "Spectral features extracted from performance A";
Chris@15 567 desc.unit = "";
Chris@15 568 desc.hasFixedBinCount = true;
Chris@38 569 desc.binCount = featureSize;
Chris@15 570 desc.hasKnownExtents = false;
Chris@15 571 desc.isQuantized = false;
Chris@16 572 desc.sampleType = OutputDescriptor::FixedSampleRate;
Chris@15 573 desc.sampleRate = outRate;
Chris@180 574 m_aFeaturesOutNo = int(list.size());
Chris@16 575 list.push_back(desc);
Chris@16 576
Chris@16 577 desc.identifier = "b_features";
Chris@140 578 desc.name = "Raw B Features";
Chris@16 579 desc.description = "Spectral features extracted from performance B";
Chris@16 580 desc.unit = "";
Chris@16 581 desc.hasFixedBinCount = true;
Chris@38 582 desc.binCount = featureSize;
Chris@16 583 desc.hasKnownExtents = false;
Chris@16 584 desc.isQuantized = false;
Chris@16 585 desc.sampleType = OutputDescriptor::FixedSampleRate;
Chris@16 586 desc.sampleRate = outRate;
Chris@180 587 m_bFeaturesOutNo = int(list.size());
Chris@15 588 list.push_back(desc);
Chris@15 589
Chris@140 590 desc.identifier = "a_cfeatures";
Chris@140 591 desc.name = "Conditioned A Features";
Chris@140 592 desc.description = "Spectral features extracted from performance A, after normalisation and conditioning";
Chris@140 593 desc.unit = "";
Chris@140 594 desc.hasFixedBinCount = true;
Chris@140 595 desc.binCount = featureSize;
Chris@140 596 desc.hasKnownExtents = false;
Chris@140 597 desc.isQuantized = false;
Chris@140 598 desc.sampleType = OutputDescriptor::FixedSampleRate;
Chris@140 599 desc.sampleRate = outRate;
Chris@180 600 m_caFeaturesOutNo = int(list.size());
Chris@140 601 list.push_back(desc);
Chris@140 602
Chris@140 603 desc.identifier = "b_cfeatures";
Chris@140 604 desc.name = "Conditioned B Features";
Chris@140 605 desc.description = "Spectral features extracted from performance B, after norrmalisation and conditioning";
Chris@140 606 desc.unit = "";
Chris@140 607 desc.hasFixedBinCount = true;
Chris@140 608 desc.binCount = featureSize;
Chris@140 609 desc.hasKnownExtents = false;
Chris@140 610 desc.isQuantized = false;
Chris@140 611 desc.sampleType = OutputDescriptor::FixedSampleRate;
Chris@140 612 desc.sampleRate = outRate;
Chris@180 613 m_cbFeaturesOutNo = int(list.size());
Chris@140 614 list.push_back(desc);
Chris@140 615
Chris@163 616 desc.identifier = "overall_cost";
Chris@163 617 desc.name = "Overall Cost";
Chris@163 618 desc.description = "Normalised overall path cost for the cheapest path";
Chris@163 619 desc.unit = "";
Chris@163 620 desc.hasFixedBinCount = true;
Chris@163 621 desc.binCount = 1;
Chris@163 622 desc.hasKnownExtents = false;
Chris@163 623 desc.isQuantized = false;
Chris@163 624 desc.sampleType = OutputDescriptor::FixedSampleRate;
Chris@163 625 desc.sampleRate = 1;
Chris@180 626 m_overallCostOutNo = int(list.size());
Chris@163 627 list.push_back(desc);
Chris@163 628
cannam@0 629 return list;
cannam@0 630 }
cannam@0 631
cannam@0 632 MatchVampPlugin::FeatureSet
cannam@0 633 MatchVampPlugin::process(const float *const *inputBuffers,
cannam@0 634 Vamp::RealTime timestamp)
cannam@0 635 {
cannam@0 636 if (m_begin) {
cannam@0 637 if (!m_locked && m_serialise) {
cannam@0 638 m_locked = true;
cannam@0 639 #ifdef _WIN32
cannam@0 640 WaitForSingleObject(m_serialisingMutex, INFINITE);
cannam@0 641 #else
cannam@0 642 pthread_mutex_lock(&m_serialisingMutex);
cannam@0 643 #endif
cannam@0 644 }
Chris@10 645 m_startTime = timestamp;
cannam@0 646 m_begin = false;
cannam@0 647 }
cannam@0 648
cannam@0 649 // std::cerr << timestamp.toString();
cannam@0 650
Chris@107 651 m_pipeline->feedFrequencyDomainAudio(inputBuffers[0], inputBuffers[1]);
Chris@74 652
Chris@140 653 FeatureSet returnFeatures;
Chris@140 654
Chris@185 655 feature_t f1, f2;
Chris@140 656 m_pipeline->extractFeatures(f1, f2);
Chris@16 657
Chris@185 658 feature_t cf1, cf2;
Chris@140 659 m_pipeline->extractConditionedFeatures(cf1, cf2);
Chris@16 660
Chris@16 661 Feature f;
Chris@16 662 f.hasTimestamp = false;
Chris@16 663
Chris@74 664 f.values.clear();
Chris@188 665 for (auto v: f1) f.values.push_back(float(v));
Chris@74 666 returnFeatures[m_aFeaturesOutNo].push_back(f);
Chris@16 667
Chris@74 668 f.values.clear();
Chris@188 669 for (auto v: f2) f.values.push_back(float(v));
Chris@74 670 returnFeatures[m_bFeaturesOutNo].push_back(f);
cannam@0 671
Chris@140 672 f.values.clear();
Chris@188 673 for (auto v: cf1) f.values.push_back(float(v));
Chris@140 674 returnFeatures[m_caFeaturesOutNo].push_back(f);
Chris@140 675
Chris@140 676 f.values.clear();
Chris@188 677 for (auto v: cf2) f.values.push_back(float(v));
Chris@140 678 returnFeatures[m_cbFeaturesOutNo].push_back(f);
Chris@140 679
cannam@0 680 // std::cerr << ".";
cannam@0 681 // std::cerr << std::endl;
cannam@0 682
Chris@74 683 ++m_frameNo;
Chris@74 684
Chris@16 685 return returnFeatures;
cannam@0 686 }
cannam@0 687
cannam@0 688 MatchVampPlugin::FeatureSet
cannam@0 689 MatchVampPlugin::getRemainingFeatures()
cannam@0 690 {
Chris@107 691 m_pipeline->finish();
Chris@74 692
Chris@63 693 FeatureSet returnFeatures;
Chris@63 694
cannam@0 695 std::vector<int> pathx;
cannam@0 696 std::vector<int> pathy;
Chris@155 697 int len = m_pipeline->retrievePath(m_smooth, pathx, pathy);
cannam@0 698
Chris@173 699 double cost = m_pipeline->getOverallCost();
Chris@163 700 Feature costFeature;
Chris@163 701 costFeature.hasTimestamp = false;
Chris@188 702 costFeature.values.push_back(float(cost));
Chris@163 703 returnFeatures[m_overallCostOutNo].push_back(costFeature);
Chris@163 704
cannam@0 705 int prevx = 0;
cannam@0 706 int prevy = 0;
cannam@0 707
Chris@30 708 for (int i = 0; i < len; ++i) {
cannam@0 709
cannam@0 710 int x = pathx[i];
cannam@0 711 int y = pathy[i];
cannam@0 712
cannam@0 713 Vamp::RealTime xt = Vamp::RealTime::frame2RealTime
Chris@180 714 (x * m_stepSize, int(m_inputSampleRate + 0.5));
cannam@0 715 Vamp::RealTime yt = Vamp::RealTime::frame2RealTime
Chris@180 716 (y * m_stepSize, int(m_inputSampleRate + 0.5));
cannam@0 717
cannam@0 718 Feature feature;
cannam@0 719 feature.hasTimestamp = true;
Chris@10 720 feature.timestamp = m_startTime + xt;
cannam@0 721 feature.values.clear();
Chris@52 722 feature.values.push_back(float(yt.sec + double(yt.nsec)/1.0e9));
Chris@16 723 returnFeatures[m_pathOutNo].push_back(feature);
cannam@0 724
cannam@0 725 if (x != prevx) {
cannam@0 726
cannam@0 727 feature.hasTimestamp = true;
Chris@10 728 feature.timestamp = m_startTime + xt;
cannam@0 729 feature.values.clear();
Chris@52 730 feature.values.push_back(float(yt.sec + yt.msec()/1000.0));
Chris@16 731 returnFeatures[m_abOutNo].push_back(feature);
cannam@0 732
cannam@0 733 Vamp::RealTime diff = yt - xt;
cannam@0 734 feature.values.clear();
Chris@52 735 feature.values.push_back(float(diff.sec + diff.msec()/1000.0));
Chris@16 736 returnFeatures[m_abDivOutNo].push_back(feature);
cannam@0 737
cannam@0 738 if (i > 0) {
cannam@0 739 int lookback = 100; //!!! arbitrary
cannam@0 740 if (lookback > i) lookback = i;
cannam@0 741 int xdiff = x - pathx[i-lookback];
cannam@0 742 int ydiff = y - pathy[i-lookback];
cannam@0 743 if (xdiff != 0 && ydiff != 0) {
cannam@0 744 float ratio = float(ydiff)/float(xdiff);
cannam@0 745 if (ratio < 8 && ratio > (1.0/8)) { //!!! just for now, since we aren't dealing properly with silence yet
cannam@0 746 feature.values.clear();
cannam@0 747 feature.values.push_back(ratio);
Chris@16 748 returnFeatures[m_abRatioOutNo].push_back(feature);
cannam@0 749 }
cannam@0 750 }
cannam@0 751 }
cannam@0 752 }
cannam@0 753
cannam@0 754 if (y != prevy) {
cannam@0 755 feature.hasTimestamp = true;
Chris@10 756 feature.timestamp = m_startTime + yt;
cannam@0 757 feature.values.clear();
Chris@52 758 feature.values.push_back(float(xt.sec + xt.msec()/1000.0));
Chris@16 759 returnFeatures[m_baOutNo].push_back(feature);
cannam@0 760 }
cannam@0 761
cannam@0 762 prevx = x;
cannam@0 763 prevy = y;
cannam@0 764 }
cannam@0 765
Chris@107 766 delete m_pipeline;
Chris@107 767 m_pipeline = 0;
cannam@0 768
cannam@0 769 if (m_locked) {
cannam@0 770 #ifdef _WIN32
cannam@0 771 ReleaseMutex(m_serialisingMutex);
cannam@0 772 #else
cannam@0 773 pthread_mutex_unlock(&m_serialisingMutex);
cannam@0 774 #endif
cannam@0 775 m_locked = false;
cannam@0 776 }
cannam@0 777
cannam@0 778 return returnFeatures;
cannam@0 779
cannam@0 780
cannam@0 781 /*
Chris@30 782 for (int i = 0; i < len; ++i) {
cannam@0 783 std::cerr << i << ": [" << pathx[i] << "," << pathy[i] << "]" << std::endl;
cannam@0 784 }
cannam@0 785
cannam@0 786 std::cerr << std::endl;
cannam@0 787 std::cerr << "File: A" << std::endl;
cannam@0 788 std::cerr << "Marks: -1" << std::endl;
cannam@0 789 std::cerr << "FixedPoints: true 0" << std::endl;
cannam@0 790 std::cerr << "0" << std::endl;
cannam@0 791 std::cerr << "0" << std::endl;
cannam@0 792 std::cerr << "0" << std::endl;
cannam@0 793 std::cerr << "0" << std::endl;
cannam@0 794 std::cerr << "File: B" << std::endl;
cannam@0 795 std::cerr << "Marks: 0" << std::endl;
cannam@0 796 std::cerr << "FixedPoints: true 0" << std::endl;
cannam@0 797 std::cerr << "0.02" << std::endl;
cannam@0 798 std::cerr << "0.02" << std::endl;
cannam@0 799
Chris@30 800 std::cerr << len << std::endl;
Chris@30 801 for (int i = 0; i < len; ++i) {
cannam@0 802 std::cerr << pathx[i] << std::endl;
cannam@0 803 }
cannam@0 804
Chris@30 805 std::cerr << len << std::endl;
Chris@30 806 for (int i = 0; i < len; ++i) {
cannam@0 807 std::cerr << pathy[i] << std::endl;
cannam@0 808 }
cannam@0 809 */
cannam@0 810 }
cannam@0 811
cannam@0 812 static Vamp::PluginAdapter<MatchVampPlugin> mvpAdapter;
cannam@0 813
cannam@0 814 const VampPluginDescriptor *vampGetPluginDescriptor(unsigned int version,
cannam@0 815 unsigned int index)
cannam@0 816 {
cannam@0 817 if (version < 1) return 0;
cannam@0 818
cannam@0 819 switch (index) {
cannam@0 820 case 0: return mvpAdapter.getDescriptor();
cannam@0 821 default: return 0;
cannam@0 822 }
cannam@0 823 }