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     $Id$
  19 */
  20
  21 #ifndef __ardour_plugin_h__
  22 #define __ardour_plugin_h__
  23
  24 #include <boost/shared_ptr.hpp>
  25 #include <sigc++/signal.h>
  26
  27 #include <pbd/stateful.h>
  28 #include <pbd/controllable.h>
  29
  30 #include <jack/types.h>
  31 #include <ardour/types.h>
  32 #include <ardour/plugin_state.h>
  33 #include <ardour/cycles.h>
  34
  35 #include <vector>
  36 #include <set>
  37 #include <map>
  38
  39 using std::string;
  40 using std::vector;
  41 using std::set;
  42 using std::map;
  43
  44 namespace ARDOUR {
  45
  46 class AudioEngine;
  47 class Session;
  48
  49 class Plugin;
  50 typedef boost::shared_ptr<Plugin> PluginPtr;
  51
  52 class PluginInfo {
  53   public:
  54         enum Type {
  55                 AudioUnit,
  56                 LADSPA,
  57                 VST
  58         };
  59
  60         PluginInfo () { }
  61         PluginInfo (const PluginInfo &o)
  62                 : name(o.name), n_inputs(o.n_inputs), n_outputs(o.n_outputs),
  63                 unique_id(o.unique_id), path (o.path), index(o.index) {}
  64         virtual ~PluginInfo () { }
  65
  66         string name;
  67         string category;
  68         uint32_t n_inputs;
  69         uint32_t n_outputs;
  70         Type type;
  71
  72         long unique_id;
  73
  74         virtual PluginPtr load (Session& session) = 0;
  75
  76   protected:
  77         friend class PluginManager;
  78         string path;
  79         uint32_t index;
  80 };
  81
  82 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
  83 typedef std::list<PluginInfoPtr> PluginInfoList;
  84
  85 class Plugin : public Stateful, public sigc::trackable
  86
  87 {
  88   public:
  89         Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
  90         Plugin (const Plugin&);
  91         virtual ~Plugin ();
  92
  93         struct ParameterDescriptor {
  94
  95             /* essentially a union of LADSPA and VST info */
  96
  97             bool integer_step;
  98             bool toggled;
  99             bool logarithmic;
 100             bool sr_dependent;
 101             string label;
 102             float lower;
 103             float upper;
 104             float step;
 105             float smallstep;
 106             float largestep;
 107
 108                 bool min_unbound;
 109                 bool max_unbound;
 110         };
 111
 112         virtual uint32_t unique_id() const = 0;
 113         virtual const char * label() const = 0;
 114         virtual const char * name() const = 0;
 115         virtual const char * maker() const = 0;
 116         virtual uint32_t parameter_count () const = 0;
 117         virtual float default_value (uint32_t port) = 0;
 118         virtual jack_nframes_t latency() const = 0;
 119         virtual void set_parameter (uint32_t which, float val) = 0;
 120         virtual float get_parameter(uint32_t which) const = 0;
 121
 122         virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
 123         virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
 124         virtual void activate () = 0;
 125         virtual void deactivate () = 0;
 126         virtual void set_block_size (jack_nframes_t nframes) = 0;
 127
 128         virtual int connect_and_run (vector<Sample*>& bufs, uint32_t maxbuf, int32_t& in, int32_t& out, jack_nframes_t nframes, jack_nframes_t offset) = 0;
 129         virtual std::set<uint32_t> automatable() const = 0;
 130         virtual void store_state (ARDOUR::PluginState&) = 0;
 131         virtual void restore_state (ARDOUR::PluginState&) = 0;
 132         virtual string describe_parameter (uint32_t) = 0;
 133         virtual string state_node_name() const = 0;
 134         virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
 135
 136         virtual bool parameter_is_audio(uint32_t) const = 0;
 137         virtual bool parameter_is_control(uint32_t) const = 0;
 138         virtual bool parameter_is_input(uint32_t) const = 0;
 139         virtual bool parameter_is_output(uint32_t) const = 0;
 140
 141         virtual bool save_preset(string name) = 0;
 142         virtual bool load_preset (const string preset_label);
 143         virtual std::vector<std::string> get_presets();
 144
 145         virtual bool has_editor() const = 0;
 146
 147         sigc::signal<void,uint32_t,float> ParameterChanged;
 148         sigc::signal<void,Plugin *> GoingAway;
 149
 150         PBD::Controllable *get_nth_control (uint32_t);
 151
 152         PluginInfoPtr get_info() { return _info; }
 153         void set_info (const PluginInfoPtr inf) { _info = inf; }
 154
 155         ARDOUR::AudioEngine& engine() const { return _engine; }
 156         ARDOUR::Session& session() const { return _session; }
 157
 158         void set_cycles (uint32_t c) { _cycles = c; }
 159         cycles_t cycles() const { return _cycles; }
 160
 161   protected:
 162         ARDOUR::AudioEngine& _engine;
 163         ARDOUR::Session& _session;
 164         PluginInfoPtr _info;
 165         uint32_t _cycles;
 166         map<string,string>       presets;
 167         bool save_preset(string name, string domain /* vst, ladspa etc. */);
 168
 169         void setup_controls ();
 170
 171         struct PortControllable : public PBD::Controllable {
 172             PortControllable (Plugin&, uint32_t abs_port_id,
 173                               float lower, float upper, bool toggled, bool logarithmic);
 174
 175             void set_value (float);
 176             float get_value () const;
 177
 178             Plugin& plugin;
 179             uint32_t absolute_port;
 180             float upper;
 181             float lower;
 182             float range;
 183             bool  toggled;
 184             bool  logarithmic;
 185         };
 186
 187         vector<PortControllable*> controls;
 188 };
 189
 190 /* this is actually defined in plugin_manager.cc */
 191 boost::shared_ptr<Plugin> find_plugin(ARDOUR::Session&, string name, long unique_id, PluginInfo::Type);
 192
 193 } // namespace ARDOUR
 194
 195 #endif /* __ardour_plugin_h__ */