Merge windows+cc branch into cairocanvas branch. Not finished, need to now merge...
[ardour.git] / libs / surfaces / mackie / mackie_control_protocol.cc
index cc345eb7df657642c586fc30b48cd64b7f28e143..c83ce819d950edae1ce168b036ea4ffdddbfa03e 100644 (file)
@@ -1,5 +1,6 @@
 /*
        Copyright (C) 2006,2007 John Anderson
+       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
 #include <float.h>
 #include <sys/time.h>
 #include <errno.h>
-#include <poll.h>
 
 #include <boost/shared_array.hpp>
 
 #include "midi++/types.h"
 #include "midi++/port.h"
+#include "midi++/ipmidi_port.h"
 #include "pbd/pthread_utils.h"
 #include "pbd/error.h"
 #include "pbd/memento_command.h"
 #include "pbd/convert.h"
 
+#include "ardour/automation_control.h"
 #include "ardour/dB.h"
 #include "ardour/debug.h"
 #include "ardour/location.h"
@@ -48,6 +50,7 @@
 #include "ardour/route.h"
 #include "ardour/session.h"
 #include "ardour/tempo.h"
+#include "ardour/track.h"
 #include "ardour/types.h"
 #include "ardour/audioengine.h"
 
@@ -55,6 +58,7 @@
 
 #include "midi_byte_array.h"
 #include "mackie_control_exception.h"
+#include "device_profile.h"
 #include "surface_port.h"
 #include "surface.h"
 #include "strip.h"
@@ -74,12 +78,10 @@ using namespace Glib;
 
 #include "pbd/abstract_ui.cc" // instantiate template
 
-#define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
-
 const int MackieControlProtocol::MODIFIER_OPTION = 0x1;
 const int MackieControlProtocol::MODIFIER_CONTROL = 0x2;
-const int MackieControlProtocol::MODIFIER_SHIFT = 0x3;
-const int MackieControlProtocol::MODIFIER_CMDALT = 0x4;
+const int MackieControlProtocol::MODIFIER_SHIFT = 0x4;
+const int MackieControlProtocol::MODIFIER_CMDALT = 0x8;
 
 MackieControlProtocol* MackieControlProtocol::_instance = 0;
 
@@ -89,30 +91,30 @@ bool MackieControlProtocol::probe()
 }
 
 MackieControlProtocol::MackieControlProtocol (Session& session)
-       : ControlProtocol (session, X_("Mackie"), this)
+       : ControlProtocol (session, X_("Mackie"))
        , AbstractUI<MackieControlUIRequest> ("mackie")
        , _current_initial_bank (0)
        , _timecode_type (ARDOUR::AnyTime::BBT)
-       , _input_bundle (new ARDOUR::Bundle (_("Mackie Control In"), true))
-       , _output_bundle (new ARDOUR::Bundle (_("Mackie Control Out"), false))
        , _gui (0)
        , _zoom_mode (false)
        , _scrub_mode (false)
        , _flip_mode (Normal)
-       , _view_mode (Global)
+       , _view_mode (Mixer)
        , _current_selected_track (-1)
+       , _modifier_state (0)
+       , _ipmidi_base (MIDI::IPMIDIPort::lowest_ipmidi_port_default)
+       , needs_ipmidi_restart (false)
+       , _metering_active (true)
+       , _initialized (false)
+       , _surfaces_state (0)
+       , _surfaces_version (0)
 {
        DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
 
        DeviceInfo::reload_device_info ();
-       set_device (Config->get_mackie_device_name());
-
-       AudioEngine::instance()->PortConnectedOrDisconnected.connect (
-               audio_engine_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::port_connected_or_disconnected, this, _2, _4, _5),
-               this
-               );
+       DeviceProfile::reload_device_profiles ();
 
-       TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::gui_track_selection_changed, this, _1), this);
+       TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::gui_track_selection_changed, this, _1, true), this);
 
        _instance = this;
 
@@ -121,11 +123,22 @@ MackieControlProtocol::MackieControlProtocol (Session& session)
 
 MackieControlProtocol::~MackieControlProtocol()
 {
-       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol\n");
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol init\n");
+       
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol drop_connections ()\n");
+       drop_connections ();
+
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol tear_down_gui ()\n");
+       tear_down_gui ();
 
-       _active = false;
+       delete _surfaces_state;
+
+       /* stop event loop */
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol BaseUI::quit ()\n");
+       BaseUI::quit ();
 
        try {
+               DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol close()\n");
                close();
        }
        catch (exception & e) {
@@ -135,9 +148,9 @@ MackieControlProtocol::~MackieControlProtocol()
                cout << "~MackieControlProtocol caught unknown" << endl;
        }
 
-       DEBUG_TRACE (DEBUG::MackieControl, "finished ~MackieControlProtocol::MackieControlProtocol\n");
-
        _instance = 0;
+
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol done\n");
 }
 
 void
@@ -158,6 +171,20 @@ MackieControlProtocol::thread_init ()
        }
 }
 
+void
+MackieControlProtocol::midi_connectivity_established ()
+{
+       for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
+               (*si)->say_hello ();
+       }
+
+       if (_device_info.no_handshake()) {
+               for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
+                       (*si)->turn_it_on ();
+               }
+       }
+}
+
 // go to the previous track.
 // Assume that get_sorted_routes().size() > route_table.size()
 void 
@@ -179,6 +206,17 @@ MackieControlProtocol::next_track()
        }
 }
 
+bool
+MackieControlProtocol::route_is_locked_to_strip (boost::shared_ptr<Route> r) const
+{
+       for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
+               if ((*si)->route_is_locked_to_strip (r)) {
+                       return true;
+               }
+       }
+       return false;
+}
+
 // predicate for sort call in get_sorted_routes
 struct RouteByRemoteId
 {
@@ -216,18 +254,24 @@ MackieControlProtocol::get_sorted_routes()
 
        for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it) {
 
-               Route & route = **it;
+               boost::shared_ptr<Route> route = *it;
 
-               if (remote_ids.find (route.remote_control_id()) != remote_ids.end()) {
+               if (remote_ids.find (route->remote_control_id()) != remote_ids.end()) {
                        continue;
                }
 
-               if (route.is_hidden() || route.is_master() || route.is_monitor()) {
+               if (route->is_auditioner() || route->is_master() || route->is_monitor()) {
+                       continue;
+               }
+
+               /* don't include locked routes */
+
+               if (route_is_locked_to_strip(route)) {
                        continue;
                }
 
                switch (_view_mode) {
-               case Global:
+               case Mixer:
                        break;
                case AudioTracks:
                        break;
@@ -248,7 +292,7 @@ MackieControlProtocol::get_sorted_routes()
                }
 
                sorted.push_back (*it);
-               remote_ids.insert (route.remote_control_id());
+               remote_ids.insert (route->remote_control_id());
        }
 
        sort (sorted.begin(), sorted.end(), RouteByRemoteId());
@@ -262,12 +306,12 @@ MackieControlProtocol::refresh_current_bank()
 }
 
 uint32_t
-MackieControlProtocol::n_strips() const
+MackieControlProtocol::n_strips (bool with_locked_strips) const
 {
        uint32_t strip_count = 0;
 
        for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
-               strip_count += (*si)->n_strips ();
+               strip_count += (*si)->n_strips (with_locked_strips);
        }
 
        return strip_count;
@@ -283,27 +327,19 @@ MackieControlProtocol::switch_banks (uint32_t initial, bool force)
        }
 
        Sorted sorted = get_sorted_routes();
