Optimize automation-event process splitting
[ardour.git] / libs / ardour / ardour / processor.h
index 85d466a169265434d859ba44da3aa4a7343d727e..ea982035bc63dc375fe3d77288ab0a01cdd53cb1 100644 (file)
 #include "ardour/automatable.h"
 
 class XMLNode;
+class ProcessorWindowProxy;
+class PluginPinWindowProxy;
 
 namespace ARDOUR {
 
+class Location;
 class Session;
 class Route;
 
@@ -50,21 +53,35 @@ class LIBARDOUR_API Processor : public SessionObject, public Automatable, public
        Processor(Session&, const std::string& name);
        Processor (const Processor& other);
 
-       virtual ~Processor() { }
+       virtual ~Processor();
 
        virtual std::string display_name() const { return SessionObject::name(); }
 
        virtual bool display_to_user() const { return _display_to_user; }
        virtual void set_display_to_user (bool);
 
-       bool active () const { return _pending_active; }
+       bool active () const { return _pending_active; } ///< ardour hard bypass
+       virtual bool enabled () const { return _pending_active; } ///< processor enabled/bypass
+       virtual bool bypassable () const { return true; } ///< enable is not automated or locked
 
        virtual bool does_routing() const { return false; }
 
        bool get_next_ab_is_active () const { return _next_ab_is_active; }
        void set_next_ab_is_active (bool yn) { _next_ab_is_active = yn; }
 
-       virtual framecnt_t signal_latency() const { return 0; }
+       virtual samplecnt_t signal_latency() const { return 0; }
+
+       virtual void set_input_latency (samplecnt_t cnt) { _input_latency = cnt; }
+       samplecnt_t input_latency () const               { return _input_latency; }
+
+       virtual void set_output_latency (samplecnt_t cnt) { _output_latency = cnt; }
+       samplecnt_t output_latency () const               { return _output_latency; }
+
+       virtual void set_capture_offset (samplecnt_t cnt) { _capture_offset = cnt; }
+       samplecnt_t capture_offset () const               { return _capture_offset; }
+
+       virtual void set_playback_offset (samplecnt_t cnt) { _playback_offset = cnt; }
+       samplecnt_t playback_offset () const               { return _playback_offset; }
 
        virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
        virtual bool requires_fixed_sized_buffers() const { return false; }
@@ -72,13 +89,15 @@ class LIBARDOUR_API Processor : public SessionObject, public Automatable, public
        /** @param result_required true if, on return from this method, @a bufs is required to contain valid data;
         *  if false, the method need not bother writing to @a bufs if it doesn't want to.
         */
-       virtual void run (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t /*nframes*/, bool /*result_required*/) {}
-       virtual void silence (framecnt_t /*nframes*/) {}
+       virtual void run (BufferSet& /*bufs*/, samplepos_t /*start_sample*/, samplepos_t /*end_sample*/, double speed, pframes_t /*nframes*/, bool /*result_required*/) {}
+       virtual void silence (samplecnt_t nframes, samplepos_t start_sample) { automation_run (start_sample, nframes); }
 
        virtual void activate ()   { _pending_active = true; ActiveChanged(); }
        virtual void deactivate () { _pending_active = false; ActiveChanged(); }
        virtual void flush() {}
 
+       virtual void enable (bool yn) { if (yn) { activate (); } else { deactivate (); } }
+
        virtual bool configure_io (ChanCount in, ChanCount out);
 
        /* Derived classes should override these, or processor appears as an in-place pass-through */
@@ -90,6 +109,8 @@ class LIBARDOUR_API Processor : public SessionObject, public Automatable, public
        virtual void realtime_handle_transport_stopped () {}
        virtual void realtime_locate () {}
 
+       virtual void set_loop (Location *loc) { _loop_location = loc; }
+
        /* most processors won't care about this, but plugins that
           receive MIDI or similar data from an input source that
           may suddenly go "quiet" because of monitoring changes
@@ -102,24 +123,37 @@ class LIBARDOUR_API Processor : public SessionObject, public Automatable, public
           smoothly.
         */
 
-       virtual XMLNode& state (bool full);
-       XMLNode& get_state (void);
+       XMLNode& get_state ();
        int set_state (const XMLNode&, int version);
 
-       void set_pre_fader (bool);
+       virtual void set_pre_fader (bool);
 
        PBD::Signal0<void>                     ActiveChanged;
+       PBD::Signal0<void>                     BypassableChanged;
        PBD::Signal2<void,ChanCount,ChanCount> ConfigurationChanged;
 
-       void  set_ui (void*);
-       void* get_ui () const { return _ui_pointer; }
+       /* cross-thread signals.
+        * This allows control-surfaces to show/hide a plugin GUI.
+        */
+       PBD::Signal0<void> ToggleUI;
+       PBD::Signal0<void> ShowUI;
+       PBD::Signal0<void> HideUI;
+
+       ProcessorWindowProxy * window_proxy () const { return _window_proxy; }
+       void set_window_proxy (ProcessorWindowProxy* wp) { _window_proxy = wp; }
 
-        void set_owner (SessionObject*);
-        SessionObject* owner() const;
+       PluginPinWindowProxy * pinmgr_proxy () const { return _pinmgr_proxy; }
+       void set_pingmgr_proxy (PluginPinWindowProxy* wp) { _pinmgr_proxy = wp ; }
+
+       virtual void set_owner (SessionObject*);
+       SessionObject* owner() const;
 
 protected:
+       virtual XMLNode& state ();
        virtual int set_state_2X (const XMLNode&, int version);
 
+       bool map_loop_range (samplepos_t& start, samplepos_t& end) const;
+
        int       _pending_active;
        bool      _active;
        bool      _next_ab_is_active;
@@ -129,7 +163,16 @@ protected:
        bool      _display_to_user;
        bool      _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false
        void*     _ui_pointer;
-        SessionObject* _owner;
+       ProcessorWindowProxy *_window_proxy;
+       PluginPinWindowProxy *_pinmgr_proxy;
+       SessionObject* _owner;
+       // relative to route
+       samplecnt_t _input_latency;
+       samplecnt_t _output_latency;
+       // absolute alignment to session i/o
+       samplecnt_t _capture_offset;
+       samplecnt_t _playback_offset;
+       Location*   _loop_location;
 };
 
 } // namespace ARDOUR