remove unused and useless stuff relating to bundles inside Mackie::Strip
[ardour.git] / libs / surfaces / mackie / surface.cc
index 52ff4bbbae297badae634ce7cd0ecdd8ce18e85f..020b389ad4a48bec5ff58cee0324b2ed33d4e148 100644 (file)
@@ -1,12 +1,33 @@
+/*
+    Copyright (C) 2012 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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
 #include <sstream>
 #include <iomanip>
 #include <iostream>
 #include <cstdio>
 #include <cmath>
 
+#include <glibmm/convert.h>
+
 #include "midi++/port.h"
-#include "midi++/manager.h"
 
+#include "ardour/audioengine.h"
 #include "ardour/automation_control.h"
 #include "ardour/debug.h"
 #include "ardour/route.h"
 
 #include "i18n.h"
 
+#ifdef PLATFORM_WINDOWS
+#define random() rand()
+#endif
+
 using namespace std;
 using namespace PBD;
-using namespace Mackie;
 using ARDOUR::Route;
 using ARDOUR::Panner;
 using ARDOUR::Pannable;
 using ARDOUR::AutomationControl;
+using namespace ArdourSurface;
+using namespace Mackie;
 
 #define ui_context() MackieControlProtocol::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
 
@@ -63,15 +89,24 @@ Surface::Surface (MackieControlProtocol& mcp, const std::string& device_name, ui
        , _active (false)
        , _connected (false)
        , _jog_wheel (0)
+       , _master_fader (0)
+       , _last_master_gain_written (-0.0f)
+       , connection_state (0)
+       , input_source (0)
 {
-       DEBUG_TRACE (DEBUG::MackieControl, "Surface::init\n");
-       
-       _port = new SurfacePort (*this);
+       DEBUG_TRACE (DEBUG::MackieControl, "Surface::Surface init\n");
 
-       /* only the first Surface object has global controls */
+       try {
+               _port = new SurfacePort (*this);
+       } catch (...) {
+               throw failed_constructor ();
+       }
 
-       if (_number == 0) {
-               DEBUG_TRACE (DEBUG::MackieControl, "Surface has global controls\n");
+       /* only the first Surface object has global controls */
+       /* lets use master_position instead */
+       uint32_t mp = _mcp.device_info().master_position();
+       if (_number == mp) {
+               DEBUG_TRACE (DEBUG::MackieControl, "Surface matches MasterPosition. Might have global controls.\n");
                if (_mcp.device_info().has_global_controls()) {
                        init_controls ();
                        DEBUG_TRACE (DEBUG::MackieControl, "init_controls done\n");
@@ -84,38 +119,153 @@ Surface::Surface (MackieControlProtocol& mcp, const std::string& device_name, ui
        }
 
        uint32_t n = _mcp.device_info().strip_cnt();
-       
+
        if (n) {
                init_strips (n);
                DEBUG_TRACE (DEBUG::MackieControl, "init_strips done\n");
        }
-       
+
+       if (!_mcp.device_info().uses_ipmidi()) {
+               ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&Surface::connection_handler, this, _1, _2, _3, _4, _5), &_mcp);
+       } else {
+               /* ipMIDI port already exists, we can just assume that we're
+                * connected.
+                *
+                * If the user still hasn't connected the ipMIDI surface and/or
+                * turned it on, then they have to press "Discover Mackie
+                * Devices" in the GUI at the right time.
+                */
+
+               connection_state |= (InputConnected|OutputConnected);
+               connected ();
+       }
+
        connect_to_signals ();
 
-       DEBUG_TRACE (DEBUG::MackieControl, "Surface::init finish\n");
+       DEBUG_TRACE (DEBUG::MackieControl, "Surface::Surface done\n");
 }
 
 Surface::~Surface ()
 {
-       DEBUG_TRACE (DEBUG::MackieControl, "Surface: destructor\n");
+       DEBUG_TRACE (DEBUG::MackieControl, "Surface::~Surface init\n");
 
-       zero_all ();
+       // zero_all ();
 
        // delete groups
        for (Groups::iterator it = groups.begin(); it != groups.end(); ++it) {
                delete it->second;
        }
-       
+
        // delete controls
        for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) {
                delete *it;
        }
-       
+
+       port_connection.disconnect ();
+
+       if (input_source) {
+               g_source_destroy (input_source);
+               input_source = 0;
+       }
+
        delete _jog_wheel;
        delete _port;