-       uint32_t strip_cnt = n_strips();
-
-       if (sorted.size() <= strip_cnt && !force) {
-               /* no banking - not enough routes to fill all strips */
-               return;
-       }
-
-       uint32_t delta = sorted.size() - strip_cnt;
+       uint32_t strip_cnt = n_strips (false); // do not include locked strips
+                                              // in this count
 
-       if (delta > 0 && initial > delta) {
-               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("not switching to %1\n", initial));
+       if (sorted.size() <= strip_cnt && _current_initial_bank == 0 && !force) {
+               /* no banking - not enough routes to fill all strips and we're
+                * not at the first one.
+                */
                return;
        }
 
        _current_initial_bank = initial;
        _current_selected_track = -1;
 
-       for (Surfaces::iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
-               (*si)->drop_routes ();
-       }
-
        // Map current bank of routes onto each surface(+strip)
 
        if (_current_initial_bank <= sorted.size()) {
@@ -318,9 +354,9 @@ MackieControlProtocol::switch_banks (uint32_t initial, bool force)
                        vector<boost::shared_ptr<Route> > routes;
                        uint32_t added = 0;
 
-                       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has %1 strips\n", (*si)->n_strips()));
+                       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has %1 unlockedstrips\n", (*si)->n_strips (false)));
 
-                       for (; r != sorted.end() && added < (*si)->n_strips(); ++r, ++added) {
+                       for (; r != sorted.end() && added < (*si)->n_strips (false); ++r, ++added) {
                                routes.push_back (*r);
                        }
 
@@ -332,51 +368,53 @@ MackieControlProtocol::switch_banks (uint32_t initial, bool force)
 
        /* reset this to get the right display of view mode after the switch */
        set_view_mode (_view_mode);
+
+       /* make sure selection is correct */
+       
+       _gui_track_selection_changed (&_last_selected_routes, false);
        
        /* current bank has not been saved */
-
        session->set_dirty();
 }
 
 int 
 MackieControlProtocol::set_active (bool yn)
 {
-       if (yn == _active) {
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active init with yn: '%1'\n", yn));
+
+       if (yn == active()) {
                return 0;
        }
 
-       try
-       {
-               if (yn) {
-
-                       /* start event loop */
+       if (yn) {
+               
+               /* start event loop */
+               
+               BaseUI::run ();
+               
+               if (create_surfaces ()) {
+                       return -1;
+               }
+               connect_session_signals ();
+               update_surfaces ();
+               
+               /* set up periodic task for metering and automation
+                */
+               
+               Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
+               periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
+               periodic_timeout->attach (main_loop()->get_context());
+               
+       } else {
 
-                       BaseUI::run ();
+               BaseUI::quit ();
+               close ();
 
-                       create_surfaces ();
-                       connect_session_signals ();
-                       _active = true;
-                       update_surfaces ();
+       }
 
-                       /* set up periodic task for metering and automation
-                        */
+       ControlProtocol::set_active (yn);
 
-                       Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
-                       periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
-                       periodic_timeout->attach (main_loop()->get_context());
-
-               } else {
-                       BaseUI::quit ();
-                       close();
-                       _active = false;
-               }
-       }
-       
-       catch (exception & e) {
-               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("set_active to false because exception caught: %1\n", e.what()));
-               _active = false;
-               throw;
-       }
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active done with yn: '%1'\n", yn));
 
        return 0;
 }
@@ -384,29 +422,54 @@ MackieControlProtocol::set_active (bool yn)
 bool
 MackieControlProtocol::periodic ()
 {
-       if (!_active) {
+       if (!active()) {
                return false;
        }
 
-       for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
-               (*s)->periodic ();
+       if (needs_ipmidi_restart) {
+               ipmidi_restart ();
+               return true;
        }
        
+       if (!_initialized) {
+               initialize();
+       }
+
+       struct timeval now;
+       uint64_t now_usecs;
+       gettimeofday (&now, 0);
+
+       now_usecs = (now.tv_sec * 1000000) + now.tv_usec;
+
+       {
+               Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
+               for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
+                       (*s)->periodic (now_usecs);
+               }
+       }
+
+       update_timecode_display ();
+       
        return true;
 }
 
-
 void 
 MackieControlProtocol::update_timecode_beats_led()
 {
+       if (!_device_info.has_timecode_display()) {
+               return;
+       }
+
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::update_timecode_beats_led(): %1\n", _timecode_type));
        switch (_timecode_type) {
                case ARDOUR::AnyTime::BBT:
-                       update_global_led ("beats", on);
-                       update_global_led ("timecode", off);
+                       update_global_led (Led::Beats, on);
+                       update_global_led (Led::Timecode, off);
                        break;
                case ARDOUR::AnyTime::Timecode:
-                       update_global_led ("timecode", on);
-                       update_global_led ("beats", off);
+                       update_global_led (Led::Timecode, on);
+                       update_global_led (Led::Beats, off);
                        break;
                default:
                        ostringstream os;
@@ -416,36 +479,44 @@ MackieControlProtocol::update_timecode_beats_led()
 }
 
 void 
-MackieControlProtocol::update_global_button (const string & name, LedState ls)
+MackieControlProtocol::update_global_button (int id, LedState ls)
 {
-       boost::shared_ptr<Surface> surface = surfaces.front();
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
 
-       if (!surface->type() == mcu) {
+       if (!_device_info.has_global_controls()) {
                return;
        }
 
-       if (surface->controls_by_name.find (name) != surface->controls_by_name.end()) {
-               Button * button = dynamic_cast<Button*> (surface->controls_by_name[name]);
+       boost::shared_ptr<Surface> surface = surfaces.front();
+
+       map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
+       if (x != surface->controls_by_device_independent_id.end()) {
+               Button * button = dynamic_cast<Button*> (x->second);
                surface->write (button->set_state (ls));
        } else {
-               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", name));
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", id));
        }
 }
 
 void 
-MackieControlProtocol::update_global_led (const string & name, LedState ls)
+MackieControlProtocol::update_global_led (int id, LedState ls)
 {
-       boost::shared_ptr<Surface> surface = surfaces.front();
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
 
-       if (!surface->type() == mcu) {
+       if (!_device_info.has_global_controls()) {
                return;
        }
 
-       if (surface->controls_by_name.find (name) != surface->controls_by_name.end()) {
-               Led * led = dynamic_cast<Led*> (surface->controls_by_name[name]);
+       boost::shared_ptr<Surface> surface = surfaces.front();
+
+       map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
+
+       if (x != surface->controls_by_device_independent_id.end()) {
+               Led * led = dynamic_cast<Led*> (x->second);
+               DEBUG_TRACE (DEBUG::MackieControl, "Writing LedState\n");
                surface->write (led->set_state (ls));
        } else {
-               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", name));
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", id));
        }
 }
 
@@ -453,7 +524,8 @@ MackieControlProtocol::update_global_led (const string & name, LedState ls)
 void 
 MackieControlProtocol::update_surfaces()
 {
-       if (!_active) {
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::update_surfaces() init\n");
+       if (!active()) {
                return;
        }
 
@@ -461,65 +533,115 @@ MackieControlProtocol::update_surfaces()
        // _current_initial_bank is initialised by set_state
        switch_banks (_current_initial_bank, true);
        
-       // sometimes the jog wheel is a pot
-       surfaces.front()->blank_jog_ring ();
-       
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::update_surfaces() finished\n");
+}
+
+void
+MackieControlProtocol::initialize()
+{
+       {
+               Glib::Threads::Mutex::Lock lm (surfaces_lock);
+               
+               if (surfaces.empty()) {
+                       return;
+               }
+               
+               if (!surfaces.front()->active ()) {
+                       return;
+               }
+               
+               // sometimes the jog wheel is a pot
+               if (_device_info.has_jog_wheel()) {
+                       surfaces.front()->blank_jog_ring ();
+               }
+       }
+
        // update global buttons and displays
 
        notify_record_state_changed();
        notify_transport_state_changed();
        update_timecode_beats_led();
+       
+       _initialized = true;
 }
 
 void 
 MackieControlProtocol::connect_session_signals()
 {
        // receive routes added
-       session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_route_added, this, _1), this);
+       session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_route_added, this, _1), this);
        // receive record state toggled
-       session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_record_state_changed, this), this);
+       session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_record_state_changed, this), this);
        // receive transport state changed
