libs/surfaces/mackie/mackie_control_protocol.cc

   1 /*
   2         Copyright (C) 2006,2007 John Anderson
   3         Copyright (C) 2012 Paul Davis
   4
   5         This program is free software; you can redistribute it and/or modify
   6         it under the terms of the GNU General Public License as published by
   7         the Free Software Foundation; either version 2 of the License, or
   8         (at your option) any later version.
   9
  10         This program is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13         GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to the Free Software
  17         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #include <fcntl.h>
  21 #include <iostream>
  22 #include <algorithm>
  23 #include <cmath>
  24 #include <sstream>
  25 #include <vector>
  26 #include <iomanip>
  27
  28 #include <inttypes.h>
  29 #include <float.h>
  30 #include <sys/time.h>
  31 #include <errno.h>
  32
  33 #include <boost/shared_array.hpp>
  34 #include <glibmm/miscutils.h>
  35
  36 #include "midi++/types.h"
  37 #include "midi++/port.h"
  38 #include "midi++/ipmidi_port.h"
  39 #include "pbd/pthread_utils.h"
  40 #include "pbd/error.h"
  41 #include "pbd/memento_command.h"
  42 #include "pbd/convert.h"
  43
  44 #include "ardour/audio_track.h"
  45 #include "ardour/automation_control.h"
  46 #include "ardour/async_midi_port.h"
  47 #include "ardour/dB.h"
  48 #include "ardour/debug.h"
  49 #include "ardour/location.h"
  50 #include "ardour/meter.h"
  51 #include "ardour/midi_track.h"
  52 #include "ardour/panner.h"
  53 #include "ardour/panner_shell.h"
  54 #include "ardour/profile.h"
  55 #include "ardour/route.h"
  56 #include "ardour/route_group.h"
  57 #include "ardour/session.h"
  58 #include "ardour/tempo.h"
  59 #include "ardour/track.h"
  60 #include "ardour/types.h"
  61 #include "ardour/audioengine.h"
  62
  63 #include "mackie_control_protocol.h"
  64
  65 #include "midi_byte_array.h"
  66 #include "mackie_control_exception.h"
  67 #include "device_profile.h"
  68 #include "surface_port.h"
  69 #include "surface.h"
  70 #include "strip.h"
  71 #include "control_group.h"
  72 #include "meter.h"
  73 #include "button.h"
  74 #include "fader.h"
  75 #include "pot.h"
  76
  77 using namespace ARDOUR;
  78 using namespace std;
  79 using namespace PBD;
  80 using namespace Glib;
  81 using namespace ArdourSurface;
  82 using namespace Mackie;
  83
  84 #include "i18n.h"
  85
  86 #include "pbd/abstract_ui.cc" // instantiate template
  87
  88 const int MackieControlProtocol::MODIFIER_OPTION = 0x1;
  89 const int MackieControlProtocol::MODIFIER_CONTROL = 0x2;
  90 const int MackieControlProtocol::MODIFIER_SHIFT = 0x4;
  91 const int MackieControlProtocol::MODIFIER_CMDALT = 0x8;
  92 const int MackieControlProtocol::MODIFIER_ZOOM = 0x10;
  93 const int MackieControlProtocol::MODIFIER_SCRUB = 0x20;
  94 const int MackieControlProtocol::MAIN_MODIFIER_MASK = (MackieControlProtocol::MODIFIER_OPTION|
  95                                                        MackieControlProtocol::MODIFIER_CONTROL|
  96                                                        MackieControlProtocol::MODIFIER_SHIFT|
  97                                                        MackieControlProtocol::MODIFIER_CMDALT);
  98
  99 MackieControlProtocol* MackieControlProtocol::_instance = 0;
 100
 101 bool MackieControlProtocol::probe()
 102 {
 103         return true;
 104 }
 105
 106 MackieControlProtocol::MackieControlProtocol (Session& session)
 107         : ControlProtocol (session, X_("Mackie"))
 108         , AbstractUI<MackieControlUIRequest> (name())
 109         , _current_initial_bank (0)
 110         , _frame_last (0)
 111         , _timecode_type (ARDOUR::AnyTime::BBT)
 112         , _gui (0)
 113         , _scrub_mode (false)
 114         , _flip_mode (Normal)
 115         , _view_mode (Mixer)
 116         , _subview_mode (None)
 117         , _pot_mode (Pan)
 118         , _current_selected_track (-1)
 119         , _modifier_state (0)
 120         , _ipmidi_base (MIDI::IPMIDIPort::lowest_ipmidi_port_default)
 121         , needs_ipmidi_restart (false)
 122         , _metering_active (true)
 123         , _initialized (false)
 124         , configuration_state (0)
 125         , state_version (0)
 126 {
 127         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
 128
 129         DeviceInfo::reload_device_info ();
 130         DeviceProfile::reload_device_profiles ();
 131
 132         for (int i = 0; i < 9; i++) {
 133                 _last_bank[i] = 0;
 134         }
 135
 136         _last_bank[Mixer] = _current_selected_track;
 137
 138         TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::gui_track_selection_changed, this, _1, true), this);
 139
 140         _instance = this;
 141
 142         build_button_map ();
 143 }
 144
 145 MackieControlProtocol::~MackieControlProtocol()
 146 {
 147         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol init\n");
 148
 149         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 150                 (*si)->reset ();
 151         }
 152
 153         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol drop_connections ()\n");
 154         drop_connections ();
 155
 156         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol tear_down_gui ()\n");
 157         tear_down_gui ();
 158
 159         delete configuration_state;
 160
 161         /* stop event loop */
 162         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol BaseUI::quit ()\n");
 163         BaseUI::quit ();
 164
 165         try {
 166                 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol close()\n");
 167                 close();
 168         }
 169         catch (exception & e) {
 170                 cout << "~MackieControlProtocol caught " << e.what() << endl;
 171         }
 172         catch (...) {
 173                 cout << "~MackieControlProtocol caught unknown" << endl;
 174         }
 175
 176         _instance = 0;
 177
 178         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol done\n");
 179 }
 180
 181 void
 182 MackieControlProtocol::thread_init ()
 183 {
 184         struct sched_param rtparam;
 185
 186         pthread_set_name (event_loop_name().c_str());
 187
 188         PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
 189         ARDOUR::SessionEvent::create_per_thread_pool (event_loop_name(), 128);
 190
 191         memset (&rtparam, 0, sizeof (rtparam));
 192         rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
 193
 194         if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
 195                 // do we care? not particularly.
 196         }
 197 }
 198
 199 void
 200 MackieControlProtocol::ping_devices ()
 201 {
 202         /* should not be called if surfaces are not connected, but will not
 203          * malfunction if it is.
 204          */
 205
 206         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 207                 (*si)->connected ();
 208         }
 209 }
 210
 211 // go to the previous track.
 212 // Assume that get_sorted_routes().size() > route_table.size()
 213 void
 214 MackieControlProtocol::prev_track()
 215 {
 216         if (_current_initial_bank >= 1) {
 217                 switch_banks (_current_initial_bank - 1);
 218         }
 219 }
 220
 221 // go to the next track.
 222 // Assume that get_sorted_routes().size() > route_table.size()
 223 void
 224 MackieControlProtocol::next_track()
 225 {
 226         Sorted sorted = get_sorted_routes();
 227         if (_current_initial_bank + n_strips() < sorted.size()) {
 228                 switch_banks (_current_initial_bank + 1);
 229         }
 230 }
 231
 232 bool
 233 MackieControlProtocol::route_is_locked_to_strip (boost::shared_ptr<Route> r) const
 234 {
 235         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 236                 if ((*si)->route_is_locked_to_strip (r)) {
 237                         return true;
 238                 }
 239         }
 240         return false;
 241 }
 242
 243 // predicate for sort call in get_sorted_routes
 244 struct RouteByRemoteId
 245 {
 246         bool operator () (const boost::shared_ptr<Route> & a, const boost::shared_ptr<Route> & b) const
 247         {
 248                 return a->remote_control_id() < b->remote_control_id();
 249         }
 250
 251         bool operator () (const Route & a, const Route & b) const
 252         {
 253                 return a.remote_control_id() < b.remote_control_id();
 254         }
 255
 256         bool operator () (const Route * a, const Route * b) const
 257         {
 258                 return a->remote_control_id() < b->remote_control_id();
 259         }
 260 };
 261
 262 MackieControlProtocol::Sorted
 263 MackieControlProtocol::get_sorted_routes()
 264 {
 265         Sorted sorted;
 266
 267         // fetch all routes
 268         boost::shared_ptr<RouteList> routes = session->get_routes();
 269         set<uint32_t> remote_ids;
 270
 271         // routes with remote_id 0 should never be added
 272         // TODO verify this with ardour devs
 273         // remote_ids.insert (0);
 274
 275         // sort in remote_id order, and exclude master, control and hidden routes
 276         // and any routes that are already set.
 277
 278         for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it) {
 279
 280                 boost::shared_ptr<Route> route = *it;
 281
 282                 if (remote_ids.find (route->remote_control_id()) != remote_ids.end()) {
 283                         continue;
 284                 }
 285
 286                 if (route->is_auditioner() || route->is_master() || route->is_monitor()) {
 287                         continue;
 288                 }
 289
 290                 /* don't include locked routes */
 291
 292                 if (route_is_locked_to_strip(route)) {
 293                         continue;
 294                 }
 295
 296                 switch (_view_mode) {
 297                 case Mixer:
 298                         if (! is_hidden(route)) {
 299                                 sorted.push_back (route);
 300                                 remote_ids.insert (route->remote_control_id());
 301                         }
 302                         break;
 303                 case AudioTracks:
 304                         if (is_audio_track(route) && !is_hidden(route)) {
 305                                 sorted.push_back (route);
 306                                 remote_ids.insert (route->remote_control_id());
 307                         }
 308                         break;
 309                 case Busses:
 310                         if (Profile->get_mixbus()) {
 311 #ifdef MIXBUS
 312                                 if (route->mixbus()) {
 313                                         sorted.push_back (route);
 314                                         remote_ids.insert (route->remote_control_id());
 315                                 }
 316 #endif
 317                         } else {
 318                                 if (!is_track(route) && !is_hidden(route)) {
 319                                         sorted.push_back (route);
 320                                         remote_ids.insert (route->remote_control_id());
 321                                 }
 322                         }
 323                         break;
 324                 case MidiTracks:
 325                         if (is_midi_track(route) && !is_hidden(route)) {
 326                                 sorted.push_back (route);
 327                                 remote_ids.insert (route->remote_control_id());
 328                         }
 329                         break;
 330                 case Plugins:
 331                         break;
 332                 case Auxes: // in ardour, for now aux and buss are same. for mixbus, see "Busses" case above
 333                         if (!is_track(route) && !is_hidden(route)) {
 334                                 sorted.push_back (route);
 335                                 remote_ids.insert (route->remote_control_id());
 336                         }
 337                         break;
 338                 case Hidden: // Show all the tracks we have hidden
 339                         if (is_hidden(route)) {
 340                                 // maybe separate groups
 341                                 sorted.push_back (route);
 342                                 remote_ids.insert (route->remote_control_id());
 343                         }
 344                         break;
 345                 case Selected: // For example: a group (this is USER)
 346                         if (selected(route) && !is_hidden(route)) {
 347                                 sorted.push_back (route);
 348                                 remote_ids.insert (route->remote_control_id());
 349                         }
 350                         break;
 351                 }
 352
 353         }
 354
 355         sort (sorted.begin(), sorted.end(), RouteByRemoteId());
 356         return sorted;
 357 }
 358
 359 void
 360 MackieControlProtocol::refresh_current_bank()
 361 {
 362         switch_banks (_current_initial_bank, true);
 363 }
 364
 365 uint32_t
 366 MackieControlProtocol::n_strips (bool with_locked_strips) const
 367 {
 368         uint32_t strip_count = 0;
 369
 370         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 371                 strip_count += (*si)->n_strips (with_locked_strips);
 372         }
 373
 374         return strip_count;
 375 }
 376
 377 void
 378 MackieControlProtocol::switch_banks (uint32_t initial, bool force)
 379 {
 380         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch banking to start at %1 force ? %2 current = %3\n", initial, force, _current_initial_bank));
 381
 382         if (initial == _current_initial_bank && !force) {
 383                 return;
 384         }
 385
 386         Sorted sorted = get_sorted_routes();
 387         uint32_t strip_cnt = n_strips (false); // do not include locked strips
 388                                                // in this count
 389
 390         if (sorted.size() <= strip_cnt && _current_initial_bank == 0 && !force) {
 391                 /* no banking - not enough routes to fill all strips and we're
 392                  * not at the first one.
 393                  */
 394                 return;
 395         }
 396         _current_initial_bank = initial;
 397         _current_selected_track = -1;
 398
 399         // Map current bank of routes onto each surface(+strip)
 400
 401         if (_current_initial_bank <= sorted.size()) {
 402
 403                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch to %1, %2, available routes %3 on %4 surfaces\n",
 404                                                                    _current_initial_bank, strip_cnt, sorted.size(),
 405                                                                    surfaces.size()));
 406
 407                 // link routes to strips
 408
 409                 Sorted::iterator r = sorted.begin() + _current_initial_bank;
 410
 411                 for (Surfaces::iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 412                         vector<boost::shared_ptr<Route> > routes;
 413                         uint32_t added = 0;
 414
 415                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has %1 unlockedstrips\n", (*si)->n_strips (false)));
 416
 417                         for (; r != sorted.end() && added < (*si)->n_strips (false); ++r, ++added) {
 418                                 routes.push_back (*r);
 419                         }
 420
 421                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("give surface %1 routes\n", routes.size()));
 422
 423                         (*si)->map_routes (routes);
 424                 }
 425         }
 426
 427         /* make sure selection is correct */
 428
 429         _gui_track_selection_changed (&_last_selected_routes, false, false);
 430
 431         /* current bank has not been saved */
 432         session->set_dirty();
 433 }
 434
 435 int
 436 MackieControlProtocol::set_active (bool yn)
 437 {
 438         DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active init with yn: '%1'\n", yn));
 439
 440         if (yn == active()) {
 441                 return 0;
 442         }
 443
 444         if (yn) {
 445
 446                 /* start event loop */
 447
 448                 BaseUI::run ();
 449
 450                 connect_session_signals ();
 451
 452                 if (!_device_info.name().empty()) {
 453                         set_device (_device_info.name(), true);
 454                 }
 455
 456                 /* set up periodic task for metering and automation
 457                  */
 458
 459                 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
 460                 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
 461                 periodic_timeout->attach (main_loop()->get_context());
 462
 463                 /* a faster periodic task used to display parameter updates */
 464
 465                 Glib::RefPtr<Glib::TimeoutSource> redisplay_timeout = Glib::TimeoutSource::create (10); // milliseconds
 466                 redisplay_connection = redisplay_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::redisplay));
 467                 redisplay_timeout->attach (main_loop()->get_context());
 468
 469         } else {
 470
 471                 BaseUI::quit ();
 472                 close ();
 473
 474         }
 475
 476         ControlProtocol::set_active (yn);
 477
 478         DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active done with yn: '%1'\n", yn));
 479
 480         return 0;
 481 }
 482
 483 bool
 484 MackieControlProtocol::hui_heartbeat ()
 485 {
 486         Glib::Threads::Mutex::Lock lm (surfaces_lock);
 487
 488         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 489                 (*s)->hui_heartbeat ();
 490         }
 491
 492         return true;
 493 }
 494
 495 bool
 496 MackieControlProtocol::periodic ()
 497 {
 498         if (!active()) {
 499                 return false;
 500         }
 501
 502         if (needs_ipmidi_restart) {
 503                 ipmidi_restart ();
 504                 return true;
 505         }
 506
 507         if (!_initialized) {
 508                 initialize();
 509         }
 510
 511         ARDOUR::microseconds_t now_usecs = ARDOUR::get_microseconds ();
 512
 513         {
 514                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 515
 516                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 517                         (*s)->periodic (now_usecs);
 518                 }
 519         }
 520
 521         update_timecode_display ();
 522
 523         return true;
 524 }
 525
 526 bool
 527 MackieControlProtocol::redisplay ()
 528 {
 529         if (!active()) {
 530                 return false;
 531         }
 532
 533         if (needs_ipmidi_restart) {
 534                 ipmidi_restart ();
 535                 return true;
 536         }
 537
 538         if (!_initialized) {
 539                 initialize();
 540         }
 541
 542         ARDOUR::microseconds_t now = ARDOUR::get_microseconds ();
 543
 544         {
 545                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 546
 547                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 548                         (*s)->redisplay (now);
 549                 }
 550         }
 551
 552         return true;
 553 }
 554
 555 void
 556 MackieControlProtocol::update_timecode_beats_led()
 557 {
 558         if (!_device_info.has_timecode_display()) {
 559                 return;
 560         }
 561
 562         DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::update_timecode_beats_led(): %1\n", _timecode_type));
 563         switch (_timecode_type) {
 564                 case ARDOUR::AnyTime::BBT:
 565                         update_global_led (Led::Beats, on);
 566                         update_global_led (Led::Timecode, off);
 567                         break;
 568                 case ARDOUR::AnyTime::Timecode:
 569                         update_global_led (Led::Timecode, on);
 570                         update_global_led (Led::Beats, off);
 571                         break;
 572                 default:
 573                         ostringstream os;
 574                         os << "Unknown Anytime::Type " << _timecode_type;
 575                         throw runtime_error (os.str());
 576         }
 577 }
 578
 579 void
 580 MackieControlProtocol::update_global_button (int id, LedState ls)
 581 {
 582         boost::shared_ptr<Surface> surface;
 583
 584         {
 585                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 586
 587                 if (surfaces.empty()) {
 588                         return;
 589                 }
 590
 591                 if (!_device_info.has_global_controls()) {
 592                         return;
 593                 }
 594                 // surface needs to be master surface
 595                 surface = _master_surface;
 596         }
 597
 598         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
 599         if (x != surface->controls_by_device_independent_id.end()) {
 600                 Button * button = dynamic_cast<Button*> (x->second);
 601                 surface->write (button->set_state (ls));
 602         } else {
 603                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", id));
 604         }
 605 }
 606
 607 void
 608 MackieControlProtocol::update_global_led (int id, LedState ls)
 609 {
 610         Glib::Threads::Mutex::Lock lm (surfaces_lock);
 611
 612         if (surfaces.empty()) {
 613                 return;
 614         }
 615
 616         if (!_device_info.has_global_controls()) {
 617                 return;
 618         }
 619         boost::shared_ptr<Surface> surface = _master_surface;
 620
 621         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
 622
 623         if (x != surface->controls_by_device_independent_id.end()) {
 624                 Led * led = dynamic_cast<Led*> (x->second);
 625                 DEBUG_TRACE (DEBUG::MackieControl, "Writing LedState\n");
 626                 surface->write (led->set_state (ls));
 627         } else {
 628                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", id));
 629         }
 630 }
 631
 632 void
 633 MackieControlProtocol::device_ready ()
 634 {
 635         /* this is not required to be called, but for devices which do
 636          * handshaking, it can be called once the device has verified the
 637          * connection.
 638          */
 639
 640         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("device ready init (active=%1)\n", active()));
 641         update_surfaces ();
 642         set_pot_mode (_pot_mode);
 643 }
 644
 645 // send messages to surface to set controls to correct values
 646 void
 647 MackieControlProtocol::update_surfaces()
 648 {
 649         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::update_surfaces() init (active=%1)\n", active()));
 650         if (!active()) {
 651                 return;
 652         }
 653
 654         // do the initial bank switch to connect signals
 655         // _current_initial_bank is initialised by set_state
 656         switch_banks (_current_initial_bank, true);
 657
 658         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::update_surfaces() finished\n");
 659 }
 660
 661 void
 662 MackieControlProtocol::initialize()
 663 {
 664         {
 665                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 666
 667                 if (surfaces.empty()) {
 668                         return;
 669                 }
 670
 671                 if (!_master_surface->active ()) {
 672                         return;
 673                 }
 674
 675                 // sometimes the jog wheel is a pot
 676                 if (_device_info.has_jog_wheel()) {
 677                         _master_surface->blank_jog_ring ();
 678                 }
 679         }
 680
 681         // update global buttons and displays
 682
 683         notify_record_state_changed();
 684         notify_transport_state_changed();
 685         update_timecode_beats_led();
 686
 687         _initialized = true;
 688 }
 689
 690 void
 691 MackieControlProtocol::connect_session_signals()
 692 {
 693         // receive routes added
 694         session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_route_added, this, _1), this);
 695         session->RouteAddedOrRemoved.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_route_added_or_removed, this), this);
 696         // receive record state toggled
 697         session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_record_state_changed, this), this);
 698         // receive transport state changed
 699         session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
 700         session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
 701         // receive punch-in and punch-out
 702         Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
 703         session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
 704         // receive rude solo changed
 705         session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), this);
 706
 707         // make sure remote id changed signals reach here
 708         // see also notify_route_added
 709         Sorted sorted = get_sorted_routes();
 710
 711         for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
 712                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
 713         }
 714 }
 715
 716 void
 717 MackieControlProtocol::set_profile (const string& profile_name)
 718 {
 719         map<string,DeviceProfile>::iterator d = DeviceProfile::device_profiles.find (profile_name);
 720
 721         if (d == DeviceProfile::device_profiles.end()) {
 722                 _device_profile = DeviceProfile (profile_name);
 723                 return;
 724         }
 725
 726         _device_profile = d->second;
 727 }
 728
 729 int
 730 MackieControlProtocol::set_device_info (const string& device_name)
 731 {
 732         map<string,DeviceInfo>::iterator d = DeviceInfo::device_info.find (device_name);
 733
 734         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("new device chosen %1\n", device_name));
 735
 736         if (d == DeviceInfo::device_info.end()) {
 737                 return -1;
 738         }
 739
 740         _device_info = d->second;
 741
 742         return 0;
 743 }
 744
 745 int
 746 MackieControlProtocol::set_device (const string& device_name, bool force)
 747 {
 748         if (device_name == device_info().name() && !force) {
 749                 /* already using that device, nothing to do */
 750                 return 0;
 751         }
 752         /* get state from the current setup, and make sure it is stored in
 753            the configuration_states node so that if we switch back to this device,
 754            we will have its state available.
 755         */
 756
 757         {
 758                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 759                 if (!surfaces.empty()) {
 760                         update_configuration_state ();
 761                 }
 762         }
 763
 764         if (set_device_info (device_name)) {
 765                 return -1;
 766         }
 767
 768         clear_surfaces ();
 769         port_connection.disconnect ();
 770         hui_connection.disconnect ();
 771
 772         if (_device_info.device_type() == DeviceInfo::HUI) {
 773                 Glib::RefPtr<Glib::TimeoutSource> hui_timeout = Glib::TimeoutSource::create (1000); // milliseconds
 774                 hui_connection = hui_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::hui_heartbeat));
 775                 hui_timeout->attach (main_loop()->get_context());
 776         }
 777
 778         if (!_device_info.uses_ipmidi()) {
 779                 /* notice that the handler for this will execute in our event
 780                    loop, not in the thread where the
 781                    PortConnectedOrDisconnected signal is emitted.
 782                 */
 783                 ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::connection_handler, this, _1, _2, _3, _4, _5), this);
 784         }
 785
 786         if (create_surfaces ()) {
 787                 return -1;
 788         }
 789
 790         DeviceChanged ();
 791
 792         return 0;
 793 }
 794
 795 gboolean
 796 ArdourSurface::ipmidi_input_handler (GIOChannel*, GIOCondition condition, void *data)
 797 {
 798         ArdourSurface::MackieControlProtocol::ipMIDIHandler* ipm = static_cast<ArdourSurface::MackieControlProtocol::ipMIDIHandler*>(data);
 799         return ipm->mcp->midi_input_handler (Glib::IOCondition (condition), ipm->port);
 800 }
 801
 802 int
 803 MackieControlProtocol::create_surfaces ()
 804 {
 805         string device_name;
 806         surface_type_t stype = mcu; // type not yet determined
 807
 808         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Create %1 surfaces for %2\n", 1 + _device_info.extenders(), _device_info.name()));
 809
 810         if (!_device_info.uses_ipmidi()) {
 811                 _input_bundle.reset (new ARDOUR::Bundle (_("Mackie Control In"), true));
 812                 _output_bundle.reset (new ARDOUR::Bundle (_("Mackie Control Out"), false));
 813         } else {
 814                 _input_bundle.reset ();
 815                 _output_bundle.reset ();
 816
 817         }
 818         for (uint32_t n = 0; n < 1 + _device_info.extenders(); ++n) {
 819                 bool is_master = false;
 820
 821                 if (n == _device_info.master_position()) {
 822                         is_master = true;
 823                         if (_device_info.extenders() == 0) {
 824                                 device_name = _device_info.name();
 825                         } else {
 826                                 device_name = X_("mackie control");
 827                         }
 828
 829                 }
 830
 831                 if (!is_master) {
 832                         device_name = string_compose (X_("mackie control ext %1"), n+1);
 833                 }
 834
 835                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Port Name for surface %1 is %2\n", n, device_name));
 836
 837                 boost::shared_ptr<Surface> surface;
 838
 839                 if (is_master) {
 840                         stype = mcu;
 841                 } else {
 842                         stype = ext;
 843                 }
 844                 try {
 845                         surface.reset (new Surface (*this, device_name, n, stype));
 846                 } catch (...) {
 847                         return -1;
 848                 }
 849
 850                 if (is_master) {
 851                         _master_surface = surface;
 852                 }
 853
 854                 if (configuration_state) {
 855                         XMLNode* this_device = 0;
 856                         XMLNodeList const& devices = configuration_state->children();
 857                         for (XMLNodeList::const_iterator d = devices.begin(); d != devices.end(); ++d) {
 858                                 XMLProperty* prop = (*d)->property (X_("name"));
 859                                 if (prop && prop->value() == _device_info.name()) {
 860                                         this_device = *d;
 861                                         break;
 862                                 }
 863                         }
 864                         if (this_device) {
 865                                 XMLNode* snode = this_device->child (X_("Surfaces"));
 866                                 if (snode) {
 867                                         surface->set_state (*snode, state_version);
 868                                 }
 869                         }
 870                 }
 871
 872                 {
 873                         Glib::Threads::Mutex::Lock lm (surfaces_lock);
 874                         surfaces.push_back (surface);
 875                 }
 876
 877                 if (!_device_info.uses_ipmidi()) {
 878
 879                         _input_bundle->add_channel (
 880                                 surface->port().input_port().name(),
 881                                 ARDOUR::DataType::MIDI,
 882                                 session->engine().make_port_name_non_relative (surface->port().input_port().name())
 883                                 );
 884
 885                         _output_bundle->add_channel (
 886                                 surface->port().output_port().name(),
 887                                 ARDOUR::DataType::MIDI,
 888                                 session->engine().make_port_name_non_relative (surface->port().output_port().name())
 889                                 );
 890                 }
 891
 892                 MIDI::Port& input_port (surface->port().input_port());
 893                 AsyncMIDIPort* asp = dynamic_cast<AsyncMIDIPort*> (&input_port);
 894
 895                 if (asp) {
 896
 897                         /* async MIDI port */
 898
 899                         asp->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &MackieControlProtocol::midi_input_handler), &input_port));
 900                         asp->xthread().attach (main_loop()->get_context());
 901
 902                 } else {
 903
 904                         /* ipMIDI port, no IOSource method at this time */
 905
 906                         int fd;
 907
 908                         if ((fd = input_port.selectable ()) >= 0) {
 909
 910                                 GIOChannel* ioc = g_io_channel_unix_new (fd);
 911                                 surface->input_source = g_io_create_watch (ioc, GIOCondition (G_IO_IN|G_IO_HUP|G_IO_ERR));
 912
 913                                 /* make surface's input source now hold the
 914                                  * only reference on the IO channel
 915                                  */
 916                                 g_io_channel_unref (ioc);
 917
 918                                 /* hack up an object so that in the callback from the event loop
 919                                    we have both the MackieControlProtocol and the input port.
 920
 921                                    If we were using C++ for this stuff we wouldn't need this
 922                                    but a nasty, not-fixable bug in the binding between C
 923                                    and C++ makes it necessary to avoid C++ for the IO
 924                                    callback setup.
 925                                 */
 926
 927                                 ipMIDIHandler* ipm = new ipMIDIHandler (); /* we will leak this sizeof(pointer)*2 sized object */
 928                                 ipm->mcp = this;
 929                                 ipm->port = &input_port;
 930
 931                                 g_source_set_callback (surface->input_source, (GSourceFunc) ipmidi_input_handler, ipm, NULL);
 932                                 g_source_attach (surface->input_source, main_loop()->get_context()->gobj());
 933                         }
 934                 }
 935         }
 936
 937         if (!_device_info.uses_ipmidi()) {
 938                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 939                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 940                         (*s)->port().reconnect ();
 941                 }
 942         }
 943
 944         session->BundleAddedOrRemoved ();
 945
 946         assert (_master_surface);
 947
 948         return 0;
 949 }
 950
 951 void
 952 MackieControlProtocol::close()
 953 {
 954         port_connection.disconnect ();
 955         session_connections.drop_connections ();
 956         route_connections.drop_connections ();
 957         periodic_connection.disconnect ();
 958
 959         clear_surfaces();
 960 }
 961
 962 /** Ensure that the configuration_state XML node contains an up-to-date
 963  *  copy of the state node the current device. If configuration_state already
 964  *  contains a state node for the device, it will deleted and replaced.
 965  */
 966 void
 967 MackieControlProtocol::update_configuration_state ()
 968 {
 969         /* CALLER MUST HOLD SURFACES LOCK */
 970
 971         if (!configuration_state) {
 972                 configuration_state = new XMLNode (X_("Configurations"));
 973         }
 974
 975         XMLNode* devnode = new XMLNode (X_("Configuration"));
 976         devnode->add_property (X_("name"), _device_info.name());
 977
 978         configuration_state->remove_nodes_and_delete (X_("name"), _device_info.name());
 979         configuration_state->add_child_nocopy (*devnode);
 980
 981         XMLNode* snode = new XMLNode (X_("Surfaces"));
 982
 983         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 984                 snode->add_child_nocopy ((*s)->get_state());
 985         }
 986
 987         devnode->add_child_nocopy (*snode);
 988 }
 989
 990 XMLNode&
 991 MackieControlProtocol::get_state()
 992 {
 993         XMLNode& node (ControlProtocol::get_state());
 994
 995         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state init\n");
 996         char buf[16];
 997
 998         // add current bank
 999         snprintf (buf, sizeof (buf), "%d", _current_initial_bank);
1000         node.add_property (X_("bank"), buf);
1001
1002         // ipMIDI base port (possibly not used)
1003         snprintf (buf, sizeof (buf), "%d", _ipmidi_base);
1004         node.add_property (X_("ipmidi-base"), buf);
1005
1006         node.add_property (X_("device-profile"), _device_profile.name());
1007         node.add_property (X_("device-name"), _device_info.name());
1008
1009         {
1010                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1011                 update_configuration_state ();
1012         }
1013
1014         /* force a copy of the _surfaces_state node, because we want to retain ownership */
1015         node.add_child_copy (*configuration_state);
1016
1017         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state done\n");
1018
1019         return node;
1020 }
1021
1022 int
1023 MackieControlProtocol::set_state (const XMLNode & node, int version)
1024 {
1025         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", active()));
1026
1027         int retval = 0;
1028         const XMLProperty* prop;
1029         uint32_t bank = 0;
1030
1031         if (ControlProtocol::set_state (node, version)) {
1032                 return -1;
1033         }
1034
1035         if ((prop = node.property (X_("ipmidi-base"))) != 0) {
1036                 set_ipmidi_base (atoi (prop->value()));
1037         }
1038
1039         // fetch current bank
1040         if ((prop = node.property (X_("bank"))) != 0) {
1041                 bank = atoi (prop->value());
1042         }
1043
1044         if ((prop = node.property (X_("device-name"))) != 0) {
1045                 set_device_info (prop->value());
1046         }
1047
1048         if ((prop = node.property (X_("device-profile"))) != 0) {
1049                 if (prop->value().empty()) {
1050                         string default_profile_name;
1051
1052                         default_profile_name = Glib::get_user_name();
1053                         default_profile_name += ' ';
1054                         default_profile_name += _device_info.name();
1055
1056                         set_profile (default_profile_name);
1057                 } else {
1058                         set_profile (prop->value());
1059                 }
1060         }
1061
1062         XMLNode* dnode = node.child (X_("Configurations"));
1063
1064         delete configuration_state;
1065         configuration_state = 0;
1066
1067         if (dnode) {
1068                 configuration_state = new XMLNode (*dnode);
1069                 state_version = version;
1070         }
1071
1072         switch_banks (bank, true);
1073
1074         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::set_state done\n");
1075
1076         return retval;
1077 }
1078
1079 string
1080 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
1081 {
1082         Timecode::BBT_Time bbt_time;
1083
1084         session->bbt_time (now_frame, bbt_time);
1085
1086         // The Mackie protocol spec is built around a BBT time display of
1087         //
1088         // digits:     888/88/88/888
1089         // semantics:  BBB/bb/ss/ttt
1090         //
1091         // The third field is "subdivisions" which is a concept found in Logic
1092         // but not present in Ardour. Instead Ardour displays a 4 digit tick
1093         // count, which we need to spread across the 5 digits of ss/ttt.
1094
1095         ostringstream os;
1096
1097         os << setw(3) << setfill('0') << bbt_time.bars;
1098         os << setw(2) << setfill('0') << bbt_time.beats;
1099         os << ' ';
1100         os << setw(1) << setfill('0') << bbt_time.ticks / 1000;
1101         os << setw(3) << setfill('0') << bbt_time.ticks % 1000;
1102
1103         return os.str();
1104 }
1105
1106 string
1107 MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
1108 {
1109         Timecode::Time timecode;
1110         session->timecode_time (now_frame, timecode);
1111
1112         // According to the Logic docs
1113         // digits: 888/88/88/888
1114         // Timecode mode: Hours/Minutes/Seconds/Frames
1115         ostringstream os;
1116         os << setw(2) << setfill('0') << timecode.hours;
1117         os << ' ';
1118         os << setw(2) << setfill('0') << timecode.minutes;
1119         os << setw(2) << setfill('0') << timecode.seconds;
1120         os << ' ';
1121         os << setw(2) << setfill('0') << timecode.frames;
1122
1123         return os.str();
1124 }
1125
1126 void
1127 MackieControlProtocol::update_timecode_display()
1128 {
1129         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1130
1131         if (surfaces.empty()) {
1132                 return;
1133         }
1134
1135         boost::shared_ptr<Surface> surface = _master_surface;
1136
1137         if (surface->type() != mcu || !_device_info.has_timecode_display() || !surface->active ()) {
1138                 return;
1139         }
1140
1141         // do assignment here so current_frame is fixed
1142         framepos_t current_frame = session->transport_frame();
1143         string timecode;
1144         // For large jumps in play head possition do full reset
1145         int moved = (current_frame - _frame_last) / session->frame_rate ();
1146         if (moved) {
1147                 DEBUG_TRACE (DEBUG::MackieControl, "Timecode reset\n");
1148                 _timecode_last = string (10, ' ');
1149         }
1150         _frame_last = current_frame;
1151
1152         switch (_timecode_type) {
1153         case ARDOUR::AnyTime::BBT:
1154                 timecode = format_bbt_timecode (current_frame);
1155                 break;
1156         case ARDOUR::AnyTime::Timecode:
1157                 timecode = format_timecode_timecode (current_frame);
1158                 break;
1159         default:
1160                 return;
1161         }
1162
1163         // only write the timecode string to the MCU if it's changed
1164         // since last time. This is to reduce midi bandwidth used.
1165         if (timecode != _timecode_last) {
1166                 surface->display_timecode (timecode, _timecode_last);
1167                 _timecode_last = timecode;
1168         }
1169 }
1170
1171 ///////////////////////////////////////////
1172 // Session signals
1173 ///////////////////////////////////////////
1174
1175 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
1176 {
1177         if (p == "punch-in") {
1178                 // no such button right now
1179                 // update_global_button (Button::PunchIn, session->config.get_punch_in());
1180         } else if (p == "punch-out") {
1181                 // no such button right now
1182                 // update_global_button (Button::PunchOut, session->config.get_punch_out());
1183         } else if (p == "clicking") {
1184                 update_global_button (Button::Click, Config->get_clicking());
1185         } else {
1186                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
1187         }
1188 }
1189
1190 void
1191 MackieControlProtocol::notify_route_added_or_removed ()
1192 {
1193         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1194         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1195                 (*s)->master_monitor_may_have_changed ();
1196         }
1197 }
1198
1199 // RouteList is the set of routes that have just been added
1200 void
1201 MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
1202 {
1203         {
1204                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1205
1206                 if (surfaces.empty()) {
1207                         return;
1208                 }
1209         }
1210
1211         /* special case: single route, and it is the monitor or master out */
1212
1213         if (rl.size() == 1 && (rl.front()->is_monitor() || rl.front()->is_master())) {
1214                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1215                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1216                         (*s)->master_monitor_may_have_changed ();
1217                 }
1218         }
1219
1220         // currently assigned banks are less than the full set of
1221         // strips, so activate the new strip now.
1222
1223         refresh_current_bank();
1224
1225         // otherwise route added, but current bank needs no updating
1226
1227         // make sure remote id changes in the new route are handled
1228         typedef ARDOUR::RouteList ARS;
1229
1230         for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
1231                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
1232         }
1233 }
1234
1235 void
1236 MackieControlProtocol::notify_solo_active_changed (bool active)
1237 {
1238         boost::shared_ptr<Surface> surface;
1239
1240         {
1241                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1242
1243                 if (surfaces.empty()) {
1244                         return;
1245                 }
1246
1247                 surface = _master_surface;
1248         }
1249
1250         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Led::RudeSolo);
1251         if (x != surface->controls_by_device_independent_id.end()) {
1252                 Led* rude_solo = dynamic_cast<Led*> (x->second);
1253                 if (rude_solo) {
1254                         surface->write (rude_solo->set_state (active ? flashing : off));
1255                 }
1256         }
1257 }
1258
1259 void
1260 MackieControlProtocol::notify_remote_id_changed()
1261 {
1262         {
1263                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1264
1265                 if (surfaces.empty()) {
1266                         return;
1267                 }
1268         }
1269
1270         Sorted sorted = get_sorted_routes();
1271         uint32_t sz = n_strips();
1272
1273         // if a remote id has been moved off the end, we need to shift
1274         // the current bank backwards.
1275
1276         if (sorted.size() - _current_initial_bank < sz) {
1277                 // but don't shift backwards past the zeroth channel
1278                 if (sorted.size() < sz) {  // avoid unsigned math mistake below
1279                         switch_banks(0, true);
1280                 } else {
1281                         switch_banks (max((Sorted::size_type) 0, sorted.size() - sz), true);
1282                 }
1283         } else {
1284                 // Otherwise just refresh the current bank
1285                 refresh_current_bank();
1286         }
1287 }
1288
1289 ///////////////////////////////////////////
1290 // Transport signals
1291 ///////////////////////////////////////////
1292
1293 void
1294 MackieControlProtocol::notify_loop_state_changed()
1295 {
1296         update_global_button (Button::Loop, session->get_play_loop());
1297 }
1298
1299 void
1300 MackieControlProtocol::notify_transport_state_changed()
1301 {
1302         if (!_device_info.has_global_controls()) {
1303                 return;
1304         }
1305
1306         // switch various play and stop buttons on / off
1307         update_global_button (Button::Loop, session->get_play_loop());
1308         update_global_button (Button::Play, session->transport_speed() == 1.0);
1309         update_global_button (Button::Stop, session->transport_stopped ());
1310         update_global_button (Button::Rewind, session->transport_speed() < 0.0);
1311         update_global_button (Button::Ffwd, session->transport_speed() > 1.0);
1312
1313         // sometimes a return to start leaves time code at old time
1314         _timecode_last = string (10, ' ');
1315
1316         notify_metering_state_changed ();
1317 }
1318
1319 void
1320 MackieControlProtocol::notify_metering_state_changed()
1321 {
1322         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1323
1324         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1325                 (*s)->notify_metering_state_changed ();
1326         }
1327 }
1328
1329 void
1330 MackieControlProtocol::notify_record_state_changed ()
1331 {
1332         if (!_device_info.has_global_controls()) {
1333                 return;
1334         }
1335
1336         boost::shared_ptr<Surface> surface;
1337
1338         {
1339                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1340                 if (surfaces.empty()) {
1341                         return;
1342                 }
1343                 surface = _master_surface;
1344         }
1345
1346         /* rec is a tristate */
1347
1348         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Button::Record);
1349         if (x != surface->controls_by_device_independent_id.end()) {
1350                 Button * rec = dynamic_cast<Button*> (x->second);
1351                 if (rec) {
1352                         LedState ls;
1353
1354                         switch (session->record_status()) {
1355                         case Session::Disabled:
1356                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to disabled, LED off\n");
1357                                 ls = off;
1358                                 break;
1359                         case Session::Recording:
1360                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to recording, LED on\n");
1361                                 ls = on;
1362                                 break;
1363                         case Session::Enabled:
1364                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to enabled, LED flashing\n");
1365                                 ls = flashing;
1366                                 break;
1367                         }
1368
1369                         surface->write (rec->set_state (ls));
1370                 }
1371         }
1372 }
1373
1374 list<boost::shared_ptr<ARDOUR::Bundle> >
1375 MackieControlProtocol::bundles ()
1376 {
1377         list<boost::shared_ptr<ARDOUR::Bundle> > b;
1378
1379         if (_input_bundle) {
1380                 b.push_back (_input_bundle);
1381                 b.push_back (_output_bundle);
1382         }
1383
1384         return b;
1385 }
1386
1387 void
1388 MackieControlProtocol::do_request (MackieControlUIRequest* req)
1389 {
1390         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("doing request type %1\n", req->type));
1391         if (req->type == CallSlot) {
1392
1393                 call_slot (MISSING_INVALIDATOR, req->the_slot);
1394
1395         } else if (req->type == Quit) {
1396
1397                 stop ();
1398         }
1399 }
1400
1401 int
1402 MackieControlProtocol::stop ()
1403 {
1404         BaseUI::quit ();
1405
1406         return 0;
1407 }
1408
1409 void
1410 MackieControlProtocol::update_led (Surface& surface, Button& button, Mackie::LedState ls)
1411 {
1412         if (ls != none) {
1413                 surface.port().write (button.set_state (ls));
1414         }
1415 }
1416
1417 void
1418 MackieControlProtocol::build_button_map ()
1419 {
1420         /* this maps our device-independent button codes to the methods that handle them.
1421          */
1422
1423 #define DEFINE_BUTTON_HANDLER(b,p,r) button_map.insert (pair<Button::ID,ButtonHandlers> ((b), ButtonHandlers ((p),(r))));
1424
1425         DEFINE_BUTTON_HANDLER (Button::Track, &MackieControlProtocol::track_press, &MackieControlProtocol::track_release);
1426         DEFINE_BUTTON_HANDLER (Button::Send, &MackieControlProtocol::send_press, &MackieControlProtocol::send_release);
1427         DEFINE_BUTTON_HANDLER (Button::Pan, &MackieControlProtocol::pan_press, &MackieControlProtocol::pan_release);
1428         DEFINE_BUTTON_HANDLER (Button::Plugin, &MackieControlProtocol::plugin_press, &MackieControlProtocol::plugin_release);
1429         DEFINE_BUTTON_HANDLER (Button::Eq, &MackieControlProtocol::eq_press, &MackieControlProtocol::eq_release);
1430         DEFINE_BUTTON_HANDLER (Button::Dyn, &MackieControlProtocol::dyn_press, &MackieControlProtocol::dyn_release);
1431         DEFINE_BUTTON_HANDLER (Button::Left, &MackieControlProtocol::left_press, &MackieControlProtocol::left_release);
1432         DEFINE_BUTTON_HANDLER (Button::Right, &MackieControlProtocol::right_press, &MackieControlProtocol::right_release);
1433         DEFINE_BUTTON_HANDLER (Button::ChannelLeft, &MackieControlProtocol::channel_left_press, &MackieControlProtocol::channel_left_release);
1434         DEFINE_BUTTON_HANDLER (Button::ChannelRight, &MackieControlProtocol::channel_right_press, &MackieControlProtocol::channel_right_release);
1435         DEFINE_BUTTON_HANDLER (Button::Flip, &MackieControlProtocol::flip_press, &MackieControlProtocol::flip_release);
1436         DEFINE_BUTTON_HANDLER (Button::View, &MackieControlProtocol::view_press, &MackieControlProtocol::view_release);
1437         DEFINE_BUTTON_HANDLER (Button::NameValue, &MackieControlProtocol::name_value_press, &MackieControlProtocol::name_value_release);
1438         DEFINE_BUTTON_HANDLER (Button::TimecodeBeats, &MackieControlProtocol::timecode_beats_press, &MackieControlProtocol::timecode_beats_release);
1439         DEFINE_BUTTON_HANDLER (Button::F1, &MackieControlProtocol::F1_press, &MackieControlProtocol::F1_release);
1440         DEFINE_BUTTON_HANDLER (Button::F2, &MackieControlProtocol::F2_press, &MackieControlProtocol::F2_release);
1441         DEFINE_BUTTON_HANDLER (Button::F3, &MackieControlProtocol::F3_press, &MackieControlProtocol::F3_release);
1442         DEFINE_BUTTON_HANDLER (Button::F4, &MackieControlProtocol::F4_press, &MackieControlProtocol::F4_release);
1443         DEFINE_BUTTON_HANDLER (Button::F5, &MackieControlProtocol::F5_press, &MackieControlProtocol::F5_release);
1444         DEFINE_BUTTON_HANDLER (Button::F6, &MackieControlProtocol::F6_press, &MackieControlProtocol::F6_release);
1445         DEFINE_BUTTON_HANDLER (Button::F7, &MackieControlProtocol::F7_press, &MackieControlProtocol::F7_release);
1446         DEFINE_BUTTON_HANDLER (Button::F8, &MackieControlProtocol::F8_press, &MackieControlProtocol::F8_release);
1447         DEFINE_BUTTON_HANDLER (Button::MidiTracks, &MackieControlProtocol::miditracks_press, &MackieControlProtocol::miditracks_release);
1448         DEFINE_BUTTON_HANDLER (Button::Inputs, &MackieControlProtocol::inputs_press, &MackieControlProtocol::inputs_release);
1449         DEFINE_BUTTON_HANDLER (Button::AudioTracks, &MackieControlProtocol::audiotracks_press, &MackieControlProtocol::audiotracks_release);
1450         DEFINE_BUTTON_HANDLER (Button::AudioInstruments, &MackieControlProtocol::audioinstruments_press, &MackieControlProtocol::audioinstruments_release);
1451         DEFINE_BUTTON_HANDLER (Button::Aux, &MackieControlProtocol::aux_press, &MackieControlProtocol::aux_release);
1452         DEFINE_BUTTON_HANDLER (Button::Busses, &MackieControlProtocol::busses_press, &MackieControlProtocol::busses_release);
1453         DEFINE_BUTTON_HANDLER (Button::Outputs, &MackieControlProtocol::outputs_press, &MackieControlProtocol::outputs_release);
1454         DEFINE_BUTTON_HANDLER (Button::User, &MackieControlProtocol::user_press, &MackieControlProtocol::user_release);
1455         DEFINE_BUTTON_HANDLER (Button::Shift, &MackieControlProtocol::shift_press, &MackieControlProtocol::shift_release);
1456         DEFINE_BUTTON_HANDLER (Button::Option, &MackieControlProtocol::option_press, &MackieControlProtocol::option_release);
1457         DEFINE_BUTTON_HANDLER (Button::Ctrl, &MackieControlProtocol::control_press, &MackieControlProtocol::control_release);
1458         DEFINE_BUTTON_HANDLER (Button::CmdAlt, &MackieControlProtocol::cmd_alt_press, &MackieControlProtocol::cmd_alt_release);
1459         DEFINE_BUTTON_HANDLER (Button::Read, &MackieControlProtocol::read_press, &MackieControlProtocol::read_release);
1460         DEFINE_BUTTON_HANDLER (Button::Write, &MackieControlProtocol::write_press, &MackieControlProtocol::write_release);
1461         DEFINE_BUTTON_HANDLER (Button::Trim, &MackieControlProtocol::trim_press, &MackieControlProtocol::trim_release);
1462         DEFINE_BUTTON_HANDLER (Button::Touch, &MackieControlProtocol::touch_press, &MackieControlProtocol::touch_release);
1463         DEFINE_BUTTON_HANDLER (Button::Latch, &MackieControlProtocol::latch_press, &MackieControlProtocol::latch_release);
1464         DEFINE_BUTTON_HANDLER (Button::Grp, &MackieControlProtocol::grp_press, &MackieControlProtocol::grp_release);
1465         DEFINE_BUTTON_HANDLER (Button::Save, &MackieControlProtocol::save_press, &MackieControlProtocol::save_release);
1466         DEFINE_BUTTON_HANDLER (Button::Undo, &MackieControlProtocol::undo_press, &MackieControlProtocol::undo_release);
1467         DEFINE_BUTTON_HANDLER (Button::Cancel, &MackieControlProtocol::cancel_press, &MackieControlProtocol::cancel_release);
1468         DEFINE_BUTTON_HANDLER (Button::Enter, &MackieControlProtocol::enter_press, &MackieControlProtocol::enter_release);
1469         DEFINE_BUTTON_HANDLER (Button::Marker, &MackieControlProtocol::marker_press, &MackieControlProtocol::marker_release);
1470         DEFINE_BUTTON_HANDLER (Button::Nudge, &MackieControlProtocol::nudge_press, &MackieControlProtocol::nudge_release);
1471         DEFINE_BUTTON_HANDLER (Button::Loop, &MackieControlProtocol::loop_press, &MackieControlProtocol::loop_release);
1472         DEFINE_BUTTON_HANDLER (Button::Drop, &MackieControlProtocol::drop_press, &MackieControlProtocol::drop_release);
1473         DEFINE_BUTTON_HANDLER (Button::Replace, &MackieControlProtocol::replace_press, &MackieControlProtocol::replace_release);
1474         DEFINE_BUTTON_HANDLER (Button::Click, &MackieControlProtocol::click_press, &MackieControlProtocol::click_release);
1475         DEFINE_BUTTON_HANDLER (Button::ClearSolo, &MackieControlProtocol::clearsolo_press, &MackieControlProtocol::clearsolo_release);
1476         DEFINE_BUTTON_HANDLER (Button::Rewind, &MackieControlProtocol::rewind_press, &MackieControlProtocol::rewind_release);
1477         DEFINE_BUTTON_HANDLER (Button::Ffwd, &MackieControlProtocol::ffwd_press, &MackieControlProtocol::ffwd_release);
1478         DEFINE_BUTTON_HANDLER (Button::Stop, &MackieControlProtocol::stop_press, &MackieControlProtocol::stop_release);
1479         DEFINE_BUTTON_HANDLER (Button::Play, &MackieControlProtocol::play_press, &MackieControlProtocol::play_release);
1480         DEFINE_BUTTON_HANDLER (Button::Record, &MackieControlProtocol::record_press, &MackieControlProtocol::record_release);
1481         DEFINE_BUTTON_HANDLER (Button::CursorUp, &MackieControlProtocol::cursor_up_press, &MackieControlProtocol::cursor_up_release);
1482         DEFINE_BUTTON_HANDLER (Button::CursorDown, &MackieControlProtocol::cursor_down_press, &MackieControlProtocol::cursor_down_release);
1483         DEFINE_BUTTON_HANDLER (Button::CursorLeft, &MackieControlProtocol::cursor_left_press, &MackieControlProtocol::cursor_left_release);
1484         DEFINE_BUTTON_HANDLER (Button::CursorRight, &MackieControlProtocol::cursor_right_press, &MackieControlProtocol::cursor_right_release);
1485         DEFINE_BUTTON_HANDLER (Button::Zoom, &MackieControlProtocol::zoom_press, &MackieControlProtocol::zoom_release);
1486         DEFINE_BUTTON_HANDLER (Button::Scrub, &MackieControlProtocol::scrub_press, &MackieControlProtocol::scrub_release);
1487         DEFINE_BUTTON_HANDLER (Button::UserA, &MackieControlProtocol::user_a_press, &MackieControlProtocol::user_a_release);
1488         DEFINE_BUTTON_HANDLER (Button::UserB, &MackieControlProtocol::user_b_press, &MackieControlProtocol::user_b_release);
1489         DEFINE_BUTTON_HANDLER (Button::MasterFaderTouch, &MackieControlProtocol::master_fader_touch_press, &MackieControlProtocol::master_fader_touch_release);
1490 }
1491
1492 void
1493 MackieControlProtocol::handle_button_event (Surface& surface, Button& button, ButtonState bs)
1494 {
1495         Button::ID button_id = button.bid();
1496
1497         if  (bs != press && bs != release) {
1498                 update_led (surface, button, none);
1499                 return;
1500         }
1501
1502         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2 (%3)\n", (bs == press ? "press" : "release"), button.id(),
1503                                                            Button::id_to_name (button.bid())));
1504
1505         /* check profile first */
1506
1507         string action = _device_profile.get_button_action (button.bid(), _modifier_state);
1508
1509         if (!action.empty()) {
1510
1511                 if (action.find ('/') != string::npos) { /* good chance that this is really an action */
1512
1513                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Looked up action for button %1 with modifier %2, got [%3]\n",
1514                                                                            button.bid(), _modifier_state, action));
1515
1516                         /* if there is a bound action for this button, and this is a press event,
1517                            carry out the action. If its a release event, do nothing since we
1518                            don't bind to them at all but don't want any other handling to
1519                            occur either.
1520                         */
1521                         if (bs == press) {
1522                                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("executing action %1\n", action));
1523                                 access_action (action);
1524                         }
1525
1526                         return;
1527
1528                 } else {
1529
1530                         /* "action" is more likely to be a button name. We use this to
1531                          * allow remapping buttons to different (builtin) functionality
1532                          * associated with an existing button. This is similar to the
1533                          * way that (for example) Nuendo moves the "Shift" function to
1534                          * the "Enter" key of the MCU Pro.
1535                          */
1536
1537                         int bid = Button::name_to_id (action);
1538
1539                         if (bid < 0) {
1540                                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("apparent button name %1 not found\n", action));
1541                                 return;
1542                         }
1543
1544                         button_id = (Button::ID) bid;
1545                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handling button %1 as if it was %2 (%3)\n", Button::id_to_name (button.bid()), button_id, Button::id_to_name (button_id)));
1546                 }
1547         }
1548
1549         /* lookup using the device-INDEPENDENT button ID */
1550
1551         ButtonMap::iterator b = button_map.find (button_id);
1552
1553         if (b != button_map.end()) {
1554
1555                 ButtonHandlers& bh (b->second);
1556
1557                 switch  (bs) {
1558                 case press:
1559                         surface.write (button.set_state ((this->*(bh.press)) (button)));
1560                         break;
1561                 case release:
1562                         surface.write (button.set_state ((this->*(bh.release)) (button)));
1563                         break;
1564                 default:
1565                         break;
1566                 }
1567         } else {
1568                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1569                                                                    button.bid(), button.id()));
1570                 error << string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1571                                          button.bid(), button.id()) << endmsg;
1572         }
1573 }
1574
1575 bool
1576 MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
1577 {
1578         if (ioc & ~IO_IN) {
1579                 DEBUG_TRACE (DEBUG::MackieControl, "MIDI port closed\n");
1580                 return false;
1581         }
1582
1583         if (ioc & IO_IN) {
1584
1585                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("something happend on  %1\n", port->name()));
1586
1587                 /* Devices using regular JACK MIDI ports will need to have
1588                    the x-thread FIFO drained to avoid burning endless CPU.
1589
1590                    Devices using ipMIDI have port->selectable() as the same
1591                    file descriptor that data arrives on, so doing this
1592                    for them will simply throw all incoming data away.
1593                 */
1594
1595                 if (!_device_info.uses_ipmidi()) {
1596                         AsyncMIDIPort* asp = dynamic_cast<AsyncMIDIPort*>(port);
1597                         if (asp) {
1598                                 asp->clear ();
1599                         }
1600                 }
1601
1602                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("data available on %1\n", port->name()));
1603                 framepos_t now = session->engine().sample_time();
1604                 port->parse (now);
1605         }
1606
1607         return true;
1608 }
1609
1610 void
1611 MackieControlProtocol::clear_ports ()
1612 {
1613         if (_input_bundle) {
1614                 _input_bundle->remove_channels ();
1615                 _output_bundle->remove_channels ();
1616         }
1617 }
1618
1619 void
1620 MackieControlProtocol::notify_subview_route_deleted ()
1621 {
1622         /* return to global/mixer view */
1623         _subview_route.reset ();
1624         set_view_mode (Mixer);
1625 }
1626
1627 void
1628 MackieControlProtocol::set_subview_mode (SubViewMode sm, boost::shared_ptr<Route> r)
1629 {
1630         SubViewMode old_mode = _subview_mode;
1631         boost::shared_ptr<Route> old_route = _subview_route;
1632
1633         _subview_mode = sm;
1634
1635         if (r) {
1636                 /* retain _subview_route even if it is reset to null implicitly */
1637                 _subview_route = r;
1638         }
1639
1640         if ((_subview_mode != old_mode) || (_subview_route != old_route)) {
1641
1642                 if (r != old_route) {
1643                         subview_route_connections.drop_connections ();
1644                         if (_subview_route) {
1645                                 _subview_route->DropReferences.connect (subview_route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_subview_route_deleted, this), this);
1646                         }
1647                 }
1648
1649                 /* subview mode did actually change */
1650
1651                 {
1652                         Surfaces copy; /* can't hold surfaces lock while calling Strip::subview_mode_changed */
1653
1654                         {
1655                                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1656                                 copy = surfaces;
1657                         }
1658
1659                         for (Surfaces::iterator s = copy.begin(); s != copy.end(); ++s) {
1660                                 (*s)->subview_mode_changed ();
1661                         }
1662                 }
1663
1664                 if (_subview_mode != old_mode) {
1665
1666                         /* turn buttons related to vpot mode on or off as required */
1667
1668                         switch (_subview_mode) {
1669                         case MackieControlProtocol::None:
1670                                 pot_mode_globals ();
1671                                 break;
1672                         case MackieControlProtocol::EQ:
1673                                 update_global_button (Button::Send, off);
1674                                 update_global_button (Button::Eq, on);
1675                                 update_global_button (Button::Dyn, off);
1676                                 update_global_button (Button::AudioInstruments, off); /* faking up Dyn */
1677                                 update_global_button (Button::Trim, off);
1678                                 update_global_button (Button::Send, off);
1679                                 update_global_button (Button::Pan, off);
1680                                 break;
1681                         case MackieControlProtocol::Dynamics:
1682                                 update_global_button (Button::Send, off);
1683                                 update_global_button (Button::Eq, off);
1684                                 update_global_button (Button::Dyn, on);
1685                                 update_global_button (Button::AudioInstruments, on); /* faking up Dyn */
1686                                 update_global_button (Button::Trim, off);
1687                                 update_global_button (Button::Send, off);
1688                                 update_global_button (Button::Pan, off);
1689                                 break;
1690                         case MackieControlProtocol::Sends:
1691                                 update_global_button (Button::Send, on);
1692                                 update_global_button (Button::Eq, off);
1693                                 update_global_button (Button::Dyn, off);
1694                                 update_global_button (Button::AudioInstruments, on); /* faking up Dyn */
1695                                 update_global_button (Button::Trim, off);
1696                                 update_global_button (Button::Send, off);
1697                                 update_global_button (Button::Pan, off);
1698                                 break;
1699                         }
1700                 }
1701         }
1702 }
1703
1704 void
1705 MackieControlProtocol::set_view_mode (ViewMode m)
1706 {
1707         _last_bank[_view_mode] = _current_initial_bank;
1708
1709         _view_mode = m;
1710         set_subview_mode (None, boost::shared_ptr<Route>());
1711
1712         switch_banks(_last_bank[_view_mode], true);
1713         display_view_mode ();
1714 }
1715
1716 void
1717 MackieControlProtocol::display_view_mode ()
1718 {
1719         {
1720                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1721
1722                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1723                         (*s)->update_view_mode_display ();
1724                 }
1725         }
1726 }
1727
1728 void
1729 MackieControlProtocol::set_flip_mode (FlipMode fm)
1730 {
1731         if (_flip_mode != fm) {
1732                 if (fm == Normal) {
1733                         update_global_button (Button::Flip, off);
1734                 } else {
1735                         update_global_button (Button::Flip, on);
1736                 }
1737
1738                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1739
1740                 _flip_mode = fm;
1741
1742                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1743                         (*s)->update_flip_mode_display ();
1744                 }
1745         }
1746 }
1747
1748 void
1749 MackieControlProtocol::set_pot_mode (PotMode m)
1750 {
1751         // maybe not in flip mode.
1752         if (flip_mode()) {
1753                 return;
1754         }
1755
1756         _pot_mode = m;
1757
1758         {
1759                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1760
1761                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1762                         (*s)->update_potmode ();
1763
1764                 }
1765         }
1766
1767         pot_mode_globals ();
1768 }
1769
1770 void
1771 MackieControlProtocol::pot_mode_globals ()
1772 {
1773         update_global_button (Button::Eq, off);
1774         update_global_button (Button::Dyn, off);
1775         update_global_button (Button::AudioInstruments, off);
1776
1777         switch (_pot_mode) {
1778         case Trim:
1779                 update_global_button (Button::Track, on);
1780                 update_global_button (Button::Send, off);
1781                 update_global_button (Button::Pan, off);
1782                 break;
1783         case Pan:
1784                 update_global_button (Button::Track, off);
1785                 update_global_button (Button::Send, off);
1786                 update_global_button (Button::Pan, on);
1787         };
1788 }
1789
1790 void
1791 MackieControlProtocol::set_master_on_surface_strip (uint32_t surface, uint32_t strip_number)
1792 {
1793         force_special_route_to_strip (session->master_out(), surface, strip_number);
1794 }
1795
1796 void
1797 MackieControlProtocol::set_monitor_on_surface_strip (uint32_t surface, uint32_t strip_number)
1798 {
1799         force_special_route_to_strip (session->monitor_out(), surface, strip_number);
1800 }
1801
1802 void
1803 MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r, uint32_t surface, uint32_t strip_number)
1804 {
1805         if (!r) {
1806                 return;
1807         }
1808
1809         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1810
1811         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1812                 if ((*s)->number() == surface) {
1813                         Strip* strip = (*s)->nth_strip (strip_number);
1814                         if (strip) {
1815                                 strip->set_route (session->master_out());
1816                                 strip->lock_controls ();
1817                         }
1818                 }
1819         }
1820 }
1821
1822 void
1823 MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl, bool save_list)
1824 {
1825         _gui_track_selection_changed (rl.get(), save_list, true);
1826 }
1827
1828 void
1829 MackieControlProtocol::_gui_track_selection_changed (ARDOUR::RouteNotificationList* rl, bool save_list, bool gui_selection_did_change)
1830 {
1831         /* We need to keep a list of the most recently selected routes around,
1832            but we are not allowed to keep shared_ptr<Route> unless we want to
1833            handle the complexities of route deletion. So instead, the GUI sends
1834            us a notification using weak_ptr<Route>, which we keep a copy
1835            of. For efficiency's sake, however, we convert the weak_ptr's into
1836            shared_ptr<Route> before passing them to however many surfaces (and
1837            thus strips) that we have.
1838         */
1839
1840         StrongRouteNotificationList srl;
1841
1842         for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
1843                 boost::shared_ptr<ARDOUR::Route> r = (*i).lock();
1844                 if (r) {
1845                         srl.push_back (r);
1846                 }
1847         }
1848
1849         {
1850                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1851
1852                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1853                         (*s)->gui_selection_changed (srl);
1854                 }
1855         }
1856
1857         if (save_list) {
1858                 _last_selected_routes = *rl;
1859         }
1860
1861         if (gui_selection_did_change) {
1862                 /* actual GUI selection changed */
1863                 set_subview_mode (_subview_mode, first_selected_route());
1864         }
1865 }
1866
1867 framepos_t
1868 MackieControlProtocol::transport_frame() const
1869 {
1870         return session->transport_frame();
1871 }
1872
1873 void
1874 MackieControlProtocol::add_down_select_button (int surface, int strip)
1875 {
1876         _down_select_buttons.insert ((surface<<8)|(strip&0xf));
1877 }
1878
1879 void
1880 MackieControlProtocol::remove_down_select_button (int surface, int strip)
1881 {
1882         DownButtonList::iterator x = find (_down_select_buttons.begin(), _down_select_buttons.end(), (uint32_t) (surface<<8)|(strip&0xf));
1883         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down select buttons\n", surface, strip));
1884         if (x != _down_select_buttons.end()) {
1885                 _down_select_buttons.erase (x);
1886         } else {
1887                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down select buttons\n",
1888                                                                    surface, strip));
1889         }
1890 }
1891
1892 void
1893 MackieControlProtocol::select_range ()
1894 {
1895         RouteList routes;
1896
1897         pull_route_range (_down_select_buttons, routes);
1898
1899         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("select range: found %1 routes\n", routes.size()));
1900
1901         if (!routes.empty()) {
1902                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1903
1904                         if (main_modifier_state() == MODIFIER_CONTROL) {
1905                                 ToggleRouteSelection ((*r)->remote_control_id ());
1906                         } else {
1907                                 if (r == routes.begin()) {
1908                                         SetRouteSelection ((*r)->remote_control_id());
1909                                 } else {
1910                                         AddRouteToSelection ((*r)->remote_control_id());
1911                                 }
1912                         }
1913                 }
1914         }
1915 }
1916
1917 void
1918 MackieControlProtocol::add_down_button (AutomationType a, int surface, int strip)
1919 {
1920         DownButtonMap::iterator m = _down_buttons.find (a);
1921
1922         if (m == _down_buttons.end()) {
1923                 _down_buttons[a] = DownButtonList();
1924         }
1925
1926         _down_buttons[a].insert ((surface<<8)|(strip&0xf));
1927 }
1928
1929 void
1930 MackieControlProtocol::remove_down_button (AutomationType a, int surface, int strip)
1931 {
1932         DownButtonMap::iterator m = _down_buttons.find (a);
1933
1934         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down buttons for %3\n", surface, strip, (int) a));
1935
1936         if (m == _down_buttons.end()) {
1937                 return;
1938         }
1939
1940         DownButtonList& l (m->second);
1941         DownButtonList::iterator x = find (l.begin(), l.end(), (surface<<8)|(strip&0xf));
1942
1943         if (x != l.end()) {
1944                 l.erase (x);
1945         } else {
1946                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down buttons for %3\n",
1947                                                                    surface, strip, (int) a));
1948         }
1949 }
1950
1951 MackieControlProtocol::ControlList
1952 MackieControlProtocol::down_controls (AutomationType p)
1953 {
1954         ControlList controls;
1955         RouteList routes;
1956
1957         DownButtonMap::iterator m = _down_buttons.find (p);
1958
1959         if (m == _down_buttons.end()) {
1960                 return controls;
1961         }
1962
1963         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("looking for down buttons for %1, got %2\n",
1964                                                            p, m->second.size()));
1965
1966         pull_route_range (m->second, routes);
1967
1968         switch (p) {
1969         case GainAutomation:
1970                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1971                         controls.push_back ((*r)->gain_control());
1972                 }
1973                 break;
1974         case SoloAutomation:
1975                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1976                         controls.push_back ((*r)->solo_control());
1977                 }
1978                 break;
1979         case MuteAutomation:
1980                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1981                         controls.push_back ((*r)->mute_control());
1982                 }
1983                 break;
1984         case RecEnableAutomation:
1985                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1986                         boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (*r);
1987                         if (trk) {
1988                                 controls.push_back (trk->rec_enable_control());
1989                         }
1990                 }
1991                 break;
1992         default:
1993                 break;
1994         }
1995
1996         return controls;
1997
1998 }
1999
2000 struct ButtonRangeSorter {
2001     bool operator() (const uint32_t& a, const uint32_t& b) {
2002             return (a>>8) < (b>>8) // a.surface < b.surface
2003                     ||
2004                     ((a>>8) == (b>>8) && (a&0xf) < (b&0xf)); // a.surface == b.surface && a.strip < b.strip
2005     }
2006 };
2007
2008 void
2009 MackieControlProtocol::pull_route_range (DownButtonList& down, RouteList& selected)
2010 {
2011         ButtonRangeSorter cmp;
2012
2013         if (down.empty()) {
2014                 return;
2015         }
2016
2017         list<uint32_t> ldown;
2018         ldown.insert (ldown.end(), down.begin(), down.end());
2019         ldown.sort (cmp);
2020
2021         uint32_t first = ldown.front();
2022         uint32_t last = ldown.back ();
2023
2024         uint32_t first_surface = first>>8;
2025         uint32_t first_strip = first&0xf;
2026
2027         uint32_t last_surface = last>>8;
2028         uint32_t last_strip = last&0xf;
2029
2030         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("PRR %5 in list %1.%2 - %3.%4\n", first_surface, first_strip, last_surface, last_strip,
2031                                                            down.size()));
2032
2033         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2034
2035         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2036
2037                 if ((*s)->number() >= first_surface && (*s)->number() <= last_surface) {
2038
2039                         uint32_t fs;
2040                         uint32_t ls;
2041
2042                         if ((*s)->number() == first_surface) {
2043                                 fs = first_strip;
2044                         } else {
2045                                 fs = 0;
2046                         }
2047
2048                         if ((*s)->number() == last_surface) {
2049                                 ls = last_strip;
2050                                 ls += 1;
2051                         } else {
2052                                 ls = (*s)->n_strips ();
2053                         }
2054
2055                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("adding strips for surface %1 (%2 .. %3)\n",
2056                                                                            (*s)->number(), fs, ls));
2057
2058                         for (uint32_t n = fs; n < ls; ++n) {
2059                                 boost::shared_ptr<Route> r = (*s)->nth_strip (n)->route();
2060                                 if (r) {
2061                                         selected.push_back (r);
2062                                 }
2063                         }
2064                 }
2065         }
2066 }
2067
2068 void
2069 MackieControlProtocol::set_ipmidi_base (int16_t portnum)
2070 {
2071         /* this will not be saved without a session save, so .. */
2072
2073         session->set_dirty ();
2074
2075         _ipmidi_base = portnum;
2076
2077         /* if the current device uses ipMIDI we need
2078            to restart.
2079         */
2080
2081         if (active() && _device_info.uses_ipmidi()) {
2082                 needs_ipmidi_restart = true;
2083         }
2084 }
2085
2086 int
2087 MackieControlProtocol::ipmidi_restart ()
2088 {
2089         clear_surfaces ();
2090         if (create_surfaces ()) {
2091                 return -1;
2092         }
2093         switch_banks (_current_initial_bank, true);
2094         needs_ipmidi_restart = false;
2095         return 0;
2096 }
2097
2098 void
2099 MackieControlProtocol::clear_surfaces ()
2100 {
2101         clear_ports ();
2102
2103         {
2104                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
2105                 _master_surface.reset ();
2106                 surfaces.clear ();
2107         }
2108 }
2109
2110 void
2111 MackieControlProtocol::set_touch_sensitivity (int sensitivity)
2112 {
2113         sensitivity = min (9, sensitivity);
2114         sensitivity = max (0, sensitivity);
2115
2116         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2117
2118         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2119                 (*s)->set_touch_sensitivity (sensitivity);
2120         }
2121 }
2122
2123 void
2124 MackieControlProtocol::recalibrate_faders ()
2125 {
2126         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2127
2128         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2129                 (*s)->recalibrate_faders ();
2130         }
2131 }
2132
2133 void
2134 MackieControlProtocol::toggle_backlight ()
2135 {
2136         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2137
2138         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2139                 (*s)->toggle_backlight ();
2140         }
2141 }
2142
2143 boost::shared_ptr<Surface>
2144 MackieControlProtocol::get_surface_by_raw_pointer (void* ptr) const
2145 {
2146         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2147
2148         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2149                 if ((*s).get() == (Surface*) ptr) {
2150                         return *s;
2151                 }
2152         }
2153
2154         return boost::shared_ptr<Surface> ();
2155 }
2156
2157 boost::shared_ptr<Surface>
2158 MackieControlProtocol::nth_surface (uint32_t n) const
2159 {
2160         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2161
2162         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s, --n) {
2163                 if (n == 0) {
2164                         return *s;
2165                 }
2166         }
2167
2168         return boost::shared_ptr<Surface> ();
2169 }
2170
2171 void
2172 MackieControlProtocol::connection_handler (boost::weak_ptr<ARDOUR::Port> wp1, std::string name1, boost::weak_ptr<ARDOUR::Port> wp2, std::string name2, bool yn)
2173 {
2174         Surfaces scopy;
2175         {
2176                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
2177                 scopy = surfaces;
2178         }
2179
2180         for (Surfaces::const_iterator s = scopy.begin(); s != scopy.end(); ++s) {
2181                 if ((*s)->connection_handler (wp1, name1, wp2, name2, yn)) {
2182                         ConnectionChange (*s);
2183                         break;
2184                 }
2185         }
2186 }
2187
2188 bool
2189 MackieControlProtocol::is_track (boost::shared_ptr<Route> r) const
2190 {
2191         return boost::dynamic_pointer_cast<Track>(r) != 0;
2192 }
2193
2194 bool
2195 MackieControlProtocol::is_audio_track (boost::shared_ptr<Route> r) const
2196 {
2197         return boost::dynamic_pointer_cast<AudioTrack>(r) != 0;
2198 }
2199
2200 bool
2201 MackieControlProtocol::is_midi_track (boost::shared_ptr<Route> r) const
2202 {
2203         return boost::dynamic_pointer_cast<MidiTrack>(r) != 0;
2204 }
2205
2206 bool
2207 MackieControlProtocol::selected (boost::shared_ptr<Route> r) const
2208 {
2209         const RouteNotificationList* rl = &_last_selected_routes;
2210
2211         for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
2212                 boost::shared_ptr<ARDOUR::Route> rt = (*i).lock();
2213                 if (rt == r) {
2214                         return true;
2215                 }
2216         }
2217         return false;
2218 }
2219
2220 bool
2221 MackieControlProtocol::is_hidden (boost::shared_ptr<Route> r) const
2222 {
2223         if (!r) {
2224                 return false;
2225         }
2226         return (((r->remote_control_id()) >>31) != 0);
2227 }
2228
2229 boost::shared_ptr<Route>
2230 MackieControlProtocol::first_selected_route () const
2231 {
2232         if (_last_selected_routes.empty()) {
2233                 return boost::shared_ptr<Route>();
2234         }
2235
2236         boost::shared_ptr<Route> r = _last_selected_routes.front().lock();
2237
2238         return r; /* may be null */
2239 }
2240
2241 boost::shared_ptr<Route>
2242 MackieControlProtocol::subview_route () const
2243 {
2244         return _subview_route;
2245 }
2246
2247 uint32_t
2248 MackieControlProtocol::global_index (Strip& strip)
2249 {
2250         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2251         uint32_t global = 0;
2252
2253         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2254                 if ((*s).get() == strip.surface()) {
2255                         return global + strip.index();
2256                 }
2257                 global += (*s)->n_strips ();
2258         }
2259
2260         return global;
2261 }
2262
2263 void*
2264 MackieControlProtocol::request_factory (uint32_t num_requests)
2265 {
2266         /* AbstractUI<T>::request_buffer_factory() is a template method only
2267            instantiated in this source module. To provide something visible for
2268            use in the interface/descriptor, we have this static method that is
2269            template-free.
2270         */
2271         return request_buffer_factory (num_requests);
2272 }