Trim function that is only used once.
[ardour.git] / libs / ardour / ardour / plugin_insert.h
index 37cf0d49b28891f95762ab4d34a7fc22c4f73a1d..b7a89b663ffe5e355e44d4aa08e491112aeb90df 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000,2007 Paul Davis 
+    Copyright (C) 2000,2007 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 #include <vector>
 #include <string>
-#include <exception>
 
-#include <sigc++/signal.h>
-#include <ardour/ardour.h>
-#include <ardour/plugin_state.h>
-#include <ardour/types.h>
-#include <ardour/insert.h>
+#include <boost/weak_ptr.hpp>
+
+#include "ardour/ardour.h"
+#include "ardour/types.h"
+#include "ardour/processor.h"
+#include "ardour/automation_control.h"
 
 class XMLNode;
 
@@ -40,27 +40,26 @@ class Plugin;
 
 /** Plugin inserts: send data through a plugin
  */
-class PluginInsert : public Insert
+class PluginInsert : public Processor
 {
   public:
-       PluginInsert (Session&, boost::shared_ptr<Plugin>, Placement);
-       PluginInsert (Session&, const XMLNode&);
-       PluginInsert (const PluginInsert&);
+       PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
        ~PluginInsert ();
 
-       static const string port_automation_node_name;
-       
+       static const std::string port_automation_node_name;
+
        XMLNode& state(bool);
        XMLNode& get_state(void);
-       int set_state(const XMLNode&);
+       int set_state(const XMLNode&, int version);
+
+       void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
+       void silence (framecnt_t nframes);
 
-       void run (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes, nframes_t offset);
-       void silence (nframes_t nframes, nframes_t offset);
-       
        void activate ();
        void deactivate ();
+       void flush ();
 
-       void set_block_size (nframes_t nframes);
+       int set_block_size (pframes_t nframes);
 
        ChanCount output_streams() const;
        ChanCount input_streams() const;
@@ -70,22 +69,40 @@ class PluginInsert : public Insert
        bool     set_count (uint32_t num);
        uint32_t get_count () const { return _plugins.size(); }
 
-       virtual bool      can_support_input_configuration (ChanCount in) const;
-       virtual ChanCount output_for_input_configuration (ChanCount in) const;
-       virtual bool      configure_io (ChanCount in, ChanCount out);
+       bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
+       bool configure_io (ChanCount in, ChanCount out);
+
+       bool has_no_inputs() const;
+       bool has_no_audio_inputs() const;
+       bool is_midi_instrument() const;
 
-       bool is_generator() const;
+       void realtime_handle_transport_stopped ();
 
-       void set_parameter (uint32_t port, float val);
+       struct PluginControl : public AutomationControl
+       {
+               PluginControl (PluginInsert* p, const Evoral::Parameter &param,
+                               boost::shared_ptr<AutomationList> list = boost::shared_ptr<AutomationList>());
 
-       AutoState get_port_automation_state (uint32_t port);
-       void set_port_automation_state (uint32_t port, AutoState);
-       void protect_automation ();
+               void set_value (double val);
+               double get_value (void) const;
+               XMLNode& get_state();
 
-       float default_parameter_value (uint32_t which);
+               double user_to_ui (double) const;
+               double ui_to_user (double) const;
+               double plugin_to_ui (double) const;
+               double plugin_to_user (double) const;
+
+       private:
+               double user_to_plugin (double) const;
+
+               PluginInsert* _plugin;
+               bool _logarithmic;
+               bool _sr_dependent;
+               bool _toggled;
+       };
 
        boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
-               if (num < _plugins.size()) { 
+               if (num < _plugins.size()) {
                        return _plugins[num];
                } else {
                        return _plugins[0]; // we always have one
@@ -94,30 +111,82 @@ class PluginInsert : public Insert
 
        PluginType type ();
 
-       string describe_parameter (uint32_t);
+       std::string describe_parameter (Evoral::Parameter param);
 
-       nframes_t latency();
+       framecnt_t signal_latency () const;
 
-       void transport_stopped (nframes_t now);
-       void automation_snapshot (nframes_t now);
+       boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 
-  private:
+       void collect_signal_for_analysis (framecnt_t nframes);
 
-       void parameter_changed (uint32_t, float);
-       
-       vector<boost::shared_ptr<Plugin> > _plugins;
+       bool splitting () const {
+               return _match.method == Split;
+       }
+
+       PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
+       /** Emitted when the return value of splitting () has changed */
+       PBD::Signal0<void> SplittingChanged;
+
+       /** 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
+       };
        
-       void automation_run (BufferSet& bufs, nframes_t nframes, nframes_t offset);
-       void connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t offset, bool with_auto, nframes_t now = 0);
+  private:
+       /* disallow copy construction */
+       PluginInsert (const PluginInsert&);
+
+       void parameter_changed (Evoral::Parameter, float);
+
+       void  set_parameter (Evoral::Parameter param, float val);
+       float get_parameter (Evoral::Parameter param);
+
+       float default_parameter_value (const Evoral::Parameter& param);
+
+       typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
+       Plugins _plugins;
+
+       boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
+
+       framecnt_t _signal_analysis_collected_nframes;
+       framecnt_t _signal_analysis_collect_nframes_max;
+
+       BufferSet _signal_analysis_inputs;
+       BufferSet _signal_analysis_outputs;
+
+       /** 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
+       };
+
+       Match private_can_support_io_configuration (ChanCount const &, ChanCount &) const;
+
+       /** details of the match currently being used */
+       Match _match;
 
-       void init ();
-       void set_automatable ();
-       void auto_state_changed (uint32_t which);
-       void automation_list_creation_callback (uint32_t, AutomationList&);
+       void automation_run (BufferSet& bufs, pframes_t nframes);
+       void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
 
-       int32_t count_for_configuration (ChanCount in, ChanCount out) const;
+       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>);
 };
 
 } // namespace ARDOUR