-       session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
-       session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
+       session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
+       session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
        // receive punch-in and punch-out
-       Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
-       session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
+       Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
+       session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
        // receive rude solo changed
-       session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), this);
+       session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), this);
 
        // make sure remote id changed signals reach here
        // see also notify_route_added
        Sorted sorted = get_sorted_routes();
 
        for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
-               (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind(&MackieControlProtocol::notify_remote_id_changed, this), this);
+               (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
        }
 }
 
 void
-MackieControlProtocol::set_device (const string& device_name)
+MackieControlProtocol::set_profile (const string& profile_name)
+{
+       if (profile_name == "default") {
+               /* reset to default */
+               _device_profile = DeviceProfile (profile_name);
+       }
+
+       map<string,DeviceProfile>::iterator d = DeviceProfile::device_profiles.find (profile_name);
+
+       if (d == DeviceProfile::device_profiles.end()) {
+               return;
+       }
+       
+       _device_profile = d->second;
+}      
+
+int
+MackieControlProtocol::set_device_info (const string& device_name)
 {
        map<string,DeviceInfo>::iterator d = DeviceInfo::device_info.find (device_name);
 
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("new device chosen %1\n", device_name));
+
        if (d == DeviceInfo::device_info.end()) {
-               return;
+               return -1;
        }
        
        _device_info = d->second;
 
-       /* store it away in a global location */
-       
-       Config->set_mackie_device_name (device_name);
+       return 0;
+}
+
+int
+MackieControlProtocol::set_device (const string& device_name)
+{
+       if (set_device_info (device_name)) {
+               return -1;
+       }
 
-       if (_active) {
-               clear_ports ();
-               surfaces.clear ();
-               create_surfaces ();
-               switch_banks (0, true);
+       clear_surfaces ();
+
+       if (create_surfaces ()) {
+               return -1;
        }
+
+       switch_banks (0, true);
+
+       return 0;
 }
 
-void 
+int
 MackieControlProtocol::create_surfaces ()
 {
        string device_name;
@@ -536,8 +658,22 @@ MackieControlProtocol::create_surfaces ()
 
        for (uint32_t n = 0; n < 1 + _device_info.extenders(); ++n) {
 
-               boost::shared_ptr<Surface> surface (new Surface (*this, device_name, n, stype));
-               surfaces.push_back (surface);
+               boost::shared_ptr<Surface> surface;
+
+               try {
+                       surface.reset (new Surface (*this, device_name, n, stype));
+               } catch (...) {
+                       return -1;
+               }
+
+               if (_surfaces_state) {
+                       surface->set_state (*_surfaces_state, _surfaces_version);
+               }
+
+               {
+                       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+                       surfaces.push_back (surface);
+               }
 
                /* next device will be an extender */
                
@@ -549,21 +685,37 @@ MackieControlProtocol::create_surfaces ()
                }
                stype = ext;
 
-               _input_bundle->add_channel (
-                       surface->port().input_port().name(),
-                       ARDOUR::DataType::MIDI,
-                       session->engine().make_port_name_non_relative (surface->port().input_port().name())
-                       );
-               
-               _output_bundle->add_channel (
-                       surface->port().output_port().name(),
-                       ARDOUR::DataType::MIDI,
-                       session->engine().make_port_name_non_relative (surface->port().output_port().name())
-                       );
+               if (!_device_info.uses_ipmidi()) {
+
+                       _input_bundle.reset (new ARDOUR::Bundle (_("Mackie Control In"), true));
+                       _output_bundle.reset (new ARDOUR::Bundle (_("Mackie Control Out"), false));
+
+                       _input_bundle->add_channel (
+                               surface->port().input_port().name(),
+                               ARDOUR::DataType::MIDI,
+                               session->engine().make_port_name_non_relative (surface->port().input_port().name())
+                               );
+                       
+                       _output_bundle->add_channel (
+                               surface->port().output_port().name(),
+                               ARDOUR::DataType::MIDI,
+                               session->engine().make_port_name_non_relative (surface->port().output_port().name())
+                               );
+
+                       session->BundleAdded (_input_bundle);
+                       session->BundleAdded (_output_bundle);
+
+               } else {
+                       _input_bundle.reset ((ARDOUR::Bundle*) 0);
+                       _output_bundle.reset ((ARDOUR::Bundle*) 0);
+
+                       session->BundleRemoved (_input_bundle);
+                       session->BundleRemoved (_output_bundle);
+               }
 
                int fd;
                MIDI::Port& input_port (surface->port().input_port());
-               
+
                if ((fd = input_port.selectable ()) >= 0) {
                        Glib::RefPtr<IOSource> psrc = IOSource::create (fd, IO_IN|IO_HUP|IO_ERR);
 
@@ -576,116 +728,117 @@ MackieControlProtocol::create_surfaces ()
                        g_source_ref (psrc->gobj());
                }
        }
+
+       return 0;
 }
 
 void 
 MackieControlProtocol::close()
 {
-       clear_ports ();
-
-       port_connections.drop_connections ();
        session_connections.drop_connections ();
        route_connections.drop_connections ();
        periodic_connection.disconnect ();
 
-       surfaces.clear ();
+       clear_surfaces();
 }
 
 XMLNode& 
 MackieControlProtocol::get_state()
 {
-       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state\n");
+       XMLNode& node (ControlProtocol::get_state());
 
-       // add name of protocol
-       XMLNode* node = new XMLNode (X_("Protocol"));
-       node->add_property (X_("name"), ARDOUR::ControlProtocol::_name);
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state init\n");
+       char buf[16];
 
        // add current bank
-       ostringstream os;
-       os << _current_initial_bank;
-       node->add_property (X_("bank"), os.str());
+       snprintf (buf, sizeof (buf), "%d", _current_initial_bank);
+       node.add_property (X_("bank"), buf);
+
+       // ipMIDI base port (possibly not used)
+       snprintf (buf, sizeof (buf), "%d", _ipmidi_base);
+       node.add_property (X_("ipmidi-base"), buf);
+
+       node.add_property (X_("device-profile"), _device_profile.name());
+       node.add_property (X_("device-name"), _device_info.name());
 
-       for (uint32_t n = 0; n < 16; ++n) {
-               ostringstream s;
-               s << string_compose ("f%1-action", n+1);
-               node->add_property (s.str().c_str(), f_action (n));
+       XMLNode* snode = new XMLNode (X_("Surfaces"));
+       for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
+               snode->add_child_nocopy ((*s)->get_state());
        }
 
-       return *node;
+       node.add_child_nocopy (*snode);
+
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state done\n");
+
+       return node;
 }
 
 int 
-MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
+MackieControlProtocol::set_state (const XMLNode & node, int version)
 {
-       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", _active));
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", active()));
 
        int retval = 0;
        const XMLProperty* prop;
+       uint32_t bank = 0;
+
+       if ((prop = node.property (X_("ipmidi-base"))) != 0) {
+               set_ipmidi_base (atoi (prop->value()));
+       }
 
        // fetch current bank
        if ((prop = node.property (X_("bank"))) != 0) {
-               string bank = prop->value();
-               set_active (true);
-               uint32_t new_bank = atoi (bank.c_str());
-               if (_current_initial_bank != new_bank) {
-                       switch_banks (new_bank);
-               }
+               bank = atoi (prop->value());
+       }
+       
+       if ((prop = node.property (X_("device-name"))) != 0) {
+               set_device_info (prop->value());
        }
 
-       _f_actions.clear ();
-       _f_actions.resize (16);
-
-       for (uint32_t n = 0; n < 16; ++n) {
-               string action;
-               if ((prop = node.property (string_compose ("f%1-action", n+1))) != 0) {
-                       action = prop->value();
-               }
-
-               if (action.empty()) {
-                       /* default action if nothing is specified */
-                       action = string_compose ("Editor/goto-visual-state-%1", n+1);
-               }
+       if ((prop = node.property (X_("device-profile"))) != 0) {
+               set_profile (prop->value());
+       }
+       
+       XMLNode* snode = node.child (X_("Surfaces"));
+       
+       delete _surfaces_state;
+       _surfaces_state = 0;
 
-               _f_actions[n] = action;
+       if (snode) {
+               _surfaces_state = new XMLNode (*snode);
+               _surfaces_version = version;
        }
 
+       switch_banks (bank, true);
+       
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::set_state done\n");
+
        return retval;
 }
 
-
-/////////////////////////////////////////////////
-// handlers for Route signals
-// TODO should these be part of RouteSignal?
-// They started off as signal/slot handlers for signals
-// from Route, but they're also used in polling for automation
-/////////////////////////////////////////////////
-
-// TODO handle plugin automation polling
 string 
 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
 {
        Timecode::BBT_Time bbt_time;
+
        session->bbt_time (now_frame, bbt_time);
 
-       // According to the Logic docs
-       // digits: 888/88/88/888
-       // BBT mode: Bars/Beats/Subdivisions/Ticks
+       // The Mackie protocol spec is built around a BBT time display of
+       //
+       // digits:     888/88/88/888
+       // semantics:  BBB/bb/ss/ttt
+       //
+       // The third field is "subdivisions" which is a concept found in Logic
+       // but not present in Ardour. Instead Ardour displays a 4 digit tick
+       // count, which we need to spread across the 5 digits of ss/ttt.
+
        ostringstream os;
+
        os << setw(3) << setfill('0') << bbt_time.bars;
        os << setw(2) << setfill('0') << bbt_time.beats;
-
-       // figure out subdivisions per beat
-       const ARDOUR::Meter & meter = session->tempo_map().meter_at (now_frame);
-       int subdiv = 2;
-       if (meter.note_divisor() == 8 && (meter.divisions_per_bar() == 12.0 || meter.divisions_per_bar() == 9.0 || meter.divisions_per_bar() == 6.0)) {
-               subdiv = 3;
-       }
-
-       uint32_t subdivisions = bbt_time.ticks / uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
-       uint32_t ticks = bbt_time.ticks % uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
-
-       os << setw(2) << setfill('0') << subdivisions + 1;
-       os << setw(3) << setfill('0') << ticks;
+       os << ' ';
+       os << setw(1) << setfill('0') << bbt_time.ticks / 1000;
+       os << setw(3) << setfill('0') << bbt_time.ticks % 1000;
 
        return os.str();
 }
@@ -700,10 +853,12 @@ MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
        // digits: 888/88/88/888
        // Timecode mode: Hours/Minutes/Seconds/Frames
        ostringstream os;
-       os << setw(3) << setfill('0') << timecode.hours;
+       os << setw(2) << setfill('0') << timecode.hours;
+       os << ' ';
        os << setw(2) << setfill('0') << timecode.minutes;
        os << setw(2) << setfill('0') << timecode.seconds;
-       os << setw(3) << setfill('0') << timecode.frames;
+       os << ' ';
+       os << setw(2) << setfill('0') << timecode.frames;
 
        return os.str();
 }
