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/chan_count.h>
  33 #include <ardour/plugin_state.h>
  34 #include <ardour/cycles.h>
  35 #include <ardour/latent.h>
  36 #include <ardour/parameter.h>
  37 #include <ardour/plugin_insert.h>
  38
  39 #include <vector>
  40 #include <set>
  41 #include <map>
  42
  43 using std::string;
  44 using std::vector;
  45 using std::set;
  46 using std::map;
  47
  48 namespace ARDOUR {
  49
  50 class AudioEngine;
  51 class Session;
  52 class BufferSet;
  53
  54 class Plugin;
  55
  56 typedef boost::shared_ptr<Plugin> PluginPtr;
  57
  58 class PluginInfo {
  59   public:
  60         PluginInfo () { }
  61         PluginInfo (const PluginInfo &o)
  62                 : name(o.name), n_inputs(o.n_inputs), n_outputs(o.n_outputs),
  63                 path (o.path), unique_id(o.unique_id), index(o.index) {}
  64         virtual ~PluginInfo () { }
  65
  66         string name;
  67         string category;
  68         Glib::ustring creator;
  69         Glib::ustring path;
  70         ChanCount n_inputs;
  71         ChanCount n_outputs;
  72         ARDOUR::PluginType type;
  73
  74         long 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, public Latent
  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 uint32_t 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 float get_parameter(uint32_t which) const = 0;
 118
 119         virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
 120         virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
 121         virtual void activate () = 0;
 122         virtual void deactivate () = 0;
 123         virtual void set_block_size (nframes_t nframes) = 0;
 124
 125         virtual int connect_and_run (BufferSet& bufs, uint32_t& in, uint32_t& out, nframes_t nframes, nframes_t offset) = 0;
 126
 127         virtual std::set<Parameter> automatable() const = 0;
 128         virtual void store_state (ARDOUR::PluginState&) = 0;
 129         virtual void restore_state (ARDOUR::PluginState&) = 0;
 130         virtual string describe_parameter (Parameter) = 0;
 131         virtual string state_node_name() const = 0;
 132         virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
 133
 134         virtual bool parameter_is_audio(uint32_t) const = 0;
 135         virtual bool parameter_is_control(uint32_t) const = 0;
 136         virtual bool parameter_is_input(uint32_t) const = 0;
 137         virtual bool parameter_is_output(uint32_t) const = 0;
 138
 139         virtual bool save_preset(string name) = 0;
 140         virtual bool load_preset (const string preset_label);
 141         virtual std::vector<std::string> get_presets();
 142
 143         virtual bool has_editor() const = 0;
 144
 145         PluginInfoPtr get_info() { return _info; }
 146         void set_info (const PluginInfoPtr inf) { _info = inf; }
 147
 148         ARDOUR::AudioEngine& engine() const { return _engine; }
 149         ARDOUR::Session& session() const { return _session; }
 150
 151         void set_cycles (uint32_t c) { _cycles = c; }
 152         cycles_t cycles() const { return _cycles; }
 153
 154   protected:
 155         friend class PluginInsert;
 156         friend struct PluginInsert::PluginControl;
 157         virtual void set_parameter (uint32_t which, float val) = 0;
 158
 159         ARDOUR::AudioEngine& _engine;
 160         ARDOUR::Session& _session;
 161         PluginInfoPtr _info;
 162         uint32_t _cycles;
 163         map<string,string>       presets;
 164         bool save_preset(string name, string domain /* vst, ladspa etc. */);
 165 };
 166
 167 PluginPtr find_plugin(ARDOUR::Session&, string name, long unique_id, ARDOUR::PluginType);
 168
 169 } // namespace ARDOUR
 170
 171 #endif /* __ardour_plugin_h__ */