Merge remote-tracking branch 'remotes/origin/cairocanvas' into windows
[ardour.git] / libs / surfaces / control_protocol / control_protocol / control_protocol.h
index 69135f2b4b010c3f1a60603582cebed802632494..37322530e46f6fc2598c3c9cc17bd40020f0a499 100644 (file)
@@ -16,7 +16,6 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #ifndef ardour_control_protocols_h
 #include <string>
 #include <vector>
 #include <list>
-#include <sigc++/sigc++.h>
 
-#include <control_protocol/basic_ui.h>
+#include <boost/shared_ptr.hpp>
+
+#include "pbd/stateful.h"
+#include "pbd/signals.h"
+
+#include "control_protocol/basic_ui.h"
+#include "control_protocol/types.h"
+
+#ifdef ARDOURSURFACE_DLL_EXPORTS // defined if we are building the ARDOUR surface DLLs (instead of using them)
+    #define ARDOURSURFACE_API LIBARDOUR_HELPER_DLL_EXPORT
+#else
+    #define ARDOURSURFACE_API LIBARDOUR_HELPER_DLL_IMPORT
+#endif 
+#define ARDOURSURFACE_LOCAL LIBARDOUR_HELPER_DLL_LOCAL
 
 namespace ARDOUR {
 
 class Route;
 class Session;
+class Bundle;
 
-class ControlProtocol : public sigc::trackable, public BasicUI {
+class ARDOURCP_API ControlProtocol : public PBD::Stateful, public PBD::ScopedConnectionList, public BasicUI
+{
   public:
        ControlProtocol (Session&, std::string name);
        virtual ~ControlProtocol();
@@ -44,17 +57,45 @@ class ControlProtocol : public sigc::trackable, public BasicUI {
        virtual int set_active (bool yn) = 0;
        bool get_active() const { return _active; }
 
-       sigc::signal<void> ActiveChanged;
+       virtual int set_feedback (bool /*yn*/) { return 0; }
+       virtual bool get_feedback () const { return false; }
+
+       virtual void midi_connectivity_established () {}
+
+       PBD::Signal0<void> ActiveChanged;
 
        /* signals that a control protocol can emit and other (presumably graphical)
           user interfaces can respond to
        */
 
-       static sigc::signal<void> ZoomToSession;
-       static sigc::signal<void> ZoomIn;
-       static sigc::signal<void> ZoomOut;
-       static sigc::signal<void> Enter;
-       static sigc::signal<void,float> ScrollTimeline;
+       static PBD::Signal0<void> ZoomToSession;
+       static PBD::Signal0<void> ZoomIn;
+       static PBD::Signal0<void> ZoomOut;
+       static PBD::Signal0<void> Enter;
+       static PBD::Signal0<void> Undo;
+       static PBD::Signal0<void> Redo;
+       static PBD::Signal1<void,float> ScrollTimeline;
+       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:
 
@@ -73,7 +114,7 @@ class ControlProtocol : public sigc::trackable, public BasicUI {
        */
 
        void set_route_table_size (uint32_t size);
-       void set_route_table (uint32_t table_index, ARDOUR::Route*);
+       void set_route_table (uint32_t table_index, boost::shared_ptr<ARDOUR::Route>);
        bool set_route_table (uint32_t table_index, uint32_t remote_control_id);
 
        void route_set_rec_enable (uint32_t table_index, bool yn);
@@ -93,22 +134,33 @@ class ControlProtocol : public sigc::trackable, public BasicUI {
 
        std::string route_get_name (uint32_t table_index);
 
+       virtual std::list<boost::shared_ptr<ARDOUR::Bundle> > bundles ();
+
+       virtual bool  has_editor () const { return false; }
+       virtual void* get_gui() const { return 0; }
+       virtual void  tear_down_gui() { }
+
   protected:
-       std::vector<ARDOUR::Route*> route_table;
+       std::vector<boost::shared_ptr<ARDOUR::Route> > route_table;
        std::string _name;
        bool _active;
 
        void next_track (uint32_t initial_id);
        void prev_track (uint32_t initial_id);
+
+  private:
+       ARDOURSURFACE_LOCAL ControlProtocol (const ControlProtocol&); /* noncopyable */
 };
 
 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 */
            void*       module;    /* not for public access */
            int         mandatory; /* if non-zero, always load and do not make optional */
+           bool        supports_feedback; /* if true, protocol has toggleable feedback mechanism */
            bool             (*probe)(ControlProtocolDescriptor*);
            ControlProtocol* (*initialize)(ControlProtocolDescriptor*,Session*);
            void             (*destroy)(ControlProtocolDescriptor*,ControlProtocol*);