set + store signal chain latency for all processors; DiskWriter sets its capture_offs...
[ardour.git] / libs / ardour / ardour / processor.h
index 85d466a169265434d859ba44da3aa4a7343d727e..095ab7fadf8c7321fa9276c6e38a1ad17f977a56 100644 (file)
@@ -35,6 +35,8 @@
 #include "ardour/automatable.h"
 
 class XMLNode;
+class ProcessorWindowProxy;
+class PluginPinWindowProxy;
 
 namespace ARDOUR {
 
@@ -50,14 +52,16 @@ 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; }
 
@@ -66,19 +70,24 @@ class LIBARDOUR_API Processor : public SessionObject, public Automatable, public
 
        virtual framecnt_t signal_latency() const { return 0; }
 
+       virtual void set_input_latency (framecnt_t);
+       framecnt_t input_latency () const { return _input_latency; }
+
        virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
        virtual bool requires_fixed_sized_buffers() const { return false; }
 
        /** @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*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, double speed, pframes_t /*nframes*/, bool /*result_required*/) {}
+       virtual void silence (framecnt_t nframes, framepos_t start_frame) { automation_run (start_frame, 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 */
@@ -106,16 +115,27 @@ class LIBARDOUR_API Processor : public SessionObject, public Automatable, public
        XMLNode& get_state (void);
        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; }
+
+       PluginPinWindowProxy * pinmgr_proxy () const { return _pinmgr_proxy; }
+       void set_pingmgr_proxy (PluginPinWindowProxy* wp) { _pinmgr_proxy = wp ; }
 
-        void set_owner (SessionObject*);
-        SessionObject* owner() const;
+       virtual void set_owner (SessionObject*);
+       SessionObject* owner() const;
 
 protected:
        virtual int set_state_2X (const XMLNode&, int version);
@@ -129,7 +149,10 @@ 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;
+       framecnt_t _input_latency;
 };
 
 } // namespace ARDOUR