Re-implement URIMap to tolerate broken plugins that use the wrong context to

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

diff --git a/libs/ardour/ardour/plugin.h b/libs/ardour/ardour/plugin.h
index 2c819e96f2287f30f593b9328aaa2e54c69ed515..cfdf0e81217c73a9d8d4fe06d8c78379e78be534 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;
@@ -136,12 +157,13 @@ class Plugin : public PBD::StatefulDestructible, public Latent
 
        typedef std::map<const std::string, const float> ScalePoints;
 
-       virtual boost::shared_ptr<ScalePoints>
-       get_scale_points(uint32_t port_index) const {
+       virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
                return boost::shared_ptr<ScalePoints>();
        }
 
        void realtime_handle_transport_stopped ();
+       void realtime_locate ();
+       void monitoring_changed ();
 
        struct PresetRecord {
                PresetRecord () : user (true) {}
@@ -193,19 +215,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
@@ -216,7 +225,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; }
@@ -258,6 +267,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);