Tempo ramps - Remove the tick walk, store c_func, document the approach.

[ardour.git] / libs / ardour / ardour / processor.h

diff --git a/libs/ardour/ardour/processor.h b/libs/ardour/ardour/processor.h
index 94b936348081d61588efa3410b1d1ef3fdc202bc..914ddb904fca0f24bda07fc4c2c2430e152701c9 100644 (file)
--- a/libs/ardour/ardour/processor.h
+++ b/libs/ardour/ardour/processor.h
@@ -30,25 +30,27 @@
 #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 {
 
 class Session;
 class Route;
 
-/* A mixer strip element - plugin, send, meter, etc.
- */
-class Processor : public SessionObject, public Automatable, public Latent
+/** A mixer strip element - plugin, send, meter, etc */
+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() { }
 
@@ -59,33 +61,43 @@ class Processor : public SessionObject, public Automatable, public Latent
 
        bool active () const { return _pending_active; }
 
+       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 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, bufs is required to contain valid data;
-        *  if false, the method need not bother writing to bufs if it doesn't want to.
-        */  
+       /** @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 activate ()   { _pending_active = true; ActiveChanged(); }
        virtual void deactivate () { _pending_active = false; ActiveChanged(); }
-        virtual void flush() {}
+       virtual void flush() {}
 
        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
@@ -95,18 +107,27 @@ 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::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,8 +135,11 @@ protected:
        ChanCount _configured_input;
        ChanCount _configured_output;
        bool      _display_to_user;
-       bool      _pre_fader;
-        void*     _ui_pointer;
+       bool      _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false
+       void*     _ui_pointer;
+       ProcessorWindowProxy *_window_proxy;
+       PluginPinWindowProxy *_pinmgr_proxy;
+       SessionObject* _owner;
 };
 
 } // namespace ARDOUR