+
+       DEBUG_TRACE (DEBUG::MackieControl, "Surface::~Surface done\n");
 }
 
-const MidiByteArray& 
+void
+Surface::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
+{
+       if (!_port) {
+               return;
+       }
+
+       string ni = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (_port->input_name());
+       string no = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (_port->output_name());
+
+       if (ni == name1 || ni == name2) {
+               if (yn) {
+                       connection_state |= InputConnected;
+               } else {
+                       connection_state &= ~InputConnected;
+               }
+       } else if (no == name1 || no == name2) {
+               if (yn) {
+                       connection_state |= OutputConnected;
+               } else {
+                       connection_state &= ~OutputConnected;
+               }
+       }
+
+       if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) {
+
+               /* this will send a device query message, which should
+                  result in a response that will kick off device type
+                  discovery and activation of the surface(s).
+
+                  The intended order of events is:
+
+                  - each surface sends a device query message
+                  - devices respond with either MCP or LCP response (sysex in both
+                  cases)
+                  - sysex message causes Surface::turn_it_on() which tells the
+                  MCP object that the surface is ready, and sets up strip
+                  displays and binds faders and buttons for that surface
+
+                  In the case of LCP, where this is a handshake process that could
+                  fail, the response process to the initial sysex after a device query
+                  will mark the surface inactive, which won't shut anything down
+                  but will stop any writes to the device.
+
+                  Note: there are no known cases of the handshake process failing.
+
+                  We actually can't initiate this in this callback, so we have
+                  to queue it with the MCP event loop.
+               */
+
+               connected ();
+
+       } else {
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 disconnected (input or output or both)\n", _name));
+               _active = false;
+       }
+}
+
+XMLNode&
+Surface::get_state()
+{
+       char buf[64];
+       snprintf (buf, sizeof (buf), X_("surface-%u"), _number);
+       XMLNode* node = new XMLNode (buf);
+
+       node->add_child_nocopy (_port->get_state());
+
+       return *node;
+}
+
+int
+Surface::set_state (const XMLNode& node, int version)
+{
+       char buf[64];
+       snprintf (buf, sizeof (buf), X_("surface-%u"), _number);
+       XMLNode* mynode = node.child (buf);
+
+       if (!mynode) {
+               return 0;
+       }
+
+       XMLNode* portnode = mynode->child (X_("Port"));
+       if (portnode) {
+               if (_port->set_state (*portnode, version)) {
+                       return -1;
+               }
+       }
+
+       return 0;
+}
+
+const MidiByteArray&
 Surface::sysex_hdr() const
 {
        switch  (_stype) {
@@ -136,11 +286,11 @@ static GlobalControlDefinition mackie_global_controls[] = {
        { "", 0, Led::factory, "" }
 };
 
-void 
+void
 Surface::init_controls()
 {
        Group* group;
-       
+
        DEBUG_TRACE (DEBUG::MackieControl, "Surface::init_controls: creating groups\n");
        groups["assignment"] = new Group  ("assignment");
        groups["automation"] = new Group  ("automation");
@@ -155,7 +305,7 @@ Surface::init_controls()
        groups["transport"] = new Group  ("transport");
        groups["user"] = new Group  ("user");
        groups["utilities"] = new Group  ("utilities");
-               
+
        DEBUG_TRACE (DEBUG::MackieControl, "Surface::init_controls: creating jog wheel\n");
        if (_mcp.device_info().has_jog_wheel()) {
                _jog_wheel = new Mackie::JogWheel (_mcp);
@@ -178,7 +328,7 @@ Surface::init_controls()
        }
 }
 
-void 
+void
 Surface::init_strips (uint32_t n)
 {
        const map<Button::ID,StripButtonInfo>& strip_buttons (_mcp.device_info().strip_buttons());
@@ -186,11 +336,11 @@ Surface::init_strips (uint32_t n)
        for (uint32_t i = 0; i < n; ++i) {
 
                char name[32];
-               
+
                snprintf (name, sizeof (name), "strip_%d", (8* _number) + i);
 
                Strip* strip = new Strip (*this, name, i, strip_buttons);
-               
+
                groups[name] = strip;
                strips.push_back (strip);
        }
@@ -199,31 +349,61 @@ Surface::init_strips (uint32_t n)
 void
 Surface::setup_master ()
 {
-       _master_fader = dynamic_cast<Fader*> (Fader::factory (*this, 8, "master", *groups["master"]));
-       
        boost::shared_ptr<Route> m;
-       
+
        if ((m = _mcp.get_session().monitor_out()) == 0) {
                m = _mcp.get_session().master_out();
-       } 
-       
+       }
+
        if (!m) {
                return;
        }
-       
+
+       _master_fader = dynamic_cast<Fader*> (Fader::factory (*this, _mcp.device_info().strip_cnt(), "master", *groups["master"]));
+
        _master_fader->set_control (m->gain_control());
        m->gain_control()->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&Surface::master_gain_changed, this), ui_context());
+
+       Groups::iterator group_it;
+       group_it = groups.find("master");
+
+       DeviceInfo device_info = _mcp.device_info();
+       GlobalButtonInfo master_button = device_info.get_global_button(Button::MasterFaderTouch);
+       Button* bb = dynamic_cast<Button*> (Button::factory (
+               *this,
+               Button::MasterFaderTouch,
+               master_button.id,
+               master_button.label,
+               *(group_it->second)
+));
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 Master Fader new button BID %2 id %3\n",
+               number(), Button::MasterFaderTouch, bb->id()));
 }
 
 void
 Surface::master_gain_changed ()
 {
+       if (!_master_fader) {
+               return;
+       }
+
        boost::shared_ptr<AutomationControl> ac = _master_fader->control();
-       float pos = ac->internal_to_interface (ac->get_value());
-       _port->write (_master_fader->set_position (pos));
+       if (!ac) {
+               return;
+       }
+
+       float normalized_position = ac->internal_to_interface (ac->get_value());
+       if (normalized_position == _last_master_gain_written) {
+               return;
+       }
+
+       DEBUG_TRACE (DEBUG::MackieControl, "Surface::master_gain_changed: updating surface master fader\n");
+
+       _port->write (_master_fader->set_position (normalized_position));
+       _last_master_gain_written = normalized_position;
 }
 
