switch to using boost::signals2 instead of sigc++, at least for libardour. not finish...
[ardour.git] / libs / ardour / ardour / processor.h
index 757af64c872c2cc40c2f9c9c99c9877e191a5473..5962e8f44ecb95c54f8304d86fc5e01fdce2c023 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000 Paul Davis 
+    Copyright (C) 2000 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -24,9 +24,8 @@
 #include <string>
 #include <exception>
 
-#include "pbd/statefuldestructible.h" 
+#include "pbd/statefuldestructible.h"
 
-#include <sigc++/signal.h>
 
 #include "ardour/ardour.h"
 #include "ardour/automatable_controls.h"
@@ -50,70 +49,59 @@ class Processor : public SessionObject, public AutomatableControls, public Laten
        static const std::string state_node_name;
 
        Processor(Session&, const std::string& name);
-       
+       Processor(Session&, const XMLNode& node);
+
        virtual ~Processor() { }
-       
-       /** Configuration of a processor on a bus
-        * (i.e. how to apply to a BufferSet)
-        */
-       struct Mapping {
-           ChanCount in;
-           ChanCount out;
-       };
-       
-       uint32_t sort_key() const { return _sort_key; }
-       void set_sort_key (uint32_t key);
 
-       bool active () const { return _active; }
-       
+       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 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 void transport_stopped (nframes_t frame) {}
-       
-       virtual void set_block_size (nframes_t nframes) {}
 
-       virtual void run_in_place (BufferSet& bufs,
-                       nframes_t start_frame, nframes_t end_frame,
-                       nframes_t nframes) { assert(is_in_place()); }
-       
-       virtual void run_out_of_place (BufferSet& input, BufferSet& output,
-                       nframes_t start_frame, nframes_t end_frame,
-                       nframes_t nframes) { assert(is_out_of_place()); }
-       
-       virtual void silence (nframes_t nframes) {}
-       
-       void activate ()   { _active = true; ActiveChanged(); }
-       void deactivate () { _active = false; ActiveChanged(); }
-       
-       virtual bool configure_io (ChanCount in, ChanCount out);
+       virtual void transport_stopped (sframes_t /*frame*/) {}
 
-       /* Derived classes should override these, or processor appears as an in-place pass-through */
+       virtual void set_block_size (nframes_t /*nframes*/) {}
 
-       /** In-place processors implement run_in_place and modify thee input buffer parameter */
-       virtual bool is_in_place () const { return true; }
+       /** @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*/, sframes_t /*start_frame*/, sframes_t /*end_frame*/, nframes_t /*nframes*/, bool /*result_required*/) {}
+       virtual void silence (nframes_t /*nframes*/) {}
 
-       /* Out-Of-Place processors implement run_out_of_place, don't modify the input parameter
-        * and write to their output parameter */
-       virtual bool is_out_of_place () const { return false; }
+       virtual void activate ()   { _pending_active = true; ActiveChanged(); }
+       virtual void deactivate () { _pending_active = false; ActiveChanged(); }
+
+       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 ChanCount input_streams () const { return _configured_input; }
        virtual ChanCount output_streams() const { return _configured_output; }
 
+       /* note: derived classes should implement state(), NOT get_state(), to allow
+          us to merge C++ inheritance and XML lack-of-inheritance reasonably
+          smoothly.
+        */
+
        virtual XMLNode& state (bool full);
-       virtual XMLNode& get_state (void);
-       virtual int set_state (const XMLNode&);
+       XMLNode& get_state (void);
+       int set_state (const XMLNode&, int version);
        
        void *get_gui () const { return _gui; }
        void  set_gui (void *p) { _gui = p; }
 
-       static sigc::signal<void,Processor*> ProcessorCreated;
+       static boost::signals2::signal<void(Processor*)> ProcessorCreated;
 
-       sigc::signal<void>                     ActiveChanged;
-       sigc::signal<void,ChanCount,ChanCount> ConfigurationChanged;
+       boost::signals2::signal<void()>                     ActiveChanged;
+       boost::signals2::signal<void(ChanCount,ChanCount)> ConfigurationChanged;
 
 protected:
        int       _pending_active;
@@ -122,9 +110,11 @@ protected:
        bool      _configured;
        ChanCount _configured_input;
        ChanCount _configured_output;
-       uint32_t  _sort_key;
        void*     _gui;  /* generic, we don't know or care what this is */
-       Mapping   _mapping;
+       bool        _display_to_user;
+
+private:
+       int set_state_2X (const XMLNode&, int version);
 };
 
 } // namespace ARDOUR