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