remove reference "const int32_t&" -> const int32_t"
[ardour.git] / libs / ardour / ardour / plugin.h
index e48201e73c4b9255dfb5566f05cb9e85bb2ea343..df4b512ef70404ed2f06688d17d9e16532f17c61 100644 (file)
@@ -22,6 +22,7 @@
 
 #include <boost/shared_ptr.hpp>
 #include <string>
+#include <set>
 
 #include "pbd/statefuldestructible.h"
 #include "pbd/controllable.h"
@@ -54,6 +55,7 @@ class AutomationControl;
 typedef boost::shared_ptr<Plugin> PluginPtr;
 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
 typedef std::list<PluginInfoPtr> PluginInfoList;
+typedef std::set<uint32_t> PluginOutputConfiguration;
 
 /** A plugin is an external module (usually 3rd party provided) loaded into Ardour
  * for the purpose of digital signal processing.
@@ -86,6 +88,18 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
        virtual std::string get_docs () const { return ""; }
        virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
 
+       struct UILayoutHint {
+               UILayoutHint ()
+                       : x0(-1), x1(-1), y0(-1), y1(-1), knob(false) {}
+               int x0;
+               int x1;
+               int y0;
+               int y1;
+               bool knob;
+       };
+
+       virtual bool get_layout (uint32_t which, UILayoutHint&) const { return false; }
+
        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;
@@ -97,8 +111,9 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
        virtual bool inplace_broken() const { return false; }
 
        virtual int connect_and_run (BufferSet& bufs,
-                                    ChanMapping in, ChanMapping out,
-                                    pframes_t nframes, framecnt_t offset);
+                       framepos_t start, framepos_t end, double speed,
+                       ChanMapping in, ChanMapping out,
+                       pframes_t nframes, framecnt_t offset);
 
        virtual std::set<Evoral::Parameter> automatable() const = 0;
        virtual std::string describe_parameter (Evoral::Parameter) = 0;
@@ -110,6 +125,8 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
        virtual bool parameter_is_input(uint32_t) const = 0;
        virtual bool parameter_is_output(uint32_t) const = 0;
 
+       virtual uint32_t designated_bypass_port () { return UINT32_MAX; }
+
        struct LIBARDOUR_API IOPortDescription {
                public:
                IOPortDescription (const std::string& n)
@@ -124,7 +141,8 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
                bool is_sidechain;
        };
 
-       virtual IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id);
+       virtual IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id) const;
+       virtual PluginOutputConfiguration possible_output () const;
 
        virtual void set_automation_control (uint32_t /*port_index*/, boost::shared_ptr<ARDOUR::AutomationControl>) { }
 
@@ -207,23 +225,6 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
                return 0;
        }
 
-       /** Emitted when a Latency Changes
-        *
-        * (this cannot be part of ARDOUR::Latent because
-        * signals cannot be copy-constructed).
-        */
-       PBD::Signal2<void,framecnt_t, framecnt_t> LatencyChanged;
-
-       /* overload Latent::set_user_latency w/signal emission */
-       virtual void set_user_latency (framecnt_t val) {
-               bool changed = val != _user_latency;
-               framecnt_t old = effective_latency ();
-               _user_latency = val;
-               if (changed) {
-                       LatencyChanged (old, effective_latency ()); /* EMIT SIGNAL */
-               }
-       }
-
        /** the max possible latency a plugin will have */
        virtual framecnt_t max_latency () const { return 0; } // TODO = 0, require implementation
 
@@ -394,6 +395,7 @@ class LIBARDOUR_API PluginInfo {
 
        virtual PluginPtr load (Session& session) = 0;
        virtual bool is_instrument() const;
+       virtual bool needs_midi_input() const { return is_instrument (); }
        virtual bool in_category (const std::string &) const { return false; }
 
        virtual std::vector<Plugin::PresetRecord> get_presets (bool user_only) const = 0;