annotate plugin/RealTimePluginFactory.h @ 166:702fc936e6a6

* Pull transforms out of Layer menu (again) and into a separate Transforms menu * Add Recent Transforms submenu * Add effects and generators to the transforms menu (not yet implemented) as well as analysis plugins and data-from-effects (control output ports) * Add a nice dictionary-volume-style alphabetic subdivision of plugin names in plugins By Name menus
author Chris Cannam
date Fri, 22 Sep 2006 16:12:23 +0000
parents 5ae5885d6ce3
children dc46851837d6
rev   line source
Chris@49 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@0 2
Chris@0 3 /*
Chris@52 4 Sonic Visualiser
Chris@52 5 An audio file viewer and annotation editor.
Chris@52 6 Centre for Digital Music, Queen Mary, University of London.
Chris@52 7 This file copyright 2006 Chris Cannam.
Chris@0 8
Chris@52 9 This program is free software; you can redistribute it and/or
Chris@52 10 modify it under the terms of the GNU General Public License as
Chris@52 11 published by the Free Software Foundation; either version 2 of the
Chris@52 12 License, or (at your option) any later version. See the file
Chris@52 13 COPYING included with this distribution for more information.
Chris@0 14 */
Chris@0 15
Chris@0 16 /*
Chris@0 17 This is a modified version of a source file from the
Chris@0 18 Rosegarden MIDI and audio sequencer and notation editor.
Chris@17 19 This file copyright 2000-2006 Chris Cannam.
Chris@0 20 */
Chris@0 21
Chris@0 22 #ifndef _REALTIME_PLUGIN_FACTORY_H_
Chris@0 23 #define _REALTIME_PLUGIN_FACTORY_H_
Chris@0 24
Chris@0 25 #include <QString>
Chris@0 26 #include <vector>
Chris@0 27
Chris@0 28 class RealTimePluginInstance;
Chris@0 29
Chris@60 30 class RealTimePluginDescriptor
Chris@60 31 {
Chris@60 32 public:
Chris@60 33 std::string name;
Chris@60 34 std::string label;
Chris@60 35 std::string maker;
Chris@60 36 std::string copyright;
Chris@60 37 std::string category;
Chris@60 38 bool isSynth;
Chris@60 39 unsigned int parameterCount;
Chris@60 40 unsigned int audioInputPortCount;
Chris@166 41 unsigned int audioOutputPortCount;
Chris@60 42 unsigned int controlOutputPortCount;
Chris@60 43 std::vector<std::string> controlOutputPortNames;
Chris@60 44 };
Chris@60 45
Chris@0 46 class RealTimePluginFactory
Chris@0 47 {
Chris@0 48 public:
Chris@0 49 static RealTimePluginFactory *instance(QString pluginType);
Chris@0 50 static RealTimePluginFactory *instanceFor(QString identifier);
Chris@0 51 static std::vector<QString> getAllPluginIdentifiers();
Chris@0 52 static void enumerateAllPlugins(std::vector<QString> &);
Chris@0 53
Chris@0 54 static void setSampleRate(int sampleRate) { m_sampleRate = sampleRate; }
Chris@0 55
Chris@0 56 /**
Chris@0 57 * Look up the plugin path and find the plugins in it. Called
Chris@0 58 * automatically after construction of a factory.
Chris@0 59 */
Chris@0 60 virtual void discoverPlugins() = 0;
Chris@0 61
Chris@0 62 /**
Chris@0 63 * Return a reference to a list of all plugin identifiers that can
Chris@0 64 * be created by this factory.
Chris@0 65 */
Chris@0 66 virtual const std::vector<QString> &getPluginIdentifiers() const = 0;
Chris@0 67
Chris@0 68 /**
Chris@0 69 * Append to the given list descriptions of all the available
Chris@0 70 * plugins and their ports. This is in a standard format, see
Chris@0 71 * the LADSPA implementation for details.
Chris@0 72 */
Chris@0 73 virtual void enumeratePlugins(std::vector<QString> &list) = 0;
Chris@0 74
Chris@0 75 /**
Chris@60 76 * Get some basic information about a plugin (rapidly).
Chris@60 77 */
Chris@60 78 virtual const RealTimePluginDescriptor *getPluginDescriptor(QString identifier) const = 0;
Chris@60 79
Chris@60 80 /**
Chris@0 81 * Instantiate a plugin.
Chris@0 82 */
Chris@0 83 virtual RealTimePluginInstance *instantiatePlugin(QString identifier,
Chris@0 84 int clientId,
Chris@0 85 int position,
Chris@0 86 unsigned int sampleRate,
Chris@0 87 unsigned int blockSize,
Chris@0 88 unsigned int channels) = 0;
Chris@0 89
Chris@165 90 /**
Chris@165 91 * Get category metadata about a plugin (without instantiating it).
Chris@165 92 */
Chris@165 93 virtual QString getPluginCategory(QString identifier) = 0;
Chris@165 94
Chris@0 95 protected:
Chris@0 96 RealTimePluginFactory() { }
Chris@0 97
Chris@0 98 // for call by RealTimePluginInstance dtor
Chris@0 99 virtual void releasePlugin(RealTimePluginInstance *, QString identifier) = 0;
Chris@0 100 friend class RealTimePluginInstance;
Chris@0 101
Chris@0 102 static int m_sampleRate;
Chris@0 103 };
Chris@0 104
Chris@0 105 #endif