add wrapper for ChanMapping::get()
[ardour.git] / libs / ardour / ardour / plugin_insert.h
index 2e24bdd707407b1591df1852db89b684383f00ad..ffa55b9eaa4bafc4184a930b00bf4613a3e2c5f1 100644 (file)
@@ -26,7 +26,9 @@
 #include <boost/weak_ptr.hpp>
 
 #include "ardour/ardour.h"
+#include "ardour/libardour_visibility.h"
 #include "ardour/types.h"
+#include "ardour/parameter_descriptor.h"
 #include "ardour/processor.h"
 #include "ardour/automation_control.h"
 
@@ -40,7 +42,7 @@ class Plugin;
 
 /** Plugin inserts: send data through a plugin
  */
-class PluginInsert : public Processor
+class LIBARDOUR_API PluginInsert : public Processor
 {
   public:
        PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
@@ -51,14 +53,20 @@ class PluginInsert : public Processor
        XMLNode& state(bool);
        XMLNode& get_state(void);
        int set_state(const XMLNode&, int version);
+       void update_id (PBD::ID);
+       void set_state_dir (const std::string& d = "");
 
-       void run (BufferSet& in, sframes_t start_frame, sframes_t end_frame, nframes_t nframes, bool);
-       void silence (nframes_t nframes);
+       void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
+       void silence (framecnt_t nframes);
 
        void activate ();
        void deactivate ();
+       void flush ();
 
-       void set_block_size (nframes_t nframes);
+       bool reset_parameters_to_default ();
+       bool can_reset_all_parameters ();
+
+       int set_block_size (pframes_t nframes);
 
        ChanCount output_streams() const;
        ChanCount input_streams() const;
@@ -68,23 +76,52 @@ class PluginInsert : public Processor
        bool     set_count (uint32_t num);
        uint32_t get_count () const { return _plugins.size(); }
 
-       bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
+       bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
        bool configure_io (ChanCount in, ChanCount out);
 
-       bool is_generator() const;
+       bool has_no_inputs() const;
+       bool has_no_audio_inputs() const;
+       bool is_midi_instrument() const;
+
+       void realtime_handle_transport_stopped ();
+       void realtime_locate ();
+       void monitoring_changed ();
 
+       /** A control that manipulates a plugin parameter (control port). */
        struct PluginControl : public AutomationControl
        {
-               PluginControl (PluginInsert* p, const Evoral::Parameter &param,
-                               boost::shared_ptr<AutomationList> list = boost::shared_ptr<AutomationList>());
+               PluginControl (PluginInsert*                     p,
+                              const Evoral::Parameter&          param,
+                              const ParameterDescriptor&        desc,
+                              boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
 
-               void set_value (float val);
-               float get_value (void) const;
+               void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
+               void set_value_unchecked (double);
+               double get_value (void) const;
+               void catch_up_with_external_value (double val);
+               XMLNode& get_state();
 
        private:
                PluginInsert* _plugin;
-               bool _logarithmic;
-               bool _toggled;
+               void _set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
+       };
+
+       /** A control that manipulates a plugin property (message). */
+       struct PluginPropertyControl : public AutomationControl
+       {
+               PluginPropertyControl (PluginInsert*                     p,
+                                      const Evoral::Parameter&          param,
+                                      const ParameterDescriptor&        desc,
+                                      boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
+
+               void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
+               void set_value_unchecked (double);
+               double get_value (void) const;
+               XMLNode& get_state();
+
+       private:
+               PluginInsert* _plugin;
+               Variant       _value;
        };
 
        boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
@@ -99,22 +136,41 @@ class PluginInsert : public Processor
 
        std::string describe_parameter (Evoral::Parameter param);
 
-       nframes_t signal_latency() const;
+       framecnt_t signal_latency () const;
 
        boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 
-       void collect_signal_for_analysis(nframes_t nframes);
+       void collect_signal_for_analysis (framecnt_t nframes);
+
+       bool splitting () const {
+               return _match.method == Split;
+       }
+
+       void configured_io (ChanCount &in, ChanCount &out) { in = _configured_in; out = _configured_out; }
 
        PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
+       PBD::Signal0<void> PluginIoReConfigure;
+
+       /** Enumeration of the ways in which we can match our insert's
+        *  IO to that of the plugin(s).
+        */
+       enum MatchingMethod {
+               Impossible,  ///< we can't
+               Delegate,    ///< we are delegating to the plugin, and it can handle it
+               NoInputs,    ///< plugin has no inputs, so anything goes
+               ExactMatch,  ///< our insert's inputs are the same as the plugin's
+               Replicate,   ///< we have multiple instances of the plugin
+               Split,       ///< we copy one of our insert's inputs to multiple plugin inputs
+               Hide,        ///< we `hide' some of the plugin's inputs by feeding them silence
+       };
 
   private:
        /* disallow copy construction */
        PluginInsert (const PluginInsert&);
 
-       void parameter_changed (Evoral::Parameter, float);
+       void parameter_changed_externally (uint32_t, float);
 
        void  set_parameter (Evoral::Parameter param, float val);
-       float get_parameter (Evoral::Parameter param);
 
        float default_parameter_value (const Evoral::Parameter& param);
 
@@ -123,23 +179,45 @@ class PluginInsert : public Processor
 
        boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
 
-       nframes_t _signal_analysis_collected_nframes;
-       nframes_t _signal_analysis_collect_nframes_max;
+       framecnt_t _signal_analysis_collected_nframes;
+       framecnt_t _signal_analysis_collect_nframes_max;
 
        BufferSet _signal_analysis_inputs;
        BufferSet _signal_analysis_outputs;
 
-       void automation_run (BufferSet& bufs, nframes_t nframes);
-       void connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t offset, bool with_auto, nframes_t now = 0);
+       ChanCount midi_bypass;
 
-       void set_automatable ();
-       void auto_state_changed (Evoral::Parameter which);
-       void set_parameter_state (const XMLNode& node, int version);
-       void set_parameter_state_2X (const XMLNode& node, int version);
+       ChanCount _configured_in;
+       ChanCount _configured_out;
+
+       /** Description of how we can match our plugin's IO to our own insert IO */
+       struct Match {
+               Match () : method (Impossible), plugins (0) {}
+               Match (MatchingMethod m, int32_t p, ChanCount h = ChanCount ()) : method (m), plugins (p), hide (h) {}
+
+               MatchingMethod method; ///< method to employ
+               int32_t plugins;       ///< number of copies of the plugin that we need
+               ChanCount hide;        ///< number of channels to hide
+       };
 
-       int32_t count_for_configuration (ChanCount in, ChanCount out) const;
+       Match private_can_support_io_configuration (ChanCount const &, ChanCount &);
+
+       /** details of the match currently being used */
+       Match _match;
+
+       void automation_run (BufferSet& bufs, framepos_t start, pframes_t nframes);
+       void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
+
+       void create_automatable_parameters ();
+       void control_list_automation_state_changed (Evoral::Parameter, AutoState);
+       void set_parameter_state_2X (const XMLNode& node, int version);
+       void set_control_ids (const XMLNode&, int version);
 
        boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
+       void add_plugin (boost::shared_ptr<Plugin>);
+
+       void start_touch (uint32_t param_id);
+       void end_touch (uint32_t param_id);
 };
 
 } // namespace ARDOUR