@@ -711,9 +866,15 @@ MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
 void 
 MackieControlProtocol::update_timecode_display()
 {
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
+       if (surfaces.empty()) {
+               return;
+       }
+
        boost::shared_ptr<Surface> surface = surfaces.front();
 
-       if (surface->type() != mcu || !surface->has_timecode_display()) {
+       if (surface->type() != mcu || !_device_info.has_timecode_display() || !surface->active ()) {
                return;
        }
 
@@ -747,11 +908,11 @@ MackieControlProtocol::update_timecode_display()
 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
 {
        if (p == "punch-in") {
-               update_global_button ("punch_in", session->config.get_punch_in());
+               update_global_button (Button::PunchIn, session->config.get_punch_in());
        } else if (p == "punch-out") {
-               update_global_button ("punch_out", session->config.get_punch_out());
+               update_global_button (Button::PunchOut, session->config.get_punch_out());
        } else if (p == "clicking") {
-               update_global_button ("clicking", Config->get_clicking());
+               // update_global_button (Button::RelayClick, Config->get_clicking());
        } else {
                DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
        }
@@ -772,19 +933,26 @@ MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
        typedef ARDOUR::RouteList ARS;
 
        for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
-               (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
+               (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
        }
 }
 
 void 
 MackieControlProtocol::notify_solo_active_changed (bool active)
 {
-       boost::shared_ptr<Surface> surface = surfaces.front();
-       
-       Led* rude_solo = dynamic_cast<Led*> (surface->controls_by_name["solo"]);
+       boost::shared_ptr<Surface> surface;
 
-       if (rude_solo) {
-               surface->write (rude_solo->set_state (active ? flashing : off));
+       {
+               Glib::Threads::Mutex::Lock lm (surfaces_lock);
+               surface = surfaces.front ();
+       }
+       
+       map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Led::RudeSolo);
+       if (x != surface->controls_by_device_independent_id.end()) {
+               Led* rude_solo = dynamic_cast<Led*> (x->second);
+               if (rude_solo) {
+                       surface->write (rude_solo->set_state (active ? flashing : off));
+               }
        }
 }
 
@@ -813,49 +981,75 @@ MackieControlProtocol::notify_remote_id_changed()
 void 
 MackieControlProtocol::notify_loop_state_changed()
 {
-       update_global_button ("loop", session->get_play_loop());
+       update_global_button (Button::Loop, session->get_play_loop());
 }
 
 void 
 MackieControlProtocol::notify_transport_state_changed()
 {
+       if (!_device_info.has_global_controls()) {
+               return;
+       }
+
        // switch various play and stop buttons on / off
-       update_global_button ("play", session->transport_speed() == 1.0);
-       update_global_button ("stop", !session->transport_rolling());
-       update_global_button ("rewind", session->transport_speed() < 0.0);
-       update_global_button ("ffwd", session->transport_speed() > 1.0);
+       update_global_button (Button::Loop, session->get_play_loop());
+       update_global_button (Button::Play, session->transport_speed() == 1.0);
+       update_global_button (Button::Stop, session->transport_stopped ());
+       update_global_button (Button::Rewind, session->transport_speed() < 0.0);
+       update_global_button (Button::Ffwd, session->transport_speed() > 1.0);
 
-       _transport_previously_rolling = session->transport_rolling();
+       notify_metering_state_changed ();
+}
+
+void 
+MackieControlProtocol::notify_metering_state_changed()
+{
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
+       for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
+               (*s)->notify_metering_state_changed ();
+       }       
 }
 
 void
 MackieControlProtocol::notify_record_state_changed ()
 {
-       /* rec is a tristate */
+       if (!_device_info.has_global_controls()) {
+               return;
+       }
 
+       boost::shared_ptr<Surface> surface;
 
-       Button * rec = reinterpret_cast<Button*> (surfaces.front()->controls_by_name["record"]);
-       if (rec) {
-               LedState ls;
+       {
+               Glib::Threads::Mutex::Lock lm (surfaces_lock);
+               surface = surfaces.front();
+       }
+               
+       /* rec is a tristate */
 
-               switch (session->record_status()) {
-               case Session::Disabled:
-                       DEBUG_TRACE (DEBUG::MackieControl, "record state changed to disabled, LED off\n");
-                       ls = off;
-                       break;
-               case Session::Recording:
-                       DEBUG_TRACE (DEBUG::MackieControl, "record state changed to recording, LED on\n");
-                       ls = on;
-                       break;
-               case Session::Enabled:
-                       DEBUG_TRACE (DEBUG::MackieControl, "record state changed to enabled, LED flashing\n");
-                       ls = flashing;
-                       break;
-               }
+       map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Button::Record);
+       if (x != surface->controls_by_device_independent_id.end()) {
+               Button * rec = dynamic_cast<Button*> (x->second);
+               if (rec) {
+                       LedState ls;
+                       
+                       switch (session->record_status()) {
+                       case Session::Disabled:
+                               DEBUG_TRACE (DEBUG::MackieControl, "record state changed to disabled, LED off\n");
+                               ls = off;
+                               break;
+                       case Session::Recording:
+                               DEBUG_TRACE (DEBUG::MackieControl, "record state changed to recording, LED on\n");
+                               ls = on;
+                               break;
+                       case Session::Enabled:
+                               DEBUG_TRACE (DEBUG::MackieControl, "record state changed to enabled, LED flashing\n");
+                               ls = flashing;
+                               break;
+                       }
 
-               surfaces.front()->write (rec->set_state (ls));
-       } else {
-               DEBUG_TRACE (DEBUG::MackieControl, "record button control not found\n");
+                       surface->write (rec->set_state (ls));
+               }
        }
 }
 
@@ -863,29 +1057,13 @@ list<boost::shared_ptr<ARDOUR::Bundle> >
 MackieControlProtocol::bundles ()
 {
        list<boost::shared_ptr<ARDOUR::Bundle> > b;
-       b.push_back (_input_bundle);
-       b.push_back (_output_bundle);
-       return b;
-}
-
-void
-MackieControlProtocol::port_connected_or_disconnected (string a, string b, bool connected)
-{
-       /* If something is connected to one of our output ports, send MIDI to update the surface
-          to whatever state it should have.
-       */
 
-       if (!connected) {
-               return;
+       if (_input_bundle) {
+               b.push_back (_input_bundle);
+               b.push_back (_output_bundle);
        }
 
-       for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
-               string const n = AudioEngine::instance()->make_port_name_non_relative ((*s)->port().output_port().name ());
-               if (a == n || b == n) {
-                       update_surfaces ();
-                       return;
-               }
-       }
+       return b;
 }
 
 void
@@ -909,46 +1087,6 @@ MackieControlProtocol::stop ()
        return 0;
 }
 
-/** Add a timeout so that a control's in_use flag will be reset some time in the future.
- *  @param in_use_control the control whose in_use flag to reset.
- *  @param touch_control a touch control to emit an event for, or 0.
- */
-void
-MackieControlProtocol::add_in_use_timeout (Surface& surface, Control& in_use_control, Control* touch_control)
-{
-       Glib::RefPtr<Glib::TimeoutSource> timeout (Glib::TimeoutSource::create (250)); // milliseconds
-
-       in_use_control.in_use_connection.disconnect ();
-       in_use_control.in_use_connection = timeout->connect (
-               sigc::bind (sigc::mem_fun (*this, &MackieControlProtocol::control_in_use_timeout), &surface, &in_use_control, touch_control));
-       in_use_control.in_use_touch_control = touch_control;
-       
-       timeout->attach (main_loop()->get_context());
-
-       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("timeout queued for surface %1, control %2 touch control %3\n",
-                                                          surface.number(), &in_use_control, touch_control));}
-
-/** Handle timeouts to reset in_use for controls that can't
- *  do this by themselves (e.g. pots, and faders without touch support).
- *  @param in_use_control the control whose in_use flag to reset.
- *  @param touch_control a touch control to emit an event for, or 0.
- */
-bool
-MackieControlProtocol::control_in_use_timeout (Surface* surface, Control* in_use_control, Control* touch_control)
-{
-       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("timeout elapsed for surface %1, control %2 touch control %3\n",
-                                                          surface->number(), in_use_control, touch_control));
-
-       in_use_control->set_in_use (false);
-
-       if (touch_control) {
-               /* figure out what to do here */
-       }
-       
-       // only call this method once from the timer
-       return false;
-}
-
 void 
 MackieControlProtocol::update_led (Surface& surface, Button& button, Mackie::LedState ls)
 {
@@ -960,9 +1098,12 @@ MackieControlProtocol::update_led (Surface& surface, Button& button, Mackie::Led
 void
 MackieControlProtocol::build_button_map ()
 {
-#define DEFINE_BUTTON_HANDLER(b,p,r) button_map.insert (pair<int,ButtonHandlers> ((b), ButtonHandlers ((p),(r))));
+       /* this maps our device-independent button codes to the methods that handle them.
+        */
 
-       DEFINE_BUTTON_HANDLER (Button::Io, &MackieControlProtocol::io_press, &MackieControlProtocol::io_release);
+#define DEFINE_BUTTON_HANDLER(b,p,r) button_map.insert (pair<Button::ID,ButtonHandlers> ((b), ButtonHandlers ((p),(r))));
+
+       DEFINE_BUTTON_HANDLER (Button::IO, &MackieControlProtocol::io_press, &MackieControlProtocol::io_release);
        DEFINE_BUTTON_HANDLER (Button::Sends, &MackieControlProtocol::sends_press, &MackieControlProtocol::sends_release);
        DEFINE_BUTTON_HANDLER (Button::Pan, &MackieControlProtocol::pan_press, &MackieControlProtocol::pan_release);
        DEFINE_BUTTON_HANDLER (Button::Plugin, &MackieControlProtocol::plugin_press, &MackieControlProtocol::plugin_release);
@@ -1026,6 +1167,31 @@ MackieControlProtocol::build_button_map ()
        DEFINE_BUTTON_HANDLER (Button::Scrub, &MackieControlProtocol::scrub_press, &MackieControlProtocol::scrub_release);
        DEFINE_BUTTON_HANDLER (Button::UserA, &MackieControlProtocol::user_a_press, &MackieControlProtocol::user_a_release);
        DEFINE_BUTTON_HANDLER (Button::UserB, &MackieControlProtocol::user_b_press, &MackieControlProtocol::user_b_release);
+       DEFINE_BUTTON_HANDLER (Button::MasterFaderTouch, &MackieControlProtocol::master_fader_touch_press, &MackieControlProtocol::master_fader_touch_release);
+
+       DEFINE_BUTTON_HANDLER (Button::Snapshot, &MackieControlProtocol::snapshot_press, &MackieControlProtocol::snapshot_release);
+       DEFINE_BUTTON_HANDLER (Button::Read, &MackieControlProtocol::read_press, &MackieControlProtocol::read_release);
+       DEFINE_BUTTON_HANDLER (Button::Write, &MackieControlProtocol::write_press, &MackieControlProtocol::write_release);
+       DEFINE_BUTTON_HANDLER (Button::FdrGroup, &MackieControlProtocol::fdrgroup_press, &MackieControlProtocol::fdrgroup_release);
+       DEFINE_BUTTON_HANDLER (Button::ClearSolo, &MackieControlProtocol::clearsolo_press, &MackieControlProtocol::clearsolo_release);
+       DEFINE_BUTTON_HANDLER (Button::Track, &MackieControlProtocol::track_press, &MackieControlProtocol::track_release);
+       DEFINE_BUTTON_HANDLER (Button::Send, &MackieControlProtocol::send_press, &MackieControlProtocol::send_release);
+       DEFINE_BUTTON_HANDLER (Button::MidiTracks, &MackieControlProtocol::miditracks_press, &MackieControlProtocol::miditracks_release);
+       DEFINE_BUTTON_HANDLER (Button::Inputs, &MackieControlProtocol::inputs_press, &MackieControlProtocol::inputs_release);
+       DEFINE_BUTTON_HANDLER (Button::AudioTracks, &MackieControlProtocol::audiotracks_press, &MackieControlProtocol::audiotracks_release);
+       DEFINE_BUTTON_HANDLER (Button::AudioInstruments, &MackieControlProtocol::audioinstruments_press, &MackieControlProtocol::audioinstruments_release);
+       DEFINE_BUTTON_HANDLER (Button::Aux, &MackieControlProtocol::aux_press, &MackieControlProtocol::aux_release);
+       DEFINE_BUTTON_HANDLER (Button::Busses, &MackieControlProtocol::busses_press, &MackieControlProtocol::busses_release);
+       DEFINE_BUTTON_HANDLER (Button::Outputs, &MackieControlProtocol::outputs_press, &MackieControlProtocol::outputs_release);
+       DEFINE_BUTTON_HANDLER (Button::User, &MackieControlProtocol::user_press, &MackieControlProtocol::user_release);
+       DEFINE_BUTTON_HANDLER (Button::Trim, &MackieControlProtocol::trim_press, &MackieControlProtocol::trim_release);
+       DEFINE_BUTTON_HANDLER (Button::Latch, &MackieControlProtocol::latch_press, &MackieControlProtocol::latch_release);
+       DEFINE_BUTTON_HANDLER (Button::Grp, &MackieControlProtocol::grp_press, &MackieControlProtocol::grp_release);
+       DEFINE_BUTTON_HANDLER (Button::Nudge, &MackieControlProtocol::nudge_press, &MackieControlProtocol::nudge_release);
+       DEFINE_BUTTON_HANDLER (Button::Drop, &MackieControlProtocol::drop_press, &MackieControlProtocol::drop_release);
+       DEFINE_BUTTON_HANDLER (Button::Replace, &MackieControlProtocol::replace_press, &MackieControlProtocol::replace_release);
+       DEFINE_BUTTON_HANDLER (Button::Click, &MackieControlProtocol::click_press, &MackieControlProtocol::click_release);
+       DEFINE_BUTTON_HANDLER (Button::View, &MackieControlProtocol::view_press, &MackieControlProtocol::view_release);
 }
 
 void 
@@ -1036,9 +1202,32 @@ MackieControlProtocol::handle_button_event (Surface& surface, Button& button, Bu
                return;
        }
        
-       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2\n", (bs == press ? "press" : "release"), button.id()));
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2 (%3)\n", (bs == press ? "press" : "release"), button.id(),
+                                                          Button::id_to_name (button.bid())));
 
