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