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 <jack/types.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/plugin_insert.h"
35 #include "ardour/types.h"
36 #include "ardour/midi_state_tracker.h"
50 typedef boost::shared_ptr<Plugin> PluginPtr;
55 virtual ~PluginInfo () { }
63 ARDOUR::PluginType type;
65 std::string unique_id;
67 virtual PluginPtr load (Session& session) = 0;
68 virtual bool is_instrument() const;
70 /* NOTE: this block of virtual methods looks like the interface
71 to a Processor, but Plugin does not inherit from Processor.
72 It is therefore not required that these precisely match
73 the interface, but it is likely that they will evolve together.
76 /* this returns true if the plugin can change its inputs or outputs on demand.
77 LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
80 virtual bool reconfigurable_io() const { return false; }
83 friend class PluginManager;
87 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
88 typedef std::list<PluginInfoPtr> PluginInfoList;
90 class Plugin : public PBD::StatefulDestructible, public Latent
93 Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
94 Plugin (const Plugin&);
97 struct ParameterDescriptor {
99 ParameterDescriptor ()
100 : integer_step(false)
102 , logarithmic (false)
103 , sr_dependent (false)
111 , enumeration (false)
115 /* essentially a union of LADSPA, VST and LV2 info */
122 float lower; ///< if this is a frequency, it will be in Hz (not a fraction of the sample rate)
123 float upper; ///< if this is a frequency, it will be in Hz (not a fraction of the sample rate)
130 bool midinote; ///< only used if integer_step is also true
133 XMLNode& get_state ();
134 virtual int set_state (const XMLNode &, int version);
136 virtual void set_insert_info (const PluginInsert*) {}
138 virtual std::string unique_id() const = 0;
139 virtual const char * label() const = 0;
140 virtual const char * name() const = 0;
141 virtual const char * maker() const = 0;
142 virtual uint32_t parameter_count () const = 0;
143 virtual float default_value (uint32_t port) = 0;
144 virtual float get_parameter(uint32_t which) const = 0;
145 virtual std::string get_docs () const { return ""; }
146 virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
148 virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
149 virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
150 virtual void activate () = 0;
151 virtual void deactivate () = 0;
152 virtual void flush () { deactivate(); activate(); }
154 virtual int set_block_size (pframes_t nframes) = 0;
156 virtual int connect_and_run (BufferSet& bufs,
157 ChanMapping in, ChanMapping out,
158 pframes_t nframes, framecnt_t offset);
160 virtual std::set<Evoral::Parameter> automatable() const = 0;
161 virtual std::string describe_parameter (Evoral::Parameter) = 0;
162 virtual std::string state_node_name() const = 0;
163 virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
165 virtual bool parameter_is_audio(uint32_t) const = 0;
166 virtual bool parameter_is_control(uint32_t) const = 0;
167 virtual bool parameter_is_input(uint32_t) const = 0;
168 virtual bool parameter_is_output(uint32_t) const = 0;
170 typedef std::map<const std::string, const float> ScalePoints;
172 virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
173 return boost::shared_ptr<ScalePoints>();
176 void realtime_handle_transport_stopped ();
177 void realtime_locate ();
178 void monitoring_changed ();
180 struct PresetRecord {
181 PresetRecord () : number (-1), user (true) {}
182 PresetRecord (const std::string& u, const std::string& l, int n = -1, bool s = true) : uri (u), label (l), number (n), user (s) {}
184 bool operator!= (PresetRecord const & a) const {
185 return number != a.number || uri != a.uri || label != a.label;
190 int number; // if <0, invalid
194 PresetRecord save_preset (std::string);
195 void remove_preset (std::string);
197 virtual bool load_preset (PresetRecord);
198 void clear_preset ();
200 const PresetRecord * preset_by_label (const std::string &);
201 const PresetRecord * preset_by_uri (const std::string &);
203 std::vector<PresetRecord> get_presets ();
205 /** @return true if this plugin will respond to MIDI program
206 * change messages by changing presets.
208 * This is hard to return a correct value for because most plugin APIs
209 * do not specify plugin behaviour. However, if you want to force
210 * the display of plugin built-in preset names rather than MIDI program
211 * numbers, return true. If you want a generic description, return
214 virtual bool presets_are_MIDI_programs() const { return false; }
216 /** @return true if this plugin is General MIDI compliant, false
219 * It is important to note that it is is almost impossible for a host
220 * (e.g. Ardour) to determine this for just about any plugin API
221 * known as of June 2012
223 virtual bool current_preset_uses_general_midi() const { return false; }
225 /** @return Last preset to be requested; the settings may have
226 * been changed since; find out with parameter_changed_since_last_preset.
228 PresetRecord last_preset () const {
232 bool parameter_changed_since_last_preset () const {
233 return _parameter_changed_since_last_preset;
236 virtual int first_user_preset_index () const {
240 /** Emitted when a preset is added or removed, respectively */
241 PBD::Signal0<void> PresetAdded;
242 PBD::Signal0<void> PresetRemoved;
244 /** Emitted when a preset has been loaded */
245 PBD::Signal0<void> PresetLoaded;
247 virtual bool has_editor () const = 0;
249 /** Emitted when any parameter changes */
250 PBD::Signal2<void, uint32_t, float> ParameterChanged;
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*/) { 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 PBD::Signal1<void,uint32_t> StartTouch;
271 PBD::Signal1<void,uint32_t> EndTouch;
275 friend class PluginInsert;
276 friend struct PluginInsert::PluginControl;
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 /** Add state to an existing XMLNode */
299 virtual void add_state (XMLNode *) const = 0;
302 MidiStateTracker _tracker;
303 BufferSet _pending_stop_events;
304 bool _have_pending_stop_events;
305 PresetRecord _last_preset;
306 bool _parameter_changed_since_last_preset;
308 void resolve_midi ();
311 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
313 } // namespace ARDOUR
315 #endif /* __ardour_plugin_h__ */