-float 
+float
 Surface::scaled_delta (float delta, float current_speed)
 {
        /* XXX needs work before use */
@@ -232,7 +412,7 @@ Surface::scaled_delta (float delta, float current_speed)
        return ((sign * std::pow (delta + 1.0, 2.0)) + current_speed) / 100.0;
 }
 
-void 
+void
 Surface::display_bank_start (uint32_t current_bank)
 {
        if  (current_bank == 0) {
@@ -244,7 +424,7 @@ Surface::display_bank_start (uint32_t current_bank)
        }
 }
 
-void 
+void
 Surface::blank_jog_ring ()
 {
        Control* control = controls_by_device_independent_id[Jog::ID];
@@ -263,13 +443,13 @@ Surface::scrub_scaling_factor () const
        return 100.0;
 }
 
-void 
+void
 Surface::connect_to_signals ()
 {
        if (!_connected) {
 
 
-               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 connecting to signals on port %2\n", 
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 connecting to signals on port %2\n",
                                                                   number(), _port->input_port().name()));
 
                MIDI::Parser* p = _port->input_port().parser();
@@ -280,18 +460,16 @@ Surface::connect_to_signals ()
                p->controller.connect_same_thread (*this, boost::bind (&Surface::handle_midi_controller_message, this, _1, _2));
                /* Button messages are NoteOn */
                p->note_on.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2));
-               /* Button messages are NoteOn. libmidi++ sends note-on w/velocity = 0 as note-off so catch them too */
+               /* Button messages are NoteOn but libmidi++ sends note-on w/velocity = 0 as note-off so catch them too */
                p->note_off.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2));
                /* Fader messages are Pitchbend */
-               p->channel_pitchbend[0].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 0U));
-               p->channel_pitchbend[1].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 1U));
-               p->channel_pitchbend[2].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 2U));
-               p->channel_pitchbend[3].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 3U));
-               p->channel_pitchbend[4].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 4U));
-               p->channel_pitchbend[5].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 5U));
-               p->channel_pitchbend[6].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 6U));
-               p->channel_pitchbend[7].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 7U));
-               
+               uint32_t i;
+               for (i = 0; i < _mcp.device_info().strip_cnt(); i++) {
+                       p->channel_pitchbend[i].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, i));
+               }
+               // Master fader
+               p->channel_pitchbend[_mcp.device_info().strip_cnt()].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, _mcp.device_info().strip_cnt()));
+
                _connected = true;
        }
 }
