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