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_ring_buffer.h"
37 #include "ardour/midi_state_tracker.h"
38 #include "ardour/parameter_descriptor.h"
39 #include "ardour/types.h"
40 #include "ardour/variant.h"
54 class AutomationControl;
57 typedef boost::shared_ptr<Plugin> PluginPtr;
58 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
59 typedef std::list<PluginInfoPtr> PluginInfoList;
60 typedef std::set<uint32_t> PluginOutputConfiguration;
62 /** A plugin is an external module (usually 3rd party provided) loaded into Ardour
63 * for the purpose of digital signal processing.
65 * This class provides an abstraction for methords provided by
66 * all supported plugin standards such as presets, name, parameters etc.
68 * Plugins are not used directly in Ardour but always wrapped by a PluginInsert.
70 class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
73 Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
74 Plugin (const Plugin&);
77 XMLNode& get_state ();
78 virtual int set_state (const XMLNode &, int version);
80 virtual void set_insert_id (PBD::ID id) {}
81 virtual void set_state_dir (const std::string& d = "") {}
83 virtual std::string unique_id() const = 0;
84 virtual const char * label() const = 0;
85 virtual const char * name() const = 0;
86 virtual const char * maker() const = 0;
87 virtual uint32_t parameter_count () const = 0;
88 virtual float default_value (uint32_t port) = 0;
89 virtual float get_parameter(uint32_t which) const = 0;
90 virtual std::string get_docs () const { return ""; }
91 virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
95 : x0(-1), x1(-1), y0(-1), y1(-1), knob(false) {}
103 virtual bool get_layout (uint32_t which, UILayoutHint&) const { return false; }
105 virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
106 virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
107 virtual std::string parameter_label (uint32_t which) const;
108 virtual void activate () = 0;
109 virtual void deactivate () = 0;
110 virtual void flush () { deactivate(); activate(); }
112 virtual int set_block_size (pframes_t nframes) = 0;
113 virtual bool requires_fixed_sized_buffers() const { return false; }
114 virtual bool inplace_broken() const { return false; }
116 virtual int connect_and_run (BufferSet& bufs,
117 samplepos_t start, samplepos_t end, double speed,
118 ChanMapping const& in, ChanMapping const& out,
119 pframes_t nframes, samplecnt_t offset);
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 virtual uint32_t designated_bypass_port () { return UINT32_MAX; }
133 struct LIBARDOUR_API IOPortDescription {
135 IOPortDescription (const std::string& n)
137 , is_sidechain (false)
141 IOPortDescription (const IOPortDescription &other)
143 , is_sidechain (other.is_sidechain)
144 , group_name (other.group_name)
145 , group_channel (other.group_channel)
150 std::string group_name;
151 uint32_t group_channel;
154 virtual IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id) const;
155 virtual PluginOutputConfiguration possible_output () const;
157 virtual void set_automation_control (uint32_t /*port_index*/, boost::shared_ptr<ARDOUR::AutomationControl>) { }
159 virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
160 return boost::shared_ptr<ScalePoints>();
163 bool write_immediate_event (size_t size, const uint8_t* buf);
165 void realtime_handle_transport_stopped ();
166 void realtime_locate ();
167 void monitoring_changed ();
174 } Display_Image_Surface;
176 virtual bool has_inline_display () { return false; }
177 virtual bool inline_display_in_gui () { return false; }
178 virtual Display_Image_Surface* render_inline_display (uint32_t, uint32_t) { return NULL; }
179 PBD::Signal0<void> QueueDraw;
181 virtual bool has_midnam () { return false; }
182 virtual bool read_midnam () { return false; }
183 virtual std::string midnam_model () { return ""; }
184 PBD::Signal0<void> UpdateMidnam;
185 PBD::Signal0<void> UpdatedMidnam;
187 virtual bool knows_bank_patch () { return false; }
188 virtual uint32_t bank_patch (uint8_t chn) { return UINT32_MAX; }
189 PBD::Signal1<void, uint8_t> BankPatchChange;
191 struct PresetRecord {
192 PresetRecord () : valid (false) {}
193 PresetRecord (const std::string& u, const std::string& l, bool s = true, const std::string& d = "")
194 : uri (u), label (l), description (d), user (s), valid (true) {}
196 bool operator!= (PresetRecord const & a) const {
197 return uri != a.uri || label != a.label;
202 std::string description;
207 PresetRecord save_preset (std::string);
208 void remove_preset (std::string);
210 virtual bool load_preset (PresetRecord);
211 void clear_preset ();
213 const PresetRecord * preset_by_label (const std::string &);
214 const PresetRecord * preset_by_uri (const std::string &);
216 std::vector<PresetRecord> get_presets ();
218 /** @return true if this plugin will respond to MIDI program
219 * change messages by changing presets.
221 * This is hard to return a correct value for because most plugin APIs
222 * do not specify plugin behaviour. However, if you want to force
223 * the display of plugin built-in preset names rather than MIDI program
224 * numbers, return true. If you want a generic description, return
227 virtual bool presets_are_MIDI_programs() const { return false; }
229 /** @return true if this plugin is General MIDI compliant, false
232 * It is important to note that it is is almost impossible for a host
233 * (e.g. Ardour) to determine this for just about any plugin API
234 * known as of June 2012
236 virtual bool current_preset_uses_general_midi() const { return false; }
238 /** @return Last preset to be requested; the settings may have
239 * been changed since; find out with parameter_changed_since_last_preset.
241 PresetRecord last_preset () const {
245 bool parameter_changed_since_last_preset () const {
246 return _parameter_changed_since_last_preset;
249 virtual int first_user_preset_index () const {
253 /** the max possible latency a plugin will have */
254 virtual samplecnt_t max_latency () const { return 0; } // TODO = 0, require implementation
256 /** Emitted when a preset is added or removed, respectively */
257 PBD::Signal0<void> PresetAdded;
258 PBD::Signal0<void> PresetRemoved;
260 /** Emitted when any preset has been changed */
261 static PBD::Signal2<void, std::string, Plugin*> PresetsChanged;
263 /** Emitted when a preset has been loaded */
264 PBD::Signal0<void> PresetLoaded;
266 /** Emitted when a parameter is altered in a way that may have
267 * changed the settings with respect to any loaded preset.
269 PBD::Signal0<void> PresetDirty;
271 /** Emitted for preset-load to set a control-port */
272 PBD::Signal2<void, uint32_t, float> PresetPortSetValue;
274 virtual bool has_editor () const = 0;
276 /** Emitted when a parameter is altered by something outside of our
277 * control, most typically a Plugin GUI/editor
279 PBD::Signal2<void, uint32_t, float> ParameterChangedExternally;
281 virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
283 /* specific types of plugins can overload this. As of September 2008, only
286 virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/, ChanCount* imprecise = 0) { return false; }
287 virtual ChanCount output_streams() const;
288 virtual ChanCount input_streams() const;
290 PluginInfoPtr get_info() const { return _info; }
291 virtual void set_info (const PluginInfoPtr inf);
293 virtual void set_owner (SessionObject* o) { _owner = o; }
294 SessionObject* owner() const { return _owner; }
296 ARDOUR::AudioEngine& engine() const { return _engine; }
297 ARDOUR::Session& session() const { return _session; }
299 void set_cycles (uint32_t c) { _cycles = c; }
300 cycles_t cycles() const { return _cycles; }
302 typedef std::map<uint32_t, ParameterDescriptor> PropertyDescriptors;
304 /** Get a descrption of all properties supported by this plugin.
306 * Properties are distinct from parameters in that they are potentially
307 * dynamic, referred to by key, and do not correspond 1:1 with ports.
309 * For LV2 plugins, properties are implemented by sending/receiving set/get
310 * messages to/from the plugin via event ports.
312 virtual const PropertyDescriptors& get_supported_properties() const {
313 static const PropertyDescriptors nothing;
317 virtual const ParameterDescriptor& get_property_descriptor(uint32_t id) const {
318 static const ParameterDescriptor nothing;
322 /** Set a property from the UI.
324 * This is not UI-specific, but may only be used by one thread. If the
325 * Ardour UI is present, that is the UI thread, but otherwise, any thread
326 * except the audio thread may call this function as long as it is not
327 * called concurrently.
329 virtual void set_property(uint32_t key, const Variant& value) {}
331 /** Emit PropertyChanged for all current property values. */
332 virtual void announce_property_values() {}
334 /** Emitted when a property is changed in the plugin. */
335 PBD::Signal2<void, uint32_t, Variant> PropertyChanged;
337 PBD::Signal1<void,uint32_t> StartTouch;
338 PBD::Signal1<void,uint32_t> EndTouch;
342 friend class PluginInsert;
343 friend class Session;
345 /* Called when a parameter of the plugin is changed outside of this
346 * host's control (typical via a plugin's own GUI/editor)
348 virtual void parameter_changed_externally (uint32_t which, float val);
350 /* should be overridden by plugin API specific derived types to
351 * actually implement changing the parameter. The derived type should
352 * call this after the change is made.
354 virtual void set_parameter (uint32_t which, float val);
356 /** Do the actual saving of the current plugin settings to a preset of the provided name.
357 * Should return a URI on success, or an empty string on failure.
359 virtual std::string do_save_preset (std::string) = 0;
360 /** Do the actual removal of a preset of the provided name */
361 virtual void do_remove_preset (std::string) = 0;
363 ARDOUR::AudioEngine& _engine;
364 ARDOUR::Session& _session;
367 std::map<std::string, PresetRecord> _presets;
369 SessionObject* _owner;
373 /** Fill _presets with our presets */
374 virtual void find_presets () = 0;
376 /** Add state to an existing XMLNode */
377 virtual void add_state (XMLNode *) const = 0;
380 MidiStateTracker _tracker;
381 BufferSet _pending_stop_events;
382 bool _have_pending_stop_events;
383 PresetRecord _last_preset;
384 bool _parameter_changed_since_last_preset;
386 PBD::ScopedConnection _preset_connection;
388 MidiRingBuffer<samplepos_t> _immediate_events;
390 void resolve_midi ();
393 struct PluginPreset {
395 Plugin::PresetRecord _preset;
397 PluginPreset (PluginInfoPtr pip, const Plugin::PresetRecord *preset = NULL)
401 _preset.uri = preset->uri;
402 _preset.label = preset->label;
403 _preset.user = preset->user;
404 _preset.valid = preset->valid;
409 typedef boost::shared_ptr<PluginPreset> PluginPresetPtr;
410 typedef std::list<PluginPresetPtr> PluginPresetList;
412 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
414 class LIBARDOUR_API PluginInfo {
417 virtual ~PluginInfo () { }
420 std::string category;
425 ARDOUR::PluginType type;
427 std::string unique_id;
429 virtual PluginPtr load (Session& session) = 0;
431 /* NOTE: it is possible for a plugin to be an effect AND an instrument.
432 * override these funcs as necessary to support that.
434 virtual bool is_effect () const;
435 virtual bool is_instrument () const;
436 virtual bool is_utility () const; //this includes things like "generators" and "midi filters"
437 virtual bool is_analyzer () const;
439 virtual bool needs_midi_input() const;
441 virtual std::vector<Plugin::PresetRecord> get_presets (bool user_only) const = 0;
443 /* NOTE: this block of virtual methods looks like the interface
444 to a Processor, but Plugin does not inherit from Processor.
445 It is therefore not required that these precisely match
446 the interface, but it is likely that they will evolve together.
449 /* this returns true if the plugin can change its inputs or outputs on demand.
450 LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
453 virtual bool reconfigurable_io() const { return false; }
456 friend class PluginManager;
460 } // namespace ARDOUR
462 #endif /* __ardour_plugin_h__ */