@@ -299,30 +477,38 @@ Surface::connect_to_signals ()
 void
 Surface::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb, uint32_t fader_id)
 {
-       /* Pitchbend messages are fader messages. Nothing in the data we get
+       /* Pitchbend messages are fader position messages. Nothing in the data we get
         * from the MIDI::Parser conveys the fader ID, which was given by the
         * channel ID in the status byte.
         *
-        * Instead, we have used bind() to supply the fader-within-strip ID 
+        * Instead, we have used bind() to supply the fader-within-strip ID
         * when we connected to the per-channel pitchbend events.
         */
 
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface::handle_midi_pitchbend_message on port %3, fader = %1 value = %2 (%4)\n",
+                                                          fader_id, pb, _number, pb/16384.0));
 
-       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handle_midi pitchbend on port %3, fader = %1 value = %2\n", 
-                                                          fader_id, pb, _number));
-       
        if (_mcp.device_info().no_handshake()) {
                turn_it_on ();
        }
 
+       if (_mcp.main_modifier_state() & MackieControlProtocol::MODIFIER_SHIFT) {
+               /* user is doing a reset to unity gain but device sends a PB
+                * message in the middle of the touch on/off messages. Ignore
+                * it.
+                */
+               return;
+       }
+
        Fader* fader = faders[fader_id];
 
        if (fader) {
                Strip* strip = dynamic_cast<Strip*> (&fader->group());
-               float pos = (pb >> 4)/1023.0; // only the top 10 bytes are used
+               float pos = pb / 16384.0;
                if (strip) {
                        strip->handle_fader (*fader, pos);
                } else {
+                       DEBUG_TRACE (DEBUG::MackieControl, "Handling master fader\n");
                        /* master fader */
                        fader->set_value (pos); // alter master gain
                        _port->write (fader->set_position (pos)); // write back value (required for servo)
@@ -332,18 +518,49 @@ Surface::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb, uin
        }
 }
 
-void 
+void
 Surface::handle_midi_note_on_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
 {
-       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_note_on %1 = %2\n", (int) ev->note_number, (int) ev->velocity));
-       
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface::handle_midi_note_on_message %1 = %2\n", (int) ev->note_number, (int) ev->velocity));
+
        if (_mcp.device_info().no_handshake()) {
                turn_it_on ();
        }
 
+       if (_mcp.device_info().device_type() == DeviceInfo::HUI && ev->note_number == 0 && ev->velocity == 127) {
+               turn_it_on ();
+       }
+
+       /* fader touch sense is given by "buttons" 0xe..0xe7 and 0xe8 for the
+        * master.
+        */
+
+       if (ev->note_number >= 0xE0 && ev->note_number <= 0xE8) {
+               Fader* fader = faders[ev->note_number];
+
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface: fader touch message, fader = %1\n", fader));
+
+               if (fader) {
+
+                       Strip* strip = dynamic_cast<Strip*> (&fader->group());
+
+                       if (ev->velocity > 64) {
+                               strip->handle_fader_touch (*fader, true);
+                       } else {
+                               strip->handle_fader_touch (*fader, false);
+                       }
+               }
+               return;
+       }
+
        Button* button = buttons[ev->note_number];
 
        if (button) {
+
+               if (ev->velocity > 64) {
+                       button->pressed ();
+               }
+
                Strip* strip = dynamic_cast<Strip*> (&button->group());
 
                if (strip) {
@@ -355,12 +572,19 @@ Surface::handle_midi_note_on_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
                        DEBUG_TRACE (DEBUG::MackieControl, string_compose ("global button %1\n", button->id()));
                        _mcp.handle_button_event (*this, *button, ev->velocity > 64 ? press : release);
                }
+
+               if (ev->velocity <= 64) {
+                       button->released ();
+               }
+
        } else {
-               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button found for %1\n", ev->note_number));
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button found for %1\n", (int) ev->note_number));
        }
+
+       /* button release should reset timer AFTER handler(s) have run */
 }
 
