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