Fix broken whitespace. I'd apologize for the compile times if it was my fault :D
[ardour.git] / libs / ardour / ardour / plugin.h
index 4a2153c6e05094ba527f4d65053f5b7dcf81d517..2c819e96f2287f30f593b9328aaa2e54c69ed515 100644 (file)
@@ -33,6 +33,7 @@
 #include "ardour/latent.h"
 #include "ardour/plugin_insert.h"
 #include "ardour/types.h"
+#include "ardour/midi_state_tracker.h"
 
 #include <vector>
 #include <set>
@@ -89,8 +90,8 @@ class Plugin : public PBD::StatefulDestructible, public Latent
                bool logarithmic;
                bool sr_dependent;
                std::string label;
-               float lower;
-               float upper;
+               float lower; ///< if this is a frequency, it will be in Hz (not a fraction of the sample rate)
+               float upper; ///< if this is a frequency, it will be in Hz (not a fraction of the sample rate)
                float step;
                float smallstep;
                float largestep;
@@ -98,6 +99,11 @@ class Plugin : public PBD::StatefulDestructible, public Latent
                bool max_unbound;
        };
 
+       XMLNode& get_state ();
+       virtual int set_state (const XMLNode &, int version);
+
+       virtual void set_insert_info (const PluginInsert*) {}
+
        virtual std::string unique_id() const = 0;
        virtual const char * label() const = 0;
        virtual const char * name() const = 0;
@@ -110,13 +116,13 @@ class Plugin : public PBD::StatefulDestructible, public Latent
        virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
        virtual void activate () = 0;
        virtual void deactivate () = 0;
-        virtual void flush () { deactivate(); activate(); }
+       virtual void flush () { deactivate(); activate(); }
 
        virtual int set_block_size (pframes_t nframes) = 0;
 
        virtual int connect_and_run (BufferSet& bufs,
-                       ChanMapping in, ChanMapping out,
-                       pframes_t nframes, framecnt_t offset) = 0;
+                                    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;
@@ -128,27 +134,64 @@ class 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 bool save_preset (std::string) = 0;
-       virtual void remove_preset (std::string) = 0;
-       virtual bool load_preset (const std::string& uri);
+       typedef std::map<const std::string, const float> ScalePoints;
+
+       virtual boost::shared_ptr<ScalePoints>
+       get_scale_points(uint32_t port_index) const {
+               return boost::shared_ptr<ScalePoints>();
+       }
+
+       void realtime_handle_transport_stopped ();
 
        struct PresetRecord {
-               PresetRecord(const std::string& u, const std::string& l) : uri(u), label(l) {}
+               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;
        };
 
-       virtual std::vector<PresetRecord> get_presets();
-       virtual std::string current_preset() const { return std::string(); }
+       PresetRecord save_preset (std::string);
+       void remove_preset (std::string);
+
+       virtual bool load_preset (PresetRecord);
+
+       const PresetRecord * preset_by_label (const std::string &);
+       const PresetRecord * preset_by_uri (const std::string &);
+
+       std::vector<PresetRecord> get_presets ();
 
-       static PBD::Signal0<bool> PresetFileExists;
+       /** @return Last preset to be requested; the settings may have
+        * been changed since; find out with parameter_changed_since_last_preset.
+        */
+       PresetRecord last_preset () const {
+               return _last_preset;
+       }
 
-       const PresetRecord* preset_by_label(const std::string& label);
-       const PresetRecord* preset_by_uri(const std::string& uri);
+       bool parameter_changed_since_last_preset () const {
+               return _parameter_changed_since_last_preset;
+       }
 
-       virtual bool has_editor() const = 0;
+       virtual int first_user_preset_index () const {
+               return 0;
+       }
 
-       PBD::Signal2<void,uint32_t,float> ParameterChanged;
+       /** Emitted when a preset is added or removed, respectively */
+       PBD::Signal0<void> PresetAdded;
+       PBD::Signal0<void> PresetRemoved;
+
+       /** Emitted when a preset has been loaded */
+       PBD::Signal0<void> PresetLoaded;
+
+       virtual bool has_editor () const = 0;
+
+       /** 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.
@@ -181,23 +224,40 @@ class Plugin : public PBD::StatefulDestructible, public Latent
        void set_cycles (uint32_t c) { _cycles = c; }
        cycles_t cycles() const { return _cycles; }
 
-  protected:
+protected:
+
        friend class PluginInsert;
        friend struct PluginInsert::PluginControl;
 
-       virtual void set_parameter (uint32_t which, float val) = 0;
+       virtual void set_parameter (uint32_t which, float val);
 
-       bool save_preset (std::string, std::string /* vst, ladspa etc. */);
-       void remove_preset (std::string, std::string);
-       bool write_preset_file (std::string, std::string);
-       std::string preset_source (std::string, std::string) const;
-       std::string preset_envvar () const;
+       /** Do the actual saving of the current plugin settings to a preset of the provided name.
+        *  Should return a URI on success, or an empty string on failure.
+        */
+       virtual std::string do_save_preset (std::string) = 0;
+       /** Do the actual removal of a preset of the provided name */
+       virtual void do_remove_preset (std::string) = 0;
 
        ARDOUR::AudioEngine&     _engine;
        ARDOUR::Session&         _session;
        PluginInfoPtr            _info;
        uint32_t                 _cycles;
-       std::map<std::string,PresetRecord>  presets;
+       std::map<std::string, PresetRecord> _presets;
+
+private:
+
+       /** Fill _presets with our presets */
+       virtual void find_presets () = 0;
+
+       /** Add state to an existing XMLNode */
+       virtual void add_state (XMLNode *) const = 0;
+
+       bool _have_presets;
+       MidiStateTracker _tracker;
+       BufferSet _pending_stop_events;
+       bool _have_pending_stop_events;
+       PresetRecord _last_preset;
+       bool _parameter_changed_since_last_preset;
 };
 
 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);