Prepare for non-bypassable plugins (Mixbus channelstrip)
[ardour.git] / libs / ardour / ardour / plugin_insert.h
index db052f0f0d174971301ac1dd06a46667e3482a3f..a0dd8618f49409fd70792823e4e436c9bc91ad32 100644 (file)
@@ -25,6 +25,8 @@
 
 #include <boost/weak_ptr.hpp>
 
+#include "pbd/timing.h"
+
 #include "ardour/ardour.h"
 #include "ardour/libardour_visibility.h"
 #include "ardour/chan_mapping.h"
@@ -34,6 +36,7 @@
 #include "ardour/parameter_descriptor.h"
 #include "ardour/plugin.h"
 #include "ardour/processor.h"
+#include "ardour/readonly_control.h"
 #include "ardour/sidechain.h"
 #include "ardour/automation_control.h"
 
@@ -49,28 +52,36 @@ class Plugin;
  */
 class LIBARDOUR_API PluginInsert : public Processor
 {
-  public:
+public:
        PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
        ~PluginInsert ();
 
        static const std::string port_automation_node_name;
 
-       XMLNode& state(bool);
-       XMLNode& get_state(void);
        int set_state(const XMLNode&, int version);
        void update_id (PBD::ID);
+       void set_owner (SessionObject*);
        void set_state_dir (const std::string& d = "");
 
-       void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
-       void silence (framecnt_t nframes);
+       void run (BufferSet& in, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool);
+       void silence (samplecnt_t nframes, samplepos_t start_sample);
 
        void activate ();
        void deactivate ();
        void flush ();
 
+       void enable (bool yn);
+       bool enabled () const;
+       bool bypassable () const;
+
        bool reset_parameters_to_default ();
        bool can_reset_all_parameters ();
 
+       bool write_immediate_event (size_t size, const uint8_t* buf);
+
+       void automation_run (samplepos_t, pframes_t);
+       bool find_next_event (double, double, Evoral::ControlEvent&, bool only_active = true) const;
+
        int set_block_size (pframes_t nframes);
 
        ChanMapping input_map (uint32_t num) const {
@@ -93,7 +104,10 @@ class LIBARDOUR_API PluginInsert : public Processor
                return _thru_map;
        }
 
+       bool pre_seed (const ChanCount&, const ChanCount&, const ChanMapping&, const ChanMapping&, const ChanMapping&);
+
        ChanMapping input_map () const; ///< combined (all instances) input map
+       ChanMapping no_sc_input_map () const; ///< combined (all instances) input map w/o sidechain sinks
        ChanMapping output_map () const; ///< combined (all instances) output map
        bool has_midi_bypass () const;
        bool has_midi_thru () const;
@@ -101,6 +115,10 @@ class LIBARDOUR_API PluginInsert : public Processor
 
 #ifdef MIXBUS
        bool is_channelstrip () const;
+       bool is_nonbypassable () const;
+#else
+       bool is_channelstrip () const { return false; }
+       bool is_nonbypassable () const { return false; }
 #endif
 
        void set_input_map (uint32_t, ChanMapping);
@@ -109,6 +127,7 @@ class LIBARDOUR_API PluginInsert : public Processor
        bool reset_map (bool emit = true);
        bool sanitize_maps ();
        bool check_inplace ();
+       bool configured () const { return _configured; }
 
        // these are ports visible on the outside
        ChanCount output_streams() const;
@@ -149,7 +168,7 @@ class LIBARDOUR_API PluginInsert : public Processor
        void set_strict_io  (bool b);
        void set_custom_cfg (bool b);
        bool set_preset_out (const ChanCount&);
-       bool add_sidechain  (uint32_t n_audio = 1);
+       bool add_sidechain  (uint32_t n_audio = 1, uint32_t n_midi = 0);
        bool del_sidechain ();
        boost::shared_ptr<SideChain> sidechain () const { return _sidechain; }
        // end C++ class slavery!
@@ -163,7 +182,9 @@ class LIBARDOUR_API PluginInsert : public Processor
 
        bool has_no_inputs() const;
        bool has_no_audio_inputs() const;
-       bool needs_midi_input() const;
+
+       bool is_instrument () const;
+
        bool has_output_presets (
                        ChanCount in = ChanCount (DataType::MIDI, 1),
                        ChanCount out = ChanCount (DataType::AUDIO, 2)
@@ -175,6 +196,8 @@ class LIBARDOUR_API PluginInsert : public Processor
 
        bool load_preset (Plugin::PresetRecord);
 
+       bool get_stats (uint64_t& min, uint64_t& max, double& avg, double& dev) const;
+
        /** A control that manipulates a plugin parameter (control port). */
        struct PluginControl : public AutomationControl
        {
@@ -183,15 +206,13 @@ class LIBARDOUR_API PluginInsert : public Processor
                               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;
                void catch_up_with_external_value (double val);
                XMLNode& get_state();
 
        private:
                PluginInsert* _plugin;
-               void _set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
+               void actually_set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
        };
 
        /** A control that manipulates a plugin property (message). */
@@ -202,10 +223,10 @@ class LIBARDOUR_API PluginInsert : public Processor
                                       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();
+       protected:
+               void actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
 
        private:
                PluginInsert* _plugin;
@@ -220,7 +241,7 @@ class LIBARDOUR_API PluginInsert : public Processor
                }
        }
 
