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