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