Vamp Plugin Tester

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*

    Vamp Plugin Tester

    Chris Cannam, cannam@all-day-breakfast.com

    Centre for Digital Music, Queen Mary, University of London.

    Copyright 2009-2015 QMUL.

    This program loads a Vamp plugin and tests its susceptibility to a

    number of common pitfalls, including handling of extremes of input

    data.  If you can think of any additional useful tests that are

    easily added, please send them to me.

    Permission is hereby granted, free of charge, to any person

    obtaining a copy of this software and associated documentation

    files (the "Software"), to deal in the Software without

    restriction, including without limitation the rights to use, copy,

    modify, merge, publish, distribute, sublicense, and/or sell copies

    of the Software, and to permit persons to whom the Software is

    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be

    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR

    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF

    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Except as contained in this notice, the names of the Centre for

    Digital Music; Queen Mary, University of London; and Chris Cannam

    shall not be used in advertising or otherwise to promote the sale,

    use or other dealings in this Software without prior written

    authorization.

*/

#include <vamp-hostsdk/PluginHostAdapter.h>

#include <vamp-hostsdk/PluginInputDomainAdapter.h>

#include <vamp-hostsdk/PluginLoader.h>

#include <iostream>

#include <cstdlib>

#include <cstring>

#include "Tester.h"

using namespace std;

static const std::string VERSION="1.1";

void usage(const char *name)

{

    cerr << "\n"

         << name << ": A Vamp plugin host that tests plugins for common errors.\n"

        "Chris Cannam, Centre for Digital Music, Queen Mary, University of London.\n"

        "Copyright 2009-2015 QMUL.\n"

        "Freely redistributable; published under a BSD-style license.\n\n"

        "Usage:\n"

        "  " << name << " [-nv] [-t <test>] <pluginbasename>:<plugin>\n"

        "  " << name << " [-nv] [-t <test>] -a\n"

        "  " << name << " -l\n\n"

        "Example:\n"

        "  " << name << " vamp-example-plugins:amplitudefollower\n\n"

        "Options:\n"

        "  -a, --all                 Test all plugins found in Vamp path\n\n"

        "  -n, --nondeterministic    Plugins may be nondeterministic: print a note\n"

        "                            instead of an error if results differ between runs\n\n"

        "  -v, --verbose             Show returned features each time a note, warning,\n"

        "                            or error arises from feature data\n\n"

        "  -t, --test <test>         Run only a single test, not the full test suite.\n"

        "                            Identify the test by its id, e.g. A3\n\n"

        "  -l, --list-tests          List tests by id and name\n\n"

        "  --version                 Display the version of " << name << "\n"

        "\nIf you have access to a runtime memory checker, you may find it especially\n"

        "helpful to run this tester under it and watch for errors thus provoked.\n"

         << endl;

    exit(2);

}

int main(int argc, char **argv)

{

    char *scooter = argv[0];

    char *name = 0;

    while (scooter && *scooter) {

        if (*scooter == '/' || *scooter == '\\') name = ++scooter;

        else ++scooter;

    }

    if (!name || !*name) name = argv[0];

    bool nondeterministic = false;

    bool verbose = false;

    bool all = false;

    bool list = false;

    string plugin;

    string single;

    // Would be better to use getopt, but let's avoid the dependency for now

    for (int i = 1; i < argc; ++i) {

        if (!argv[i]) break;

        if (argv[i][0] == '-') {

            if (!strcmp(argv[i], "-vn") ||

                !strcmp(argv[i], "-nv")) {

                verbose = true;

                nondeterministic = true;

                continue;

            }

            if (!strcmp(argv[i], "-v") ||

                !strcmp(argv[i], "--verbose")) {

                verbose = true;

                continue;

            }

            if (!strcmp(argv[i], "-n") ||

                !strcmp(argv[i], "--nondeterministic")) {

                nondeterministic = true;

                continue;

            }

            if (!strcmp(argv[i], "-a") ||

                !strcmp(argv[i], "--all")) {

                all = true;

                continue;

            }

            if (!strcmp(argv[i], "-l") ||

                !strcmp(argv[i], "--list-tests")) {

                list = true;

                continue;

            }

            if (!strcmp(argv[i], "-t") ||

                !strcmp(argv[i], "--test")) {

                if (i + 1 < argc) {

                    single = argv[i+1];

                    ++i;

                } else {

                    usage(name);

                }

                continue;

            }

            if (!strcmp(argv[i], "--version")) {

                cout << "v" << VERSION << endl;

                return 0;

            }

            usage(name);

        } else {

            if (plugin != "") usage(name);

            else plugin = argv[i];

        }

    }

    if (list) {

        if (all || nondeterministic || (single != "") || (plugin != "")) {

            usage(name);

        }

        Tester::listTests();

        return 0;

    }

    if (plugin == "" && !all) usage(name);

    if (plugin != "" &&  all) usage(name);

    cerr << name << ": Running..." << endl;

    Test::Options opts = Test::NoOption;

    if (nondeterministic) opts |= Test::NonDeterministic;

    if (verbose) opts |= Test::Verbose;

    if (single != "") opts |= Test::SingleTest;

    if (all) {

        bool good = true;

        Vamp::HostExt::PluginLoader::PluginKeyList keys =

            Vamp::HostExt::PluginLoader::getInstance()->listPlugins();

        if (keys.size() == 0) {

            cout << name << ": NOTE: No plugins found!" << endl;

            cout << name << ": (No libraries in search path, or no descriptors in library)" << endl;

            return 2;

        }

        int notes = 0, warnings = 0, errors = 0;

        for (int i = 0; i < (int)keys.size(); ++i) {

            cout << "Testing plugin: " << keys[i] << endl;

            Tester tester(keys[i], opts, single);

            if (tester.test(notes, warnings, errors)) {

                cout << name << ": All tests succeeded for this plugin" << endl;

            } else {

                cout << name << ": Some tests failed for this plugin" << endl;

                good = false;

            }

            cout << endl;

        }

        if (good) {

            cout << name << ": All tests succeeded";

            if (warnings > 0) {

                cout << ", with " << warnings << " warning(s)";

                if (notes > 0) {

                    cout << " and " << notes << " other note(s)";

                }

            } else if (notes > 0) {

                cout << ", with " << notes << " note(s)";

            }

            cout << endl;

            return 0;

        } else {

            cout << name << ": Some tests failed" << endl;

            return 1;

        }

    } else {

        Tester tester(plugin, opts, single);

        int notes = 0, warnings = 0, errors = 0;

        if (tester.test(notes, warnings, errors)) {

            cout << name << ": All tests succeeded";

            if (warnings > 0) {

                cout << ", with " << warnings << " warning(s)";

                if (notes > 0) {

                    cout << " and " << notes << " other note(s)";

                }

            } else if (notes > 0) {

                cout << ", with " << notes << " note(s)";

            }

            cout << endl;

            return 0;

        } else {

            cout << name << ": Some tests failed" << endl;

            return 1;

        }

    }

}