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