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