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 typedef boost::shared_ptr<Plugin> PluginPtr;
54 class LIBARDOUR_API PluginInfo {
57 virtual ~PluginInfo () { }
65 ARDOUR::PluginType type;
67 std::string unique_id;
69 virtual PluginPtr load (Session& session) = 0;
70 virtual bool is_instrument() const;
71 virtual bool in_category (const std::string &) const { return false; }
73 /* NOTE: this block of virtual methods looks like the interface
74 to a Processor, but Plugin does not inherit from Processor.
75 It is therefore not required that these precisely match
76 the interface, but it is likely that they will evolve together.
79 /* this returns true if the plugin can change its inputs or outputs on demand.
80 LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
83 virtual bool reconfigurable_io() const { return false; }
86 friend class PluginManager;
90 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
91 typedef std::list<PluginInfoPtr> PluginInfoList;
93 class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
96 Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
97 Plugin (const Plugin&);
100 XMLNode& get_state ();
101 virtual int set_state (const XMLNode &, int version);
103 virtual void set_insert_id (PBD::ID id) {}
104 virtual void set_state_dir (const std::string& d = "") {}
106 virtual std::string unique_id() const = 0;
107 virtual const char * label() const = 0;
108 virtual const char * name() const = 0;
109 virtual const char * maker() const = 0;
110 virtual uint32_t parameter_count () const = 0;
111 virtual float default_value (uint32_t port) = 0;
112 virtual float get_parameter(uint32_t which) const = 0;
113 virtual std::string get_docs () const { return ""; }
114 virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
116 virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
117 virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
118 virtual void activate () = 0;
119 virtual void deactivate () = 0;
120 virtual void flush () { deactivate(); activate(); }
122 virtual int set_block_size (pframes_t nframes) = 0;
124 virtual int connect_and_run (BufferSet& bufs,
125 ChanMapping in, ChanMapping out,
126 pframes_t nframes, framecnt_t offset);
128 virtual std::set<Evoral::Parameter> automatable() const = 0;
129 virtual std::string describe_parameter (Evoral::Parameter) = 0;
130 virtual std::string state_node_name() const = 0;
131 virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
133 virtual bool parameter_is_audio(uint32_t) const = 0;
134 virtual bool parameter_is_control(uint32_t) const = 0;
135 virtual bool parameter_is_input(uint32_t) const = 0;
136 virtual bool parameter_is_output(uint32_t) const = 0;
138 virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
139 return boost::shared_ptr<ScalePoints>();
142 void realtime_handle_transport_stopped ();
143 void realtime_locate ();
144 void monitoring_changed ();
146 struct PresetRecord {
147 PresetRecord () : valid (false) {}
148 PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s), valid (true) {}
150 bool operator!= (PresetRecord const & a) const {
151 return uri != a.uri || label != a.label;
160 PresetRecord save_preset (std::string);
161 void remove_preset (std::string);
163 virtual bool load_preset (PresetRecord);
164 void clear_preset ();
166 const PresetRecord * preset_by_label (const std::string &);
167 const PresetRecord * preset_by_uri (const std::string &);
169 std::vector<PresetRecord> get_presets ();
171 /** @return true if this plugin will respond to MIDI program
172 * change messages by changing presets.
174 * This is hard to return a correct value for because most plugin APIs
175 * do not specify plugin behaviour. However, if you want to force
176 * the display of plugin built-in preset names rather than MIDI program
177 * numbers, return true. If you want a generic description, return
180 virtual bool presets_are_MIDI_programs() const { return false; }
182 /** @return true if this plugin is General MIDI compliant, false
185 * It is important to note that it is is almost impossible for a host
186 * (e.g. Ardour) to determine this for just about any plugin API
187 * known as of June 2012
189 virtual bool current_preset_uses_general_midi() const { return false; }
191 /** @return Last preset to be requested; the settings may have
192 * been changed since; find out with parameter_changed_since_last_preset.
194 PresetRecord last_preset () const {
198 bool parameter_changed_since_last_preset () const {
199 return _parameter_changed_since_last_preset;
202 virtual int first_user_preset_index () const {
206 /** Emitted when a preset is added or removed, respectively */
207 PBD::Signal0<void> PresetAdded;
208 PBD::Signal0<void> PresetRemoved;
210 /** Emitted when any preset has been changed */
211 static PBD::Signal2<void, std::string, Plugin*> PresetsChanged;
213 /** Emitted when a preset has been loaded */
214 PBD::Signal0<void> PresetLoaded;
216 /** Emitted when a parameter is altered in a way that may have
217 * changed the settings with respect to any loaded preset.
219 PBD::Signal0<void> PresetDirty;
221 virtual bool has_editor () const = 0;
223 /** Emitted when a parameter is altered by something outside of our
224 * control, most typically a Plugin GUI/editor
226 PBD::Signal2<void, uint32_t, float> ParameterChangedExternally;
228 virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
230 /* specific types of plugins can overload this. As of September 2008, only
233 virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) { return false; }
234 virtual ChanCount output_streams() const;
235 virtual ChanCount input_streams() const;
237 PluginInfoPtr get_info() const { return _info; }
238 virtual void set_info (const PluginInfoPtr inf);
240 ARDOUR::AudioEngine& engine() const { return _engine; }
241 ARDOUR::Session& session() const { return _session; }
243 void set_cycles (uint32_t c) { _cycles = c; }
244 cycles_t cycles() const { return _cycles; }
246 typedef std::map<uint32_t, ParameterDescriptor> PropertyDescriptors;
248 /** Get a descrption of all properties supported by this plugin.
250 * Properties are distinct from parameters in that they are potentially
251 * dynamic, referred to by key, and do not correspond 1:1 with ports.
253 * For LV2 plugins, properties are implemented by sending/receiving set/get
254 * messages to/from the plugin via event ports.
256 virtual const PropertyDescriptors& get_supported_properties() const {
257 static const PropertyDescriptors nothing;
261 virtual const ParameterDescriptor& get_property_descriptor(uint32_t id) const {
262 static const ParameterDescriptor nothing;
266 /** Set a property from the UI.
268 * This is not UI-specific, but may only be used by one thread. If the
269 * Ardour UI is present, that is the UI thread, but otherwise, any thread
270 * except the audio thread may call this function as long as it is not
271 * called concurrently.
273 virtual void set_property(uint32_t key, const Variant& value) {}
275 /** Emit PropertyChanged for all current property values. */
276 virtual void announce_property_values() {}
278 /** Emitted when a property is changed in the plugin. */
279 PBD::Signal2<void, uint32_t, Variant> PropertyChanged;
281 PBD::Signal1<void,uint32_t> StartTouch;
282 PBD::Signal1<void,uint32_t> EndTouch;
286 friend class PluginInsert;
287 friend class Session;
289 /* Called when a parameter of the plugin is changed outside of this
290 * host's control (typical via a plugin's own GUI/editor)
292 void parameter_changed_externally (uint32_t which, float val);
294 /* should be overridden by plugin API specific derived types to
295 * actually implement changing the parameter. The derived type should
296 * call this after the change is made.
298 virtual void set_parameter (uint32_t which, float val);
300 /** Do the actual saving of the current plugin settings to a preset of the provided name.
301 * Should return a URI on success, or an empty string on failure.
303 virtual std::string do_save_preset (std::string) = 0;
304 /** Do the actual removal of a preset of the provided name */
305 virtual void do_remove_preset (std::string) = 0;
307 ARDOUR::AudioEngine& _engine;
308 ARDOUR::Session& _session;
311 std::map<std::string, PresetRecord> _presets;
315 /** Fill _presets with our presets */
316 virtual void find_presets () = 0;
318 void update_presets (std::string src_unique_id, Plugin* src );
320 /** Add state to an existing XMLNode */
321 virtual void add_state (XMLNode *) const = 0;
324 MidiStateTracker _tracker;
325 BufferSet _pending_stop_events;
326 bool _have_pending_stop_events;
327 PresetRecord _last_preset;
328 bool _parameter_changed_since_last_preset;
330 PBD::ScopedConnection _preset_connection;
332 void resolve_midi ();
335 struct PluginPreset {
337 Plugin::PresetRecord _preset;
339 PluginPreset (PluginInfoPtr pip, const Plugin::PresetRecord *preset = NULL)
343 _preset.uri = preset->uri;
344 _preset.label = preset->label;
345 _preset.user = preset->user;
346 _preset.valid = preset->valid;
351 typedef boost::shared_ptr<PluginPreset> PluginPresetPtr;
352 typedef std::list<PluginPresetPtr> PluginPresetList;
354 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
356 } // namespace ARDOUR
358 #endif /* __ardour_plugin_h__ */