annotate plugin/RealTimePluginFactory.h @ 816:e2b535b35b5f tonioni

bugfixes to compile on Linux again
author gyorgyf
date Tue, 18 Jun 2013 22:18:10 +0100
parents b4a8d8221eaf
children a1cd5abcb38b
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@686 28 #include "base/Debug.h"
Chris@686 29
Chris@0 30 class RealTimePluginInstance;
Chris@0 31
Chris@60 32 class RealTimePluginDescriptor
Chris@60 33 {
Chris@60 34 public:
Chris@60 35 std::string name;
Chris@60 36 std::string label;
Chris@60 37 std::string maker;
Chris@60 38 std::string copyright;
Chris@60 39 std::string category;
Chris@60 40 bool isSynth;
Chris@60 41 unsigned int parameterCount;
Chris@60 42 unsigned int audioInputPortCount;
Chris@166 43 unsigned int audioOutputPortCount;
Chris@60 44 unsigned int controlOutputPortCount;
Chris@60 45 std::vector<std::string> controlOutputPortNames;
Chris@60 46 };
Chris@60 47
Chris@0 48 class RealTimePluginFactory
Chris@0 49 {
Chris@0 50 public:
Chris@259 51 virtual ~RealTimePluginFactory();
Chris@259 52
Chris@0 53 static RealTimePluginFactory *instance(QString pluginType);
Chris@0 54 static RealTimePluginFactory *instanceFor(QString identifier);
Chris@0 55 static std::vector<QString> getAllPluginIdentifiers();
Chris@0 56 static void enumerateAllPlugins(std::vector<QString> &);
Chris@0 57
Chris@0 58 static void setSampleRate(int sampleRate) { m_sampleRate = sampleRate; }
Chris@0 59
Chris@0 60 /**
Chris@0 61 * Look up the plugin path and find the plugins in it. Called
Chris@0 62 * automatically after construction of a factory.
Chris@0 63 */
Chris@0 64 virtual void discoverPlugins() = 0;
Chris@0 65
Chris@0 66 /**
Chris@0 67 * Return a reference to a list of all plugin identifiers that can
Chris@0 68 * be created by this factory.
Chris@0 69 */
Chris@0 70 virtual const std::vector<QString> &getPluginIdentifiers() const = 0;
Chris@0 71
Chris@0 72 /**
Chris@0 73 * Append to the given list descriptions of all the available
Chris@0 74 * plugins and their ports. This is in a standard format, see
Chris@0 75 * the LADSPA implementation for details.
Chris@0 76 */
Chris@0 77 virtual void enumeratePlugins(std::vector<QString> &list) = 0;
Chris@0 78
Chris@0 79 /**
Chris@60 80 * Get some basic information about a plugin (rapidly).
Chris@60 81 */
Chris@60 82 virtual const RealTimePluginDescriptor *getPluginDescriptor(QString identifier) const = 0;
Chris@60 83
Chris@60 84 /**
Chris@0 85 * Instantiate a plugin.
Chris@0 86 */
Chris@0 87 virtual RealTimePluginInstance *instantiatePlugin(QString identifier,
Chris@0 88 int clientId,
Chris@0 89 int position,
Chris@0 90 unsigned int sampleRate,
Chris@0 91 unsigned int blockSize,
Chris@0 92 unsigned int channels) = 0;
Chris@0 93
Chris@165 94 /**
Chris@165 95 * Get category metadata about a plugin (without instantiating it).
Chris@165 96 */
Chris@165 97 virtual QString getPluginCategory(QString identifier) = 0;
Chris@165 98
Chris@0 99 protected:
Chris@0 100 RealTimePluginFactory() { }
Chris@0 101
Chris@0 102 // for call by RealTimePluginInstance dtor
Chris@0 103 virtual void releasePlugin(RealTimePluginInstance *, QString identifier) = 0;
Chris@0 104 friend class RealTimePluginInstance;
Chris@0 105
Chris@0 106 static int m_sampleRate;
Chris@0 107 };
Chris@0 108
Chris@0 109 #endif