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