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>
27 #include "pbd/statefuldestructible.h"
28 #include "pbd/controllable.h"
30 #include "ardour/buffer_set.h"
31 #include "ardour/chan_count.h"
32 #include "ardour/chan_mapping.h"
33 #include "ardour/cycles.h"
34 #include "ardour/latent.h"
35 #include "ardour/libardour_visibility.h"
36 #include "ardour/midi_state_tracker.h"
37 #include "ardour/parameter_descriptor.h"
38 #include "ardour/types.h"
39 #include "ardour/variant.h"
53 class AutomationControl;
55 typedef boost::shared_ptr<Plugin> PluginPtr;
56 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
57 typedef std::list<PluginInfoPtr> PluginInfoList;
58 typedef std::set<uint32_t> PluginOutputConfiguration;
60 /** A plugin is an external module (usually 3rd party provided) loaded into Ardour
61 * for the purpose of digital signal processing.
63 * This class provides an abstraction for methords provided by
64 * all supported plugin standards such as presets, name, parameters etc.
66 * Plugins are not used directly in Ardour but always wrapped by a PluginInsert.
68 class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
71 Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
72 Plugin (const Plugin&);
75 XMLNode& get_state ();
76 virtual int set_state (const XMLNode &, int version);
78 virtual void set_insert_id (PBD::ID id) {}
79 virtual void set_state_dir (const std::string& d = "") {}
81 virtual std::string unique_id() const = 0;
82 virtual const char * label() const = 0;
83 virtual const char * name() const = 0;
84 virtual const char * maker() const = 0;
85 virtual uint32_t parameter_count () const = 0;
86 virtual float default_value (uint32_t port) = 0;
87 virtual float get_parameter(uint32_t which) const = 0;
88 virtual std::string get_docs () const { return ""; }
89 virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
91 virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
92 virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
93 virtual void activate () = 0;
94 virtual void deactivate () = 0;
95 virtual void flush () { deactivate(); activate(); }
97 virtual int set_block_size (pframes_t nframes) = 0;
98 virtual bool requires_fixed_sized_buffers() const { return false; }
99 virtual bool inplace_broken() const { return false; }
101 virtual int connect_and_run (BufferSet& bufs,
102 framepos_t start, framepos_t end, double speed,
103 ChanMapping in, ChanMapping out,
104 pframes_t nframes, framecnt_t offset);
106 virtual std::set<Evoral::Parameter> automatable() const = 0;
107 virtual std::string describe_parameter (Evoral::Parameter) = 0;
108 virtual std::string state_node_name() const = 0;
109 virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
111 virtual bool parameter_is_audio(uint32_t) const = 0;
112 virtual bool parameter_is_control(uint32_t) const = 0;
113 virtual bool parameter_is_input(uint32_t) const = 0;
114 virtual bool parameter_is_output(uint32_t) const = 0;
116 virtual uint32_t designated_bypass_port () { return UINT32_MAX; }
118 struct LIBARDOUR_API IOPortDescription {
120 IOPortDescription (const std::string& n)
122 , is_sidechain (false)
124 IOPortDescription (const IOPortDescription &other)
126 , is_sidechain (other.is_sidechain)
132 virtual IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id) const;
133 virtual PluginOutputConfiguration possible_output () const;
135 virtual void set_automation_control (uint32_t /*port_index*/, boost::shared_ptr<ARDOUR::AutomationControl>) { }
137 virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
138 return boost::shared_ptr<ScalePoints>();
141 void realtime_handle_transport_stopped ();
142 void realtime_locate ();
143 void monitoring_changed ();
150 } Display_Image_Surface;
152 virtual bool has_inline_display () { return false; }
153 virtual Display_Image_Surface* render_inline_display (uint32_t, uint32_t) { return NULL; }
154 PBD::Signal0<void> QueueDraw;
156 struct PresetRecord {
157 PresetRecord () : valid (false) {}
158 PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s), valid (true) {}
160 bool operator!= (PresetRecord const & a) const {
161 return uri != a.uri || label != a.label;
170 PresetRecord save_preset (std::string);
171 void remove_preset (std::string);
173 virtual bool load_preset (PresetRecord);
174 void clear_preset ();
176 const PresetRecord * preset_by_label (const std::string &);
177 const PresetRecord * preset_by_uri (const std::string &);
179 std::vector<PresetRecord> get_presets ();
181 /** @return true if this plugin will respond to MIDI program
182 * change messages by changing presets.
184 * This is hard to return a correct value for because most plugin APIs
185 * do not specify plugin behaviour. However, if you want to force
186 * the display of plugin built-in preset names rather than MIDI program
187 * numbers, return true. If you want a generic description, return
190 virtual bool presets_are_MIDI_programs() const { return false; }
192 /** @return true if this plugin is General MIDI compliant, false
195 * It is important to note that it is is almost impossible for a host
196 * (e.g. Ardour) to determine this for just about any plugin API
197 * known as of June 2012
199 virtual bool current_preset_uses_general_midi() const { return false; }
201 /** @return Last preset to be requested; the settings may have
202 * been changed since; find out with parameter_changed_since_last_preset.
204 PresetRecord last_preset () const {
208 bool parameter_changed_since_last_preset () const {
209 return _parameter_changed_since_last_preset;
212 virtual int first_user_preset_index () const {
216 /** Emitted when a Latency Changes
218 * (this cannot be part of ARDOUR::Latent because
219 * signals cannot be copy-constructed).
221 PBD::Signal2<void,framecnt_t, framecnt_t> LatencyChanged;
223 /* overload Latent::set_user_latency w/signal emission */
224 virtual void set_user_latency (framecnt_t val) {
225 bool changed = val != _user_latency;
226 framecnt_t old = effective_latency ();
229 LatencyChanged (old, effective_latency ()); /* EMIT SIGNAL */
233 /** the max possible latency a plugin will have */
234 virtual framecnt_t max_latency () const { return 0; } // TODO = 0, require implementation
236 /** Emitted when a preset is added or removed, respectively */
237 PBD::Signal0<void> PresetAdded;
238 PBD::Signal0<void> PresetRemoved;
240 /** Emitted when any preset has been changed */
241 static PBD::Signal2<void, std::string, Plugin*> PresetsChanged;
243 /** Emitted when a preset has been loaded */
244 PBD::Signal0<void> PresetLoaded;
246 /** Emitted when a parameter is altered in a way that may have
247 * changed the settings with respect to any loaded preset.
249 PBD::Signal0<void> PresetDirty;
251 virtual bool has_editor () const = 0;
253 /** Emitted when a parameter is altered by something outside of our
254 * control, most typically a Plugin GUI/editor
256 PBD::Signal2<void, uint32_t, float> ParameterChangedExternally;
258 virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
260 /* specific types of plugins can overload this. As of September 2008, only
263 virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/, ChanCount* imprecise = 0) { return false; }
264 virtual ChanCount output_streams() const;
265 virtual ChanCount input_streams() const;
267 PluginInfoPtr get_info() const { return _info; }
268 virtual void set_info (const PluginInfoPtr inf);
270 ARDOUR::AudioEngine& engine() const { return _engine; }
271 ARDOUR::Session& session() const { return _session; }
273 void set_cycles (uint32_t c) { _cycles = c; }
274 cycles_t cycles() const { return _cycles; }
276 typedef std::map<uint32_t, ParameterDescriptor> PropertyDescriptors;
278 /** Get a descrption of all properties supported by this plugin.
280 * Properties are distinct from parameters in that they are potentially
281 * dynamic, referred to by key, and do not correspond 1:1 with ports.
283 * For LV2 plugins, properties are implemented by sending/receiving set/get
284 * messages to/from the plugin via event ports.
286 virtual const PropertyDescriptors& get_supported_properties() const {
287 static const PropertyDescriptors nothing;
291 virtual const ParameterDescriptor& get_property_descriptor(uint32_t id) const {
292 static const ParameterDescriptor nothing;
296 /** Set a property from the UI.
298 * This is not UI-specific, but may only be used by one thread. If the
299 * Ardour UI is present, that is the UI thread, but otherwise, any thread
300 * except the audio thread may call this function as long as it is not
301 * called concurrently.
303 virtual void set_property(uint32_t key, const Variant& value) {}
305 /** Emit PropertyChanged for all current property values. */
306 virtual void announce_property_values() {}
308 /** Emitted when a property is changed in the plugin. */
309 PBD::Signal2<void, uint32_t, Variant> PropertyChanged;
311 PBD::Signal1<void,uint32_t> StartTouch;
312 PBD::Signal1<void,uint32_t> EndTouch;
316 friend class PluginInsert;
317 friend class Session;
319 /* Called when a parameter of the plugin is changed outside of this
320 * host's control (typical via a plugin's own GUI/editor)
322 void parameter_changed_externally (uint32_t which, float val);
324 /* should be overridden by plugin API specific derived types to
325 * actually implement changing the parameter. The derived type should
326 * call this after the change is made.
328 virtual void set_parameter (uint32_t which, float val);
330 /** Do the actual saving of the current plugin settings to a preset of the provided name.
331 * Should return a URI on success, or an empty string on failure.
333 virtual std::string do_save_preset (std::string) = 0;
334 /** Do the actual removal of a preset of the provided name */
335 virtual void do_remove_preset (std::string) = 0;
337 ARDOUR::AudioEngine& _engine;
338 ARDOUR::Session& _session;
341 std::map<std::string, PresetRecord> _presets;
345 /** Fill _presets with our presets */
346 virtual void find_presets () = 0;
348 void update_presets (std::string src_unique_id, Plugin* src );
350 /** Add state to an existing XMLNode */
351 virtual void add_state (XMLNode *) const = 0;
354 MidiStateTracker _tracker;
355 BufferSet _pending_stop_events;
356 bool _have_pending_stop_events;
357 PresetRecord _last_preset;
358 bool _parameter_changed_since_last_preset;
360 PBD::ScopedConnection _preset_connection;
362 void resolve_midi ();
365 struct PluginPreset {
367 Plugin::PresetRecord _preset;
369 PluginPreset (PluginInfoPtr pip, const Plugin::PresetRecord *preset = NULL)
373 _preset.uri = preset->uri;
374 _preset.label = preset->label;
375 _preset.user = preset->user;
376 _preset.valid = preset->valid;
381 typedef boost::shared_ptr<PluginPreset> PluginPresetPtr;
382 typedef std::list<PluginPresetPtr> PluginPresetList;
384 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
386 class LIBARDOUR_API PluginInfo {
389 virtual ~PluginInfo () { }
392 std::string category;
397 ARDOUR::PluginType type;
399 std::string unique_id;
401 virtual PluginPtr load (Session& session) = 0;
402 virtual bool is_instrument() const;
403 virtual bool needs_midi_input() const { return is_instrument (); }
404 virtual bool in_category (const std::string &) const { return false; }
406 virtual std::vector<Plugin::PresetRecord> get_presets (bool user_only) const = 0;
408 /* NOTE: this block of virtual methods looks like the interface
409 to a Processor, but Plugin does not inherit from Processor.
410 It is therefore not required that these precisely match
411 the interface, but it is likely that they will evolve together.
414 /* this returns true if the plugin can change its inputs or outputs on demand.
415 LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
418 virtual bool reconfigurable_io() const { return false; }
421 friend class PluginManager;
425 } // namespace ARDOUR
427 #endif /* __ardour_plugin_h__ */