Fix portability of Session::source_search_path
[ardour.git] / libs / ardour / ardour / plugin.h
index cfdf0e81217c73a9d8d4fe06d8c78379e78be534..9e4f5c40fd7c8ef89fe6319c4606983d895492b3 100644 (file)
@@ -166,28 +166,50 @@ class Plugin : public PBD::StatefulDestructible, public Latent
        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.
         */
@@ -233,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;