rationalize save/restore of control surface "feedback" property
[ardour.git] / libs / surfaces / control_protocol / control_protocol / control_protocol.h
index abbf73c396c2be741b5989586d2ed650c4fe7f7c..13b8dcad7a76c7bda186523ce5afd7a8c3fa3420 100644 (file)
 #include <string>
 #include <vector>
 #include <list>
+
 #include <boost/shared_ptr.hpp>
+
 #include "pbd/stateful.h"
 #include "pbd/signals.h"
+
+#include "control_protocol/visibility.h"
 #include "control_protocol/basic_ui.h"
+#include "control_protocol/types.h"
 
 namespace ARDOUR {
 
@@ -35,20 +40,21 @@ class Route;
 class Session;
 class Bundle;
 
-class ControlProtocol : virtual public sigc::trackable, public PBD::Stateful, public PBD::ScopedConnectionList, public BasicUI {
+class LIBCONTROLCP_API ControlProtocol : public PBD::Stateful, public PBD::ScopedConnectionList, public BasicUI
+{
   public:
-       ControlProtocol (Session&, std::string name, PBD::EventLoop* event_loop);
+       ControlProtocol (Session&, std::string name);
        virtual ~ControlProtocol();
 
        std::string name() const { return _name; }
 
-       virtual int set_active (bool yn) = 0;
-       bool get_active() const { return _active; }
+        virtual int set_active (bool yn);
+        bool active() const { return _active; }
 
        virtual int set_feedback (bool /*yn*/) { return 0; }
        virtual bool get_feedback () const { return false; }
 
-       virtual void route_list_changed () {}
+       virtual void midi_connectivity_established () {}
 
        PBD::Signal0<void> ActiveChanged;
 
@@ -63,14 +69,27 @@ class ControlProtocol : virtual public sigc::trackable, public PBD::Stateful, pu
        static PBD::Signal0<void> Undo;
        static PBD::Signal0<void> Redo;
        static PBD::Signal1<void,float> ScrollTimeline;
-       static PBD::Signal1<void,uint32_t> SelectByRID;
-       static PBD::Signal0<void> UnselectTrack;
        static PBD::Signal1<void,uint32_t> GotoView;
        static PBD::Signal0<void> CloseDialog;
        static PBD::Signal0<void> VerticalZoomInAll;
        static PBD::Signal0<void> VerticalZoomOutAll;
        static PBD::Signal0<void> VerticalZoomInSelected;
        static PBD::Signal0<void> VerticalZoomOutSelected;
+       static PBD::Signal0<void> StepTracksDown;
+       static PBD::Signal0<void> StepTracksUp;
+
+       static PBD::Signal1<void,uint32_t> AddRouteToSelection;
+       static PBD::Signal1<void,uint32_t> SetRouteSelection;
+       static PBD::Signal1<void,uint32_t> ToggleRouteSelection;
+       static PBD::Signal1<void,uint32_t> RemoveRouteFromSelection;
+       static PBD::Signal0<void>          ClearRouteSelection;
+
+       /* signals that one UI (e.g. the GUI) can emit to get all other UI's to 
+          respond. Typically this will always be GUI->"others" - the GUI pays
+          no attention to these signals.
+       */
+       
+       static PBD::Signal1<void,RouteNotificationListPtr> TrackSelectionChanged;
 
        /* the model here is as follows:
 
@@ -115,24 +134,26 @@ class ControlProtocol : virtual public sigc::trackable, public PBD::Stateful, pu
        virtual void* get_gui() const { return 0; }
        virtual void  tear_down_gui() { }
 
+        XMLNode& get_state ();
+        int set_state (XMLNode const &, int version);
+        
+        static const std::string state_node_name;
+
   protected:
-       PBD::EventLoop* _event_loop;
-       bool _own_event_loop;
        std::vector<boost::shared_ptr<ARDOUR::Route> > route_table;
        std::string _name;
-       bool _active;
-
-       void add_strip (std::list<boost::shared_ptr<ARDOUR::Route> >&);
 
        void next_track (uint32_t initial_id);
        void prev_track (uint32_t initial_id);
 
   private:
-       ControlProtocol (const ControlProtocol&); /* noncopyable */
+       LIBCONTROLCP_LOCAL ControlProtocol (const ControlProtocol&); /* noncopyable */
+        bool _active;
 };
 
 extern "C" {
-       struct ControlProtocolDescriptor {
+       class ControlProtocolDescriptor {
+       public:
            const char* name;      /* descriptive */
            const char* id;        /* unique and version-specific */
            void*       ptr;       /* protocol can store a value here */