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