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