libs/ardour/ardour/plugin.h

   1 /*
   2     Copyright (C) 2000-2006 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __ardour_plugin_h__
  21 #define __ardour_plugin_h__
  22
  23 #include <boost/shared_ptr.hpp>
  24 #include <string>
  25 #include <set>
  26
  27 #include "pbd/statefuldestructible.h"
  28 #include "pbd/controllable.h"
  29
  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"
  40
  41 #include <vector>
  42 #include <set>
  43 #include <map>
  44
  45 namespace ARDOUR {
  46
  47 class AudioEngine;
  48 class Session;
  49 class BufferSet;
  50 class PluginInsert;
  51 class Plugin;
  52 class PluginInfo;
  53 class AutomationControl;
  54
  55 typedef boost::shared_ptr<Plugin> PluginPtr;
  56 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
  57 typedef std::list<PluginInfoPtr> PluginInfoList;
  58 typedef std::set<uint32_t> PluginOutputConfiguration;
  59
  60 /** A plugin is an external module (usually 3rd party provided) loaded into Ardour
  61  * for the purpose of digital signal processing.
  62  *
  63  * This class provides an abstraction for methords provided by
  64  * all supported plugin standards such as presets, name, parameters etc.
  65  *
  66  * Plugins are not used directly in Ardour but always wrapped by a PluginInsert.
  67  */
  68 class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
  69 {
  70   public:
  71         Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
  72         Plugin (const Plugin&);
  73         virtual ~Plugin ();
  74
  75         XMLNode& get_state ();
  76         virtual int set_state (const XMLNode &, int version);
  77
  78         virtual void set_insert_id (PBD::ID id) {}
  79         virtual void set_state_dir (const std::string& d = "") {}
  80
  81         virtual std::string unique_id() const = 0;
  82         virtual const char * label() const = 0;
  83         virtual const char * name() const = 0;
  84         virtual const char * maker() const = 0;
  85         virtual uint32_t parameter_count () const = 0;
  86         virtual float default_value (uint32_t port) = 0;
  87         virtual float get_parameter(uint32_t which) const = 0;
  88         virtual std::string get_docs () const { return ""; }
  89         virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
  90
  91         struct UILayoutHint {
  92                 UILayoutHint ()
  93                         : x0(-1), x1(-1), y0(-1), y1(-1), knob(false) {}
  94                 int x0;
  95                 int x1;
  96                 int y0;
  97                 int y1;
  98                 bool knob;
  99         };
 100
 101         virtual bool get_layout (uint32_t which, UILayoutHint&) const { return false; }
 102
 103         virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
 104         virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
 105         virtual void activate () = 0;
 106         virtual void deactivate () = 0;
 107         virtual void flush () { deactivate(); activate(); }
 108
 109         virtual int set_block_size (pframes_t nframes) = 0;
 110         virtual bool requires_fixed_sized_buffers() const { return false; }
 111         virtual bool inplace_broken() const { return false; }
 112
 113         virtual int connect_and_run (BufferSet& bufs,
 114                         framepos_t start, framepos_t end, double speed,
 115                         ChanMapping in, ChanMapping out,
 116                         pframes_t nframes, framecnt_t offset);
 117
 118         virtual std::set<Evoral::Parameter> automatable() const = 0;
 119         virtual std::string describe_parameter (Evoral::Parameter) = 0;
 120         virtual std::string state_node_name() const = 0;
 121         virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
 122
 123         virtual bool parameter_is_audio(uint32_t) const = 0;
 124         virtual bool parameter_is_control(uint32_t) const = 0;
 125         virtual bool parameter_is_input(uint32_t) const = 0;
 126         virtual bool parameter_is_output(uint32_t) const = 0;
 127
 128         virtual uint32_t designated_bypass_port () { return UINT32_MAX; }
 129
 130         struct LIBARDOUR_API IOPortDescription {
 131                 public:
 132                 IOPortDescription (const std::string& n)
 133                         : name (n)
 134                         , is_sidechain (false)
 135                 {}
 136                 IOPortDescription (const IOPortDescription &other)
 137                         : name (other.name)
 138                         , is_sidechain (other.is_sidechain)
 139                 {}
 140                 std::string name;
 141                 bool is_sidechain;
 142         };
 143
 144         virtual IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id) const;
 145         virtual PluginOutputConfiguration possible_output () const;
 146
 147         virtual void set_automation_control (uint32_t /*port_index*/, boost::shared_ptr<ARDOUR::AutomationControl>) { }
 148
 149         virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
 150                 return boost::shared_ptr<ScalePoints>();
 151         }
 152
 153         void realtime_handle_transport_stopped ();
 154         void realtime_locate ();
 155         void monitoring_changed ();
 156
 157         typedef struct {
 158                 unsigned char *data;
 159                 int width;
 160                 int height;
 161                 int stride;
 162         } Display_Image_Surface;
 163
 164         virtual bool has_inline_display () { return false; }
 165         virtual Display_Image_Surface* render_inline_display (uint32_t, uint32_t) { return NULL; }
 166         PBD::Signal0<void> QueueDraw;
 167
 168         struct PresetRecord {
 169             PresetRecord () : valid (false) {}
 170             PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s), valid (true)  {}
 171
 172             bool operator!= (PresetRecord const & a) const {
 173                     return uri != a.uri || label != a.label;
 174             }
 175
 176             std::string uri;
 177             std::string label;
 178             bool user;
 179             bool valid;
 180         };
 181
 182         PresetRecord save_preset (std::string);
 183         void remove_preset (std::string);
 184
 185         virtual bool load_preset (PresetRecord);
 186         void clear_preset ();
 187
 188         const PresetRecord * preset_by_label (const std::string &);
 189         const PresetRecord * preset_by_uri (const std::string &);
 190
 191         std::vector<PresetRecord> get_presets ();
 192
 193         /** @return true if this plugin will respond to MIDI program
 194          * change messages by changing presets.
 195          *
 196          * This is hard to return a correct value for because most plugin APIs
 197          * do not specify plugin behaviour. However, if you want to force
 198          * the display of plugin built-in preset names rather than MIDI program
 199          * numbers, return true. If you want a generic description, return
 200          * false.
 201          */
 202         virtual bool presets_are_MIDI_programs() const { return false; }
 203
 204         /** @return true if this plugin is General MIDI compliant, false
 205          * otherwise.
 206          *
 207          * It is important to note that it is is almost impossible for a host
 208          * (e.g. Ardour) to determine this for just about any plugin API
 209          * known as of June 2012
 210          */
 211         virtual bool current_preset_uses_general_midi() const { return false; }
 212
 213         /** @return Last preset to be requested; the settings may have
 214          * been changed since; find out with parameter_changed_since_last_preset.
 215          */
 216         PresetRecord last_preset () const {
 217                 return _last_preset;
 218         }
 219
 220         bool parameter_changed_since_last_preset () const {
 221                 return _parameter_changed_since_last_preset;
 222         }
 223
 224         virtual int first_user_preset_index () const {
 225                 return 0;
 226         }
 227
 228         /** Emitted when a Latency Changes
 229          *
 230          * (this cannot be part of ARDOUR::Latent because
 231          * signals cannot be copy-constructed).
 232          */
 233         PBD::Signal2<void,framecnt_t, framecnt_t> LatencyChanged;
 234
 235         /* overload Latent::set_user_latency w/signal emission */
 236         virtual void set_user_latency (framecnt_t val) {
 237                 bool changed = val != _user_latency;
 238                 framecnt_t old = effective_latency ();
 239                 _user_latency = val;
 240                 if (changed) {
 241                         LatencyChanged (old, effective_latency ()); /* EMIT SIGNAL */
 242                 }
 243         }
 244
 245         /** the max possible latency a plugin will have */
 246         virtual framecnt_t max_latency () const { return 0; } // TODO = 0, require implementation
 247
 248         /** Emitted when a preset is added or removed, respectively */
 249         PBD::Signal0<void> PresetAdded;
 250         PBD::Signal0<void> PresetRemoved;
 251
 252         /** Emitted when any preset has been changed */
 253         static PBD::Signal2<void, std::string, Plugin*> PresetsChanged;
 254
 255         /** Emitted when a preset has been loaded */
 256         PBD::Signal0<void> PresetLoaded;
 257
 258         /** Emitted when a parameter is altered in a way that may have
 259          *  changed the settings with respect to any loaded preset.
 260          */
 261         PBD::Signal0<void> PresetDirty;
 262
 263         virtual bool has_editor () const = 0;
 264
 265         /** Emitted when a parameter is altered by something outside of our
 266          * control, most typically a Plugin GUI/editor
 267          */
 268         PBD::Signal2<void, uint32_t, float> ParameterChangedExternally;
 269
 270         virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
 271
 272         /* specific types of plugins can overload this. As of September 2008, only
 273            AUPlugin does this.
 274         */
 275         virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/, ChanCount* imprecise = 0) { return false; }
 276         virtual ChanCount output_streams() const;
 277         virtual ChanCount input_streams() const;
 278
 279         PluginInfoPtr get_info() const { return _info; }
 280         virtual void set_info (const PluginInfoPtr inf);
 281
 282         ARDOUR::AudioEngine& engine() const { return _engine; }
 283         ARDOUR::Session& session() const { return _session; }
 284
 285         void set_cycles (uint32_t c) { _cycles = c; }
 286         cycles_t cycles() const { return _cycles; }
 287
 288         typedef std::map<uint32_t, ParameterDescriptor> PropertyDescriptors;
 289
 290         /** Get a descrption of all properties supported by this plugin.
 291          *
 292          * Properties are distinct from parameters in that they are potentially
 293          * dynamic, referred to by key, and do not correspond 1:1 with ports.
 294          *
 295          * For LV2 plugins, properties are implemented by sending/receiving set/get
 296          * messages to/from the plugin via event ports.
 297          */
 298         virtual const PropertyDescriptors& get_supported_properties() const {
 299                 static const PropertyDescriptors nothing;
 300                 return nothing;
 301         }
 302
 303         virtual const ParameterDescriptor& get_property_descriptor(uint32_t id) const {
 304                 static const ParameterDescriptor nothing;
 305                 return nothing;
 306         }
 307
 308         /** Set a property from the UI.
 309          *
 310          * This is not UI-specific, but may only be used by one thread.  If the
 311          * Ardour UI is present, that is the UI thread, but otherwise, any thread
 312          * except the audio thread may call this function as long as it is not
 313          * called concurrently.
 314          */
 315         virtual void set_property(uint32_t key, const Variant& value) {}
 316
 317         /** Emit PropertyChanged for all current property values. */
 318         virtual void announce_property_values() {}
 319
 320         /** Emitted when a property is changed in the plugin. */
 321         PBD::Signal2<void, uint32_t, Variant> PropertyChanged;
 322
 323         PBD::Signal1<void,uint32_t> StartTouch;
 324         PBD::Signal1<void,uint32_t> EndTouch;
 325
 326 protected:
 327
 328         friend class PluginInsert;
 329         friend class Session;
 330
 331         /* Called when a parameter of the plugin is changed outside of this
 332          * host's control (typical via a plugin's own GUI/editor)
 333          */
 334         void parameter_changed_externally (uint32_t which, float val);
 335
 336         /* should be overridden by plugin API specific derived types to
 337          * actually implement changing the parameter. The derived type should
 338          * call this after the change is made.
 339          */
 340         virtual void set_parameter (uint32_t which, float val);
 341
 342         /** Do the actual saving of the current plugin settings to a preset of the provided name.
 343          *  Should return a URI on success, or an empty string on failure.
 344          */
 345         virtual std::string do_save_preset (std::string) = 0;
 346         /** Do the actual removal of a preset of the provided name */
 347         virtual void do_remove_preset (std::string) = 0;
 348
 349         ARDOUR::AudioEngine&     _engine;
 350         ARDOUR::Session&         _session;
 351         PluginInfoPtr            _info;
 352         uint32_t                 _cycles;
 353         std::map<std::string, PresetRecord> _presets;
 354
 355 private:
 356
 357         /** Fill _presets with our presets */
 358         virtual void find_presets () = 0;
 359
 360         void update_presets (std::string src_unique_id, Plugin* src );
 361
 362         /** Add state to an existing XMLNode */
 363         virtual void add_state (XMLNode *) const = 0;
 364
 365         bool _have_presets;
 366         MidiStateTracker _tracker;
 367         BufferSet _pending_stop_events;
 368         bool _have_pending_stop_events;
 369         PresetRecord _last_preset;
 370         bool _parameter_changed_since_last_preset;
 371
 372         PBD::ScopedConnection _preset_connection;
 373
 374         void resolve_midi ();
 375 };
 376
 377 struct PluginPreset {
 378         PluginInfoPtr   _pip;
 379         Plugin::PresetRecord _preset;
 380
 381         PluginPreset (PluginInfoPtr pip, const Plugin::PresetRecord *preset = NULL)
 382                 : _pip (pip)
 383         {
 384                 if (preset) {
 385                         _preset.uri    = preset->uri;
 386                         _preset.label  = preset->label;
 387                         _preset.user   = preset->user;
 388                         _preset.valid  = preset->valid;
 389                 }
 390         }
 391 };
 392
 393 typedef boost::shared_ptr<PluginPreset> PluginPresetPtr;
 394 typedef std::list<PluginPresetPtr> PluginPresetList;
 395
 396 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
 397
 398 class LIBARDOUR_API PluginInfo {
 399   public:
 400         PluginInfo () { }
 401         virtual ~PluginInfo () { }
 402
 403         std::string name;
 404         std::string category;
 405         std::string creator;
 406         std::string path;
 407         ChanCount n_inputs;
 408         ChanCount n_outputs;
 409         ARDOUR::PluginType type;
 410
 411         std::string unique_id;
 412
 413         virtual PluginPtr load (Session& session) = 0;
 414         virtual bool is_instrument() const;
 415         virtual bool needs_midi_input() const { return is_instrument (); }
 416         virtual bool in_category (const std::string &) const { return false; }
 417
 418         virtual std::vector<Plugin::PresetRecord> get_presets (bool user_only) const = 0;
 419
 420         /* NOTE: this block of virtual methods looks like the interface
 421            to a Processor, but Plugin does not inherit from Processor.
 422            It is therefore not required that these precisely match
 423            the interface, but it is likely that they will evolve together.
 424         */
 425
 426         /* this returns true if the plugin can change its inputs or outputs on demand.
 427            LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
 428         */
 429
 430         virtual bool reconfigurable_io() const { return false; }
 431
 432   protected:
 433         friend class PluginManager;
 434         uint32_t index;
 435 };
 436
 437 } // namespace ARDOUR
 438
 439 #endif /* __ardour_plugin_h__ */