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;
56 typedef boost::shared_ptr<Plugin> PluginPtr;
57 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
58 typedef std::list<PluginInfoPtr> PluginInfoList;
59 typedef std::set<uint32_t> PluginOutputConfiguration;
61 /** A plugin is an external module (usually 3rd party provided) loaded into Ardour
62 * for the purpose of digital signal processing.
64 * This class provides an abstraction for methords provided by
65 * all supported plugin standards such as presets, name, parameters etc.
67 * Plugins are not used directly in Ardour but always wrapped by a PluginInsert.
69 class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
72 Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
73 Plugin (const Plugin&);
76 XMLNode& get_state ();
77 virtual int set_state (const XMLNode &, int version);
79 virtual void set_insert_id (PBD::ID id) {}
80 virtual void set_state_dir (const std::string& d = "") {}
82 virtual std::string unique_id() const = 0;
83 virtual const char * label() const = 0;
84 virtual const char * name() const = 0;
85 virtual const char * maker() const = 0;
86 virtual uint32_t parameter_count () const = 0;
87 virtual float default_value (uint32_t port) = 0;
88 virtual float get_parameter(uint32_t which) const = 0;
89 virtual std::string get_docs () const { return ""; }
90 virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
94 : x0(-1), x1(-1), y0(-1), y1(-1), knob(false) {}
102 virtual bool get_layout (uint32_t which, UILayoutHint&) const { return false; }
104 virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
105 virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
106 virtual void activate () = 0;
107 virtual void deactivate () = 0;
108 virtual void flush () { deactivate(); activate(); }
110 virtual int set_block_size (pframes_t nframes) = 0;
111 virtual bool requires_fixed_sized_buffers() const { return false; }
112 virtual bool inplace_broken() const { return false; }
114 virtual int connect_and_run (BufferSet& bufs,
115 framepos_t start, framepos_t end, double speed,
116 ChanMapping in, ChanMapping out,
117 pframes_t nframes, framecnt_t offset);
119 virtual std::set<Evoral::Parameter> automatable() const = 0;
120 virtual std::string describe_parameter (Evoral::Parameter) = 0;
121 virtual std::string state_node_name() const = 0;
122 virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
124 virtual bool parameter_is_audio(uint32_t) const = 0;
125 virtual bool parameter_is_control(uint32_t) const = 0;
126 virtual bool parameter_is_input(uint32_t) const = 0;
127 virtual bool parameter_is_output(uint32_t) const = 0;
129 virtual uint32_t designated_bypass_port () { return UINT32_MAX; }
131 struct LIBARDOUR_API IOPortDescription {
133 IOPortDescription (const std::string& n)
135 , is_sidechain (false)
139 IOPortDescription (const IOPortDescription &other)
141 , is_sidechain (other.is_sidechain)
142 , group_name (other.group_name)
143 , group_channel (other.group_channel)
148 std::string group_name;
149 uint32_t group_channel;
152 virtual IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id) const;
153 virtual PluginOutputConfiguration possible_output () const;
155 virtual void set_automation_control (uint32_t /*port_index*/, boost::shared_ptr<ARDOUR::AutomationControl>) { }
157 virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
158 return boost::shared_ptr<ScalePoints>();
161 void realtime_handle_transport_stopped ();
162 void realtime_locate ();
163 void monitoring_changed ();
170 } Display_Image_Surface;
172 virtual bool has_inline_display () { return false; }
173 virtual Display_Image_Surface* render_inline_display (uint32_t, uint32_t) { return NULL; }
174 PBD::Signal0<void> QueueDraw;
176 virtual bool has_midnam () { return false; }
177 virtual bool read_midnam () { return false; }
178 virtual std::string midnam_model () { return ""; }
179 PBD::Signal0<void> UpdateMidnam;
181 struct PresetRecord {
182 PresetRecord () : valid (false) {}
183 PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s), valid (true) {}
185 bool operator!= (PresetRecord const & a) const {
186 return uri != a.uri || label != a.label;
195 PresetRecord save_preset (std::string);
196 void remove_preset (std::string);
198 virtual bool load_preset (PresetRecord);
199 void clear_preset ();
201 const PresetRecord * preset_by_label (const std::string &);
202 const PresetRecord * preset_by_uri (const std::string &);
204 std::vector<PresetRecord> get_presets ();
206 /** @return true if this plugin will respond to MIDI program
207 * change messages by changing presets.
209 * This is hard to return a correct value for because most plugin APIs
210 * do not specify plugin behaviour. However, if you want to force
211 * the display of plugin built-in preset names rather than MIDI program
212 * numbers, return true. If you want a generic description, return
215 virtual bool presets_are_MIDI_programs() const { return false; }
217 /** @return true if this plugin is General MIDI compliant, false
220 * It is important to note that it is is almost impossible for a host
221 * (e.g. Ardour) to determine this for just about any plugin API
222 * known as of June 2012
224 virtual bool current_preset_uses_general_midi() const { return false; }
226 /** @return Last preset to be requested; the settings may have
227 * been changed since; find out with parameter_changed_since_last_preset.
229 PresetRecord last_preset () const {
233 bool parameter_changed_since_last_preset () const {
234 return _parameter_changed_since_last_preset;
237 virtual int first_user_preset_index () const {
241 /** the max possible latency a plugin will have */
242 virtual framecnt_t max_latency () const { return 0; } // TODO = 0, require implementation
244 /** Emitted when a preset is added or removed, respectively */
245 PBD::Signal0<void> PresetAdded;
246 PBD::Signal0<void> PresetRemoved;
248 /** Emitted when any preset has been changed */
249 static PBD::Signal2<void, std::string, Plugin*> PresetsChanged;
251 /** Emitted when a preset has been loaded */
252 PBD::Signal0<void> PresetLoaded;
254 /** Emitted when a parameter is altered in a way that may have
255 * changed the settings with respect to any loaded preset.
257 PBD::Signal0<void> PresetDirty;
259 /** Emitted for preset-load to set a control-port */
260 PBD::Signal2<void, uint32_t, float> PresetPortSetValue;
262 virtual bool has_editor () const = 0;
264 /** Emitted when a parameter is altered by something outside of our
265 * control, most typically a Plugin GUI/editor
267 PBD::Signal2<void, uint32_t, float> ParameterChangedExternally;
269 virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
271 /* specific types of plugins can overload this. As of September 2008, only
274 virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/, ChanCount* imprecise = 0) { return false; }
275 virtual ChanCount output_streams() const;
276 virtual ChanCount input_streams() const;
278 PluginInfoPtr get_info() const { return _info; }
279 virtual void set_info (const PluginInfoPtr inf);
281 virtual void set_owner (SessionObject* o) { _owner = o; }
282 SessionObject* owner() const { return _owner; }
284 ARDOUR::AudioEngine& engine() const { return _engine; }
285 ARDOUR::Session& session() const { return _session; }
287 void set_cycles (uint32_t c) { _cycles = c; }
288 cycles_t cycles() const { return _cycles; }
290 typedef std::map<uint32_t, ParameterDescriptor> PropertyDescriptors;
292 /** Get a descrption of all properties supported by this plugin.
294 * Properties are distinct from parameters in that they are potentially
295 * dynamic, referred to by key, and do not correspond 1:1 with ports.
297 * For LV2 plugins, properties are implemented by sending/receiving set/get
298 * messages to/from the plugin via event ports.
300 virtual const PropertyDescriptors& get_supported_properties() const {
301 static const PropertyDescriptors nothing;
305 virtual const ParameterDescriptor& get_property_descriptor(uint32_t id) const {
306 static const ParameterDescriptor nothing;
310 /** Set a property from the UI.
312 * This is not UI-specific, but may only be used by one thread. If the
313 * Ardour UI is present, that is the UI thread, but otherwise, any thread
314 * except the audio thread may call this function as long as it is not
315 * called concurrently.
317 virtual void set_property(uint32_t key, const Variant& value) {}
319 /** Emit PropertyChanged for all current property values. */
320 virtual void announce_property_values() {}
322 /** Emitted when a property is changed in the plugin. */
323 PBD::Signal2<void, uint32_t, Variant> PropertyChanged;
325 PBD::Signal1<void,uint32_t> StartTouch;
326 PBD::Signal1<void,uint32_t> EndTouch;
330 friend class PluginInsert;
331 friend class Session;
333 /* Called when a parameter of the plugin is changed outside of this
334 * host's control (typical via a plugin's own GUI/editor)
336 virtual void parameter_changed_externally (uint32_t which, float val);
338 /* should be overridden by plugin API specific derived types to
339 * actually implement changing the parameter. The derived type should
340 * call this after the change is made.
342 virtual void set_parameter (uint32_t which, float val);
344 /** Do the actual saving of the current plugin settings to a preset of the provided name.
345 * Should return a URI on success, or an empty string on failure.
347 virtual std::string do_save_preset (std::string) = 0;
348 /** Do the actual removal of a preset of the provided name */
349 virtual void do_remove_preset (std::string) = 0;
351 ARDOUR::AudioEngine& _engine;
352 ARDOUR::Session& _session;
355 std::map<std::string, PresetRecord> _presets;
357 SessionObject* _owner;
361 /** Fill _presets with our presets */
362 virtual void find_presets () = 0;
364 /** Add state to an existing XMLNode */
365 virtual void add_state (XMLNode *) const = 0;
368 MidiStateTracker _tracker;
369 BufferSet _pending_stop_events;
370 bool _have_pending_stop_events;
371 PresetRecord _last_preset;
372 bool _parameter_changed_since_last_preset;
374 PBD::ScopedConnection _preset_connection;
376 void resolve_midi ();
379 struct PluginPreset {
381 Plugin::PresetRecord _preset;
383 PluginPreset (PluginInfoPtr pip, const Plugin::PresetRecord *preset = NULL)
387 _preset.uri = preset->uri;
388 _preset.label = preset->label;
389 _preset.user = preset->user;
390 _preset.valid = preset->valid;
395 typedef boost::shared_ptr<PluginPreset> PluginPresetPtr;
396 typedef std::list<PluginPresetPtr> PluginPresetList;
398 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
400 class LIBARDOUR_API PluginInfo {
403 virtual ~PluginInfo () { }
406 std::string category;
411 ARDOUR::PluginType type;
413 std::string unique_id;
415 virtual PluginPtr load (Session& session) = 0;
416 virtual bool is_instrument() const;
417 virtual bool needs_midi_input() const;
418 virtual bool in_category (const std::string &) const { return false; }
420 virtual std::vector<Plugin::PresetRecord> get_presets (bool user_only) const = 0;
422 /* NOTE: this block of virtual methods looks like the interface
423 to a Processor, but Plugin does not inherit from Processor.
424 It is therefore not required that these precisely match
425 the interface, but it is likely that they will evolve together.
428 /* this returns true if the plugin can change its inputs or outputs on demand.
429 LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
432 virtual bool reconfigurable_io() const { return false; }
435 friend class PluginManager;
439 } // namespace ARDOUR
441 #endif /* __ardour_plugin_h__ */