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 class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
61 Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
62 Plugin (const Plugin&);
65 XMLNode& get_state ();
66 virtual int set_state (const XMLNode &, int version);
68 virtual void set_insert_id (PBD::ID id) {}
69 virtual void set_state_dir (const std::string& d = "") {}
71 virtual std::string unique_id() const = 0;
72 virtual const char * label() const = 0;
73 virtual const char * name() const = 0;
74 virtual const char * maker() const = 0;
75 virtual uint32_t parameter_count () const = 0;
76 virtual float default_value (uint32_t port) = 0;
77 virtual float get_parameter(uint32_t which) const = 0;
78 virtual std::string get_docs () const { return ""; }
79 virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
81 virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
82 virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
83 virtual void activate () = 0;
84 virtual void deactivate () = 0;
85 virtual void flush () { deactivate(); activate(); }
87 virtual int set_block_size (pframes_t nframes) = 0;
88 virtual bool requires_fixed_sized_buffers() const { return false; }
89 virtual bool inplace_broken() const { return false; }
91 virtual int connect_and_run (BufferSet& bufs,
92 ChanMapping in, ChanMapping out,
93 pframes_t nframes, framecnt_t offset);
95 virtual std::set<Evoral::Parameter> automatable() const = 0;
96 virtual std::string describe_parameter (Evoral::Parameter) = 0;
97 virtual std::string state_node_name() const = 0;
98 virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
100 virtual bool parameter_is_audio(uint32_t) const = 0;
101 virtual bool parameter_is_control(uint32_t) const = 0;
102 virtual bool parameter_is_input(uint32_t) const = 0;
103 virtual bool parameter_is_output(uint32_t) const = 0;
105 virtual void set_automation_control (uint32_t /*port_index*/, boost::shared_ptr<ARDOUR::AutomationControl>) { }
107 virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
108 return boost::shared_ptr<ScalePoints>();
111 void realtime_handle_transport_stopped ();
112 void realtime_locate ();
113 void monitoring_changed ();
120 } Display_Image_Surface;
122 virtual bool has_inline_display () { return false; }
123 virtual Display_Image_Surface* render_inline_display (uint32_t, uint32_t) { return NULL; }
124 PBD::Signal0<void> QueueDraw;
126 struct PresetRecord {
127 PresetRecord () : valid (false) {}
128 PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s), valid (true) {}
130 bool operator!= (PresetRecord const & a) const {
131 return uri != a.uri || label != a.label;
140 PresetRecord save_preset (std::string);
141 void remove_preset (std::string);
143 virtual bool load_preset (PresetRecord);
144 void clear_preset ();
146 const PresetRecord * preset_by_label (const std::string &);
147 const PresetRecord * preset_by_uri (const std::string &);
149 std::vector<PresetRecord> get_presets ();
151 /** @return true if this plugin will respond to MIDI program
152 * change messages by changing presets.
154 * This is hard to return a correct value for because most plugin APIs
155 * do not specify plugin behaviour. However, if you want to force
156 * the display of plugin built-in preset names rather than MIDI program
157 * numbers, return true. If you want a generic description, return
160 virtual bool presets_are_MIDI_programs() const { return false; }
162 /** @return true if this plugin is General MIDI compliant, false
165 * It is important to note that it is is almost impossible for a host
166 * (e.g. Ardour) to determine this for just about any plugin API
167 * known as of June 2012
169 virtual bool current_preset_uses_general_midi() const { return false; }
171 /** @return Last preset to be requested; the settings may have
172 * been changed since; find out with parameter_changed_since_last_preset.
174 PresetRecord last_preset () const {
178 bool parameter_changed_since_last_preset () const {
179 return _parameter_changed_since_last_preset;
182 virtual int first_user_preset_index () const {
186 /** Emitted when a preset is added or removed, respectively */
187 PBD::Signal0<void> PresetAdded;
188 PBD::Signal0<void> PresetRemoved;
190 /** Emitted when any preset has been changed */
191 static PBD::Signal2<void, std::string, Plugin*> PresetsChanged;
193 /** Emitted when a preset has been loaded */
194 PBD::Signal0<void> PresetLoaded;
196 /** Emitted when a parameter is altered in a way that may have
197 * changed the settings with respect to any loaded preset.
199 PBD::Signal0<void> PresetDirty;
201 virtual bool has_editor () const = 0;
203 /** Emitted when a parameter is altered by something outside of our
204 * control, most typically a Plugin GUI/editor
206 PBD::Signal2<void, uint32_t, float> ParameterChangedExternally;
208 virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
210 /* specific types of plugins can overload this. As of September 2008, only
213 virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) { return false; }
214 virtual ChanCount output_streams() const;
215 virtual ChanCount input_streams() const;
217 PluginInfoPtr get_info() const { return _info; }
218 virtual void set_info (const PluginInfoPtr inf);
220 ARDOUR::AudioEngine& engine() const { return _engine; }
221 ARDOUR::Session& session() const { return _session; }
223 void set_cycles (uint32_t c) { _cycles = c; }
224 cycles_t cycles() const { return _cycles; }
226 typedef std::map<uint32_t, ParameterDescriptor> PropertyDescriptors;
228 /** Get a descrption of all properties supported by this plugin.
230 * Properties are distinct from parameters in that they are potentially
231 * dynamic, referred to by key, and do not correspond 1:1 with ports.
233 * For LV2 plugins, properties are implemented by sending/receiving set/get
234 * messages to/from the plugin via event ports.
236 virtual const PropertyDescriptors& get_supported_properties() const {
237 static const PropertyDescriptors nothing;
241 virtual const ParameterDescriptor& get_property_descriptor(uint32_t id) const {
242 static const ParameterDescriptor nothing;
246 /** Set a property from the UI.
248 * This is not UI-specific, but may only be used by one thread. If the
249 * Ardour UI is present, that is the UI thread, but otherwise, any thread
250 * except the audio thread may call this function as long as it is not
251 * called concurrently.
253 virtual void set_property(uint32_t key, const Variant& value) {}
255 /** Emit PropertyChanged for all current property values. */
256 virtual void announce_property_values() {}
258 /** Emitted when a property is changed in the plugin. */
259 PBD::Signal2<void, uint32_t, Variant> PropertyChanged;
261 PBD::Signal1<void,uint32_t> StartTouch;
262 PBD::Signal1<void,uint32_t> EndTouch;
266 friend class PluginInsert;
267 friend class Session;
269 /* Called when a parameter of the plugin is changed outside of this
270 * host's control (typical via a plugin's own GUI/editor)
272 void parameter_changed_externally (uint32_t which, float val);
274 /* should be overridden by plugin API specific derived types to
275 * actually implement changing the parameter. The derived type should
276 * call this after the change is made.
278 virtual void set_parameter (uint32_t which, float val);
280 /** Do the actual saving of the current plugin settings to a preset of the provided name.
281 * Should return a URI on success, or an empty string on failure.
283 virtual std::string do_save_preset (std::string) = 0;
284 /** Do the actual removal of a preset of the provided name */
285 virtual void do_remove_preset (std::string) = 0;
287 ARDOUR::AudioEngine& _engine;
288 ARDOUR::Session& _session;
291 std::map<std::string, PresetRecord> _presets;
295 /** Fill _presets with our presets */
296 virtual void find_presets () = 0;
298 void update_presets (std::string src_unique_id, Plugin* src );
300 /** Add state to an existing XMLNode */
301 virtual void add_state (XMLNode *) const = 0;
304 MidiStateTracker _tracker;
305 BufferSet _pending_stop_events;
306 bool _have_pending_stop_events;
307 PresetRecord _last_preset;
308 bool _parameter_changed_since_last_preset;
310 PBD::ScopedConnection _preset_connection;
312 void resolve_midi ();
315 struct PluginPreset {
317 Plugin::PresetRecord _preset;
319 PluginPreset (PluginInfoPtr pip, const Plugin::PresetRecord *preset = NULL)
323 _preset.uri = preset->uri;
324 _preset.label = preset->label;
325 _preset.user = preset->user;
326 _preset.valid = preset->valid;
331 typedef boost::shared_ptr<PluginPreset> PluginPresetPtr;
332 typedef std::list<PluginPresetPtr> PluginPresetList;
334 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
336 class LIBARDOUR_API PluginInfo {
339 virtual ~PluginInfo () { }
342 std::string category;
347 ARDOUR::PluginType type;
349 std::string unique_id;
351 virtual PluginPtr load (Session& session) = 0;
352 virtual bool is_instrument() const;
353 virtual bool in_category (const std::string &) const { return false; }
355 virtual std::vector<Plugin::PresetRecord> get_presets (bool user_only) const = 0;
357 /* NOTE: this block of virtual methods looks like the interface
358 to a Processor, but Plugin does not inherit from Processor.
359 It is therefore not required that these precisely match
360 the interface, but it is likely that they will evolve together.
363 /* this returns true if the plugin can change its inputs or outputs on demand.
364 LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
367 virtual bool reconfigurable_io() const { return false; }
370 friend class PluginManager;
374 } // namespace ARDOUR
376 #endif /* __ardour_plugin_h__ */