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