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