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   protected:
  71         friend class PluginManager;
  72         uint32_t index;
  73 };
  74
  75 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
  76 typedef std::list<PluginInfoPtr> PluginInfoList;
  77
  78 class Plugin : public PBD::StatefulDestructible, public Latent
  79 {
  80   public:
  81         Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
  82         Plugin (const Plugin&);
  83         virtual ~Plugin ();
  84
  85         struct ParameterDescriptor {
  86
  87                 /* XXX: it would probably be nice if this initialised everything */
  88                 ParameterDescriptor ()
  89                         : enumeration (false)
  90                 {}
  91
  92                 /* essentially a union of LADSPA and VST info */
  93
  94                 bool integer_step;
  95                 bool toggled;
  96                 bool logarithmic;
  97                 bool sr_dependent;
  98                 std::string label;
  99                 float lower; ///< if this is a frequency, it will be in Hz (not a fraction of the sample rate)
 100                 float upper; ///< if this is a frequency, it will be in Hz (not a fraction of the sample rate)
 101                 float step;
 102                 float smallstep;
 103                 float largestep;
 104                 bool min_unbound;
 105                 bool max_unbound;
 106                 bool enumeration;
 107         };
 108
 109         XMLNode& get_state ();
 110         virtual int set_state (const XMLNode &, int version);
 111
 112         virtual void set_insert_info (const PluginInsert*) {}
 113
 114         virtual std::string unique_id() const = 0;
 115         virtual const char * label() const = 0;
 116         virtual const char * name() const = 0;
 117         virtual const char * maker() const = 0;
 118         virtual uint32_t parameter_count () const = 0;
 119         virtual float default_value (uint32_t port) = 0;
 120         virtual float get_parameter(uint32_t which) const = 0;
 121         virtual std::string get_parameter_docs(uint32_t which) const { return ""; }
 122
 123         virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
 124         virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
 125         virtual void activate () = 0;
 126         virtual void deactivate () = 0;
 127         virtual void flush () { deactivate(); activate(); }
 128
 129         virtual int set_block_size (pframes_t nframes) = 0;
 130
 131         virtual int connect_and_run (BufferSet& bufs,
 132                                      ChanMapping in, ChanMapping out,
 133                                      pframes_t nframes, framecnt_t offset);
 134
 135         virtual std::set<Evoral::Parameter> automatable() const = 0;
 136         virtual std::string describe_parameter (Evoral::Parameter) = 0;
 137         virtual std::string state_node_name() const = 0;
 138         virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
 139
 140         virtual bool parameter_is_audio(uint32_t) const = 0;
 141         virtual bool parameter_is_control(uint32_t) const = 0;
 142         virtual bool parameter_is_input(uint32_t) const = 0;
 143         virtual bool parameter_is_output(uint32_t) const = 0;
 144
 145         typedef std::map<const std::string, const float> ScalePoints;
 146
 147         virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
 148                 return boost::shared_ptr<ScalePoints>();
 149         }
 150
 151         void realtime_handle_transport_stopped ();
 152         void realtime_locate ();
 153         void monitoring_changed ();
 154
 155         struct PresetRecord {
 156                 PresetRecord () : user (true) {}
 157                 PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s)  {}
 158
 159                 bool operator!= (PresetRecord const & a) const {
 160                         return uri != a.uri || label != a.label;
 161                 }
 162
 163                 std::string uri;
 164                 std::string label;
 165                 bool user;
 166         };
 167
 168         PresetRecord save_preset (std::string);
 169         void remove_preset (std::string);
 170
 171         virtual bool load_preset (PresetRecord);
 172
 173         const PresetRecord * preset_by_label (const std::string &);
 174         const PresetRecord * preset_by_uri (const std::string &);
 175
 176         std::vector<PresetRecord> get_presets ();
 177
 178         /** @return Last preset to be requested; the settings may have
 179          * been changed since; find out with parameter_changed_since_last_preset.
 180          */
 181         PresetRecord last_preset () const {
 182                 return _last_preset;
 183         }
 184
 185         bool parameter_changed_since_last_preset () const {
 186                 return _parameter_changed_since_last_preset;
 187         }
 188
 189         virtual int first_user_preset_index () const {
 190                 return 0;
 191         }
 192
 193         /** Emitted when a preset is added or removed, respectively */
 194         PBD::Signal0<void> PresetAdded;
 195         PBD::Signal0<void> PresetRemoved;
 196
 197         /** Emitted when a preset has been loaded */
 198         PBD::Signal0<void> PresetLoaded;
 199
 200         virtual bool has_editor () const = 0;
 201
 202         /** Emitted when any parameter changes */
 203         PBD::Signal2<void, uint32_t, float> ParameterChanged;
 204
 205         /* NOTE: this block of virtual methods looks like the interface
 206            to a Processor, but Plugin does not inherit from Processor.
 207            It is therefore not required that these precisely match
 208            the interface, but it is likely that they will evolve together.
 209         */
 210
 211         /* this returns true if the plugin can change its inputs or outputs on demand.
 212            LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
 213         */
 214
 215         virtual bool reconfigurable_io() const { return false; }
 216
 217         /* this is only called if reconfigurable_io() returns true */
 218         virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
 219
 220         /* specific types of plugins can overload this. As of September 2008, only
 221            AUPlugin does this.
 222         */
 223         virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) const { return false; }
 224         virtual ChanCount output_streams() const;
 225         virtual ChanCount input_streams() const;
 226
 227         PluginInfoPtr get_info() const { return _info; }
 228         virtual void set_info (const PluginInfoPtr inf);
 229
 230         ARDOUR::AudioEngine& engine() const { return _engine; }
 231         ARDOUR::Session& session() const { return _session; }
 232
 233         void set_cycles (uint32_t c) { _cycles = c; }
 234         cycles_t cycles() const { return _cycles; }
 235
 236 protected:
 237
 238         friend class PluginInsert;
 239         friend struct PluginInsert::PluginControl;
 240
 241         virtual void set_parameter (uint32_t which, float val);
 242
 243         /** Do the actual saving of the current plugin settings to a preset of the provided name.
 244          *  Should return a URI on success, or an empty string on failure.
 245          */
 246         virtual std::string do_save_preset (std::string) = 0;
 247         /** Do the actual removal of a preset of the provided name */
 248         virtual void do_remove_preset (std::string) = 0;
 249
 250         ARDOUR::AudioEngine&     _engine;
 251         ARDOUR::Session&         _session;
 252         PluginInfoPtr            _info;
 253         uint32_t                 _cycles;
 254         std::map<std::string, PresetRecord> _presets;
 255
 256 private:
 257
 258         /** Fill _presets with our presets */
 259         virtual void find_presets () = 0;
 260
 261         /** Add state to an existing XMLNode */
 262         virtual void add_state (XMLNode *) const = 0;
 263
 264         bool _have_presets;
 265         MidiStateTracker _tracker;
 266         BufferSet _pending_stop_events;
 267         bool _have_pending_stop_events;
 268         PresetRecord _last_preset;
 269         bool _parameter_changed_since_last_preset;
 270
 271         void resolve_midi ();
 272 };
 273
 274 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
 275
 276 } // namespace ARDOUR
 277
 278 #endif /* __ardour_plugin_h__ */