Another not-quite-there-but-better commit.
[ardour.git] / libs / ardour / ardour / plugin.h
index 97708065e404a17f5fb6c77d3f7a41336c2899e5..5c490693758f6f974db6d2c9e173ca415c1fef09 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000 Paul Davis 
+    Copyright (C) 2000-2006 Paul Davis 
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
-#ifndef __ardour_ladspa_h__
-#define __ardour_ladspa_h__
+#ifndef __ardour_plugin_h__
+#define __ardour_plugin_h__
 
 #include <boost/shared_ptr.hpp>
 #include <sigc++/signal.h>
 
-#include <pbd/stateful.h> 
+#include <pbd/statefuldestructible.h> 
 #include <pbd/controllable.h>
 
 #include <jack/types.h>
 #include <ardour/types.h>
+#include <ardour/chan_count.h>
 #include <ardour/plugin_state.h>
 #include <ardour/cycles.h>
+#include <ardour/latent.h>
+#include <ardour/param_id.h>
 
 #include <vector>
 #include <set>
@@ -45,41 +47,45 @@ namespace ARDOUR {
 
 class AudioEngine;
 class Session;
+class BufferSet;
+
+class Plugin;
+
+typedef boost::shared_ptr<Plugin> PluginPtr;
 
 class PluginInfo {
   public:
-       enum Type {
-               AudioUnit,
-               LADSPA,
-               VST
-       };
-
-       PluginInfo () { };
+       PluginInfo () { }
        PluginInfo (const PluginInfo &o)
                : name(o.name), n_inputs(o.n_inputs), n_outputs(o.n_outputs),
                unique_id(o.unique_id), path (o.path), index(o.index) {}
-       ~PluginInfo () { };
+       virtual ~PluginInfo () { }
+
        string name;
        string category;
-       uint32_t n_inputs;
-       uint32_t n_outputs;
-       Type type;
+       ChanCount n_inputs;
+       ChanCount n_outputs;
+       ARDOUR::PluginType type;
 
        long unique_id;
 
-  private:
+       virtual PluginPtr load (Session& session) = 0;
+
+  protected:
        friend class PluginManager;
        string path;
        uint32_t index;
 };
 
-class Plugin : public Stateful, public sigc::trackable
+typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
+typedef std::list<PluginInfoPtr> PluginInfoList;
 
+class Plugin : public PBD::StatefulDestructible, public Latent
 {
   public:
        Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
        Plugin (const Plugin&);
-       ~Plugin ();
+       virtual ~Plugin ();
        
        struct ParameterDescriptor {
 
@@ -95,9 +101,8 @@ class Plugin : public Stateful, public sigc::trackable
            float step;
            float smallstep;
            float largestep;
-
-               bool min_unbound;
-               bool max_unbound;
+           bool min_unbound;
+           bool max_unbound;
        };
 
        virtual uint32_t unique_id() const = 0;
@@ -106,21 +111,20 @@ class Plugin : public Stateful, public sigc::trackable
        virtual const char * maker() const = 0;
        virtual uint32_t parameter_count () const = 0;
        virtual float default_value (uint32_t port) = 0;
-       virtual jack_nframes_t latency() const = 0;
-       virtual void set_parameter (uint32_t which, float val) = 0;
        virtual float get_parameter(uint32_t which) const = 0;
 
        virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
        virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
        virtual void activate () = 0;
        virtual void deactivate () = 0;
-       virtual void set_block_size (jack_nframes_t nframes) = 0;
+       virtual void set_block_size (nframes_t nframes) = 0;
 
-       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;
-       virtual std::set<uint32_t> automatable() const = 0;
+       virtual int connect_and_run (BufferSet& bufs, uint32_t& in, uint32_t& out, nframes_t nframes, nframes_t offset) = 0;
+       
+       virtual std::set<ParamID> automatable() const = 0;
        virtual void store_state (ARDOUR::PluginState&) = 0;
        virtual void restore_state (ARDOUR::PluginState&) = 0;
-       virtual string describe_parameter (uint32_t) = 0;
+       virtual string describe_parameter (ParamID) = 0;
        virtual string state_node_name() const = 0;
        virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
 
@@ -135,13 +139,8 @@ class Plugin : public Stateful, public sigc::trackable
 
        virtual bool has_editor() const = 0;
 
-       sigc::signal<void,uint32_t,float> ParameterChanged;
-       sigc::signal<void,Plugin *> GoingAway;
-       
-       PBD::Controllable *get_nth_control (uint32_t);
-
-       PluginInfo & get_info() { return _info; }
-       void set_info (const PluginInfo &inf) { _info = inf; }
+       PluginInfoPtr get_info() { return _info; }
+       void set_info (const PluginInfoPtr inf) { _info = inf; }
 
        ARDOUR::AudioEngine& engine() const { return _engine; }
        ARDOUR::Session& session() const { return _session; }
@@ -150,37 +149,18 @@ class Plugin : public Stateful, public sigc::trackable
        cycles_t cycles() const { return _cycles; }
 
   protected:
+       friend class PluginInsert;
+       virtual void set_parameter (uint32_t which, float val) = 0;
+
        ARDOUR::AudioEngine& _engine;
        ARDOUR::Session& _session;
-       PluginInfo _info;
+       PluginInfoPtr _info;
        uint32_t _cycles;
        map<string,string>       presets;
        bool save_preset(string name, string domain /* vst, ladspa etc. */);
-
-       void setup_controls ();
-
-       struct PortControllable : public PBD::Controllable {
-           PortControllable (Plugin&, uint32_t abs_port_id,
-                             float lower, float upper, bool toggled, bool logarithmic);
-
-           void set_value (float);
-           float get_value () const;
-
-           Plugin& plugin;
-           uint32_t absolute_port;
-           float upper;
-           float lower;
-           float range;
-           bool  toggled;
-           bool  logarithmic;
-       };
-
-       vector<PortControllable*> controls;
 };
 
-/* this is actually defined in plugin_manager.cc */
-
-boost::shared_ptr<Plugin> find_plugin(ARDOUR::Session&, string name, long unique_id, PluginInfo::Type);
+PluginPtr find_plugin(ARDOUR::Session&, string name, long unique_id, ARDOUR::PluginType);
 
 } // namespace ARDOUR