cannam@3: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@3: 
cannam@3: /*
cannam@3:     Vamp Plugin Tester
cannam@3:     Chris Cannam, cannam@all-day-breakfast.com
cannam@3:     Centre for Digital Music, Queen Mary, University of London.
Chris@42:     Copyright 2009-2014 QMUL.
cannam@3: 
cannam@3:     This program loads a Vamp plugin and tests its susceptibility to a
cannam@3:     number of common pitfalls, including handling of extremes of input
cannam@3:     data.  If you can think of any additional useful tests that are
cannam@3:     easily added, please send them to me.
cannam@3:   
cannam@3:     Permission is hereby granted, free of charge, to any person
cannam@3:     obtaining a copy of this software and associated documentation
cannam@3:     files (the "Software"), to deal in the Software without
cannam@3:     restriction, including without limitation the rights to use, copy,
cannam@3:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@3:     of the Software, and to permit persons to whom the Software is
cannam@3:     furnished to do so, subject to the following conditions:
cannam@3: 
cannam@3:     The above copyright notice and this permission notice shall be
cannam@3:     included in all copies or substantial portions of the Software.
cannam@3: 
cannam@3:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@3:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@3:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@3:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@3:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@3:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@3:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@3: 
cannam@3:     Except as contained in this notice, the names of the Centre for
cannam@3:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@3:     shall not be used in advertising or otherwise to promote the sale,
cannam@3:     use or other dealings in this Software without prior written
cannam@3:     authorization.
cannam@3: */
cannam@3: 
cannam@3: #include "TestOutputs.h"
cannam@3: 
cannam@3: #include <vamp-hostsdk/Plugin.h>
cannam@4: #include <vamp-hostsdk/PluginLoader.h>
cannam@3: using namespace Vamp;
cannam@4: using namespace Vamp::HostExt;
cannam@3: 
cannam@3: #include <set>
cannam@3: #include <memory>
cannam@3: using namespace std;
cannam@3: 
cannam@3: #include <cmath>
cannam@3: 
cannam@3: Tester::TestRegistrar<TestOutputNumbers>
Chris@39: TestOutputNumbers::m_registrar("B1", "Output number mismatching");
cannam@3: 
cannam@3: Tester::TestRegistrar<TestTimestamps>
Chris@39: TestTimestamps::m_registrar("B2", "Invalid or dubious timestamp usage");
cannam@3: 
cannam@3: static const size_t _step = 1000;
cannam@3: 
cannam@3: Test::Results
cannam@8: TestOutputNumbers::test(string key, Options options)
cannam@3: {
cannam@3:     int rate = 44100;
cannam@3:     auto_ptr<Plugin> p(load(key, rate));
cannam@3:     Plugin::FeatureSet f;
cannam@3:     Results r;
cannam@3:     float **data = 0;
cannam@3:     size_t channels = 0;
cannam@3:     size_t count = 100;
cannam@3: 
cannam@3:     if (!initAdapted(p.get(), channels, _step, _step, r)) return r;
cannam@3:     if (!data) data = createTestAudio(channels, _step, count);
cannam@3:     for (size_t i = 0; i < count; ++i) {
Chris@67:         float **ptr = new float *[channels];
cannam@3:         size_t idx = i * _step;
cannam@3:         for (size_t c = 0; c < channels; ++c) ptr[c] = data[c] + idx;
cannam@3:         RealTime timestamp = RealTime::frame2RealTime(idx, rate);
cannam@3:         Plugin::FeatureSet fs = p->process(ptr, timestamp);
Chris@67:         delete[] ptr;
cannam@3:         appendFeatures(f, fs);
cannam@3:     }
cannam@3:     Plugin::FeatureSet fs = p->getRemainingFeatures();
cannam@3:     appendFeatures(f, fs);
cannam@3:     if (data) destroyTestAudio(data, channels);
cannam@3: 
cannam@3:     std::set<int> used;
cannam@3:     Plugin::OutputList outputs = p->getOutputDescriptors();
cannam@5:     for (Plugin::FeatureSet::const_iterator i = f.begin();
cannam@5:          i != f.end(); ++i) {
cannam@3:         int o = i->first;
cannam@3:         used.insert(o);
cannam@4:         if (o < 0 || o >= (int)outputs.size()) {
cannam@3:             r.push_back(error("Data returned on nonexistent output"));
cannam@3:         }
cannam@3:     }
cannam@4:     for (int o = 0; o < (int)outputs.size(); ++o) {
cannam@3:         if (used.find(o) == used.end()) {
cannam@12:             r.push_back(note("No results returned for output \"" + outputs[o].identifier + "\"")); 
cannam@4:         }
cannam@3:     }
cannam@3:                 
cannam@8:     if (!r.empty() && (options & Verbose)) dump(f);
cannam@3:     return r;
cannam@3: }
cannam@3: 
cannam@3: Test::Results
cannam@8: TestTimestamps::test(string key, Options options)
cannam@3: {
cannam@3:     int rate = 44100;
cannam@4: 
cannam@4:     // we want to be sure that a buffer size adapter is not used:
cannam@4:     auto_ptr<Plugin> p(PluginLoader::getInstance()->loadPlugin
cannam@4:                        (key, rate, PluginLoader::ADAPT_ALL_SAFE));
cannam@4: 
Chris@60:     Results r;
cannam@3:     Plugin::FeatureSet f;
cannam@3:     float **data = 0;
cannam@3:     size_t channels = 0;
cannam@3:     size_t step = 0, block = 0;
cannam@3:     size_t count = 100;
cannam@3: 
cannam@3:     if (!initDefaults(p.get(), channels, step, block, r)) return r;
Chris@60: 
Chris@60:     Plugin::OutputList outputs = p->getOutputDescriptors();
Chris@60:     for (int i = 0; i < (int)outputs.size(); ++i) {
Chris@60:         if (outputs[i].sampleType == Plugin::OutputDescriptor::FixedSampleRate &&
Chris@60:             outputs[i].sampleRate == 0.f) {
Chris@60:             r.push_back(error("Plugin output \"" + outputs[i].identifier +
Chris@60:                               "\" has FixedSampleRate but gives sample rate as 0"));
Chris@60:         }
Chris@60:     }
Chris@60: 
cannam@3:     if (!data) data = createTestAudio(channels, block, count);
cannam@3:     for (size_t i = 0; i < count; ++i) {
Chris@67:         float **ptr = new float *[channels];
cannam@3:         size_t idx = i * step;
cannam@3:         for (size_t c = 0; c < channels; ++c) ptr[c] = data[c] + idx;
cannam@3:         RealTime timestamp = RealTime::frame2RealTime(idx, rate);
cannam@3:         Plugin::FeatureSet fs = p->process(ptr, timestamp);
Chris@67:         delete[] ptr;
cannam@3:         appendFeatures(f, fs);
cannam@3:     }
cannam@3:     Plugin::FeatureSet fs = p->getRemainingFeatures();
cannam@3:     appendFeatures(f, fs);
cannam@3:     if (data) destroyTestAudio(data, channels);
cannam@3: 
cannam@5:     for (Plugin::FeatureSet::const_iterator i = f.begin();
cannam@5:          i != f.end(); ++i) {
cannam@3:         const Plugin::OutputDescriptor &o = outputs[i->first];
cannam@3:         const Plugin::FeatureList &fl = i->second;
cannam@3:         for (int j = 0; j < (int)fl.size(); ++j) {
cannam@5:             const Plugin::Feature &fe = fl[j];
cannam@3:             switch (o.sampleType) {
cannam@3:             case Plugin::OutputDescriptor::OneSamplePerStep:
cannam@5:                 if (fe.hasTimestamp) {
Chris@31:                     r.push_back(note("Plugin returns features with timestamps on OneSamplePerStep output \"" + o.identifier + "\""));
cannam@3:                 }
cannam@5:                 if (fe.hasDuration) {
Chris@31:                     r.push_back(note("Plugin returns features with durations on OneSamplePerStep output \"" + o.identifier + "\""));
cannam@3:                 }
cannam@3:                 break;
cannam@3:             case Plugin::OutputDescriptor::FixedSampleRate:
cannam@3:                 break;
cannam@3:             case Plugin::OutputDescriptor::VariableSampleRate:
cannam@5:                 if (!fe.hasTimestamp) {
Chris@31:                     r.push_back(error("Plugin returns features with no timestamps on VariableSampleRate output \"" + o.identifier + "\""));
cannam@3:                 }
cannam@3:                 break;
cannam@3:             }
cannam@3:         }
cannam@3:     }
cannam@3: 
cannam@8:     if (!r.empty() && (options & Verbose)) dump(f);
cannam@3:     return r;
cannam@3: }