change ownership of processor window-proxy
[ardour.git] / libs / ardour / ardour / processor.h
index 55e0cfb2d6f24a1683687aea71393dd403c394c9..4f8434f1791ec724f164dcdcf51f38458071df27 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;
 
 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);
 
        virtual ~Processor() { }
 
@@ -58,32 +60,44 @@ 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 nframes_t signal_latency() const { return 0; }
+       virtual framecnt_t signal_latency() const { return 0; }
 
-       virtual int set_block_size (nframes_t /*nframes*/) { return 0; }
-        virtual bool requires_fixed_sized_buffers() const { return false; }
+       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, bufs is required to contain valid data;
-        *  if false, the method need not bother writing to bufs if it doesn't want to.
-        */  
-       virtual void run (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, nframes_t /*nframes*/, bool result_required) {}
-       virtual void silence (nframes_t /*nframes*/) {}
+       /** @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
           smoothly.
@@ -92,13 +106,24 @@ 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);
 
        PBD::Signal0<void>                     ActiveChanged;
        PBD::Signal2<void,ChanCount,ChanCount> ConfigurationChanged;
 
+       void  set_ui (void*);
+       void* get_ui () const { return _ui_pointer; }
+
+       ProcessorWindowProxy * window_proxy () const { return _window_proxy; }
+       void set_window_proxy (ProcessorWindowProxy* 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;
@@ -106,10 +131,10 @@ protected:
        ChanCount _configured_input;
        ChanCount _configured_output;
        bool      _display_to_user;
-       bool      _pre_fader;
-
-private:
-       int set_state_2X (const XMLNode&, int version);
+       bool      _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false
+       void*     _ui_pointer;
+       ProcessorWindowProxy *_window_proxy;
+        SessionObject* _owner;
 };
 
 } // namespace ARDOUR