MCP: Momentarily light buttons when they are used to trigger a defined action.
[ardour.git] / libs / surfaces / mackie / surface.h
index 5bcd9ebde92eb1f9186ab52ae545e59dde5d0b31..3225e23ba06bfa2f7194b55f4752f5dcd1fa5f1e 100644 (file)
@@ -3,23 +3,33 @@
 
 #include <stdint.h>
 
+#include <sigc++/trackable.h>
+
+#include "pbd/signals.h"
+#include "pbd/xml++.h"
 #include "midi++/types.h"
 
+#include "ardour/types.h"
+
 #include "control_protocol/types.h"
 
 #include "controls.h"
 #include "types.h"
-#include "mackie_jog_wheel.h"
+#include "jog_wheel.h"
 
 namespace MIDI {
        class Parser;
 }
 
 namespace ARDOUR {
-       class Route;
+       class Stripable;
+       class Port;
 }
 
 class MidiByteArray;
+
+namespace ArdourSurface {
+
 class MackieControlProtocol;
 
 namespace Mackie
@@ -35,7 +45,7 @@ class Jog;
 class Pot;
 class Led;
 
-class Surface : public PBD::ScopedConnectionList
+class Surface : public PBD::ScopedConnectionList, public sigc::trackable
 {
 public:
        Surface (MackieControlProtocol&, const std::string& name, uint32_t number, surface_type_t stype);
@@ -45,8 +55,9 @@ public:
        uint32_t number() const { return _number; }
        const std::string& name() { return _name; }
 
+       void connected ();
+
        bool active() const { return _active; }
-       void drop_routes ();
 
        typedef std::vector<Control*> Controls;
        Controls controls;
@@ -57,28 +68,33 @@ public:
        std::map<int,Led*> leds;
        std::map<int,Meter*> meters;
        std::map<int,Control*> controls_by_device_independent_id;
-       
+
        Mackie::JogWheel* jog_wheel() const { return _jog_wheel; }
+       Fader* master_fader() const { return _master_fader; }
 
-       /// The collection of all numbered strips. No master
-       /// strip in here.
+       /// The collection of all numbered strips.
        typedef std::vector<Strip*> Strips;
        Strips strips;
 
-       uint32_t n_strips () const;
+       uint32_t n_strips (bool with_locked_strips = true) const;
        Strip* nth_strip (uint32_t n) const;
 
+       bool stripable_is_locked_to_strip (boost::shared_ptr<ARDOUR::Stripable>) const;
+       bool stripable_is_mapped (boost::shared_ptr<ARDOUR::Stripable>) const;
+
        /// This collection owns the groups
        typedef std::map<std::string,Group*> Groups;
        Groups groups;
 
        SurfacePort& port() const { return *_port; }
 
-       void map_routes (const std::vector<boost::shared_ptr<ARDOUR::Route> >& routes);
+       void map_stripables (const std::vector<boost::shared_ptr<ARDOUR::Stripable> >&);
 
        const MidiByteArray& sysex_hdr() const;
 
-       void periodic (uint64_t now_usecs);
+       void periodic (ARDOUR::microseconds_t now_usecs);
+       void redisplay (ARDOUR::microseconds_t now_usecs, bool force);
+       void hui_heartbeat ();
 
        void handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t, uint32_t channel_id);
        void handle_midi_controller_message (MIDI::Parser&, MIDI::EventTwoBytes*);
@@ -88,9 +104,6 @@ public:
        /// unless it's already connected
        void connect_to_signals ();
 
-       /// notification from a MackiePort that it's now inactive
-       void handle_port_inactive(Mackie::SurfacePort *);
-
        /// write a sysex message
        void write_sysex (const MidiByteArray& mba);
        void write_sysex (MIDI::byte msg);
@@ -99,17 +112,24 @@ public:
 
        /// display an indicator of the first switched-in Route. Do nothing by default.
        void display_bank_start (uint32_t /*current_bank*/);
-               
+
        /// called from MackieControlProtocol::zero_all to turn things off
        void zero_all ();
+       void zero_controls ();
 
        /// turn off leds around the jog wheel. This is for surfaces that use a pot
        /// pretending to be a jog wheel.
        void blank_jog_ring ();
 
-       bool has_timecode_display() const;
        void display_timecode (const std::string & /*timecode*/, const std::string & /*timecode_last*/);
 
+       /// sends MCP "reset" message to surface
+       void reset ();
+
+       void recalibrate_faders ();
+       void toggle_backlight ();
+       void set_touch_sensitivity (int);
+
        /**
                This is used to calculate the clicks per second that define
                a transport speed of 1.0 for the jog wheel. 100.0 is 10 clicks
@@ -129,26 +149,30 @@ public:
        // display the first 2 chars of the msg in the 2 char display
        // . is appended to the previous character, so A.B. would
        // be two characters
-       MidiByteArray two_char_display (const std::string & msg, const std::string & dots = "  ");
-       MidiByteArray two_char_display (unsigned int value, const std::string & dots = "  ");
-       
-       /**
-               Timecode display. Only the difference between timecode and last_timecode will
-               be encoded, to save midi bandwidth. If they're the same, an empty array will
-               be returned
-       */
-       MidiByteArray timecode_display (const std::string & timecode, const std::string & last_timecode = "");
+       void show_two_char_display (const std::string & msg, const std::string & dots = "  ");
+       void show_two_char_display (unsigned int value, const std::string & dots = "  ");
 
-       void update_view_mode_display ();
+       void update_view_mode_display (bool with_helpful_text);
        void update_flip_mode_display ();
 
-       void gui_selection_changed (ARDOUR::RouteNotificationListPtr);
+       void subview_mode_changed ();
 
        MackieControlProtocol& mcp() const { return _mcp; }
 
-  protected:
-       void init_controls();
-       void init_strips (uint32_t n);
+       void next_jog_mode ();
+       void set_jog_mode (Mackie::JogWheel::Mode);
+
+        void notify_metering_state_changed();
+       void turn_it_on ();
+
+       void display_message_for (std::string const& msg, uint64_t msecs);
+
+       bool connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool);
+
+       void master_monitor_may_have_changed ();
+
+       XMLNode& get_state ();
+       int set_state (const XMLNode&, int version);
 
   private:
        MackieControlProtocol& _mcp;
@@ -159,13 +183,35 @@ public:
        bool                   _active;
        bool                   _connected;
        Mackie::JogWheel*      _jog_wheel;
+       Fader*                 _master_fader;
+       float                  _last_master_gain_written;
+       PBD::ScopedConnection   master_connection;
 
-       void jog_wheel_state_display (Mackie::JogWheel::State state);
        void handle_midi_sysex (MIDI::Parser&, MIDI::byte *, size_t count);
        MidiByteArray host_connection_query (MidiByteArray& bytes);
        MidiByteArray host_connection_confirmation (const MidiByteArray& bytes);
+
+       void say_hello ();
+       void init_controls ();
+       void init_strips (uint32_t n);
+       void setup_master ();
+       void master_gain_changed ();
+
+       enum ConnectionState {
+               InputConnected = 0x1,
+               OutputConnected = 0x2
+       };
+
+       int connection_state;
+
+       MidiByteArray display_line (std::string const& msg, int line_num);
+
+  public:
+       /* IP MIDI devices need to keep a handle on this and destroy it */
+       GSource*    input_source;
 };
 
+}
 }
 
 #endif