annotate transform/FeatureExtractionModelTransformer.cpp @ 889:7f97a4d9d14f

Use fixed-rate feature no directly as column number, rather than do a calculation that might introduce rounding error
author Chris Cannam
date Tue, 11 Mar 2014 17:29:44 +0000
parents 786ee8d1f30e
children 8962f80f5d8e
rev   line source
Chris@320 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@320 2
Chris@320 3 /*
Chris@320 4 Sonic Visualiser
Chris@320 5 An audio file viewer and annotation editor.
Chris@320 6 Centre for Digital Music, Queen Mary, University of London.
Chris@320 7 This file copyright 2006 Chris Cannam and QMUL.
Chris@320 8
Chris@320 9 This program is free software; you can redistribute it and/or
Chris@320 10 modify it under the terms of the GNU General Public License as
Chris@320 11 published by the Free Software Foundation; either version 2 of the
Chris@320 12 License, or (at your option) any later version. See the file
Chris@320 13 COPYING included with this distribution for more information.
Chris@320 14 */
Chris@320 15
Chris@331 16 #include "FeatureExtractionModelTransformer.h"
Chris@320 17
Chris@320 18 #include "plugin/FeatureExtractionPluginFactory.h"
Chris@320 19 #include "plugin/PluginXml.h"
Chris@475 20 #include <vamp-hostsdk/Plugin.h>
Chris@320 21
Chris@320 22 #include "data/model/Model.h"
Chris@320 23 #include "base/Window.h"
Chris@387 24 #include "base/Exceptions.h"
Chris@320 25 #include "data/model/SparseOneDimensionalModel.h"
Chris@320 26 #include "data/model/SparseTimeValueModel.h"
Chris@320 27 #include "data/model/EditableDenseThreeDimensionalModel.h"
Chris@320 28 #include "data/model/DenseTimeValueModel.h"
Chris@320 29 #include "data/model/NoteModel.h"
Chris@441 30 #include "data/model/RegionModel.h"
Chris@320 31 #include "data/model/FFTModel.h"
Chris@320 32 #include "data/model/WaveFileModel.h"
Chris@558 33 #include "rdf/PluginRDFDescription.h"
Chris@320 34
Chris@350 35 #include "TransformFactory.h"
Chris@350 36
Chris@320 37 #include <iostream>
Chris@320 38
Chris@350 39 FeatureExtractionModelTransformer::FeatureExtractionModelTransformer(Input in,
Chris@350 40 const Transform &transform) :
Chris@350 41 ModelTransformer(in, transform),
Chris@320 42 m_plugin(0),
Chris@320 43 m_descriptor(0),
Chris@779 44 m_outputNo(0),
Chris@779 45 m_fixedRateFeatureNo(-1) // we increment before use
Chris@320 46 {
Chris@690 47 // SVDEBUG << "FeatureExtractionModelTransformer::FeatureExtractionModelTransformer: plugin " << pluginId << ", outputName " << m_transform.getOutput() << endl;
Chris@350 48
Chris@350 49 QString pluginId = transform.getPluginIdentifier();
Chris@320 50
Chris@320 51 FeatureExtractionPluginFactory *factory =
Chris@320 52 FeatureExtractionPluginFactory::instanceFor(pluginId);
Chris@320 53
Chris@320 54 if (!factory) {
Chris@361 55 m_message = tr("No factory available for feature extraction plugin id \"%1\" (unknown plugin type, or internal error?)").arg(pluginId);
Chris@320 56 return;
Chris@320 57 }
Chris@320 58
Chris@350 59 DenseTimeValueModel *input = getConformingInput();
Chris@350 60 if (!input) {
Chris@361 61 m_message = tr("Input model for feature extraction plugin \"%1\" is of wrong type (internal error?)").arg(pluginId);
Chris@350 62 return;
Chris@350 63 }
Chris@320 64
Chris@350 65 m_plugin = factory->instantiatePlugin(pluginId, input->getSampleRate());
Chris@320 66 if (!m_plugin) {
Chris@361 67 m_message = tr("Failed to instantiate plugin \"%1\"").arg(pluginId);
Chris@320 68 return;
Chris@320 69 }
Chris@320 70
Chris@350 71 TransformFactory::getInstance()->makeContextConsistentWithPlugin
Chris@350 72 (m_transform, m_plugin);
Chris@343 73
Chris@350 74 TransformFactory::getInstance()->setPluginParameters
Chris@350 75 (m_transform, m_plugin);
Chris@320 76
Chris@320 77 size_t channelCount = input->getChannelCount();
Chris@320 78 if (m_plugin->getMaxChannelCount() < channelCount) {
Chris@320 79 channelCount = 1;
Chris@320 80 }
Chris@320 81 if (m_plugin->getMinChannelCount() > channelCount) {
Chris@361 82 m_message = tr("Cannot provide enough channels to feature extraction plugin \"%1\" (plugin min is %2, max %3; input model has %4)")
Chris@361 83 .arg(pluginId)
Chris@361 84 .arg(m_plugin->getMinChannelCount())
Chris@361 85 .arg(m_plugin->getMaxChannelCount())
Chris@361 86 .arg(input->getChannelCount());
Chris@320 87 return;
Chris@320 88 }
Chris@320 89
Chris@690 90 SVDEBUG << "Initialising feature extraction plugin with channels = "
Chris@350 91 << channelCount << ", step = " << m_transform.getStepSize()
Chris@687 92 << ", block = " << m_transform.getBlockSize() << endl;
Chris@320 93
Chris@320 94 if (!m_plugin->initialise(channelCount,
Chris@350 95 m_transform.getStepSize(),
Chris@350 96 m_transform.getBlockSize())) {
Chris@361 97
Chris@361 98 size_t pstep = m_transform.getStepSize();
Chris@361 99 size_t pblock = m_transform.getBlockSize();
Chris@361 100
Chris@361 101 m_transform.setStepSize(0);
Chris@361 102 m_transform.setBlockSize(0);
Chris@361 103 TransformFactory::getInstance()->makeContextConsistentWithPlugin
Chris@361 104 (m_transform, m_plugin);
Chris@361 105
Chris@361 106 if (m_transform.getStepSize() != pstep ||
Chris@361 107 m_transform.getBlockSize() != pblock) {
Chris@361 108
Chris@361 109 if (!m_plugin->initialise(channelCount,
Chris@361 110 m_transform.getStepSize(),
Chris@361 111 m_transform.getBlockSize())) {
Chris@361 112
Chris@361 113 m_message = tr("Failed to initialise feature extraction plugin \"%1\"").arg(pluginId);
Chris@361 114 return;
Chris@361 115
Chris@361 116 } else {
Chris@361 117
Chris@361 118 m_message = tr("Feature extraction plugin \"%1\" rejected the given step and block sizes (%2 and %3); using plugin defaults (%4 and %5) instead")
Chris@361 119 .arg(pluginId)
Chris@361 120 .arg(pstep)
Chris@361 121 .arg(pblock)
Chris@361 122 .arg(m_transform.getStepSize())
Chris@361 123 .arg(m_transform.getBlockSize());
Chris@361 124 }
Chris@361 125
Chris@361 126 } else {
Chris@361 127
Chris@361 128 m_message = tr("Failed to initialise feature extraction plugin \"%1\"").arg(pluginId);
Chris@361 129 return;
Chris@361 130 }
Chris@320 131 }
Chris@320 132
Chris@366 133 if (m_transform.getPluginVersion() != "") {
Chris@366 134 QString pv = QString("%1").arg(m_plugin->getPluginVersion());
Chris@366 135 if (pv != m_transform.getPluginVersion()) {
Chris@366 136 QString vm = tr("Transform was configured for version %1 of plugin \"%2\", but the plugin being used is version %3")
Chris@366 137 .arg(m_transform.getPluginVersion())
Chris@366 138 .arg(pluginId)
Chris@366 139 .arg(pv);
Chris@366 140 if (m_message != "") {
Chris@366 141 m_message = QString("%1; %2").arg(vm).arg(m_message);
Chris@366 142 } else {
Chris@366 143 m_message = vm;
Chris@366 144 }
Chris@366 145 }
Chris@366 146 }
Chris@366 147
Chris@320 148 Vamp::Plugin::OutputList outputs = m_plugin->getOutputDescriptors();
Chris@320 149
Chris@320 150 if (outputs.empty()) {
Chris@361 151 m_message = tr("Plugin \"%1\" has no outputs").arg(pluginId);
Chris@320 152 return;
Chris@320 153 }
Chris@320 154
Chris@320 155 for (size_t i = 0; i < outputs.size(); ++i) {
Chris@690 156 // SVDEBUG << "comparing output " << i << " name \"" << outputs[i].identifier << "\" with expected \"" << m_transform.getOutput() << "\"" << endl;
Chris@350 157 if (m_transform.getOutput() == "" ||
Chris@350 158 outputs[i].identifier == m_transform.getOutput().toStdString()) {
Chris@778 159 m_outputNo = i;
Chris@441 160 m_descriptor = new Vamp::Plugin::OutputDescriptor(outputs[i]);
Chris@320 161 break;
Chris@320 162 }
Chris@320 163 }
Chris@320 164
Chris@320 165 if (!m_descriptor) {
Chris@361 166 m_message = tr("Plugin \"%1\" has no output named \"%2\"")
Chris@361 167 .arg(pluginId)
Chris@361 168 .arg(m_transform.getOutput());
Chris@320 169 return;
Chris@320 170 }
Chris@320 171
Chris@558 172 createOutputModel();
Chris@558 173 }
Chris@558 174
Chris@558 175 void
Chris@558 176 FeatureExtractionModelTransformer::createOutputModel()
Chris@558 177 {
Chris@558 178 DenseTimeValueModel *input = getConformingInput();
Chris@558 179
Chris@843 180 // cerr << "FeatureExtractionModelTransformer::createOutputModel: sample type " << m_descriptor->sampleType << ", rate " << m_descriptor->sampleRate << endl;
Chris@712 181
Chris@558 182 PluginRDFDescription description(m_transform.getPluginIdentifier());
Chris@558 183 QString outputId = m_transform.getOutput();
Chris@558 184
Chris@320 185 int binCount = 1;
Chris@320 186 float minValue = 0.0, maxValue = 0.0;
Chris@320 187 bool haveExtents = false;
Chris@320 188
Chris@320 189 if (m_descriptor->hasFixedBinCount) {
Chris@320 190 binCount = m_descriptor->binCount;
Chris@320 191 }
Chris@320 192
Chris@843 193 // cerr << "FeatureExtractionModelTransformer: output bin count "
Chris@843 194 // << binCount << endl;
Chris@320 195
Chris@320 196 if (binCount > 0 && m_descriptor->hasKnownExtents) {
Chris@320 197 minValue = m_descriptor->minValue;
Chris@320 198 maxValue = m_descriptor->maxValue;
Chris@320 199 haveExtents = true;
Chris@320 200 }
Chris@320 201
Chris@350 202 size_t modelRate = input->getSampleRate();
Chris@320 203 size_t modelResolution = 1;
Chris@712 204
Chris@785 205 if (m_descriptor->sampleType !=
Chris@785 206 Vamp::Plugin::OutputDescriptor::OneSamplePerStep) {
Chris@785 207 if (m_descriptor->sampleRate > input->getSampleRate()) {
Chris@843 208 cerr << "WARNING: plugin reports output sample rate as "
Chris@843 209 << m_descriptor->sampleRate << " (can't display features with finer resolution than the input rate of " << input->getSampleRate() << ")" << endl;
Chris@785 210 }
Chris@785 211 }
Chris@785 212
Chris@320 213 switch (m_descriptor->sampleType) {
Chris@320 214
Chris@320 215 case Vamp::Plugin::OutputDescriptor::VariableSampleRate:
Chris@320 216 if (m_descriptor->sampleRate != 0.0) {
Chris@320 217 modelResolution = size_t(modelRate / m_descriptor->sampleRate + 0.001);
Chris@320 218 }
Chris@320 219 break;
Chris@320 220
Chris@320 221 case Vamp::Plugin::OutputDescriptor::OneSamplePerStep:
Chris@350 222 modelResolution = m_transform.getStepSize();
Chris@320 223 break;
Chris@320 224
Chris@320 225 case Vamp::Plugin::OutputDescriptor::FixedSampleRate:
Chris@451 226 //!!! SV doesn't actually support display of models that have
Chris@451 227 //!!! different underlying rates together -- so we always set
Chris@451 228 //!!! the model rate to be the input model's rate, and adjust
Chris@451 229 //!!! the resolution appropriately. We can't properly display
Chris@451 230 //!!! data with a higher resolution than the base model at all
Chris@451 231 if (m_descriptor->sampleRate > input->getSampleRate()) {
Chris@451 232 modelResolution = 1;
Chris@451 233 } else {
Chris@889 234 modelResolution = size_t(round(input->getSampleRate() /
Chris@889 235 m_descriptor->sampleRate));
Chris@451 236 }
Chris@320 237 break;
Chris@320 238 }
Chris@320 239
Chris@441 240 bool preDurationPlugin = (m_plugin->getVampApiVersion() < 2);
Chris@441 241
Chris@441 242 if (binCount == 0 &&
Chris@441 243 (preDurationPlugin || !m_descriptor->hasDuration)) {
Chris@320 244
Chris@445 245 // Anything with no value and no duration is an instant
Chris@445 246
Chris@320 247 m_output = new SparseOneDimensionalModel(modelRate, modelResolution,
Chris@320 248 false);
Chris@320 249
Chris@558 250 QString outputEventTypeURI = description.getOutputEventTypeURI(outputId);
Chris@558 251 m_output->setRDFTypeURI(outputEventTypeURI);
Chris@558 252
Chris@441 253 } else if ((preDurationPlugin && binCount > 1 &&
Chris@441 254 (m_descriptor->sampleType ==
Chris@441 255 Vamp::Plugin::OutputDescriptor::VariableSampleRate)) ||
Chris@441 256 (!preDurationPlugin && m_descriptor->hasDuration)) {
Chris@441 257
Chris@441 258 // For plugins using the old v1 API without explicit duration,
Chris@441 259 // we treat anything that has multiple bins (i.e. that has the
Chris@441 260 // potential to have value and duration) and a variable sample
Chris@441 261 // rate as a note model, taking its values as pitch, duration
Chris@441 262 // and velocity (if present) respectively. This is the same
Chris@441 263 // behaviour as always applied by SV to these plugins in the
Chris@441 264 // past.
Chris@441 265
Chris@441 266 // For plugins with the newer API, we treat anything with
Chris@441 267 // duration as either a note model with pitch and velocity, or
Chris@441 268 // a region model.
Chris@441 269
Chris@441 270 // How do we know whether it's an interval or note model?
Chris@441 271 // What's the essential difference? Is a note model any
Chris@441 272 // interval model using a Hz or "MIDI pitch" scale? There
Chris@441 273 // isn't really a reliable test for "MIDI pitch"... Does a
Chris@441 274 // note model always have velocity? This is a good question
Chris@441 275 // to be addressed by accompanying RDF, but for the moment we
Chris@441 276 // will do the following...
Chris@441 277
Chris@441 278 bool isNoteModel = false;
Chris@441 279
Chris@441 280 // Regions have only value (and duration -- we can't extract a
Chris@441 281 // region model from an old-style plugin that doesn't support
Chris@441 282 // duration)
Chris@441 283 if (binCount > 1) isNoteModel = true;
Chris@441 284
Chris@595 285 // Regions do not have units of Hz or MIDI things (a sweeping
Chris@595 286 // assumption!)
Chris@595 287 if (m_descriptor->unit == "Hz" ||
Chris@595 288 m_descriptor->unit.find("MIDI") != std::string::npos ||
Chris@595 289 m_descriptor->unit.find("midi") != std::string::npos) {
Chris@595 290 isNoteModel = true;
Chris@595 291 }
Chris@441 292
Chris@441 293 // If we had a "sparse 3D model", we would have the additional
Chris@441 294 // problem of determining whether to use that here (if bin
Chris@441 295 // count > 1). But we don't.
Chris@441 296
Chris@441 297 if (isNoteModel) {
Chris@441 298
Chris@441 299 NoteModel *model;
Chris@441 300 if (haveExtents) {
Chris@441 301 model = new NoteModel
Chris@441 302 (modelRate, modelResolution, minValue, maxValue, false);
Chris@441 303 } else {
Chris@441 304 model = new NoteModel
Chris@441 305 (modelRate, modelResolution, false);
Chris@441 306 }
Chris@441 307 model->setScaleUnits(m_descriptor->unit.c_str());
Chris@441 308 m_output = model;
Chris@441 309
Chris@441 310 } else {
Chris@441 311
Chris@441 312 RegionModel *model;
Chris@441 313 if (haveExtents) {
Chris@441 314 model = new RegionModel
Chris@441 315 (modelRate, modelResolution, minValue, maxValue, false);
Chris@441 316 } else {
Chris@441 317 model = new RegionModel
Chris@441 318 (modelRate, modelResolution, false);
Chris@441 319 }
Chris@441 320 model->setScaleUnits(m_descriptor->unit.c_str());
Chris@441 321 m_output = model;
Chris@441 322 }
Chris@441 323
Chris@558 324 QString outputEventTypeURI = description.getOutputEventTypeURI(outputId);
Chris@558 325 m_output->setRDFTypeURI(outputEventTypeURI);
Chris@558 326
Chris@441 327 } else if (binCount == 1 ||
Chris@441 328 (m_descriptor->sampleType ==
Chris@441 329 Vamp::Plugin::OutputDescriptor::VariableSampleRate)) {
Chris@441 330
Chris@441 331 // Anything that is not a 1D, note, or interval model and that
Chris@441 332 // has only one value per result must be a sparse time value
Chris@441 333 // model.
Chris@441 334
Chris@441 335 // Anything that is not a 1D, note, or interval model and that
Chris@441 336 // has a variable sample rate is also treated as a sparse time
Chris@441 337 // value model regardless of its bin count, because we lack a
Chris@441 338 // sparse 3D model.
Chris@320 339
Chris@320 340 SparseTimeValueModel *model;
Chris@320 341 if (haveExtents) {
Chris@320 342 model = new SparseTimeValueModel
Chris@320 343 (modelRate, modelResolution, minValue, maxValue, false);
Chris@320 344 } else {
Chris@320 345 model = new SparseTimeValueModel
Chris@320 346 (modelRate, modelResolution, false);
Chris@320 347 }
Chris@558 348
Chris@558 349 Vamp::Plugin::OutputList outputs = m_plugin->getOutputDescriptors();
Chris@778 350 model->setScaleUnits(outputs[m_outputNo].unit.c_str());
Chris@320 351
Chris@320 352 m_output = model;
Chris@320 353
Chris@558 354 QString outputEventTypeURI = description.getOutputEventTypeURI(outputId);
Chris@558 355 m_output->setRDFTypeURI(outputEventTypeURI);
Chris@558 356
Chris@441 357 } else {
Chris@320 358
Chris@441 359 // Anything that is not a 1D, note, or interval model and that
Chris@441 360 // has a fixed sample rate and more than one value per result
Chris@441 361 // must be a dense 3D model.
Chris@320 362
Chris@320 363 EditableDenseThreeDimensionalModel *model =
Chris@320 364 new EditableDenseThreeDimensionalModel
Chris@535 365 (modelRate, modelResolution, binCount,
Chris@535 366 EditableDenseThreeDimensionalModel::BasicMultirateCompression,
Chris@535 367 false);
Chris@320 368
Chris@320 369 if (!m_descriptor->binNames.empty()) {
Chris@320 370 std::vector<QString> names;
Chris@320 371 for (size_t i = 0; i < m_descriptor->binNames.size(); ++i) {
Chris@320 372 names.push_back(m_descriptor->binNames[i].c_str());
Chris@320 373 }
Chris@320 374 model->setBinNames(names);
Chris@320 375 }
Chris@320 376
Chris@320 377 m_output = model;
Chris@558 378
Chris@558 379 QString outputSignalTypeURI = description.getOutputSignalTypeURI(outputId);
Chris@558 380 m_output->setRDFTypeURI(outputSignalTypeURI);
Chris@320 381 }
Chris@333 382
Chris@350 383 if (m_output) m_output->setSourceModel(input);
Chris@320 384 }
Chris@320 385
Chris@331 386 FeatureExtractionModelTransformer::~FeatureExtractionModelTransformer()
Chris@320 387 {
Chris@690 388 // SVDEBUG << "FeatureExtractionModelTransformer::~FeatureExtractionModelTransformer()" << endl;
Chris@320 389 delete m_plugin;
Chris@320 390 delete m_descriptor;
Chris@320 391 }
Chris@320 392
Chris@320 393 DenseTimeValueModel *
Chris@350 394 FeatureExtractionModelTransformer::getConformingInput()
Chris@320 395 {
Chris@690 396 // SVDEBUG << "FeatureExtractionModelTransformer::getConformingInput: input model is " << getInputModel() << endl;
Chris@408 397
Chris@320 398 DenseTimeValueModel *dtvm =
Chris@320 399 dynamic_cast<DenseTimeValueModel *>(getInputModel());
Chris@320 400 if (!dtvm) {
Chris@690 401 SVDEBUG << "FeatureExtractionModelTransformer::getConformingInput: WARNING: Input model is not conformable to DenseTimeValueModel" << endl;
Chris@320 402 }
Chris@320 403 return dtvm;
Chris@320 404 }
Chris@320 405
Chris@320 406 void
Chris@331 407 FeatureExtractionModelTransformer::run()
Chris@320 408 {
Chris@350 409 DenseTimeValueModel *input = getConformingInput();
Chris@320 410 if (!input) return;
Chris@320 411
Chris@320 412 if (!m_output) return;
Chris@320 413
Chris@497 414 while (!input->isReady() && !m_abandoned) {
Chris@690 415 SVDEBUG << "FeatureExtractionModelTransformer::run: Waiting for input model to be ready..." << endl;
Chris@497 416 usleep(500000);
Chris@320 417 }
Chris@497 418 if (m_abandoned) return;
Chris@320 419
Chris@350 420 size_t sampleRate = input->getSampleRate();
Chris@320 421
Chris@320 422 size_t channelCount = input->getChannelCount();
Chris@320 423 if (m_plugin->getMaxChannelCount() < channelCount) {
Chris@320 424 channelCount = 1;
Chris@320 425 }
Chris@320 426
Chris@320 427 float **buffers = new float*[channelCount];
Chris@320 428 for (size_t ch = 0; ch < channelCount; ++ch) {
Chris@350 429 buffers[ch] = new float[m_transform.getBlockSize() + 2];
Chris@320 430 }
Chris@320 431
Chris@350 432 size_t stepSize = m_transform.getStepSize();
Chris@350 433 size_t blockSize = m_transform.getBlockSize();
Chris@350 434
Chris@320 435 bool frequencyDomain = (m_plugin->getInputDomain() ==
Chris@320 436 Vamp::Plugin::FrequencyDomain);
Chris@320 437 std::vector<FFTModel *> fftModels;
Chris@320 438
Chris@320 439 if (frequencyDomain) {
Chris@320 440 for (size_t ch = 0; ch < channelCount; ++ch) {
Chris@320 441 FFTModel *model = new FFTModel
Chris@350 442 (getConformingInput(),
Chris@350 443 channelCount == 1 ? m_input.getChannel() : ch,
Chris@350 444 m_transform.getWindowType(),
Chris@350 445 blockSize,
Chris@350 446 stepSize,
Chris@350 447 blockSize,
Chris@334 448 false,
Chris@334 449 StorageAdviser::PrecisionCritical);
Chris@320 450 if (!model->isOK()) {
Chris@320 451 delete model;
Chris@320 452 setCompletion(100);
Chris@387 453 //!!! need a better way to handle this -- previously we were using a QMessageBox but that isn't an appropriate thing to do here either
Chris@387 454 throw AllocationFailed("Failed to create the FFT model for this feature extraction model transformer");
Chris@320 455 }
Chris@320 456 model->resume();
Chris@320 457 fftModels.push_back(model);
Chris@320 458 }
Chris@320 459 }
Chris@320 460
Chris@350 461 long startFrame = m_input.getModel()->getStartFrame();
Chris@350 462 long endFrame = m_input.getModel()->getEndFrame();
Chris@320 463
Chris@350 464 RealTime contextStartRT = m_transform.getStartTime();
Chris@350 465 RealTime contextDurationRT = m_transform.getDuration();
Chris@350 466
Chris@350 467 long contextStart =
Chris@350 468 RealTime::realTime2Frame(contextStartRT, sampleRate);
Chris@350 469
Chris@350 470 long contextDuration =
Chris@350 471 RealTime::realTime2Frame(contextDurationRT, sampleRate);
Chris@320 472
Chris@320 473 if (contextStart == 0 || contextStart < startFrame) {
Chris@320 474 contextStart = startFrame;
Chris@320 475 }
Chris@320 476
Chris@320 477 if (contextDuration == 0) {
Chris@320 478 contextDuration = endFrame - contextStart;
Chris@320 479 }
Chris@320 480 if (contextStart + contextDuration > endFrame) {
Chris@320 481 contextDuration = endFrame - contextStart;
Chris@320 482 }
Chris@320 483
Chris@320 484 long blockFrame = contextStart;
Chris@320 485
Chris@320 486 long prevCompletion = 0;
Chris@320 487
Chris@320 488 setCompletion(0);
Chris@320 489
Chris@556 490 float *reals = 0;
Chris@556 491 float *imaginaries = 0;
Chris@556 492 if (frequencyDomain) {
Chris@556 493 reals = new float[blockSize/2 + 1];
Chris@556 494 imaginaries = new float[blockSize/2 + 1];
Chris@556 495 }
Chris@556 496
Chris@678 497 QString error = "";
Chris@678 498
Chris@320 499 while (!m_abandoned) {
Chris@320 500
Chris@320 501 if (frequencyDomain) {
Chris@350 502 if (blockFrame - int(blockSize)/2 >
Chris@320 503 contextStart + contextDuration) break;
Chris@320 504 } else {
Chris@320 505 if (blockFrame >=
Chris@320 506 contextStart + contextDuration) break;
Chris@320 507 }
Chris@320 508
Chris@690 509 // SVDEBUG << "FeatureExtractionModelTransformer::run: blockFrame "
Chris@320 510 // << blockFrame << ", endFrame " << endFrame << ", blockSize "
Chris@687 511 // << blockSize << endl;
Chris@320 512
Chris@320 513 long completion =
Chris@350 514 (((blockFrame - contextStart) / stepSize) * 99) /
Chris@557 515 (contextDuration / stepSize + 1);
Chris@320 516
Chris@350 517 // channelCount is either m_input.getModel()->channelCount or 1
Chris@320 518
Chris@363 519 if (frequencyDomain) {
Chris@363 520 for (size_t ch = 0; ch < channelCount; ++ch) {
Chris@350 521 int column = (blockFrame - startFrame) / stepSize;
Chris@556 522 fftModels[ch]->getValuesAt(column, reals, imaginaries);
Chris@350 523 for (size_t i = 0; i <= blockSize/2; ++i) {
Chris@556 524 buffers[ch][i*2] = reals[i];
Chris@556 525 buffers[ch][i*2+1] = imaginaries[i];
Chris@320 526 }
Chris@678 527 error = fftModels[ch]->getError();
Chris@678 528 if (error != "") {
Chris@843 529 cerr << "FeatureExtractionModelTransformer::run: Abandoning, error is " << error << endl;
Chris@678 530 m_abandoned = true;
Chris@678 531 m_message = error;
Chris@678 532 }
Chris@363 533 }
Chris@363 534 } else {
Chris@363 535 getFrames(channelCount, blockFrame, blockSize, buffers);
Chris@320 536 }
Chris@320 537
Chris@497 538 if (m_abandoned) break;
Chris@497 539
Chris@320 540 Vamp::Plugin::FeatureSet features = m_plugin->process
Chris@320 541 (buffers, Vamp::RealTime::frame2RealTime(blockFrame, sampleRate));
Chris@320 542
Chris@497 543 if (m_abandoned) break;
Chris@497 544
Chris@778 545 for (size_t fi = 0; fi < features[m_outputNo].size(); ++fi) {
Chris@778 546 Vamp::Plugin::Feature feature = features[m_outputNo][fi];
Chris@320 547 addFeature(blockFrame, feature);
Chris@320 548 }
Chris@320 549
Chris@320 550 if (blockFrame == contextStart || completion > prevCompletion) {
Chris@320 551 setCompletion(completion);
Chris@320 552 prevCompletion = completion;
Chris@320 553 }
Chris@320 554
Chris@350 555 blockFrame += stepSize;
Chris@320 556 }
Chris@320 557
Chris@497 558 if (!m_abandoned) {
Chris@497 559 Vamp::Plugin::FeatureSet features = m_plugin->getRemainingFeatures();
Chris@320 560
Chris@778 561 for (size_t fi = 0; fi < features[m_outputNo].size(); ++fi) {
Chris@778 562 Vamp::Plugin::Feature feature = features[m_outputNo][fi];
Chris@497 563 addFeature(blockFrame, feature);
Chris@497 564 }
Chris@497 565 }
Chris@320 566
Chris@497 567 setCompletion(100);
Chris@320 568
Chris@320 569 if (frequencyDomain) {
Chris@320 570 for (size_t ch = 0; ch < channelCount; ++ch) {
Chris@320 571 delete fftModels[ch];
Chris@320 572 }
Chris@556 573 delete[] reals;
Chris@556 574 delete[] imaginaries;
Chris@320 575 }
Chris@320 576 }
Chris@320 577
Chris@320 578 void
Chris@363 579 FeatureExtractionModelTransformer::getFrames(int channelCount,
Chris@363 580 long startFrame, long size,
Chris@363 581 float **buffers)
Chris@320 582 {
Chris@320 583 long offset = 0;
Chris@320 584
Chris@320 585 if (startFrame < 0) {
Chris@363 586 for (int c = 0; c < channelCount; ++c) {
Chris@363 587 for (int i = 0; i < size && startFrame + i < 0; ++i) {
Chris@363 588 buffers[c][i] = 0.0f;
Chris@363 589 }
Chris@320 590 }
Chris@320 591 offset = -startFrame;
Chris@320 592 size -= offset;
Chris@320 593 if (size <= 0) return;
Chris@320 594 startFrame = 0;
Chris@320 595 }
Chris@320 596
Chris@350 597 DenseTimeValueModel *input = getConformingInput();
Chris@350 598 if (!input) return;
Chris@363 599
Chris@363 600 long got = 0;
Chris@350 601
Chris@363 602 if (channelCount == 1) {
Chris@363 603
Chris@363 604 got = input->getData(m_input.getChannel(), startFrame, size,
Chris@363 605 buffers[0] + offset);
Chris@363 606
Chris@363 607 if (m_input.getChannel() == -1 && input->getChannelCount() > 1) {
Chris@363 608 // use mean instead of sum, as plugin input
Chris@363 609 float cc = float(input->getChannelCount());
Chris@363 610 for (long i = 0; i < size; ++i) {
Chris@363 611 buffers[0][i + offset] /= cc;
Chris@363 612 }
Chris@363 613 }
Chris@363 614
Chris@363 615 } else {
Chris@363 616
Chris@363 617 float **writebuf = buffers;
Chris@363 618 if (offset > 0) {
Chris@363 619 writebuf = new float *[channelCount];
Chris@363 620 for (int i = 0; i < channelCount; ++i) {
Chris@363 621 writebuf[i] = buffers[i] + offset;
Chris@363 622 }
Chris@363 623 }
Chris@363 624
Chris@363 625 got = input->getData(0, channelCount-1, startFrame, size, writebuf);
Chris@363 626
Chris@363 627 if (writebuf != buffers) delete[] writebuf;
Chris@363 628 }
Chris@320 629
Chris@320 630 while (got < size) {
Chris@363 631 for (int c = 0; c < channelCount; ++c) {
Chris@363 632 buffers[c][got + offset] = 0.0;
Chris@363 633 }
Chris@320 634 ++got;
Chris@320 635 }
Chris@320 636 }
Chris@320 637
Chris@320 638 void
Chris@331 639 FeatureExtractionModelTransformer::addFeature(size_t blockFrame,
Chris@862 640 const Vamp::Plugin::Feature &feature)
Chris@320 641 {
Chris@350 642 size_t inputRate = m_input.getModel()->getSampleRate();
Chris@320 643
Chris@843 644 // cerr << "FeatureExtractionModelTransformer::addFeature: blockFrame = "
Chris@712 645 // << blockFrame << ", hasTimestamp = " << feature.hasTimestamp
Chris@712 646 // << ", timestamp = " << feature.timestamp << ", hasDuration = "
Chris@712 647 // << feature.hasDuration << ", duration = " << feature.duration
Chris@843 648 // << endl;
Chris@320 649
Chris@320 650 int binCount = 1;
Chris@320 651 if (m_descriptor->hasFixedBinCount) {
Chris@320 652 binCount = m_descriptor->binCount;
Chris@320 653 }
Chris@320 654
Chris@862 655 int frame = blockFrame;
Chris@320 656
Chris@320 657 if (m_descriptor->sampleType ==
Chris@320 658 Vamp::Plugin::OutputDescriptor::VariableSampleRate) {
Chris@320 659
Chris@320 660 if (!feature.hasTimestamp) {
Chris@843 661 cerr
Chris@331 662 << "WARNING: FeatureExtractionModelTransformer::addFeature: "
Chris@320 663 << "Feature has variable sample rate but no timestamp!"
Chris@843 664 << endl;
Chris@320 665 return;
Chris@320 666 } else {
Chris@320 667 frame = Vamp::RealTime::realTime2Frame(feature.timestamp, inputRate);
Chris@320 668 }
Chris@320 669
Chris@320 670 } else if (m_descriptor->sampleType ==
Chris@320 671 Vamp::Plugin::OutputDescriptor::FixedSampleRate) {
Chris@320 672
Chris@779 673 if (!feature.hasTimestamp) {
Chris@779 674 ++m_fixedRateFeatureNo;
Chris@779 675 } else {
Chris@779 676 RealTime ts(feature.timestamp.sec, feature.timestamp.nsec);
Chris@779 677 m_fixedRateFeatureNo =
Chris@779 678 lrint(ts.toDouble() * m_descriptor->sampleRate);
Chris@779 679 }
Chris@862 680
Chris@862 681 // cerr << "m_fixedRateFeatureNo = " << m_fixedRateFeatureNo
Chris@862 682 // << ", m_descriptor->sampleRate = " << m_descriptor->sampleRate
Chris@862 683 // << ", inputRate = " << inputRate
Chris@862 684 // << " giving frame = ";
Chris@889 685
Chris@779 686 frame = lrintf((m_fixedRateFeatureNo / m_descriptor->sampleRate)
Chris@862 687 * int(inputRate));
Chris@862 688
Chris@862 689 // cerr << frame << endl;
Chris@320 690 }
Chris@862 691
Chris@862 692 if (frame < 0) {
Chris@862 693 cerr
Chris@862 694 << "WARNING: FeatureExtractionModelTransformer::addFeature: "
Chris@862 695 << "Negative frame counts are not supported (frame = " << frame
Chris@862 696 << " from timestamp " << feature.timestamp
Chris@862 697 << "), dropping feature"
Chris@862 698 << endl;
Chris@862 699 return;
Chris@862 700 }
Chris@862 701
Chris@441 702 // Rather than repeat the complicated tests from the constructor
Chris@441 703 // to determine what sort of model we must be adding the features
Chris@441 704 // to, we instead test what sort of model the constructor decided
Chris@441 705 // to create.
Chris@320 706
Chris@441 707 if (isOutput<SparseOneDimensionalModel>()) {
Chris@441 708
Chris@441 709 SparseOneDimensionalModel *model =
Chris@350 710 getConformingOutput<SparseOneDimensionalModel>();
Chris@320 711 if (!model) return;
Chris@350 712
Chris@441 713 model->addPoint(SparseOneDimensionalModel::Point
Chris@441 714 (frame, feature.label.c_str()));
Chris@320 715
Chris@441 716 } else if (isOutput<SparseTimeValueModel>()) {
Chris@320 717
Chris@350 718 SparseTimeValueModel *model =
Chris@350 719 getConformingOutput<SparseTimeValueModel>();
Chris@320 720 if (!model) return;
Chris@350 721
Chris@454 722 for (int i = 0; i < feature.values.size(); ++i) {
Chris@454 723
Chris@454 724 float value = feature.values[i];
Chris@454 725
Chris@454 726 QString label = feature.label.c_str();
Chris@454 727 if (feature.values.size() > 1) {
Chris@454 728 label = QString("[%1] %2").arg(i+1).arg(label);
Chris@454 729 }
Chris@454 730
Chris@454 731 model->addPoint(SparseTimeValueModel::Point(frame, value, label));
Chris@454 732 }
Chris@320 733
Chris@441 734 } else if (isOutput<NoteModel>() || isOutput<RegionModel>()) {
Chris@320 735
Chris@441 736 int index = 0;
Chris@441 737
Chris@441 738 float value = 0.0;
Chris@441 739 if (feature.values.size() > index) {
Chris@441 740 value = feature.values[index++];
Chris@441 741 }
Chris@320 742
Chris@320 743 float duration = 1;
Chris@441 744 if (feature.hasDuration) {
Chris@441 745 duration = Vamp::RealTime::realTime2Frame(feature.duration, inputRate);
Chris@441 746 } else {
Chris@441 747 if (feature.values.size() > index) {
Chris@441 748 duration = feature.values[index++];
Chris@441 749 }
Chris@441 750 }
Chris@320 751
Chris@441 752 if (isOutput<NoteModel>()) {
Chris@320 753
Chris@441 754 float velocity = 100;
Chris@441 755 if (feature.values.size() > index) {
Chris@441 756 velocity = feature.values[index++];
Chris@441 757 }
Chris@441 758 if (velocity < 0) velocity = 127;
Chris@441 759 if (velocity > 127) velocity = 127;
Chris@320 760
Chris@441 761 NoteModel *model = getConformingOutput<NoteModel>();
Chris@441 762 if (!model) return;
Chris@441 763 model->addPoint(NoteModel::Point(frame, value, // value is pitch
Chris@441 764 lrintf(duration),
Chris@441 765 velocity / 127.f,
Chris@441 766 feature.label.c_str()));
Chris@441 767 } else {
Chris@441 768 RegionModel *model = getConformingOutput<RegionModel>();
Chris@454 769 if (!model) return;
Chris@454 770
Chris@474 771 if (feature.hasDuration && !feature.values.empty()) {
Chris@454 772
Chris@454 773 for (int i = 0; i < feature.values.size(); ++i) {
Chris@454 774
Chris@454 775 float value = feature.values[i];
Chris@454 776
Chris@454 777 QString label = feature.label.c_str();
Chris@454 778 if (feature.values.size() > 1) {
Chris@454 779 label = QString("[%1] %2").arg(i+1).arg(label);
Chris@454 780 }
Chris@454 781
Chris@454 782 model->addPoint(RegionModel::Point(frame, value,
Chris@454 783 lrintf(duration),
Chris@454 784 label));
Chris@454 785 }
Chris@454 786 } else {
Chris@454 787
Chris@441 788 model->addPoint(RegionModel::Point(frame, value,
Chris@441 789 lrintf(duration),
Chris@441 790 feature.label.c_str()));
Chris@454 791 }
Chris@441 792 }
Chris@320 793
Chris@441 794 } else if (isOutput<EditableDenseThreeDimensionalModel>()) {
Chris@320 795
Chris@533 796 DenseThreeDimensionalModel::Column values =
Chris@533 797 DenseThreeDimensionalModel::Column::fromStdVector(feature.values);
Chris@320 798
Chris@320 799 EditableDenseThreeDimensionalModel *model =
Chris@350 800 getConformingOutput<EditableDenseThreeDimensionalModel>();
Chris@320 801 if (!model) return;
Chris@320 802
Chris@889 803 // cerr << "(note: model resolution = " << model->getResolution() << ")"
Chris@889 804 // << endl;
Chris@889 805
Chris@889 806 if (!feature.hasTimestamp && m_fixedRateFeatureNo >= 0) {
Chris@889 807 model->setColumn(m_fixedRateFeatureNo, values);
Chris@889 808 } else {
Chris@889 809 model->setColumn(frame / model->getResolution(), values);
Chris@889 810 }
Chris@441 811
Chris@441 812 } else {
Chris@690 813 SVDEBUG << "FeatureExtractionModelTransformer::addFeature: Unknown output model type!" << endl;
Chris@320 814 }
Chris@320 815 }
Chris@320 816
Chris@320 817 void
Chris@331 818 FeatureExtractionModelTransformer::setCompletion(int completion)
Chris@320 819 {
Chris@320 820 int binCount = 1;
Chris@320 821 if (m_descriptor->hasFixedBinCount) {
Chris@320 822 binCount = m_descriptor->binCount;
Chris@320 823 }
Chris@320 824
Chris@690 825 // SVDEBUG << "FeatureExtractionModelTransformer::setCompletion("
Chris@687 826 // << completion << ")" << endl;
Chris@320 827
Chris@441 828 if (isOutput<SparseOneDimensionalModel>()) {
Chris@320 829
Chris@350 830 SparseOneDimensionalModel *model =
Chris@350 831 getConformingOutput<SparseOneDimensionalModel>();
Chris@320 832 if (!model) return;
Chris@441 833 model->setCompletion(completion, true);
Chris@320 834
Chris@441 835 } else if (isOutput<SparseTimeValueModel>()) {
Chris@320 836
Chris@350 837 SparseTimeValueModel *model =
Chris@350 838 getConformingOutput<SparseTimeValueModel>();
Chris@320 839 if (!model) return;
Chris@441 840 model->setCompletion(completion, true);
Chris@320 841
Chris@441 842 } else if (isOutput<NoteModel>()) {
Chris@320 843
Chris@441 844 NoteModel *model = getConformingOutput<NoteModel>();
Chris@320 845 if (!model) return;
Chris@441 846 model->setCompletion(completion, true);
Chris@320 847
Chris@441 848 } else if (isOutput<RegionModel>()) {
Chris@441 849
Chris@441 850 RegionModel *model = getConformingOutput<RegionModel>();
Chris@441 851 if (!model) return;
Chris@441 852 model->setCompletion(completion, true);
Chris@441 853
Chris@441 854 } else if (isOutput<EditableDenseThreeDimensionalModel>()) {
Chris@320 855
Chris@320 856 EditableDenseThreeDimensionalModel *model =
Chris@350 857 getConformingOutput<EditableDenseThreeDimensionalModel>();
Chris@320 858 if (!model) return;
Chris@350 859 model->setCompletion(completion, true); //!!!m_context.updates);
Chris@320 860 }
Chris@320 861 }
Chris@320 862