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/cycles.h>
  34 #include <ardour/latent.h>
  35 #include <ardour/plugin_insert.h>
  36
  37 #include <vector>
  38 #include <set>
  39 #include <map>
  40
  41 using std::string;
  42 using std::vector;
  43 using std::set;
  44 using std::map;
  45
  46 namespace ARDOUR {
  47
  48 class AudioEngine;
  49 class Session;
  50 class BufferSet;
  51
  52 class Plugin;
  53
  54 typedef boost::shared_ptr<Plugin> PluginPtr;
  55
  56 class PluginInfo {
  57   public:
  58         PluginInfo () { }
  59         PluginInfo (const PluginInfo &o)
  60                 : name(o.name),
  61                 category (o.category),
  62                 creator (o.creator),
  63                 path (o.path),
  64                 n_inputs(o.n_inputs),
  65                 n_outputs(o.n_outputs),
  66                 unique_id(o.unique_id),
  67                 index(o.index) {}
  68         virtual ~PluginInfo () { }
  69
  70         string name;
  71         string category;
  72         Glib::ustring creator;
  73         Glib::ustring path;
  74         ChanCount n_inputs;
  75         ChanCount n_outputs;
  76         ARDOUR::PluginType type;
  77
  78         std::string unique_id;
  79
  80         virtual PluginPtr load (Session& session) = 0;
  81
  82   protected:
  83         friend class PluginManager;
  84         uint32_t index;
  85 };
  86
  87 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
  88 typedef std::list<PluginInfoPtr> PluginInfoList;
  89
  90 class Plugin : public PBD::StatefulDestructible, public Latent
  91 {
  92   public:
  93         Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
  94         Plugin (const Plugin&);
  95         virtual ~Plugin ();
  96
  97         struct ParameterDescriptor {
  98
  99             /* essentially a union of LADSPA and VST info */
 100
 101             bool integer_step;
 102             bool toggled;
 103             bool logarithmic;
 104             bool sr_dependent;
 105             string label;
 106             float lower;
 107             float upper;
 108             float step;
 109             float smallstep;
 110             float largestep;
 111             bool min_unbound;
 112             bool max_unbound;
 113         };
 114
 115         virtual std::string unique_id() const = 0;
 116         virtual const char * label() const = 0;
 117         virtual const char * name() const = 0;
 118         virtual const char * maker() const = 0;
 119         virtual uint32_t parameter_count () const = 0;
 120         virtual float default_value (uint32_t port) = 0;
 121         virtual float get_parameter(uint32_t which) const = 0;
 122
 123         virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
 124         virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
 125         virtual void activate () = 0;
 126         virtual void deactivate () = 0;
 127         virtual void set_block_size (nframes_t nframes) = 0;
 128
 129         virtual int connect_and_run (BufferSet& bufs, uint32_t& in, uint32_t& out, nframes_t nframes, nframes_t offset) = 0;
 130
 131         virtual std::set<Evoral::Parameter> automatable() const = 0;
 132         virtual string describe_parameter (Evoral::Parameter) = 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 uri) = 0;
 142         virtual bool load_preset (const string uri);
 143
 144         struct PresetRecord {
 145                 PresetRecord(const std::string& u, const std::string& l) : uri(u), label(l) {}
 146                 string uri;
 147                 string label;
 148         };
 149
 150         virtual std::vector<PresetRecord> get_presets();
 151
 152         const PresetRecord* preset_by_label(const string& label);
 153         const PresetRecord* preset_by_uri(const string& uri);
 154
 155         virtual bool has_editor() const = 0;
 156
 157         sigc::signal<void,uint32_t,float> ParameterChanged;
 158
 159         /* NOTE: this block of virtual methods looks like the interface
 160            to a Processor, but Plugin does not inherit from Processor.
 161            It is therefore not required that these precisely match
 162            the interface, but it is likely that they will evolve together.
 163         */
 164
 165         /* this returns true if the plugin can change its inputs or outputs on demand.
 166            LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
 167         */
 168
 169         virtual bool reconfigurable_io() const { return false; }
 170
 171         /* this is only called if reconfigurable_io() returns true */
 172         virtual bool configure_io (ChanCount in, ChanCount out) { return true; }
 173
 174         /* specific types of plugins can overload this. As of September 2008, only
 175            AUPlugin does this.
 176         */
 177         virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const { return false; }
 178         virtual ChanCount output_streams() const;
 179         virtual ChanCount input_streams() const;
 180
 181         PBD::Controllable *get_nth_control (uint32_t, bool do_not_create = false);
 182         void make_nth_control (uint32_t, const XMLNode&);
 183
 184         PluginInfoPtr get_info() { return _info; }
 185         void set_info (const PluginInfoPtr inf) { _info = inf; }
 186
 187         ARDOUR::AudioEngine& engine() const { return _engine; }
 188         ARDOUR::Session& session() const { return _session; }
 189
 190         void set_cycles (uint32_t c) { _cycles = c; }
 191         cycles_t cycles() const { return _cycles; }
 192
 193   protected:
 194         friend class PluginInsert;
 195         friend struct PluginInsert::PluginControl;
 196         virtual void set_parameter (uint32_t which, float val) = 0;
 197
 198         ARDOUR::AudioEngine& _engine;
 199         ARDOUR::Session& _session;
 200         PluginInfoPtr _info;
 201         uint32_t _cycles;
 202         map<string,PresetRecord> presets;
 203         bool save_preset(string uri, string domain /* vst, ladspa etc. */);
 204 };
 205
 206 PluginPtr find_plugin(ARDOUR::Session&, string unique_id, ARDOUR::PluginType);
 207
 208 } // namespace ARDOUR
 209
 210 #endif /* __ardour_plugin_h__ */