-void 
+void
 Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
 {
        DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_midi_controller %1 = %2\n", (int) ev->controller_number, (int) ev->value));
@@ -372,7 +596,7 @@ Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev
        Pot* pot = pots[ev->controller_number];
 
        // bit 6 gives the sign
-       float sign = (ev->value & 0x40) == 0 ? 1.0 : -1.0; 
+       float sign = (ev->value & 0x40) == 0 ? 1.0 : -1.0;
        // bits 0..5 give the velocity. we interpret this as "ticks
        // moved before this message was sent"
        float ticks = (ev->value & 0x3f);
@@ -382,8 +606,14 @@ Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev
                */
                ticks = 1;
        }
-       float delta = sign * (ticks / (float) 0x3f);
-       
+
+       float delta = 0;
+       if (mcp().main_modifier_state() == MackieControlProtocol::MODIFIER_CONTROL) {
+               delta = sign * (ticks / (float) 0xff);
+       } else {
+               delta = sign * (ticks / (float) 0x3f);
+       }
+
        if (!pot) {
                if (ev->controller_number == Jog::ID && _jog_wheel) {
 
@@ -391,6 +621,7 @@ Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev
                        _jog_wheel->jog_event (delta);
                        return;
                }
+               // add external (pedal?) control here
 
                return;
        }
@@ -398,10 +629,10 @@ Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev
        Strip* strip = dynamic_cast<Strip*> (&pot->group());
        if (strip) {
                strip->handle_pot (*pot, delta);
-       } 
+       }
 }
 
