prototype online self-automating LV2 plugin interface
[ardour.git] / libs / ardour / ardour / plugin.h
index 063335ccc3f57d3620d9d58c2f306c0b0365d307..0bc766c4622f447d76bf933ea4185aa9313faf17 100644 (file)
@@ -48,45 +48,10 @@ class Session;
 class BufferSet;
 class PluginInsert;
 class Plugin;
+class PluginInfo;
+class AutomationControl;
 
 typedef boost::shared_ptr<Plugin> PluginPtr;
-
-class LIBARDOUR_API PluginInfo {
-  public:
-       PluginInfo () { }
-       virtual ~PluginInfo () { }
-
-       std::string name;
-       std::string category;
-       std::string creator;
-       std::string path;
-       ChanCount n_inputs;
-       ChanCount n_outputs;
-       ARDOUR::PluginType type;
-
-       std::string unique_id;
-
-       virtual PluginPtr load (Session& session) = 0;
-       virtual bool is_instrument() const;
-       virtual bool in_category (const std::string &) const { return false; }
-
-       /* 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;
-       uint32_t index;
-};
-
 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
 typedef std::list<PluginInfoPtr> PluginInfoList;
 
@@ -101,6 +66,7 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
        virtual int set_state (const XMLNode &, int version);
 
        virtual void set_insert_id (PBD::ID id) {}
+       virtual void set_state_dir (const std::string& d = "") {}
 
        virtual std::string unique_id() const = 0;
        virtual const char * label() const = 0;
@@ -119,6 +85,7 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
        virtual void flush () { deactivate(); activate(); }
 
        virtual int set_block_size (pframes_t nframes) = 0;
+       virtual bool requires_fixed_sized_buffers() const { return false; }
 
        virtual int connect_and_run (BufferSet& bufs,
                                     ChanMapping in, ChanMapping out,
@@ -134,6 +101,8 @@ class LIBARDOUR_API 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 void set_automation_control (uint32_t /*port_index*/, boost::shared_ptr<ARDOUR::AutomationControl>) { }
+
        virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
                return boost::shared_ptr<ScalePoints>();
        }
@@ -143,17 +112,17 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
        void monitoring_changed ();
 
        struct PresetRecord {
-           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)  {}
+           PresetRecord () : valid (false) {}
+           PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s), valid (true)  {}
 
            bool operator!= (PresetRecord const & a) const {
-                   return number != a.number || uri != a.uri || label != a.label;
+                   return uri != a.uri || label != a.label;
            }
 
            std::string uri;
            std::string label;
-           int number; // if <0, invalid
            bool user;
+           bool valid;
        };
 
        PresetRecord save_preset (std::string);
@@ -206,6 +175,9 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
        PBD::Signal0<void> PresetAdded;
        PBD::Signal0<void> PresetRemoved;
 
+       /** Emitted when any preset has been changed */
+       static PBD::Signal2<void, std::string, Plugin*> PresetsChanged;
+
        /** Emitted when a preset has been loaded */
        PBD::Signal0<void> PresetLoaded;
 
@@ -311,6 +283,8 @@ private:
        /** Fill _presets with our presets */
        virtual void find_presets () = 0;
 
+       void update_presets (std::string src_unique_id, Plugin* src );
+
        /** Add state to an existing XMLNode */
        virtual void add_state (XMLNode *) const = 0;
 
@@ -321,11 +295,70 @@ private:
        PresetRecord _last_preset;
        bool _parameter_changed_since_last_preset;
 
+       PBD::ScopedConnection _preset_connection;
+
        void resolve_midi ();
 };
 
+struct PluginPreset {
+       PluginInfoPtr   _pip;
+       Plugin::PresetRecord _preset;
+
+       PluginPreset (PluginInfoPtr pip, const Plugin::PresetRecord *preset = NULL)
+               : _pip (pip)
+       {
+               if (preset) {
+                       _preset.uri    = preset->uri;
+                       _preset.label  = preset->label;
+                       _preset.user   = preset->user;
+                       _preset.valid  = preset->valid;
+               }
+       }
+};
+
+typedef boost::shared_ptr<PluginPreset> PluginPresetPtr;
+typedef std::list<PluginPresetPtr> PluginPresetList;
+
 PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
 
+class LIBARDOUR_API PluginInfo {
+  public:
+       PluginInfo () { }
+       virtual ~PluginInfo () { }
+
+       std::string name;
+       std::string category;
+       std::string creator;
+       std::string path;
+       ChanCount n_inputs;
+       ChanCount n_outputs;
+       ARDOUR::PluginType type;
+
+       std::string unique_id;
+
+       virtual PluginPtr load (Session& session) = 0;
+       virtual bool is_instrument() const;
+       virtual bool in_category (const std::string &) const { return false; }
+
+       virtual std::vector<Plugin::PresetRecord> get_presets (bool user_only) const = 0;
+
+       /* 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;
+       uint32_t index;
+};
+
 } // namespace ARDOUR
 
 #endif /* __ardour_plugin_h__ */