-       ButtonMap::iterator b = button_map.find (button.id());
+       /* check profile first */
+       
+       string action = _device_profile.get_button_action (button.bid(), _modifier_state);
+       
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Looked up action for button %1 with modifier %2, got [%3]\n",
+                                                          button.bid(), _modifier_state, action));
+
+       if (!action.empty()) {
+               /* if there is a bound action for this button, and this is a press event,
+                  carry out the action. If its a release event, do nothing since we 
+                  don't bind to them at all but don't want any other handling to 
+                  occur either.
+               */
+               if (bs == press) {
+                       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("executing action %1\n", action));
+                       access_action (action);
+               }
+               return;
+       }
+
+       /* lookup using the device-INDEPENDENT button ID */
+
+       ButtonMap::iterator b = button_map.find (button.bid());
 
        if (b != button_map.end()) {
 
@@ -1047,6 +1236,7 @@ MackieControlProtocol::handle_button_event (Surface& surface, Button& button, Bu
                switch  (bs) {
                case press: 
                        surface.write (button.set_state ((this->*(bh.press)) (button)));
+                       break;
                case release: 
                        surface.write (button.set_state ((this->*(bh.release)) (button)));
                        break;
@@ -1054,30 +1244,17 @@ MackieControlProtocol::handle_button_event (Surface& surface, Button& button, Bu
                        break;
                }
        } else {
-               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button handlers for ID %1\n", button.id()));
-       }
-}
-
-void
-MackieControlProtocol::select_track (boost::shared_ptr<Route> r)
-{
-       if (_modifier_state == MODIFIER_SHIFT) {
-               r->gain_control()->set_value (0.0);
-       } else {
-               if (_current_selected_track > 0 && r->remote_control_id() == (uint32_t) _current_selected_track) {
-                       UnselectTrack (); /* EMIT SIGNAL */
-                       _current_selected_track = -1;
-               } else {
-                       SelectByRID (r->remote_control_id()); /* EMIT SIGNAL */
-                       _current_selected_track = r->remote_control_id();;
-               }
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button handlers for button ID %1 (device ID %2)\n", 
+                                                                  button.bid(), button.id()));
+               error << string_compose ("no button handlers for button ID %1 (device ID %2)\n", 
+                                        button.bid(), button.id()) << endmsg;
        }
 }
 
 bool
 MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
 {
-       DEBUG_TRACE (DEBUG::MidiIO, string_compose ("something happend on  %1\n", port->name()));
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("something happend on  %1\n", port->name()));
 
        if (ioc & ~IO_IN) {
                return false;
@@ -1085,10 +1262,22 @@ MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
 
        if (ioc & IO_IN) {
 
-               CrossThreadChannel::drain (port->selectable());
+               /* Devices using regular JACK MIDI ports will need to have
+                  the x-thread FIFO drained to avoid burning endless CPU.
+
+                  Devices using ipMIDI have port->selectable() as the same
+                  file descriptor that data arrives on, so doing this
+                  for them will simply throw all incoming data away.
+               */
+
+               if (!_device_info.uses_ipmidi()) {
+#ifndef PLATFORM_WINDOWS
+                       CrossThreadChannel::drain (port->selectable());
+#endif
+               }
 
-               DEBUG_TRACE (DEBUG::MidiIO, string_compose ("data available on %1\n", port->name()));
-               framepos_t now = session->engine().frame_time();
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("data available on %1\n", port->name()));
+               framepos_t now = session->engine().sample_time();
                port->parse (now);
        }
 