-void 
+void
 Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count)
 {
        MidiByteArray bytes (count, raw_bytes);
@@ -413,7 +644,7 @@ Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count
        }
 
        /* always save the device type ID so that our outgoing sysex messages
-        * are correct 
+        * are correct
         */
 
        if (_stype == mcu) {
@@ -424,12 +655,14 @@ Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count
 
        switch (bytes[5]) {
        case 0x01:
-               /* MCP: Device Ready 
-                  LCP: Connection Challenge 
+               /* MCP: Device Ready
+                  LCP: Connection Challenge
                */
                if (bytes[4] == 0x10 || bytes[4] == 0x11) {
+                       DEBUG_TRACE (DEBUG::MackieControl, "Logic Control Device connection challenge\n");
                        write_sysex (host_connection_query (bytes));
                } else {
+                       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Mackie Control Device ready, current status = %1\n", _active));
                        if (!_active) {
                                turn_it_on ();
                        }
@@ -437,6 +670,7 @@ Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count
                break;
 
        case 0x03: /* LCP Connection Confirmation */
+               DEBUG_TRACE (DEBUG::MackieControl, "Logic Control Device confirms connection, ardour replies\n");
                if (bytes[4] == 0x10 || bytes[4] == 0x11) {
                        write_sysex (host_connection_confirmation (bytes));
                        _active = true;
@@ -444,6 +678,7 @@ Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count
                break;
 
        case 0x04: /* LCP: Confirmation Denied */
+               DEBUG_TRACE (DEBUG::MackieControl, "Logic Control Device denies connection\n");
                _active = false;
                break;
        default:
@@ -451,31 +686,30 @@ Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count
        }
 }
 
-static MidiByteArray 
+static MidiByteArray
 calculate_challenge_response (MidiByteArray::iterator begin, MidiByteArray::iterator end)
 {
        MidiByteArray l;
        back_insert_iterator<MidiByteArray> back  (l);
        copy (begin, end, back);
-       
+
        MidiByteArray retval;
-       
+
        // this is how to calculate the response to the challenge.
        // from the Logic docs.
        retval <<  (0x7f &  (l[0] +  (l[1] ^ 0xa) - l[3]));
        retval <<  (0x7f &  ( (l[2] >> l[3]) ^  (l[0] + l[3])));
        retval <<  (0x7f &  ((l[3] -  (l[2] << 2)) ^  (l[0] | l[1])));
        retval <<  (0x7f &  (l[1] - l[2] +  (0xf0 ^  (l[3] << 4))));
-       
+
        return retval;
 }
 
-// not used right now
-MidiByteArray 
+MidiByteArray
 Surface::host_connection_query (MidiByteArray & bytes)
 {
        MidiByteArray response;
-       
+
        if (bytes[4] != 0x10 && bytes[4] != 0x11) {
                /* not a Logic Control device - no response required */
                return response;
@@ -483,7 +717,7 @@ Surface::host_connection_query (MidiByteArray & bytes)
 
        // handle host connection query
        DEBUG_TRACE (DEBUG::MackieControl, string_compose ("host connection query: %1\n", bytes));
-       
+
        if  (bytes.size() != 18) {
                cerr << "expecting 18 bytes, read " << bytes << " from " << _port->input_port().name() << endl;
                return response;
@@ -496,19 +730,18 @@ Surface::host_connection_query (MidiByteArray & bytes)
        return response;
 }
 
-// not used right now
-MidiByteArray 
+MidiByteArray
 Surface::host_connection_confirmation (const MidiByteArray & bytes)
 {
        DEBUG_TRACE (DEBUG::MackieControl, string_compose ("host_connection_confirmation: %1\n", bytes));
-       
+
        // decode host connection confirmation
        if  (bytes.size() != 14) {
                ostringstream os;
                os << "expecting 14 bytes, read " << bytes << " from " << _port->input_port().name();
                throw MackieControlException (os.str());
        }
-       
+
        // send version request
        return MidiByteArray (2, 0x13, 0x00);
 }
@@ -521,27 +754,21 @@ Surface::turn_it_on ()
        }
 
        _active = true;
-       zero_controls ();
+
+       _mcp.device_ready ();
+
        for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
                (*s)->notify_all ();
        }
+
        update_view_mode_display ();
-       if (_mcp.device_info ().has_master_fader ()) {
-               master_gain_changed ();
-       }
 
        if (_mcp.device_info ().has_global_controls ()) {
                _mcp.update_global_button (Button::Read, _mcp.metering_active ());
        }
 }
 
-void 
-Surface::handle_port_inactive (SurfacePort*)
-{
-       _active = false;
-}
-
-void 
+void
 Surface::write_sysex (const MidiByteArray & mba)
 {
        if (mba.empty()) {
@@ -553,7 +780,7 @@ Surface::write_sysex (const MidiByteArray & mba)
        _port->write (buf);
 }
 
-void 
+void
 Surface::write_sysex (MIDI::byte msg)
 {
        MidiByteArray buf;
@@ -566,7 +793,7 @@ Surface::n_strips (bool with_locked_strips) const
 {
        if (with_locked_strips) {
                return strips.size();
-       } 
+       }
 
        uint32_t n = 0;
 
@@ -593,15 +820,15 @@ Surface::zero_all ()
        if (_mcp.device_info().has_timecode_display ()) {
                display_timecode (string (10, '0'), string (10, ' '));
        }
-       
+
        if (_mcp.device_info().has_two_character_display()) {
                show_two_char_display (string (2, '0'), string (2, ' '));
        }
 
-       if (_mcp.device_info().has_master_fader ()) {
+       if (_mcp.device_info().has_master_fader () && _master_fader) {
                _port->write (_master_fader->zero ());
        }
-       
+
        // zero all strips
        for (Strips::iterator it = strips.begin(); it != strips.end(); ++it) {
                (*it)->zero();
@@ -613,13 +840,11 @@ Surface::zero_all ()
 void
 Surface::zero_controls ()
 {
-       if (_stype != mcu || !_mcp.device_info().has_global_controls()) {
+       if (!_mcp.device_info().has_global_controls()) {
                return;
        }
 
        // turn off global buttons and leds
-       // global buttons are only ever on mcu_port, so we don't have
-       // to figure out which port.
 
        for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) {
                Control & control = **it;
@@ -630,23 +855,34 @@ Surface::zero_controls ()
 
        // and the led ring for the master strip
        blank_jog_ring ();
+
+       _last_master_gain_written = 0.0f;
 }
 
 void
 Surface::periodic (uint64_t now_usecs)
 {
+       master_gain_changed();
        for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
                (*s)->periodic (now_usecs);
        }
 }
 
 void
-Surface::write (const MidiByteArray& data) 
+Surface::redisplay (ARDOUR::microseconds_t now)
+{
+       for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
+               (*s)->redisplay (now);
+       }
+}
+
+void
+Surface::write (const MidiByteArray& data)
 {
-       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface::write for %1\n", data));
        if (_active) {
-               DEBUG_TRACE (DEBUG::MackieControl, "Surface::write surface active\n");
                _port->write (data);
+       } else {
+               DEBUG_TRACE (DEBUG::MackieControl, "surface not active, write ignored\n");
        }
 }
 
@@ -656,6 +892,8 @@ Surface::map_routes (const vector<boost::shared_ptr<Route> >& routes)
        vector<boost::shared_ptr<Route> >::const_iterator r;
        Strips::iterator s = strips.begin();
 
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Mapping %1 routes\n", routes.size()));
+
        for (r = routes.begin(); r != routes.end() && s != strips.end(); ++s) {
 
                /* don't try to assign routes to a locked strip. it won't
@@ -676,7 +914,7 @@ Surface::map_routes (const vector<boost::shared_ptr<Route> >& routes)
 
 }
 
-static char 
+static char
 translate_seven_segment (char achar)
 {
        achar = toupper (achar);
@@ -696,13 +934,13 @@ Surface::show_two_char_display (const std::string & msg, const std::string & dot
        if (_stype != mcu || !_mcp.device_info().has_two_character_display() || msg.length() != 2 || dots.length() != 2) {
                return;
        }
-       
+
        MidiByteArray right (3, 0xb0, 0x4b, 0x00);
        MidiByteArray left (3, 0xb0, 0x4a, 0x00);
-       
+
        right[2] = translate_seven_segment (msg[0]) +  (dots[0] == '.' ? 0x40 : 0x00);
        left[2] = translate_seven_segment (msg[1]) +  (dots[1] == '.' ? 0x40 : 0x00);
-       
+
        _port->write (right);
        _port->write (left);
 }
@@ -723,7 +961,7 @@ Surface::display_timecode (const std::string & timecode, const std::string & las
        }
        // if there's no change, send nothing, not even sysex header
        if  (timecode == last_timecode) return;
-       
+
        // length sanity checking
        string local_timecode = timecode;
 
@@ -733,10 +971,10 @@ Surface::display_timecode (const std::string & timecode, const std::string & las
        }
 
        // pad to 10 characters
-       while  (local_timecode.length() < 10) { 
+       while  (local_timecode.length() < 10) {
                local_timecode += " ";
        }
-       
+
        // translate characters.
        // Only the characters that actually changed are sent.
        int position = 0x3f;
@@ -760,6 +998,14 @@ Surface::update_flip_mode_display ()
        }
 }
 
+ void
+Surface::update_potmode ()
+{
+       for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
+               (*s)->potmode_changed (false);
+       }
+}
+
 void
 Surface::update_view_mode_display ()
 {
@@ -773,15 +1019,7 @@ Surface::update_view_mode_display ()
        switch (_mcp.view_mode()) {
        case MackieControlProtocol::Mixer:
                show_two_char_display ("Mx");
-               id = Button::Pan;
-               break;
-       case MackieControlProtocol::Dynamics:
-               show_two_char_display ("Dy");
-               id = Button::Dyn;
-               break;
-       case MackieControlProtocol::EQ:
-               show_two_char_display ("EQ");
-               id = Button::Eq;
+               //id = Button::Pan;
                break;
        case MackieControlProtocol::Loop:
                show_two_char_display ("LP");
@@ -793,20 +1031,12 @@ Surface::update_view_mode_display ()
        case MackieControlProtocol::MidiTracks:
                show_two_char_display ("MT");
                break;
-       case MackieControlProtocol::Sends:
-               show_two_char_display ("Sn");
-               id = Button::Sends;
-               break;
-       case MackieControlProtocol::Plugins:
-               show_two_char_display ("Pl");
-               id = Button::Plugin;
-               break;
        default:
                break;
        }
 
        if (id >= 0) {
-               
+
                /* we are attempting to turn a global button/LED on */
 
                map<int,Control*>::iterator x = controls_by_device_independent_id.find (id);
@@ -842,7 +1072,7 @@ Surface::say_hello ()
        _port->write (wakeup);
        wakeup[4] = 0x15; /* wakup Mackie XT */
        _port->write (wakeup);
-       wakeup[4] = 0x10; /* wakupe Logic Control */
+       wakeup[4] = 0x10; /* wakeup Logic Control */
        _port->write (wakeup);
        wakeup[4] = 0x11; /* wakeup Logic Control XT */
        _port->write (wakeup);
@@ -856,7 +1086,7 @@ Surface::next_jog_mode ()
 void
 Surface::set_jog_mode (JogWheel::Mode)
 {
-}      
+}
 
 bool
 Surface::route_is_locked_to_strip (boost::shared_ptr<Route> r) const
@@ -869,10 +1099,169 @@ Surface::route_is_locked_to_strip (boost::shared_ptr<Route> r) const
        return false;
 }
 
-void 
+void
 Surface::notify_metering_state_changed()
 {
        for (Strips::const_iterator s = strips.begin(); s != strips.end(); ++s) {
                (*s)->notify_metering_state_changed ();
        }
 }
+
+void
+Surface::reset ()
+{
+       if (_port) {
+               /* reset msg for Mackie Control */
+               MidiByteArray msg;
+               msg << sysex_hdr();
+               msg << 0x08;
+               msg << 0x00;
+               msg << MIDI::eox;
+               _port->write (msg);
+       }
+}
+
+void
+Surface::toggle_backlight ()
+{
+       if (_port) {
+               int onoff = random() %2;
+               MidiByteArray msg;
+               msg << sysex_hdr ();
+               msg << 0xa;
+               msg << (onoff ? 0x1 : 0x0);
+               msg << MIDI::eox;
+               _port->write (msg);
+       }
+}
+
+void
+Surface::recalibrate_faders ()
+{
+       if (_port) {
+               MidiByteArray msg;
+               msg << sysex_hdr ();
+               msg << 0x09;
+               msg << 0x00;
+               msg << MIDI::eox;
+               _port->write (msg);
+       }
+}
+
+void
+Surface::set_touch_sensitivity (int sensitivity)
+{
+       /* NOTE: assumed called from GUI code, hence sleep() */
+
+       /* sensitivity already clamped by caller */
+
+       if (_port) {
+               MidiByteArray msg;
+
+               msg << sysex_hdr ();
+               msg << 0x0e;
+               msg << 0xff; /* overwritten for each fader below */
+               msg << (sensitivity & 0x7f);
+               msg << MIDI::eox;
+
+               for (int fader = 0; fader < 9; ++fader) {
+                       msg[6] = fader;
+                       _port->write (msg);
+               }
+       }
+}
+
+void
+Surface::hui_heartbeat ()
+{
+       if (!_port) {
+               return;
+       }
+
+       MidiByteArray msg (3, MIDI::on, 0x0, 0x0);
+       _port->write (msg);
+}
+
+void
+Surface::connected ()
+{
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 now connected, trying to ping device...\n", _name));
+
+       say_hello ();
+
+       if (_mcp.device_info().no_handshake()) {
+               turn_it_on ();
+       }
+}
+
+MidiByteArray
+Surface::display_line (string const& msg, int line_num)
+{
+       MidiByteArray midi_msg;
+       midi_msg << sysex_hdr ();
+       midi_msg << 0x12;
+       midi_msg << (line_num ? 0x38 : 0x0); /* offsets into char array
+                                             * on device that
+                                             * correspond to line
+                                             * starts
+                                             */
+       if (msg.empty()) {
+
+               midi_msg.insert (midi_msg.end(), 55, ' ');
+
+       } else {
+
+               /* ascii data to display. @param msg is UTF-8 which is not legal. */
+               string ascii = Glib::convert_with_fallback (msg, "UTF-8", "ISO-8859-1", "_");
+               string::size_type len = ascii.length();
+
+               if (len > 55) {
+                       midi_msg << ascii.substr (0, 55);
+               } else {
+                       midi_msg << ascii;
+
+                       for (string::size_type i = len; i < 55; ++i) {
+                               midi_msg << ' ';
+                       }
+               }
+       }
+
+       midi_msg << MIDI::eox;
+
+       return midi_msg;
+}
+
+/** display @param msg on the 55x2 screen for @param msecs milliseconds
+ *
+ *  @param msg is assumed to be UTF-8 encoded, and will be converted
+ *  to ASCII with an underscore as fallback character before being
+ *  sent to the device.
+ */
+void
+Surface::display_message_for (string const& msg, uint64_t msecs)
+{
+       string::size_type newline;
+
+       if ((newline = msg.find ('\n')) == string::npos) {
+
+               _port->write (display_line (msg, 0));
+               _port->write (display_line (string(), 1));
+
+       } else if (newline == 0) {
+
+               _port->write (display_line (string(), 0));
+               _port->write (display_line (msg.substr (1), 1));
+
+       } else {
+
+               string first_line = msg.substr (0, newline-1);
+               string second_line = msg.substr (newline+1);
+
+               _port->write (display_line (first_line, 0));
+               _port->write (display_line (second_line.substr (0, second_line.find_first_of ('\n')), 1));
+       }
+
+       for (Strips::const_iterator s = strips.begin(); s != strips.end(); ++s) {
+               (*s)->block_screen_display_for (msecs);
+       }
+}