libs/ardour/ardour/plugin.h

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