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