-       framecnt_t plugin_latency () const;
+       samplecnt_t plugin_latency () const;
 
        bool has_sidechain () const {
                return _sidechain ? true : false;
@@ -235,13 +256,15 @@ class LIBARDOUR_API PluginInsert : public Processor
 
        PluginType type ();
 
+       boost::shared_ptr<ReadOnlyControl> control_output (uint32_t) const;
+
        std::string describe_parameter (Evoral::Parameter param);
 
-       framecnt_t signal_latency () const;
+       samplecnt_t signal_latency () const;
 
        boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 
-       void collect_signal_for_analysis (framecnt_t nframes);
+       void collect_signal_for_analysis (samplecnt_t nframes);
 
        bool strict_io_configured () const {
                return _match.strict_io;
@@ -288,7 +311,10 @@ class LIBARDOUR_API PluginInsert : public Processor
                bool custom_cfg;       ///< custom config (if not strict)
        };
 
-  private:
+protected:
+       XMLNode& state ();
+
+private:
        /* disallow copy construction */
        PluginInsert (const PluginInsert&);
 
@@ -302,11 +328,14 @@ class LIBARDOUR_API PluginInsert : public Processor
        Plugins _plugins;
 
        boost::shared_ptr<SideChain> _sidechain;
+       uint32_t _sc_playback_latency;
+       uint32_t _sc_capture_latency;
+       uint32_t _plugin_signal_latency;
 
        boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
 
-       framecnt_t _signal_analysis_collected_nframes;
-       framecnt_t _signal_analysis_collect_nframes_max;
+       samplecnt_t _signal_analysis_collected_nframes;
+       samplecnt_t _signal_analysis_collect_nframes_max;
 
        BufferSet _signal_analysis_inputs;
        BufferSet _signal_analysis_outputs;
@@ -341,24 +370,35 @@ class LIBARDOUR_API PluginInsert : public Processor
        PinMappings _out_map;
        ChanMapping _thru_map; // out-idx <=  in-idx
 
-       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 automate_and_run (BufferSet& bufs, samplepos_t start, samplepos_t end, double speed, pframes_t nframes);
+       void connect_and_run (BufferSet& bufs, samplepos_t start, samplecnt_t end, double speed, pframes_t nframes, samplecnt_t offset, bool with_auto);
        void bypass (BufferSet& bufs, pframes_t nframes);
-       void inplace_silence_unconnected (BufferSet&, const PinMappings&, framecnt_t nframes, framecnt_t offset) const;
+       void inplace_silence_unconnected (BufferSet&, const PinMappings&, samplecnt_t nframes, samplecnt_t offset) 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);
 
+       void enable_changed ();
+       void bypassable_changed ();
+
        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);
 
-       void latency_changed (framecnt_t, framecnt_t);
+       void latency_changed ();
        bool _latency_changed;
+       uint32_t _bypass_port;
+
+       typedef std::map<uint32_t, boost::shared_ptr<ReadOnlyControl> >CtrlOutMap;
+       CtrlOutMap _control_outputs;
+
+       void preset_load_set_value (uint32_t, float);
+
+       PBD::TimingStats _timing_stats;
 };
 
 } // namespace ARDOUR