@@ -1098,8 +1287,10 @@ MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
 void
 MackieControlProtocol::clear_ports ()
 {
-       _input_bundle->remove_channels ();
-       _output_bundle->remove_channels ();
+       if (_input_bundle) {
+               _input_bundle->remove_channels ();
+               _output_bundle->remove_channels ();
+       }
 
        for (PortSources::iterator i = port_sources.begin(); i != port_sources.end(); ++i) {
                g_source_destroy (*i);
@@ -1109,28 +1300,11 @@ MackieControlProtocol::clear_ports ()
        port_sources.clear ();
 }
 
-string
-MackieControlProtocol::f_action (uint32_t fn)
-{
-       if (fn >= _f_actions.size()) {
-               return string();
-       }
-
-       return _f_actions[fn];
-}
-
-void
-MackieControlProtocol::f_press (uint32_t fn)
-{
-       string action = f_action (0);
-       if (!action.empty()) {
-               access_action (action);
-       }
-}
-
 void
 MackieControlProtocol::set_view_mode (ViewMode m)
 {
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
        _view_mode = m;
 
        for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
@@ -1140,9 +1314,11 @@ MackieControlProtocol::set_view_mode (ViewMode m)
 }
 
 void
-MackieControlProtocol::set_flip_mode (FlipMode m)
+MackieControlProtocol::set_flip_mode (FlipMode fm)
 {
-       _flip_mode = m;
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
+       _flip_mode = fm;
        
        for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
                (*s)->update_flip_mode_display ();
@@ -1168,21 +1344,294 @@ MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r,
                return;
        }
 
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
        for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
                if ((*s)->number() == surface) {
                        Strip* strip = (*s)->nth_strip (strip_number);
                        if (strip) {
                                strip->set_route (session->master_out());
-                               strip->lock_route ();
+                               strip->lock_controls ();
                        }
                }
        }
 }
 
 void
-MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl)
+MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl, bool save_list)
 {
-       for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
-               (*s)->gui_selection_changed (rl);
+       _gui_track_selection_changed (rl.get(), save_list);
+}
+
+void
+MackieControlProtocol::_gui_track_selection_changed (ARDOUR::RouteNotificationList* rl, bool save_list)
+{
+       /* We need to keep a list of the most recently selected routes around,
+          but we are not allowed to keep shared_ptr<Route> unless we want to
+          handle the complexities of route deletion. So instead, the GUI sends
+          us a notification using weak_ptr<Route>, which we keep a copy
+          of. For efficiency's sake, however, we convert the weak_ptr's into
+          shared_ptr<Route> before passing them to however many surfaces (and
+          thus strips) that we have.
+       */
+
+       StrongRouteNotificationList srl;
+
+       for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
+               boost::shared_ptr<ARDOUR::Route> r = (*i).lock();
+               if (r) {
+                       srl.push_back (r);
+               }
        }
