remove reference "const int32_t&" -> const int32_t"

[ardour.git] / libs / ardour / ardour / plugin.h

diff --git a/libs/ardour/ardour/plugin.h b/libs/ardour/ardour/plugin.h
index 17ac4e04d9dd41c993bcb2836d0cd2c85af05679..df4b512ef70404ed2f06688d17d9e16532f17c61 100644 (file)
--- a/libs/ardour/ardour/plugin.h
+++ b/libs/ardour/ardour/plugin.h
@@ -22,6 +22,7 @@
 
 #include <boost/shared_ptr.hpp>
 #include <string>
+#include <set>
 
 #include "pbd/statefuldestructible.h"
 #include "pbd/controllable.h"
@@ -54,7 +55,16 @@ 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.
+ *
+ * This class provides an abstraction for methords provided by
+ * all supported plugin standards such as presets, name, parameters etc.
+ *
+ * Plugins are not used directly in Ardour but always wrapped by a PluginInsert.
+ */
 class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
 {
   public:
@@ -78,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;
@@ -86,10 +108,12 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
 
        virtual int set_block_size (pframes_t nframes) = 0;
        virtual bool requires_fixed_sized_buffers() const { return false; }
+       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;
@@ -101,6 +125,25 @@ 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)
+                       : name (n)
+                       , is_sidechain (false)
+               {}
+               IOPortDescription (const IOPortDescription &other)
+                       : name (other.name)
+                       , is_sidechain (other.is_sidechain)
+               {}
+               std::string name;
+               bool is_sidechain;
+       };
+
+       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>) { }
 
        virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
@@ -111,8 +154,15 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
        void realtime_locate ();
        void monitoring_changed ();
 
+       typedef struct {
+               unsigned char *data;
+               int width;
+               int height;
+               int stride;
+       } Display_Image_Surface;
+
        virtual bool has_inline_display () { return false; }
-       virtual void* render_inline_display (uint32_t, uint32_t) { return NULL; }
+       virtual Display_Image_Surface* render_inline_display (uint32_t, uint32_t) { return NULL; }
        PBD::Signal0<void> QueueDraw;
 
        struct PresetRecord {
@@ -175,6 +225,9 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
                return 0;
        }
 
+       /** the max possible latency a plugin will have */
+       virtual framecnt_t max_latency () const { return 0; } // TODO = 0, require implementation
+
        /** Emitted when a preset is added or removed, respectively */
        PBD::Signal0<void> PresetAdded;
        PBD::Signal0<void> PresetRemoved;
@@ -202,7 +255,7 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
        /* 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*/) { return false; }
+       virtual bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/, ChanCount* imprecise = 0) { return false; }
        virtual ChanCount output_streams() const;
        virtual ChanCount input_streams() const;
 
@@ -342,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;