add initial midi sidechain if plugin has one.
[ardour.git] / libs / ardour / ardour / processor.h
index 05f7dd4fb1281b8726782ed7afbf8a48d28422ae..1a4863ff2d85eef2a53d208078968c37437f7204 100644 (file)
 #include "ardour/buffer_set.h"
 #include "ardour/latent.h"
 #include "ardour/session_object.h"
+#include "ardour/libardour_visibility.h"
 #include "ardour/types.h"
 #include "ardour/automatable.h"
 
 class XMLNode;
+class ProcessorWindowProxy;
+class PluginPinWindowProxy;
 
 namespace ARDOUR {
 
@@ -41,13 +44,13 @@ class Session;
 class Route;
 
 /** A mixer strip element - plugin, send, meter, etc */
-class Processor : public SessionObject, public Automatable, public Latent
+class LIBARDOUR_API Processor : public SessionObject, public Automatable, public Latent
 {
   public:
        static const std::string state_node_name;
 
        Processor(Session&, const std::string& name);
-        Processor (const Processor& other);
+       Processor (const Processor& other);
 
        virtual ~Processor() { }
 
@@ -56,7 +59,11 @@ class Processor : public SessionObject, public Automatable, public Latent
        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; }
@@ -64,27 +71,37 @@ class Processor : public SessionObject, public Automatable, public Latent
        virtual framecnt_t signal_latency() const { return 0; }
 
        virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
-        virtual bool requires_fixed_sized_buffers() const { return false; }
+       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*/) {}
 
        virtual void activate ()   { _pending_active = true; ActiveChanged(); }
        virtual void deactivate () { _pending_active = false; ActiveChanged(); }
-        virtual void flush() {}
+       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 */
 
-       virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const = 0;
+       virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) = 0;
        virtual ChanCount input_streams () const { return _configured_input; }
        virtual ChanCount output_streams() const { return _configured_output; }
 
        virtual void realtime_handle_transport_stopped () {}
+       virtual void realtime_locate () {}
+
+       /* 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
+          need to know about it.
+       */
+       virtual void monitoring_changed() {}
 
        /* note: derived classes should implement state(), NOT get_state(), to allow
           us to merge C++ inheritance and XML lack-of-inheritance reasonably
@@ -94,18 +111,28 @@ class Processor : public SessionObject, public Automatable, public Latent
        virtual XMLNode& state (bool full);
        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; }
+
+       void  set_ui (void*);
+       void* get_ui () const { return _ui_pointer; }
+
+       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;
 
 protected:
        virtual int set_state_2X (const XMLNode&, int version);
-       
+
        int       _pending_active;
        bool      _active;
        bool      _next_ab_is_active;
@@ -114,7 +141,10 @@ protected:
        ChanCount _configured_output;
        bool      _display_to_user;
        bool      _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false
-        void*     _ui_pointer;
+       void*     _ui_pointer;
+       ProcessorWindowProxy *_window_proxy;
+       PluginPinWindowProxy *_pinmgr_proxy;
+       SessionObject* _owner;
 };
 
 } // namespace ARDOUR