fixes for 98% of all the warnings/errors reported by OS X gcc on tiger
[ardour.git] / libs / ardour / ardour / plugin.h
index d35f7611a54a43a2dbf49154e84aa748fdf064bc..fcd7d6d19b81c77f6d59fe07d7973e9840734349 100644 (file)
@@ -90,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;
@@ -99,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;
@@ -111,7 +116,7 @@ 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;
 
@@ -129,35 +134,63 @@ 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;
 
-       void realtime_handle_transport_stopped ();
+       typedef std::map<const std::string, const float> ScalePoints;
 
-       bool save_preset (std::string);
-       void remove_preset (std::string);
-       virtual bool load_preset (const std::string& uri) = 0;
+       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;
        };
 
+       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 &);
 
-       /** Return this plugin's presets; should add them to _presets */
-       virtual std::vector<PresetRecord> get_presets () = 0;
-       virtual std::string current_preset () const { return std::string(); }
+       std::vector<PresetRecord> get_presets ();
+
+       /** @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;
+       }
+
+       bool parameter_changed_since_last_preset () const {
+               return _parameter_changed_since_last_preset;
+       }
+
+       virtual int first_user_preset_index () const {
+               return 0;
+       }
 
        /** Emitted when a preset is added or removed, respectively */
        PBD::Signal0<void> PresetAdded;
        PBD::Signal0<void> PresetRemoved;
-       
-       /* XXX: no-one listens to this */
-       static PBD::Signal0<bool> PresetFileExists;
 
-       virtual bool has_editor() const = 0;
+       /** Emitted when a preset has been loaded */
+       PBD::Signal0<void> PresetLoaded;
 
-       PBD::Signal2<void,uint32_t,float> ParameterChanged;
+       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.
@@ -191,11 +224,11 @@ class Plugin : public PBD::StatefulDestructible, public Latent
        cycles_t cycles() const { return _cycles; }
 
 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);
 
        /** 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.
@@ -211,10 +244,19 @@ protected:
        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);