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 "ardour/buffer_set.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/libardour_visibility.h"
35 #include "ardour/midi_state_tracker.h"
36 #include "ardour/parameter_descriptor.h"
37 #include "ardour/types.h"
38 #include "ardour/variant.h"
52 typedef boost::shared_ptr<Plugin> PluginPtr;
54 class LIBARDOUR_API PluginInfo {
57 virtual ~PluginInfo () { }
65 ARDOUR::PluginType type;
67 std::string unique_id;
69 virtual PluginPtr load (Session& session) = 0;
70 virtual bool is_instrument() const;
72 /* NOTE: this block of virtual methods looks like the interface
73 to a Processor, but Plugin does not inherit from Processor.
74 It is therefore not required that these precisely match
75 the interface, but it is likely that they will evolve together.
78 /* this returns true if the plugin can change its inputs or outputs on demand.
79 LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
82 virtual bool reconfigurable_io() const { return false; }
85 friend class PluginManager;
89 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
90 typedef std::list<PluginInfoPtr> PluginInfoList;
92 class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
95 Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
96 Plugin (const Plugin&);
99 XMLNode& get_state ();
100 virtual int set_state (const XMLNode &, int version);
102 virtual void set_insert_id (PBD::ID id) {}
104 virtual std::string unique_id() const = 0;
105 virtual const char * label() const = 0;
106 virtual const char * name() const = 0;
107 virtual const char * maker() const = 0;
108 virtual uint32_t parameter_count () const = 0;
109 virtual float default_value (uint32_t port) = 0;
110 virtual float get_parameter(uint32_t which) const = 0;
111 virtual std::string get_docs () const { return ""; }
112 virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
114 virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
115 virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
116 virtual void activate () = 0;
117 virtual void deactivate () = 0;
118 virtual void flush () { deactivate(); activate(); }
120 virtual int set_block_size (pframes_t nframes) = 0;
122 virtual int connect_and_run (BufferSet& bufs,
123 ChanMapping in, ChanMapping out,
124 pframes_t nframes, framecnt_t offset);
126 virtual std::set<Evoral::Parameter> automatable() const = 0;
127 virtual std::string describe_parameter (Evoral::Parameter) = 0;
128 virtual std::string state_node_name() const = 0;
129 virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
131 virtual bool parameter_is_audio(uint32_t) const = 0;
132 virtual bool parameter_is_control(uint32_t) const = 0;
133 virtual bool parameter_is_input(uint32_t) const = 0;
134 virtual bool parameter_is_output(uint32_t) const = 0;
136 virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
137 return boost::shared_ptr<ScalePoints>();
140 void realtime_handle_transport_stopped ();
141 void realtime_locate ();
142 void monitoring_changed ();
144 struct PresetRecord {
145 PresetRecord () : number (-1), user (true) {}
146 PresetRecord (const std::string& u, const std::string& l, int n = -1, bool s = true) : uri (u), label (l), number (n), user (s) {}
148 bool operator!= (PresetRecord const & a) const {
149 return number != a.number || uri != a.uri || label != a.label;
154 int number; // if <0, invalid
158 PresetRecord save_preset (std::string);
159 void remove_preset (std::string);
161 virtual bool load_preset (PresetRecord);
162 void clear_preset ();
164 const PresetRecord * preset_by_label (const std::string &);
165 const PresetRecord * preset_by_uri (const std::string &);
167 std::vector<PresetRecord> get_presets ();
169 /** @return true if this plugin will respond to MIDI program
170 * change messages by changing presets.
172 * This is hard to return a correct value for because most plugin APIs
173 * do not specify plugin behaviour. However, if you want to force
174 * the display of plugin built-in preset names rather than MIDI program
175 * numbers, return true. If you want a generic description, return
178 virtual bool presets_are_MIDI_programs() const { return false; }
180 /** @return true if this plugin is General MIDI compliant, false
183 * It is important to note that it is is almost impossible for a host
184 * (e.g. Ardour) to determine this for just about any plugin API
185 * known as of June 2012
187 virtual bool current_preset_uses_general_midi() const { return false; }
189 /** @return Last preset to be requested; the settings may have
190 * been changed since; find out with parameter_changed_since_last_preset.
192 PresetRecord last_preset () const {
196 bool parameter_changed_since_last_preset () const {
197 return _parameter_changed_since_last_preset;
200 virtual int first_user_preset_index () const {
204 /** Emitted when a preset is added or removed, respectively */
205 PBD::Signal0<void> PresetAdded;
206 PBD::Signal0<void> PresetRemoved;
208 /** Emitted when a preset has been loaded */
209 PBD::Signal0<void> PresetLoaded;
211 /** Emitted when a parameter is altered in a way that may have
212 * changed the settings with respect to any loaded preset.
214 PBD::Signal0<void> PresetDirty;
216 virtual bool has_editor () const = 0;
218 /** Emitted when a parameter is altered by something outside of our
219 * control, most typically a Plugin GUI/editor
221 PBD::Signal2<void, uint32_t, float> ParameterChangedExternally;
223 virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
225 /* specific types of plugins can overload this. As of September 2008, only
228 virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) { return false; }
229 virtual ChanCount output_streams() const;
230 virtual ChanCount input_streams() const;
232 PluginInfoPtr get_info() const { return _info; }
233 virtual void set_info (const PluginInfoPtr inf);
235 ARDOUR::AudioEngine& engine() const { return _engine; }
236 ARDOUR::Session& session() const { return _session; }
238 void set_cycles (uint32_t c) { _cycles = c; }
239 cycles_t cycles() const { return _cycles; }
241 typedef std::map<uint32_t, ParameterDescriptor> PropertyDescriptors;
243 /** Get a descrption of all properties supported by this plugin.
245 * Properties are distinct from parameters in that they are potentially
246 * dynamic, referred to by key, and do not correspond 1:1 with ports.
248 * For LV2 plugins, properties are implemented by sending/receiving set/get
249 * messages to/from the plugin via event ports.
251 virtual const PropertyDescriptors& get_supported_properties() const {
252 static const PropertyDescriptors nothing;
256 virtual const ParameterDescriptor& get_property_descriptor(uint32_t id) const {
257 static const ParameterDescriptor nothing;
261 /** Set a property from the UI.
263 * This is not UI-specific, but may only be used by one thread. If the
264 * Ardour UI is present, that is the UI thread, but otherwise, any thread
265 * except the audio thread may call this function as long as it is not
266 * called concurrently.
268 virtual void set_property(uint32_t key, const Variant& value) {}
270 /** Emit PropertyChanged for all current property values. */
271 virtual void announce_property_values() {}
273 /** Emitted when a property is changed in the plugin. */
274 PBD::Signal2<void, uint32_t, Variant> PropertyChanged;
276 PBD::Signal1<void,uint32_t> StartTouch;
277 PBD::Signal1<void,uint32_t> EndTouch;
281 friend class PluginInsert;
282 friend class Session;
284 /* Called when a parameter of the plugin is changed outside of this
285 * host's control (typical via a plugin's own GUI/editor)
287 void parameter_changed_externally (uint32_t which, float val);
289 /* should be overridden by plugin API specific derived types to
290 * actually implement changing the parameter. The derived type should
291 * call this after the change is made.
293 virtual void set_parameter (uint32_t which, float val);
295 /** Do the actual saving of the current plugin settings to a preset of the provided name.
296 * Should return a URI on success, or an empty string on failure.
298 virtual std::string do_save_preset (std::string) = 0;
299 /** Do the actual removal of a preset of the provided name */
300 virtual void do_remove_preset (std::string) = 0;
302 ARDOUR::AudioEngine& _engine;
303 ARDOUR::Session& _session;
306 std::map<std::string, PresetRecord> _presets;
310 /** Fill _presets with our presets */
311 virtual void find_presets () = 0;
313 /** Add state to an existing XMLNode */
314 virtual void add_state (XMLNode *) const = 0;
317 MidiStateTracker _tracker;
318 BufferSet _pending_stop_events;
319 bool _have_pending_stop_events;
320 PresetRecord _last_preset;
321 bool _parameter_changed_since_last_preset;
323 void resolve_midi ();
326 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
328 } // namespace ARDOUR
330 #endif /* __ardour_plugin_h__ */