NOOP, remove trailing tabs/whitespace.
[ardour.git] / libs / surfaces / mackie / surface.h
index 310eb00c249b021b6bbef4135bab1cc2a999501b..1c989ec518be45d9bef8191d3791dd187022ffa1 100644 (file)
@@ -3,13 +3,14 @@
 
 #include <stdint.h>
 
+#include "pbd/xml++.h"
 #include "midi++/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;
@@ -20,6 +21,9 @@ namespace ARDOUR {
 }
 
 class MidiByteArray;
+
+namespace ArdourSurface {
+
 class MackieControlProtocol;
 
 namespace Mackie
@@ -38,40 +42,39 @@ class Led;
 class Surface : public PBD::ScopedConnectionList
 {
 public:
-       Surface (MackieControlProtocol&, jack_client_t* jack, const std::string& device_name, uint32_t number, surface_type_t stype);
+       Surface (MackieControlProtocol&, const std::string& name, uint32_t number, surface_type_t stype);
        virtual ~Surface();
 
        surface_type_t type() const { return _stype; }
        uint32_t number() const { return _number; }
+       const std::string& name() { return _name; }
 
-       MackieControlProtocol& mcp() const { return _mcp; }
+       void say_hello ();
 
        bool active() const { return _active; }
-       void drop_routes ();
 
        typedef std::vector<Control*> Controls;
        Controls controls;
 
        std::map<int,Fader*> faders;
        std::map<int,Pot*> pots;
-       std::map<int,Button*> buttons;
+       std::map<int,Button*> buttons; // index is device-DEPENDENT
        std::map<int,Led*> leds;
        std::map<int,Meter*> meters;
+       std::map<int,Control*> controls_by_device_independent_id;
 
-       /// no strip controls in here because they usually
-       /// have the same names.
-       std::map<std::string,Control*> controls_by_name;
-       
        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 route_is_locked_to_strip (boost::shared_ptr<ARDOUR::Route>) const;
+
        /// This collection owns the groups
        typedef std::map<std::string,Group*> Groups;
        Groups groups;
@@ -82,7 +85,9 @@ public:
 
        const MidiByteArray& sysex_hdr() const;
 
-       void periodic ();
+       void periodic (uint64_t now_usecs);
+       void redisplay ();
+       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*);
@@ -92,9 +97,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);
@@ -103,17 +105,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
@@ -133,37 +142,50 @@ 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_flip_mode_display ();
 
-       void gui_selection_changed (ARDOUR::RouteNotificationListPtr);
+       void gui_selection_changed (const ARDOUR::StrongRouteNotificationList&);
+
+       MackieControlProtocol& mcp() const { return _mcp; }
+
+       void next_jog_mode ();
+       void set_jog_mode (Mackie::JogWheel::Mode);
+
+        void notify_metering_state_changed();
+       void turn_it_on ();
+
+       XMLNode& get_state ();
+       int set_state (const XMLNode&, int version);
 
   protected:
-       void init_controls();
-       void init_strips ();
 
   private:
        MackieControlProtocol& _mcp;
-       SurfacePort* _port;
-       surface_type_t _stype;
-       uint32_t _number;
-       bool _active;
-       bool _connected;
-       Mackie::JogWheel* _jog_wheel;
-
-       void jog_wheel_state_display (Mackie::JogWheel::State state);
+       SurfacePort*           _port;
+       surface_type_t         _stype;
+       uint32_t               _number;
+       std::string            _name;
+       bool                   _active;
+       bool                   _connected;
+       Mackie::JogWheel*      _jog_wheel;
+       Fader*                 _master_fader;
+       float                  _last_master_gain_written;
+
+       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 init_controls ();
+       void init_strips (uint32_t n);
+       void setup_master ();
+       void master_gain_changed ();
 };
 
+}
 }
 
 #endif