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