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