view plugin/FeatureExtractionPluginFactory.h @ 1174:0ad516dc5d8d

Presume that the Vamp SDK exists at the directory next door

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

/*
    Sonic Visualiser
    An audio file viewer and annotation editor.
    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2006 Chris Cannam.
    
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.  See the file
    COPYING included with this distribution for more information.
*/

#ifndef _FEATURE_EXTRACTION_PLUGIN_FACTORY_H_
#define _FEATURE_EXTRACTION_PLUGIN_FACTORY_H_

#include <QString>
#include <vector>
#include <map>

#include <vamp-hostsdk/Plugin.h>

#include "base/Debug.h"
#include "base/BaseTypes.h"

class FeatureExtractionPluginFactory
{
public:
    virtual ~FeatureExtractionPluginFactory() { }

    static FeatureExtractionPluginFactory *instance(QString pluginType);
    static FeatureExtractionPluginFactory *instanceFor(QString identifier);
    static std::vector<QString> getAllPluginIdentifiers();

    virtual std::vector<QString> getPluginPath();

    virtual std::vector<QString> getPluginIdentifiers();

    /**
     * Return any error message arising from the initial plugin
     * scan. The return value will either be an empty string (nothing
     * to report) or an HTML string suitable for dropping into a
     * dialog and showing the user.
     */
    virtual QString getPluginPopulationWarning() { return m_pluginScanError; }
    
    virtual QString findPluginFile(QString soname, QString inDir = "");

    // We don't set blockSize or channels on this -- they're
    // negotiated and handled via initialize() on the plugin
    virtual Vamp::Plugin *instantiatePlugin(QString identifier,
                                            sv_samplerate_t inputSampleRate);

    /**
     * Get category metadata about a plugin (without instantiating it).
     */
    virtual QString getPluginCategory(QString identifier);

protected:
    std::vector<QString> m_pluginPath;
    std::map<QString, QString> m_taxonomy;

    friend class PluginDeletionNotifyAdapter;
    void pluginDeleted(Vamp::Plugin *);
    std::map<Vamp::Plugin *, void *> m_handleMap;
    
    std::vector<QString> getPluginCandidateFiles();
    std::vector<QString> winnowPluginCandidates(std::vector<QString> candidates,
                                                QString &warningMessage);
    
    void generateTaxonomy();

    QString m_pluginScanError;
};

#endif