annotate plugin/LADSPAPluginFactory.h @ 1879:652c5360e682

Ensure transforms are populated before instantiateDefaultPluginFor runs - otherwise if we have prior knowledge of a transform id, we can find ourselves trying to instantiate it before the plugin factory has heard of it and e.g. knows which server to use

/* -*- 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 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.
*/

/*
   This is a modified version of a source file from the 
   Rosegarden MIDI and audio sequencer and notation editor.
   This file copyright 2000-2006 Chris Cannam and Richard Bown.
*/

#ifndef SV_LADSPA_PLUGIN_FACTORY_H
#define SV_LADSPA_PLUGIN_FACTORY_H

#include "RealTimePluginFactory.h"
#include "api/ladspa.h"

#include "PluginScan.h"

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

class LADSPAPluginInstance;

class LADSPAPluginFactory : public RealTimePluginFactory
{
public:
    virtual ~LADSPAPluginFactory();

    void discoverPlugins() override;

    const std::vector<QString> &getPluginIdentifiers() const override;

    void enumeratePlugins(std::vector<QString> &list) override;

    RealTimePluginDescriptor getPluginDescriptor(QString identifier)
        const override;

    std::shared_ptr<RealTimePluginInstance>
    instantiatePlugin(QString identifier,
                      int clientId,
                      int position,
                      sv_samplerate_t sampleRate,
                      int blockSize,
                      int channels) override;

    QString getPluginCategory(QString identifier) override;

    QString getPluginLibraryPath(QString identifier) override;
    
    float getPortMinimum(const LADSPA_Descriptor *, int port);
    float getPortMaximum(const LADSPA_Descriptor *, int port);
    float getPortDefault(const LADSPA_Descriptor *, int port);
    float getPortQuantization(const LADSPA_Descriptor *, int port);
    int getPortDisplayHint(const LADSPA_Descriptor *, int port);

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

protected:
    LADSPAPluginFactory();
    friend class RealTimePluginFactory;

    virtual PluginScan::PluginType getPluginType() const {
        return PluginScan::LADSPAPlugin;
    }

    virtual std::vector<QString> getLRDFPath(QString &baseUri);

    virtual void discoverPluginsFrom(QString soName);
    virtual void generateTaxonomy(QString uri, QString base);
    virtual void generateFallbackCategories();

    virtual const LADSPA_Descriptor *getLADSPADescriptor(QString identifier);

    void loadLibrary(QString soName);
    void unloadLibrary(QString soName);
    void unloadUnusedLibraries();

    std::vector<QString> m_identifiers;
    std::map<QString, QString> m_libraries; // identifier -> full file path
    std::map<QString, RealTimePluginDescriptor> m_rtDescriptors;

    std::map<QString, QString> m_taxonomy;
    std::map<unsigned long, QString> m_lrdfTaxonomy;
    std::map<unsigned long, std::map<int, float> > m_portDefaults;

    std::set<std::weak_ptr<RealTimePluginInstance>,
             std::owner_less<std::weak_ptr<RealTimePluginInstance>>> m_instances;

    typedef std::map<QString, void *> LibraryHandleMap;
    LibraryHandleMap m_libraryHandles;
};

#endif