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)
137 IOPortDescription (const IOPortDescription &other)
139 , is_sidechain (other.is_sidechain)
145 virtual IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id) const;
146 virtual PluginOutputConfiguration possible_output () const;
148 virtual void set_automation_control (uint32_t /*port_index*/, boost::shared_ptr<ARDOUR::AutomationControl>) { }
150 virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
151 return boost::shared_ptr<ScalePoints>();
154 void realtime_handle_transport_stopped ();
155 void realtime_locate ();
156 void monitoring_changed ();
163 } Display_Image_Surface;
165 virtual bool has_inline_display () { return false; }
166 virtual Display_Image_Surface* render_inline_display (uint32_t, uint32_t) { return NULL; }
167 PBD::Signal0<void> QueueDraw;
169 virtual bool has_midnam () { return false; }
170 virtual bool read_midnam () { return false; }
171 virtual std::string midnam_model () { return ""; }
172 PBD::Signal0<void> UpdateMidnam;
174 struct PresetRecord {
175 PresetRecord () : valid (false) {}
176 PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s), valid (true) {}
178 bool operator!= (PresetRecord const & a) const {
179 return uri != a.uri || label != a.label;
188 PresetRecord save_preset (std::string);
189 void remove_preset (std::string);
191 virtual bool load_preset (PresetRecord);
192 void clear_preset ();
194 const PresetRecord * preset_by_label (const std::string &);
195 const PresetRecord * preset_by_uri (const std::string &);
197 std::vector<PresetRecord> get_presets ();
199 /** @return true if this plugin will respond to MIDI program
200 * change messages by changing presets.
202 * This is hard to return a correct value for because most plugin APIs
203 * do not specify plugin behaviour. However, if you want to force
204 * the display of plugin built-in preset names rather than MIDI program
205 * numbers, return true. If you want a generic description, return
208 virtual bool presets_are_MIDI_programs() const { return false; }
210 /** @return true if this plugin is General MIDI compliant, false
213 * It is important to note that it is is almost impossible for a host
214 * (e.g. Ardour) to determine this for just about any plugin API
215 * known as of June 2012
217 virtual bool current_preset_uses_general_midi() const { return false; }
219 /** @return Last preset to be requested; the settings may have
220 * been changed since; find out with parameter_changed_since_last_preset.
222 PresetRecord last_preset () const {
226 bool parameter_changed_since_last_preset () const {
227 return _parameter_changed_since_last_preset;
230 virtual int first_user_preset_index () const {
234 /** the max possible latency a plugin will have */
235 virtual framecnt_t max_latency () const { return 0; } // TODO = 0, require implementation
237 /** Emitted when a preset is added or removed, respectively */
238 PBD::Signal0<void> PresetAdded;
239 PBD::Signal0<void> PresetRemoved;
241 /** Emitted when any preset has been changed */
242 static PBD::Signal2<void, std::string, Plugin*> PresetsChanged;
244 /** Emitted when a preset has been loaded */
245 PBD::Signal0<void> PresetLoaded;
247 /** Emitted when a parameter is altered in a way that may have
248 * changed the settings with respect to any loaded preset.
250 PBD::Signal0<void> PresetDirty;
252 virtual bool has_editor () const = 0;
254 /** Emitted when a parameter is altered by something outside of our
255 * control, most typically a Plugin GUI/editor
257 PBD::Signal2<void, uint32_t, float> ParameterChangedExternally;
259 virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
261 /* specific types of plugins can overload this. As of September 2008, only
264 virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/, ChanCount* imprecise = 0) { return false; }
265 virtual ChanCount output_streams() const;
266 virtual ChanCount input_streams() const;
268 PluginInfoPtr get_info() const { return _info; }
269 virtual void set_info (const PluginInfoPtr inf);
271 virtual void set_owner (SessionObject* o) { _owner = o; }
272 SessionObject* owner() const { return _owner; }
274 ARDOUR::AudioEngine& engine() const { return _engine; }
275 ARDOUR::Session& session() const { return _session; }
277 void set_cycles (uint32_t c) { _cycles = c; }
278 cycles_t cycles() const { return _cycles; }
280 typedef std::map<uint32_t, ParameterDescriptor> PropertyDescriptors;
282 /** Get a descrption of all properties supported by this plugin.
284 * Properties are distinct from parameters in that they are potentially
285 * dynamic, referred to by key, and do not correspond 1:1 with ports.
287 * For LV2 plugins, properties are implemented by sending/receiving set/get
288 * messages to/from the plugin via event ports.
290 virtual const PropertyDescriptors& get_supported_properties() const {
291 static const PropertyDescriptors nothing;
295 virtual const ParameterDescriptor& get_property_descriptor(uint32_t id) const {
296 static const ParameterDescriptor nothing;
300 /** Set a property from the UI.
302 * This is not UI-specific, but may only be used by one thread. If the
303 * Ardour UI is present, that is the UI thread, but otherwise, any thread
304 * except the audio thread may call this function as long as it is not
305 * called concurrently.
307 virtual void set_property(uint32_t key, const Variant& value) {}
309 /** Emit PropertyChanged for all current property values. */
310 virtual void announce_property_values() {}
312 /** Emitted when a property is changed in the plugin. */
313 PBD::Signal2<void, uint32_t, Variant> PropertyChanged;
315 PBD::Signal1<void,uint32_t> StartTouch;
316 PBD::Signal1<void,uint32_t> EndTouch;
320 friend class PluginInsert;
321 friend class Session;
323 /* Called when a parameter of the plugin is changed outside of this
324 * host's control (typical via a plugin's own GUI/editor)
326 void parameter_changed_externally (uint32_t which, float val);
328 /* should be overridden by plugin API specific derived types to
329 * actually implement changing the parameter. The derived type should
330 * call this after the change is made.
332 virtual void set_parameter (uint32_t which, float val);
334 /** Do the actual saving of the current plugin settings to a preset of the provided name.
335 * Should return a URI on success, or an empty string on failure.
337 virtual std::string do_save_preset (std::string) = 0;
338 /** Do the actual removal of a preset of the provided name */
339 virtual void do_remove_preset (std::string) = 0;
341 ARDOUR::AudioEngine& _engine;
342 ARDOUR::Session& _session;
345 std::map<std::string, PresetRecord> _presets;
347 SessionObject* _owner;
351 /** Fill _presets with our presets */
352 virtual void find_presets () = 0;
354 void update_presets (std::string src_unique_id, Plugin* src );
356 /** Add state to an existing XMLNode */
357 virtual void add_state (XMLNode *) const = 0;
360 MidiStateTracker _tracker;
361 BufferSet _pending_stop_events;
362 bool _have_pending_stop_events;
363 PresetRecord _last_preset;
364 bool _parameter_changed_since_last_preset;
366 PBD::ScopedConnection _preset_connection;
368 void resolve_midi ();
371 struct PluginPreset {
373 Plugin::PresetRecord _preset;
375 PluginPreset (PluginInfoPtr pip, const Plugin::PresetRecord *preset = NULL)
379 _preset.uri = preset->uri;
380 _preset.label = preset->label;
381 _preset.user = preset->user;
382 _preset.valid = preset->valid;
387 typedef boost::shared_ptr<PluginPreset> PluginPresetPtr;
388 typedef std::list<PluginPresetPtr> PluginPresetList;
390 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
392 class LIBARDOUR_API PluginInfo {
395 virtual ~PluginInfo () { }
398 std::string category;
403 ARDOUR::PluginType type;
405 std::string unique_id;
407 virtual PluginPtr load (Session& session) = 0;
408 virtual bool is_instrument() const;
409 virtual bool needs_midi_input() const;
410 virtual bool in_category (const std::string &) const { return false; }
412 virtual std::vector<Plugin::PresetRecord> get_presets (bool user_only) const = 0;
414 /* NOTE: this block of virtual methods looks like the interface
415 to a Processor, but Plugin does not inherit from Processor.
416 It is therefore not required that these precisely match
417 the interface, but it is likely that they will evolve together.
420 /* this returns true if the plugin can change its inputs or outputs on demand.
421 LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
424 virtual bool reconfigurable_io() const { return false; }
427 friend class PluginManager;
431 } // namespace ARDOUR
433 #endif /* __ardour_plugin_h__ */