option to ignore feedback detection - /i know what i'm doing/ mode.

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

diff --git a/libs/ardour/ardour/plugin.h b/libs/ardour/ardour/plugin.h
index fcd7d6d19b81c77f6d59fe07d7973e9840734349..9e4f5c40fd7c8ef89fe6319c4606983d895492b3 100644 (file)
--- a/libs/ardour/ardour/plugin.h
+++ b/libs/ardour/ardour/plugin.h
@@ -65,6 +65,19 @@ class PluginInfo {
        std::string unique_id;
 
        virtual PluginPtr load (Session& session) = 0;
+       virtual bool is_instrument() const; 
+
+       /* NOTE: this block of virtual methods looks like the interface
+          to a Processor, but Plugin does not inherit from Processor.
+          It is therefore not required that these precisely match
+          the interface, but it is likely that they will evolve together.
+       */
+
+       /* this returns true if the plugin can change its inputs or outputs on demand.
+          LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
+       */
+
+       virtual bool reconfigurable_io() const { return false; }
 
   protected:
        friend class PluginManager;
@@ -83,6 +96,11 @@ class Plugin : public PBD::StatefulDestructible, public Latent
 
        struct ParameterDescriptor {
 
+               /* XXX: it would probably be nice if this initialised everything */
+               ParameterDescriptor ()
+                       : enumeration (false)
+               {}
+
                /* essentially a union of LADSPA and VST info */
 
                bool integer_step;
@@ -97,6 +115,7 @@ class Plugin : public PBD::StatefulDestructible, public Latent
                float largestep;
                bool min_unbound;
                bool max_unbound;
+               bool enumeration;
        };
 
        XMLNode& get_state ();
@@ -111,6 +130,8 @@ class Plugin : public PBD::StatefulDestructible, public Latent
        virtual uint32_t parameter_count () const = 0;
        virtual float default_value (uint32_t port) = 0;
        virtual float get_parameter(uint32_t which) const = 0;
+       virtual std::string get_docs () const { return ""; }
+       virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; }
 
        virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
        virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
@@ -141,30 +162,54 @@ class Plugin : public PBD::StatefulDestructible, public Latent
        }
 
        void realtime_handle_transport_stopped ();
+       void realtime_locate ();
+       void monitoring_changed ();
 
        struct PresetRecord {
-               PresetRecord () : user (true) {}
-               PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s)  {}
-
-               bool operator!= (PresetRecord const & a) const {
-                       return uri != a.uri || label != a.label;
-               }
-
-               std::string uri;
-               std::string label;
-               bool user;
+           PresetRecord () : number (-1), user (true) {}
+           PresetRecord (const std::string& u, const std::string& l, int n = -1, bool s = true) : uri (u), label (l), number (n), user (s)  {}
+           
+           bool operator!= (PresetRecord const & a) const {
+                   return number != a.number || uri != a.uri || label != a.label;
+           }
+           
+           std::string uri;
+           std::string label;
+           int number; // if <0, invalid
+           bool user;
        };
 
        PresetRecord save_preset (std::string);
        void remove_preset (std::string);
 
        virtual bool load_preset (PresetRecord);
+       void clear_preset ();
 
        const PresetRecord * preset_by_label (const std::string &);
        const PresetRecord * preset_by_uri (const std::string &);
 
        std::vector<PresetRecord> get_presets ();
 
+        /** @return true if this plugin will respond to MIDI program
+        * change messages by changing presets.
+        *
+        * This is hard to return a correct value for because most plugin APIs
+        * do not specify plugin behaviour. However, if you want to force
+         * the display of plugin built-in preset names rather than MIDI program
+         * numbers, return true. If you want a generic description, return
+        * false.
+       */
+        virtual bool presets_are_MIDI_programs() const { return false; }
+
+        /** @return true if this plugin is General MIDI compliant, false
+        * otherwise.
+        *
+        * It is important to note that it is is almost impossible for a host
+        * (e.g. Ardour) to determine this for just about any plugin API
+        * known as of June 2012
+        */
+        virtual bool current_preset_uses_general_midi() const { return false; }
+
        /** @return Last preset to be requested; the settings may have
         * been changed since; find out with parameter_changed_since_last_preset.
         */
@@ -192,19 +237,6 @@ class Plugin : public PBD::StatefulDestructible, public Latent
        /** Emitted when any parameter changes */
        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.
-          It is therefore not required that these precisely match
-          the interface, but it is likely that they will evolve together.
-       */
-
-       /* this returns true if the plugin can change its inputs or outputs on demand.
-          LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
-       */
-
-       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; }
 
        /* specific types of plugins can overload this. As of September 2008, only
@@ -215,7 +247,7 @@ class Plugin : public PBD::StatefulDestructible, public Latent
        virtual ChanCount input_streams() const;
 
        PluginInfoPtr get_info() const { return _info; }
-       void set_info (const PluginInfoPtr inf) { _info = inf; }
+       virtual void set_info (const PluginInfoPtr inf);
 
        ARDOUR::AudioEngine& engine() const { return _engine; }
        ARDOUR::Session& session() const { return _session; }
@@ -223,6 +255,9 @@ class Plugin : public PBD::StatefulDestructible, public Latent
        void set_cycles (uint32_t c) { _cycles = c; }
        cycles_t cycles() const { return _cycles; }
 
+        PBD::Signal1<void,uint32_t> StartTouch;
+        PBD::Signal1<void,uint32_t> EndTouch;
+
 protected:
 
        friend class PluginInsert;
@@ -257,6 +292,8 @@ private:
        bool _have_pending_stop_events;
        PresetRecord _last_preset;
        bool _parameter_changed_since_last_preset;
+
+       void resolve_midi ();
 };
 
 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);