nominally add MIDI input support for AudioUnit plugins
[ardour.git] / libs / ardour / ardour / plugin.h
index ecf22443ad5c70224693ddf27b78657830cb3848..3d7c8d9c335c440da466b2ca7b0cc14677468303 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2006 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
 #define __ardour_plugin_h__
 
 #include <boost/shared_ptr.hpp>
-#include <boost/utility.hpp>
-#include <sigc++/signal.h>
-#include <glibmm/ustring.h>
+#include <string>
 
-#include "pbd/statefuldestructible.h" 
+#include "pbd/statefuldestructible.h"
 #include "pbd/controllable.h"
 
 #include <jack/types.h>
 #include "ardour/chan_count.h"
+#include "ardour/chan_mapping.h"
 #include "ardour/cycles.h"
 #include "ardour/latent.h"
 #include "ardour/plugin_insert.h"
 #include <set>
 #include <map>
 
-using std::string;
-using std::vector;
-using std::set;
-using std::map;
-
 namespace ARDOUR {
 
 class AudioEngine;
@@ -57,25 +51,16 @@ typedef boost::shared_ptr<Plugin> PluginPtr;
 class PluginInfo {
   public:
        PluginInfo () { }
-       PluginInfo (const PluginInfo &o)
-               : name(o.name), 
-               category (o.category), 
-               creator (o.creator),
-               path (o.path), 
-               n_inputs(o.n_inputs), 
-               n_outputs(o.n_outputs),
-               unique_id(o.unique_id), 
-               index(o.index) {}
        virtual ~PluginInfo () { }
 
-       string name;
-       string category;
-       Glib::ustring creator;
-       Glib::ustring path;
+       std::string name;
+       std::string category;
+       std::string creator;
+       std::string path;
        ChanCount n_inputs;
        ChanCount n_outputs;
        ARDOUR::PluginType type;
-       
+
        std::string unique_id;
 
        virtual PluginPtr load (Session& session) = 0;
@@ -88,29 +73,29 @@ class PluginInfo {
 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
 typedef std::list<PluginInfoPtr> PluginInfoList;
 
-class Plugin : public PBD::StatefulDestructible, public Latent, public boost::noncopyable
+class Plugin : public PBD::StatefulDestructible, public Latent
 {
   public:
        Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
        Plugin (const Plugin&);
        virtual ~Plugin ();
-       
+
        struct ParameterDescriptor {
 
-           /* essentially a union of LADSPA and VST info */
-
-           bool integer_step;
-           bool toggled;
-           bool logarithmic;
-           bool sr_dependent;
-           string label;
-           float lower;
-           float upper;
-           float step;
-           float smallstep;
-           float largestep;
-           bool min_unbound;
-           bool max_unbound;
+               /* essentially a union of LADSPA and VST info */
+
+               bool integer_step;
+               bool toggled;
+               bool logarithmic;
+               bool sr_dependent;
+               std::string label;
+               float lower;
+               float upper;
+               float step;
+               float smallstep;
+               float largestep;
+               bool min_unbound;
+               bool max_unbound;
        };
 
        virtual std::string unique_id() const = 0;
@@ -125,13 +110,17 @@ class Plugin : public PBD::StatefulDestructible, public Latent, public boost::no
        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 (nframes_t nframes) = 0;
+        virtual void flush () { deactivate(); activate(); }
+
+       virtual int set_block_size (nframes_t nframes) = 0;
+
+       virtual int connect_and_run (BufferSet& bufs,
+                       ChanMapping in, ChanMapping out,
+                       nframes_t nframes, nframes_t offset) = 0;
 
-       virtual int connect_and_run (BufferSet& bufs, uint32_t& in, uint32_t& out, nframes_t nframes, nframes_t offset) = 0;
-       
        virtual std::set<Evoral::Parameter> automatable() const = 0;
-       virtual string describe_parameter (Evoral::Parameter) = 0;
-       virtual string state_node_name() const = 0;
+       virtual std::string describe_parameter (Evoral::Parameter) = 0;
+       virtual std::string state_node_name() const = 0;
        virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
 
        virtual bool parameter_is_audio(uint32_t) const = 0;
@@ -139,23 +128,26 @@ class Plugin : public PBD::StatefulDestructible, public Latent, public boost::no
        virtual bool parameter_is_input(uint32_t) const = 0;
        virtual bool parameter_is_output(uint32_t) const = 0;
 
-       virtual bool save_preset(string uri) = 0;
-       virtual bool load_preset (const string uri);
+       virtual bool save_preset (std::string) = 0;
+       virtual bool load_preset (const std::string& uri);
 
        struct PresetRecord {
                PresetRecord(const std::string& u, const std::string& l) : uri(u), label(l) {}
-               string uri;
-               string label;
+               std::string uri;
+               std::string label;
        };
 
        virtual std::vector<PresetRecord> get_presets();
+       virtual std::string current_preset() const { return std::string(); }
 
-       const PresetRecord* preset_by_label(const string& label);
-       const PresetRecord* preset_by_uri(const string& uri);
+       static PBD::Signal0<bool> PresetFileExists;
+
+       const PresetRecord* preset_by_label(const std::string& label);
+       const PresetRecord* preset_by_uri(const std::string& uri);
 
        virtual bool has_editor() const = 0;
 
-       sigc::signal<void,uint32_t,float> ParameterChanged;
+       PBD::Signal2<void,uint32_t,float> ParameterChanged;
 
        /* NOTE: this block of virtual methods looks like the interface
           to a Processor, but Plugin does not inherit from Processor.
@@ -170,19 +162,16 @@ class Plugin : public PBD::StatefulDestructible, public Latent, public boost::no
        virtual bool reconfigurable_io() const { return false; }
 
        /* this is only called if reconfigurable_io() returns true */
-       virtual bool configure_io (ChanCount in, ChanCount out) { return true; }
+       virtual bool configure_io (ChanCount /*in*/, ChanCount /*out*/) { return true; }
 
        /* specific types of plugins can overload this. As of September 2008, only
           AUPlugin does this.
        */
-       virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const { return false; }
+       virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) const { return false; }
        virtual ChanCount output_streams() const;
        virtual ChanCount input_streams() const;
 
-       PBD::Controllable *get_nth_control (uint32_t, bool do_not_create = false);
-       void make_nth_control (uint32_t, const XMLNode&);
-
-       PluginInfoPtr get_info() { return _info; }
+       PluginInfoPtr get_info() const { return _info; }
        void set_info (const PluginInfoPtr inf) { _info = inf; }
 
        ARDOUR::AudioEngine& engine() const { return _engine; }
@@ -194,18 +183,20 @@ class Plugin : public PBD::StatefulDestructible, public Latent, public boost::no
   protected:
        friend class PluginInsert;
        friend struct PluginInsert::PluginControl;
+
        virtual void set_parameter (uint32_t which, float val) = 0;
 
-       ARDOUR::AudioEngine& _engine;
-       ARDOUR::Session& _session;
-       PluginInfoPtr _info;
-       uint32_t _cycles;
-       map<string,PresetRecord> presets;
-       bool save_preset(string uri, string domain /* vst, ladspa etc. */);
+       bool save_preset (std::string, std::string /* vst, ladspa etc. */);
+
+       ARDOUR::AudioEngine&     _engine;
+       ARDOUR::Session&         _session;
+       PluginInfoPtr            _info;
+       uint32_t                 _cycles;
+       std::map<std::string,PresetRecord>  presets;
 };
 
-PluginPtr find_plugin(ARDOUR::Session&, string unique_id, ARDOUR::PluginType);
+PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
 
 } // namespace ARDOUR
+
 #endif /* __ardour_plugin_h__ */