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