2 Copyright (C) 2000-2006 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_plugin_h__
21 #define __ardour_plugin_h__
23 #include <boost/shared_ptr.hpp>
26 #include "pbd/statefuldestructible.h"
27 #include "pbd/controllable.h"
29 #include <jack/types.h>
30 #include "ardour/chan_count.h"
31 #include "ardour/chan_mapping.h"
32 #include "ardour/cycles.h"
33 #include "ardour/latent.h"
34 #include "ardour/plugin_insert.h"
35 #include "ardour/types.h"
49 typedef boost::shared_ptr<Plugin> PluginPtr;
54 virtual ~PluginInfo () { }
62 ARDOUR::PluginType type;
64 std::string unique_id;
66 virtual PluginPtr load (Session& session) = 0;
69 friend class PluginManager;
73 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
74 typedef std::list<PluginInfoPtr> PluginInfoList;
76 class Plugin : public PBD::StatefulDestructible, public Latent
79 Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
80 Plugin (const Plugin&);
83 struct ParameterDescriptor {
85 /* essentially a union of LADSPA and VST info */
101 virtual std::string unique_id() const = 0;
102 virtual const char * label() const = 0;
103 virtual const char * name() const = 0;
104 virtual const char * maker() const = 0;
105 virtual uint32_t parameter_count () const = 0;
106 virtual float default_value (uint32_t port) = 0;
107 virtual float get_parameter(uint32_t which) const = 0;
109 virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
110 virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
111 virtual void activate () = 0;
112 virtual void deactivate () = 0;
113 virtual void flush () { deactivate(); activate(); }
115 virtual int set_block_size (pframes_t nframes) = 0;
117 virtual int connect_and_run (BufferSet& bufs,
118 ChanMapping in, ChanMapping out,
119 pframes_t nframes, framecnt_t offset) = 0;
121 virtual std::set<Evoral::Parameter> automatable() const = 0;
122 virtual std::string describe_parameter (Evoral::Parameter) = 0;
123 virtual std::string state_node_name() const = 0;
124 virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
126 virtual bool parameter_is_audio(uint32_t) const = 0;
127 virtual bool parameter_is_control(uint32_t) const = 0;
128 virtual bool parameter_is_input(uint32_t) const = 0;
129 virtual bool parameter_is_output(uint32_t) const = 0;
131 bool save_preset (std::string);
132 void remove_preset (std::string);
133 virtual bool load_preset (const std::string& uri) = 0;
135 struct PresetRecord {
136 PresetRecord (const std::string& u, const std::string& l) : uri(u), label(l) {}
141 const PresetRecord * preset_by_label (const std::string &);
142 const PresetRecord * preset_by_uri (const std::string &);
144 /** Return this plugin's presets; should add them to _presets */
145 virtual std::vector<PresetRecord> get_presets () = 0;
146 virtual std::string current_preset () const { return std::string(); }
148 /** Emitted when a preset is added or removed, respectively */
149 PBD::Signal0<void> PresetAdded;
150 PBD::Signal0<void> PresetRemoved;
152 /* XXX: no-one listens to this */
153 static PBD::Signal0<bool> PresetFileExists;
155 virtual bool has_editor() const = 0;
157 PBD::Signal2<void,uint32_t,float> ParameterChanged;
159 /* NOTE: this block of virtual methods looks like the interface
160 to a Processor, but Plugin does not inherit from Processor.
161 It is therefore not required that these precisely match
162 the interface, but it is likely that they will evolve together.
165 /* this returns true if the plugin can change its inputs or outputs on demand.
166 LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
169 virtual bool reconfigurable_io() const { return false; }
171 /* this is only called if reconfigurable_io() returns true */
172 virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
174 /* specific types of plugins can overload this. As of September 2008, only
177 virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) const { return false; }
178 virtual ChanCount output_streams() const;
179 virtual ChanCount input_streams() const;
181 PluginInfoPtr get_info() const { return _info; }
182 void set_info (const PluginInfoPtr inf) { _info = inf; }
184 ARDOUR::AudioEngine& engine() const { return _engine; }
185 ARDOUR::Session& session() const { return _session; }
187 void set_cycles (uint32_t c) { _cycles = c; }
188 cycles_t cycles() const { return _cycles; }
192 friend class PluginInsert;
193 friend struct PluginInsert::PluginControl;
195 virtual void set_parameter (uint32_t which, float val) = 0;
197 /** Do the actual saving of the current plugin settings to a preset of the provided name.
198 * Should return a URI on success, or an empty string on failure.
200 virtual std::string do_save_preset (std::string) = 0;
201 /** Do the actual removal of a preset of the provided name */
202 virtual void do_remove_preset (std::string) = 0;
204 ARDOUR::AudioEngine& _engine;
205 ARDOUR::Session& _session;
208 std::map<std::string, PresetRecord> _presets;
211 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
213 } // namespace ARDOUR
215 #endif /* __ardour_plugin_h__ */