+
+       {
+               Glib::Threads::Mutex::Lock lm (surfaces_lock);
+               
+               for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
+                       (*s)->gui_selection_changed (srl);
+               }
+       }
+       
+       if (save_list) {
+               _last_selected_routes = *rl;
+       }
+}
+
+framepos_t
+MackieControlProtocol::transport_frame() const
+{
+       return session->transport_frame();
+}
+
+void
+MackieControlProtocol::add_down_select_button (int surface, int strip)
+{
+       _down_select_buttons.insert ((surface<<8)|(strip&0xf));
+}
+
+void
+MackieControlProtocol::remove_down_select_button (int surface, int strip)
+{
+       DownButtonList::iterator x = find (_down_select_buttons.begin(), _down_select_buttons.end(), (uint32_t) (surface<<8)|(strip&0xf));
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down select buttons\n", surface, strip));
+       if (x != _down_select_buttons.end()) {
+               _down_select_buttons.erase (x);
+       } else {
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down select buttons\n",
+                                                                  surface, strip));
+       }
+}
+
+void
+MackieControlProtocol::select_range ()
+{
+       RouteList routes;
+
+       pull_route_range (_down_select_buttons, routes);
+
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("select range: found %1 routes\n", routes.size()));
+
+       if (!routes.empty()) {
+               for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
+
+                       if (_modifier_state == MODIFIER_CONTROL) {
+                               ToggleRouteSelection ((*r)->remote_control_id ());
+                       } else {
+                               if (r == routes.begin()) {
+                                       SetRouteSelection ((*r)->remote_control_id());
+                               } else {
+                                       AddRouteToSelection ((*r)->remote_control_id());
+                               }
+                       }
+               }
+       }
+}
+
+void
+MackieControlProtocol::add_down_button (AutomationType a, int surface, int strip)
+{
+       DownButtonMap::iterator m = _down_buttons.find (a);
+
+       if (m == _down_buttons.end()) {
+               _down_buttons[a] = DownButtonList();
+       }
+
+       _down_buttons[a].insert ((surface<<8)|(strip&0xf));
+}
+
+void
+MackieControlProtocol::remove_down_button (AutomationType a, int surface, int strip)
+{
+       DownButtonMap::iterator m = _down_buttons.find (a);
+
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down buttons for %3\n", surface, strip, (int) a));
+
+       if (m == _down_buttons.end()) {
+               return;
+       }
+
+       DownButtonList& l (m->second);
+       DownButtonList::iterator x = find (l.begin(), l.end(), (surface<<8)|(strip&0xf));
+
+       if (x != l.end()) {
+               l.erase (x);
+       } else {
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down buttons for %3\n",
+                                                                  surface, strip, (int) a));
+       }
+}
+
+MackieControlProtocol::ControlList
+MackieControlProtocol::down_controls (AutomationType p)
+{
+       ControlList controls;
+       RouteList routes;
+
+       DownButtonMap::iterator m = _down_buttons.find (p);
+
+       if (m == _down_buttons.end()) {
+               return controls;
+       }
+       
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("looking for down buttons for %1, got %2\n",
+                                                          p, m->second.size()));
+
+       pull_route_range (m->second, routes);
+       
+       switch (p) {
+       case GainAutomation:
+               for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
+                       controls.push_back ((*r)->gain_control());
+               }
+               break;
+       case SoloAutomation:
+               for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
+                       controls.push_back ((*r)->solo_control());
+               }
+               break;
+       case MuteAutomation:
+               for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
+                       controls.push_back ((*r)->mute_control());
+               }
+               break;
+       case RecEnableAutomation:
+               for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
+                       boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (*r);
+                       if (trk) {
+                               controls.push_back (trk->rec_enable_control());
+                       }
+               }
+               break;
+       default:
+               break;
+       }
+
+       return controls;
+
+}
+       
+struct ButtonRangeSorter {
+    bool operator() (const uint32_t& a, const uint32_t& b) {
+           return (a>>8) < (b>>8) // a.surface < b.surface
+                   ||
+                   ((a>>8) == (b>>8) && (a&0xf) < (b&0xf)); // a.surface == b.surface && a.strip < b.strip
+    }
+};
+
+void
+MackieControlProtocol::pull_route_range (DownButtonList& down, RouteList& selected)
+{
+       ButtonRangeSorter cmp;
+
+       if (down.empty()) {
+               return;
+       }
+
+       list<uint32_t> ldown;
+       ldown.insert (ldown.end(), down.begin(), down.end());
+       ldown.sort (cmp);
+
+       uint32_t first = ldown.front();
+       uint32_t last = ldown.back ();
+       
+       uint32_t first_surface = first>>8;
+       uint32_t first_strip = first&0xf;
+
+       uint32_t last_surface = last>>8;
+       uint32_t last_strip = last&0xf;
+
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("PRR %5 in list %1.%2 - %3.%4\n", first_surface, first_strip, last_surface, last_strip,
+                                                          down.size()));
+       
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
+       for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
+               
+               if ((*s)->number() >= first_surface && (*s)->number() <= last_surface) {
+
+                       uint32_t fs;
+                       uint32_t ls;
+
+                       if ((*s)->number() == first_surface) {
+                               fs = first_strip;
+                       } else {
+                               fs = 0;
+                       }
+
+                       if ((*s)->number() == last_surface) {
+                               ls = last_strip;
+                               ls += 1;
+                       } else {
+                               ls = (*s)->n_strips ();
+                       }
+
+                       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("adding strips for surface %1 (%2 .. %3)\n",
+                                                                          (*s)->number(), fs, ls));
+
+                       for (uint32_t n = fs; n < ls; ++n) {
+                               boost::shared_ptr<Route> r = (*s)->nth_strip (n)->route();
+                               if (r) {
+                                       selected.push_back (r);
+                               }
+                       }
+               }
+       }
+}
+
+void
+MackieControlProtocol::set_ipmidi_base (int16_t portnum)
+{
+       /* this will not be saved without a session save, so .. */
+
+       session->set_dirty ();
+
+       _ipmidi_base = portnum;
+
+       /* if the current device uses ipMIDI we need
+          to restart.
+       */
+
+       if (active() && _device_info.uses_ipmidi()) {
+               needs_ipmidi_restart = true;
+       }
+}
+
+int
+MackieControlProtocol::ipmidi_restart ()
+{
+       clear_surfaces ();
+       if (create_surfaces ()) {
+               return -1;
+       }
+       switch_banks (_current_initial_bank, true);
+       needs_ipmidi_restart = false;
+       return 0;
+}
+
+void
+MackieControlProtocol::clear_surfaces ()
+{
+       clear_ports ();
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+       surfaces.clear ();      
 }