Chris@49: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@0: 
Chris@0: /*
Chris@52:     Sonic Visualiser
Chris@52:     An audio file viewer and annotation editor.
Chris@52:     Centre for Digital Music, Queen Mary, University of London.
Chris@52:     This file copyright 2006 Chris Cannam.
Chris@0:     
Chris@52:     This program is free software; you can redistribute it and/or
Chris@52:     modify it under the terms of the GNU General Public License as
Chris@52:     published by the Free Software Foundation; either version 2 of the
Chris@52:     License, or (at your option) any later version.  See the file
Chris@52:     COPYING included with this distribution for more information.
Chris@0: */
Chris@0: 
Chris@0: /*
Chris@0:    This is a modified version of a source file from the 
Chris@0:    Rosegarden MIDI and audio sequencer and notation editor.
Chris@17:    This file copyright 2000-2006 Chris Cannam.
Chris@0: */
Chris@0: 
Chris@1581: #ifndef SV_REALTIME_PLUGIN_FACTORY_H
Chris@1581: #define SV_REALTIME_PLUGIN_FACTORY_H
Chris@0: 
Chris@0: #include <QString>
Chris@0: #include <vector>
Chris@1830: #include <memory>
Chris@0: 
Chris@686: #include "base/Debug.h"
Chris@1040: #include "base/BaseTypes.h"
Chris@686: 
Chris@0: class RealTimePluginInstance;
Chris@0: 
Chris@60: class RealTimePluginDescriptor
Chris@60: {
Chris@60: public:
Chris@60:     std::string name;
Chris@60:     std::string label;
Chris@60:     std::string maker;
Chris@60:     std::string copyright;
Chris@60:     std::string category;
Chris@60:     bool isSynth;
Chris@60:     unsigned int parameterCount;
Chris@60:     unsigned int audioInputPortCount;
Chris@166:     unsigned int audioOutputPortCount;
Chris@60:     unsigned int controlOutputPortCount;
Chris@60:     std::vector<std::string> controlOutputPortNames;
Chris@60: };
Chris@60: 
Chris@0: class RealTimePluginFactory
Chris@0: {
Chris@0: public:
Chris@259:     virtual ~RealTimePluginFactory();
Chris@259: 
Chris@0:     static RealTimePluginFactory *instance(QString pluginType);
Chris@0:     static RealTimePluginFactory *instanceFor(QString identifier);
Chris@0:     static std::vector<QString> getAllPluginIdentifiers();
Chris@0:     static void enumerateAllPlugins(std::vector<QString> &);
Chris@0: 
Chris@1040:     static void setSampleRate(sv_samplerate_t sampleRate) { m_sampleRate = sampleRate; }
Chris@0: 
Chris@0:     /**
Chris@0:      * Look up the plugin path and find the plugins in it.  Called 
Chris@0:      * automatically after construction of a factory.
Chris@0:      */
Chris@0:     virtual void discoverPlugins() = 0;
Chris@0: 
Chris@0:     /**
Chris@0:      * Return a reference to a list of all plugin identifiers that can
Chris@0:      * be created by this factory.
Chris@0:      */
Chris@0:     virtual const std::vector<QString> &getPluginIdentifiers() const = 0;
Chris@0: 
Chris@0:     /**
Chris@0:      * Append to the given list descriptions of all the available
Chris@0:      * plugins and their ports.  This is in a standard format, see
Chris@0:      * the LADSPA implementation for details.
Chris@0:      */
Chris@0:     virtual void enumeratePlugins(std::vector<QString> &list) = 0;
Chris@0: 
Chris@0:     /**
Chris@60:      * Get some basic information about a plugin (rapidly).
Chris@60:      */
Chris@1830:     virtual RealTimePluginDescriptor getPluginDescriptor(QString identifier) const = 0;
Chris@60: 
Chris@60:     /**
Chris@0:      * Instantiate a plugin.
Chris@0:      */
Chris@1830:     virtual std::shared_ptr<RealTimePluginInstance> instantiatePlugin(QString identifier,
Chris@1429:                                                       int clientId,
Chris@1429:                                                       int position,
Chris@1429:                                                       sv_samplerate_t sampleRate,
Chris@1429:                                                       int blockSize,
Chris@1429:                                                       int channels) = 0;
Chris@0: 
Chris@165:     /**
Chris@165:      * Get category metadata about a plugin (without instantiating it).
Chris@165:      */
Chris@165:     virtual QString getPluginCategory(QString identifier) = 0;
Chris@165: 
Chris@1464:     /**
Chris@1464:      * Get the full file path (including both directory and filename)
Chris@1464:      * of the library file that provides a given plugin
Chris@1464:      * identifier. Note getPluginIdentifiers() must have been called
Chris@1464:      * before this has access to the necessary information.
Chris@1464:      */
Chris@1464:     virtual QString getPluginLibraryPath(QString identifier) = 0;
Chris@1464:     
Chris@0: protected:
Chris@0:     RealTimePluginFactory() { }
Chris@0: 
Chris@1040:     static sv_samplerate_t m_sampleRate;
Chris@0: };
Chris@0: 
Chris@0: #endif