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 class AutomationControl;
54 typedef boost::shared_ptr<Plugin> PluginPtr;
55 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
56 typedef std::list<PluginInfoPtr> PluginInfoList;
58 /** A plugin is an external module (usually 3rd party provided) loaded into Ardour
59 * for the purpose of digital signal processing.
61 * This class provides an abstraction for methords provided by
62 * all supported plugin standards such as presets, name, parameters etc.
64 * Plugins are not used directly in Ardour but always wrapped by a PluginInsert.
66 class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
69 Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
70 Plugin (const Plugin&);
73 XMLNode& get_state ();
74 virtual int set_state (const XMLNode &, int version);
76 virtual void set_insert_id (PBD::ID id) {}
77 virtual void set_state_dir (const std::string& d = "") {}
79 virtual std::string unique_id() const = 0;
80 virtual const char * label() const = 0;
81 virtual const char * name() const = 0;
82 virtual const char * maker() const = 0;
83 virtual uint32_t parameter_count () const = 0;
84 virtual float default_value (uint32_t port) = 0;
85 virtual float get_parameter(uint32_t which) const = 0;
86 virtual std::string get_docs () const { return ""; }
87 virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
89 virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
90 virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
91 virtual void activate () = 0;
92 virtual void deactivate () = 0;
93 virtual void flush () { deactivate(); activate(); }
95 virtual int set_block_size (pframes_t nframes) = 0;
96 virtual bool requires_fixed_sized_buffers() const { return false; }
97 virtual bool inplace_broken() const { return false; }
99 virtual int connect_and_run (BufferSet& bufs,
100 ChanMapping in, ChanMapping out,
101 pframes_t nframes, framecnt_t offset);
103 virtual std::set<Evoral::Parameter> automatable() const = 0;
104 virtual std::string describe_parameter (Evoral::Parameter) = 0;
105 virtual std::string state_node_name() const = 0;
106 virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
108 virtual bool parameter_is_audio(uint32_t) const = 0;
109 virtual bool parameter_is_control(uint32_t) const = 0;
110 virtual bool parameter_is_input(uint32_t) const = 0;
111 virtual bool parameter_is_output(uint32_t) const = 0;
113 struct LIBARDOUR_API IOPortDescription {
115 IOPortDescription (const std::string& n)
117 , is_sidechain (false)
119 IOPortDescription (const IOPortDescription &other)
121 , is_sidechain (other.is_sidechain)
127 virtual IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id);
129 virtual void set_automation_control (uint32_t /*port_index*/, boost::shared_ptr<ARDOUR::AutomationControl>) { }
131 virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
132 return boost::shared_ptr<ScalePoints>();
135 void realtime_handle_transport_stopped ();
136 void realtime_locate ();
137 void monitoring_changed ();
144 } Display_Image_Surface;
146 virtual bool has_inline_display () { return false; }
147 virtual Display_Image_Surface* render_inline_display (uint32_t, uint32_t) { return NULL; }
148 PBD::Signal0<void> QueueDraw;
150 struct PresetRecord {
151 PresetRecord () : valid (false) {}
152 PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s), valid (true) {}
154 bool operator!= (PresetRecord const & a) const {
155 return uri != a.uri || label != a.label;
164 PresetRecord save_preset (std::string);
165 void remove_preset (std::string);
167 virtual bool load_preset (PresetRecord);
168 void clear_preset ();
170 const PresetRecord * preset_by_label (const std::string &);
171 const PresetRecord * preset_by_uri (const std::string &);
173 std::vector<PresetRecord> get_presets ();
175 /** @return true if this plugin will respond to MIDI program
176 * change messages by changing presets.
178 * This is hard to return a correct value for because most plugin APIs
179 * do not specify plugin behaviour. However, if you want to force
180 * the display of plugin built-in preset names rather than MIDI program
181 * numbers, return true. If you want a generic description, return
184 virtual bool presets_are_MIDI_programs() const { return false; }
186 /** @return true if this plugin is General MIDI compliant, false
189 * It is important to note that it is is almost impossible for a host
190 * (e.g. Ardour) to determine this for just about any plugin API
191 * known as of June 2012
193 virtual bool current_preset_uses_general_midi() const { return false; }
195 /** @return Last preset to be requested; the settings may have
196 * been changed since; find out with parameter_changed_since_last_preset.
198 PresetRecord last_preset () const {
202 bool parameter_changed_since_last_preset () const {
203 return _parameter_changed_since_last_preset;
206 virtual int first_user_preset_index () const {
210 /** Emitted when a Latency Changes
212 * (this cannot be part of ARDOUR::Latent because
213 * signals cannot be copy-constructed).
215 PBD::Signal2<void,framecnt_t, framecnt_t> LatencyChanged;
217 /* overload Latent::set_user_latency w/signal emission */
218 virtual void set_user_latency (framecnt_t val) {
219 bool changed = val != _user_latency;
220 framecnt_t old = effective_latency ();
223 LatencyChanged (old, effective_latency ()); /* EMIT SIGNAL */
227 /** the max possible latency a plugin will have */
228 virtual framecnt_t max_latency () const { return 0; } // TODO = 0, require implementation
230 /** Emitted when a preset is added or removed, respectively */
231 PBD::Signal0<void> PresetAdded;
232 PBD::Signal0<void> PresetRemoved;
234 /** Emitted when any preset has been changed */
235 static PBD::Signal2<void, std::string, Plugin*> PresetsChanged;
237 /** Emitted when a preset has been loaded */
238 PBD::Signal0<void> PresetLoaded;
240 /** Emitted when a parameter is altered in a way that may have
241 * changed the settings with respect to any loaded preset.
243 PBD::Signal0<void> PresetDirty;
245 virtual bool has_editor () const = 0;
247 /** Emitted when a parameter is altered by something outside of our
248 * control, most typically a Plugin GUI/editor
250 PBD::Signal2<void, uint32_t, float> ParameterChangedExternally;
252 virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
254 /* specific types of plugins can overload this. As of September 2008, only
257 virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/, ChanCount* imprecise = 0) { return false; }
258 virtual ChanCount output_streams() const;
259 virtual ChanCount input_streams() const;
261 PluginInfoPtr get_info() const { return _info; }
262 virtual void set_info (const PluginInfoPtr inf);
264 ARDOUR::AudioEngine& engine() const { return _engine; }
265 ARDOUR::Session& session() const { return _session; }
267 void set_cycles (uint32_t c) { _cycles = c; }
268 cycles_t cycles() const { return _cycles; }
270 typedef std::map<uint32_t, ParameterDescriptor> PropertyDescriptors;
272 /** Get a descrption of all properties supported by this plugin.
274 * Properties are distinct from parameters in that they are potentially
275 * dynamic, referred to by key, and do not correspond 1:1 with ports.
277 * For LV2 plugins, properties are implemented by sending/receiving set/get
278 * messages to/from the plugin via event ports.
280 virtual const PropertyDescriptors& get_supported_properties() const {
281 static const PropertyDescriptors nothing;
285 virtual const ParameterDescriptor& get_property_descriptor(uint32_t id) const {
286 static const ParameterDescriptor nothing;
290 /** Set a property from the UI.
292 * This is not UI-specific, but may only be used by one thread. If the
293 * Ardour UI is present, that is the UI thread, but otherwise, any thread
294 * except the audio thread may call this function as long as it is not
295 * called concurrently.
297 virtual void set_property(uint32_t key, const Variant& value) {}
299 /** Emit PropertyChanged for all current property values. */
300 virtual void announce_property_values() {}
302 /** Emitted when a property is changed in the plugin. */
303 PBD::Signal2<void, uint32_t, Variant> PropertyChanged;
305 PBD::Signal1<void,uint32_t> StartTouch;
306 PBD::Signal1<void,uint32_t> EndTouch;
310 friend class PluginInsert;
311 friend class Session;
313 /* Called when a parameter of the plugin is changed outside of this
314 * host's control (typical via a plugin's own GUI/editor)
316 void parameter_changed_externally (uint32_t which, float val);
318 /* should be overridden by plugin API specific derived types to
319 * actually implement changing the parameter. The derived type should
320 * call this after the change is made.
322 virtual void set_parameter (uint32_t which, float val);
324 /** Do the actual saving of the current plugin settings to a preset of the provided name.
325 * Should return a URI on success, or an empty string on failure.
327 virtual std::string do_save_preset (std::string) = 0;
328 /** Do the actual removal of a preset of the provided name */
329 virtual void do_remove_preset (std::string) = 0;
331 ARDOUR::AudioEngine& _engine;
332 ARDOUR::Session& _session;
335 std::map<std::string, PresetRecord> _presets;
339 /** Fill _presets with our presets */
340 virtual void find_presets () = 0;
342 void update_presets (std::string src_unique_id, Plugin* src );
344 /** Add state to an existing XMLNode */
345 virtual void add_state (XMLNode *) const = 0;
348 MidiStateTracker _tracker;
349 BufferSet _pending_stop_events;
350 bool _have_pending_stop_events;
351 PresetRecord _last_preset;
352 bool _parameter_changed_since_last_preset;
354 PBD::ScopedConnection _preset_connection;
356 void resolve_midi ();
359 struct PluginPreset {
361 Plugin::PresetRecord _preset;
363 PluginPreset (PluginInfoPtr pip, const Plugin::PresetRecord *preset = NULL)
367 _preset.uri = preset->uri;
368 _preset.label = preset->label;
369 _preset.user = preset->user;
370 _preset.valid = preset->valid;
375 typedef boost::shared_ptr<PluginPreset> PluginPresetPtr;
376 typedef std::list<PluginPresetPtr> PluginPresetList;
378 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
380 class LIBARDOUR_API PluginInfo {
383 virtual ~PluginInfo () { }
386 std::string category;
391 ARDOUR::PluginType type;
393 std::string unique_id;
395 virtual PluginPtr load (Session& session) = 0;
396 virtual bool is_instrument() const;
397 virtual bool in_category (const std::string &) const { return false; }
399 virtual std::vector<Plugin::PresetRecord> get_presets (bool user_only) const = 0;
401 /* NOTE: this block of virtual methods looks like the interface
402 to a Processor, but Plugin does not inherit from Processor.
403 It is therefore not required that these precisely match
404 the interface, but it is likely that they will evolve together.
407 /* this returns true if the plugin can change its inputs or outputs on demand.
408 LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
411 virtual bool reconfigurable_io() const { return false; }
414 friend class PluginManager;
418 } // namespace ARDOUR
420 #endif /* __ardour_plugin_h__ */