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         // need to know if group parameters change... might be hidden.
 707         session->RouteGroupPropertyChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
 708
 709         // make sure remote id changed signals reach here
 710         // see also notify_route_added
 711         Sorted sorted = get_sorted_routes();
 712
 713         for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
 714                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
 715         }
 716 }
 717
 718 void
 719 MackieControlProtocol::set_profile (const string& profile_name)
 720 {
 721         map<string,DeviceProfile>::iterator d = DeviceProfile::device_profiles.find (profile_name);
 722
 723         if (d == DeviceProfile::device_profiles.end()) {
 724                 _device_profile = DeviceProfile (profile_name);
 725                 return;
 726         }
 727
 728         _device_profile = d->second;
 729 }
 730
 731 int
 732 MackieControlProtocol::set_device_info (const string& device_name)
 733 {
 734         map<string,DeviceInfo>::iterator d = DeviceInfo::device_info.find (device_name);
 735
 736         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("new device chosen %1\n", device_name));
 737
 738         if (d == DeviceInfo::device_info.end()) {
 739                 return -1;
 740         }
 741
 742         _device_info = d->second;
 743
 744         return 0;
 745 }
 746
 747 int
 748 MackieControlProtocol::set_device (const string& device_name, bool force)
 749 {
 750         if (device_name == device_info().name() && !force) {
 751                 /* already using that device, nothing to do */
 752                 return 0;
 753         }
 754         /* get state from the current setup, and make sure it is stored in
 755            the configuration_states node so that if we switch back to this device,
 756            we will have its state available.
 757         */
 758
 759         {
 760                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 761                 if (!surfaces.empty()) {
 762                         update_configuration_state ();
 763                 }
 764         }
 765
 766         if (set_device_info (device_name)) {
 767                 return -1;
 768         }
 769
 770         clear_surfaces ();
 771         port_connection.disconnect ();
 772         hui_connection.disconnect ();
 773
 774         if (_device_info.device_type() == DeviceInfo::HUI) {
 775                 Glib::RefPtr<Glib::TimeoutSource> hui_timeout = Glib::TimeoutSource::create (1000); // milliseconds
 776                 hui_connection = hui_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::hui_heartbeat));
 777                 hui_timeout->attach (main_loop()->get_context());
 778         }
 779
 780         if (!_device_info.uses_ipmidi()) {
 781                 /* notice that the handler for this will execute in our event
 782                    loop, not in the thread where the
 783                    PortConnectedOrDisconnected signal is emitted.
 784                 */
 785                 ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::connection_handler, this, _1, _2, _3, _4, _5), this);
 786         }
 787
 788         if (create_surfaces ()) {
 789                 return -1;
 790         }
 791
 792         DeviceChanged ();
 793
 794         return 0;
 795 }
 796
 797 gboolean
 798 ArdourSurface::ipmidi_input_handler (GIOChannel*, GIOCondition condition, void *data)
 799 {
 800         ArdourSurface::MackieControlProtocol::ipMIDIHandler* ipm = static_cast<ArdourSurface::MackieControlProtocol::ipMIDIHandler*>(data);
 801         return ipm->mcp->midi_input_handler (Glib::IOCondition (condition), ipm->port);
 802 }
 803
 804 int
 805 MackieControlProtocol::create_surfaces ()
 806 {
 807         string device_name;
 808         surface_type_t stype = mcu; // type not yet determined
 809
 810         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Create %1 surfaces for %2\n", 1 + _device_info.extenders(), _device_info.name()));
 811
 812         if (!_device_info.uses_ipmidi()) {
 813                 _input_bundle.reset (new ARDOUR::Bundle (_("Mackie Control In"), true));
 814                 _output_bundle.reset (new ARDOUR::Bundle (_("Mackie Control Out"), false));
 815         } else {
 816                 _input_bundle.reset ();
 817                 _output_bundle.reset ();
 818
 819         }
 820         for (uint32_t n = 0; n < 1 + _device_info.extenders(); ++n) {
 821                 bool is_master = false;
 822
 823                 if (n == _device_info.master_position()) {
 824                         is_master = true;
 825                         if (_device_info.extenders() == 0) {
 826                                 device_name = _device_info.name();
 827                         } else {
 828                                 device_name = X_("mackie control");
 829                         }
 830
 831                 }
 832
 833                 if (!is_master) {
 834                         device_name = string_compose (X_("mackie control ext %1"), n+1);
 835                 }
 836
 837                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Port Name for surface %1 is %2\n", n, device_name));
 838
 839                 boost::shared_ptr<Surface> surface;
 840
 841                 if (is_master) {
 842                         stype = mcu;
 843                 } else {
 844                         stype = ext;
 845                 }
 846                 try {
 847                         surface.reset (new Surface (*this, device_name, n, stype));
 848                 } catch (...) {
 849                         return -1;
 850                 }
 851
 852                 if (is_master) {
 853                         _master_surface = surface;
 854                 }
 855
 856                 if (configuration_state) {
 857                         XMLNode* this_device = 0;
 858                         XMLNodeList const& devices = configuration_state->children();
 859                         for (XMLNodeList::const_iterator d = devices.begin(); d != devices.end(); ++d) {
 860                                 XMLProperty* prop = (*d)->property (X_("name"));
 861                                 if (prop && prop->value() == _device_info.name()) {
 862                                         this_device = *d;
 863                                         break;
 864                                 }
 865                         }
 866                         if (this_device) {
 867                                 XMLNode* snode = this_device->child (X_("Surfaces"));
 868                                 if (snode) {
 869                                         surface->set_state (*snode, state_version);
 870                                 }
 871                         }
 872                 }
 873
 874                 {
 875                         Glib::Threads::Mutex::Lock lm (surfaces_lock);
 876                         surfaces.push_back (surface);
 877                 }
 878
 879                 if (!_device_info.uses_ipmidi()) {
 880
 881                         _input_bundle->add_channel (
 882                                 surface->port().input_port().name(),
 883                                 ARDOUR::DataType::MIDI,
 884                                 session->engine().make_port_name_non_relative (surface->port().input_port().name())
 885                                 );
 886
 887                         _output_bundle->add_channel (
 888                                 surface->port().output_port().name(),
 889                                 ARDOUR::DataType::MIDI,
 890                                 session->engine().make_port_name_non_relative (surface->port().output_port().name())
 891                                 );
 892                 }
 893
 894                 MIDI::Port& input_port (surface->port().input_port());
 895                 AsyncMIDIPort* asp = dynamic_cast<AsyncMIDIPort*> (&input_port);
 896
 897                 if (asp) {
 898
 899                         /* async MIDI port */
 900
 901                         asp->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &MackieControlProtocol::midi_input_handler), &input_port));
 902                         asp->xthread().attach (main_loop()->get_context());
 903
 904                 } else {
 905
 906                         /* ipMIDI port, no IOSource method at this time */
 907
 908                         int fd;
 909
 910                         if ((fd = input_port.selectable ()) >= 0) {
 911
 912                                 GIOChannel* ioc = g_io_channel_unix_new (fd);
 913                                 surface->input_source = g_io_create_watch (ioc, GIOCondition (G_IO_IN|G_IO_HUP|G_IO_ERR));
 914
 915                                 /* make surface's input source now hold the
 916                                  * only reference on the IO channel
 917                                  */
 918                                 g_io_channel_unref (ioc);
 919
 920                                 /* hack up an object so that in the callback from the event loop
 921                                    we have both the MackieControlProtocol and the input port.
 922
 923                                    If we were using C++ for this stuff we wouldn't need this
 924                                    but a nasty, not-fixable bug in the binding between C
 925                                    and C++ makes it necessary to avoid C++ for the IO
 926                                    callback setup.
 927                                 */
 928
 929                                 ipMIDIHandler* ipm = new ipMIDIHandler (); /* we will leak this sizeof(pointer)*2 sized object */
 930                                 ipm->mcp = this;
 931                                 ipm->port = &input_port;
 932
 933                                 g_source_set_callback (surface->input_source, (GSourceFunc) ipmidi_input_handler, ipm, NULL);
 934                                 g_source_attach (surface->input_source, main_loop()->get_context()->gobj());
 935                         }
 936                 }
 937         }
 938
 939         if (!_device_info.uses_ipmidi()) {
 940                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 941                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 942                         (*s)->port().reconnect ();
 943                 }
 944         }
 945
 946         session->BundleAddedOrRemoved ();
 947
 948         assert (_master_surface);
 949
 950         return 0;
 951 }
 952
 953 void
 954 MackieControlProtocol::close()
 955 {
 956         port_connection.disconnect ();
 957         session_connections.drop_connections ();
 958         route_connections.drop_connections ();
 959         periodic_connection.disconnect ();
 960
 961         clear_surfaces();
 962 }
 963
 964 /** Ensure that the configuration_state XML node contains an up-to-date
 965  *  copy of the state node the current device. If configuration_state already
 966  *  contains a state node for the device, it will deleted and replaced.
 967  */
 968 void
 969 MackieControlProtocol::update_configuration_state ()
 970 {
 971         /* CALLER MUST HOLD SURFACES LOCK */
 972
 973         if (!configuration_state) {
 974                 configuration_state = new XMLNode (X_("Configurations"));
 975         }
 976
 977         XMLNode* devnode = new XMLNode (X_("Configuration"));
 978         devnode->add_property (X_("name"), _device_info.name());
 979
 980         configuration_state->remove_nodes_and_delete (X_("name"), _device_info.name());
 981         configuration_state->add_child_nocopy (*devnode);
 982
 983         XMLNode* snode = new XMLNode (X_("Surfaces"));
 984
 985         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 986                 snode->add_child_nocopy ((*s)->get_state());
 987         }
 988
 989         devnode->add_child_nocopy (*snode);
 990 }
 991
 992 XMLNode&
 993 MackieControlProtocol::get_state()
 994 {
 995         XMLNode& node (ControlProtocol::get_state());
 996
 997         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state init\n");
 998         char buf[16];
 999
1000         // add current bank
1001         snprintf (buf, sizeof (buf), "%d", _current_initial_bank);
1002         node.add_property (X_("bank"), buf);
1003
1004         // ipMIDI base port (possibly not used)
1005         snprintf (buf, sizeof (buf), "%d", _ipmidi_base);
1006         node.add_property (X_("ipmidi-base"), buf);
1007
1008         node.add_property (X_("device-profile"), _device_profile.name());
1009         node.add_property (X_("device-name"), _device_info.name());
1010
1011         {
1012                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1013                 update_configuration_state ();
1014         }
1015
1016         /* force a copy of the _surfaces_state node, because we want to retain ownership */
1017         node.add_child_copy (*configuration_state);
1018
1019         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state done\n");
1020
1021         return node;
1022 }
1023
1024 int
1025 MackieControlProtocol::set_state (const XMLNode & node, int version)
1026 {
1027         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", active()));
1028
1029         int retval = 0;
1030         const XMLProperty* prop;
1031         uint32_t bank = 0;
1032
1033         if (ControlProtocol::set_state (node, version)) {
1034                 return -1;
1035         }
1036
1037         if ((prop = node.property (X_("ipmidi-base"))) != 0) {
1038                 set_ipmidi_base (atoi (prop->value()));
1039         }
1040
1041         // fetch current bank
1042         if ((prop = node.property (X_("bank"))) != 0) {
1043                 bank = atoi (prop->value());
1044         }
1045
1046         if ((prop = node.property (X_("device-name"))) != 0) {
1047                 set_device_info (prop->value());
1048         }
1049
1050         if ((prop = node.property (X_("device-profile"))) != 0) {
1051                 if (prop->value().empty()) {
1052                         string default_profile_name;
1053
1054                         default_profile_name = Glib::get_user_name();
1055                         default_profile_name += ' ';
1056                         default_profile_name += _device_info.name();
1057
1058                         set_profile (default_profile_name);
1059                 } else {
1060                         set_profile (prop->value());
1061                 }
1062         }
1063
1064         XMLNode* dnode = node.child (X_("Configurations"));
1065
1066         delete configuration_state;
1067         configuration_state = 0;
1068
1069         if (dnode) {
1070                 configuration_state = new XMLNode (*dnode);
1071                 state_version = version;
1072         }
1073
1074         switch_banks (bank, true);
1075
1076         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::set_state done\n");
1077
1078         return retval;
1079 }
1080
1081 string
1082 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
1083 {
1084         Timecode::BBT_Time bbt_time;
1085
1086         session->bbt_time (now_frame, bbt_time);
1087
1088         // The Mackie protocol spec is built around a BBT time display of
1089         //
1090         // digits:     888/88/88/888
1091         // semantics:  BBB/bb/ss/ttt
1092         //
1093         // The third field is "subdivisions" which is a concept found in Logic
1094         // but not present in Ardour. Instead Ardour displays a 4 digit tick
1095         // count, which we need to spread across the 5 digits of ss/ttt.
1096
1097         ostringstream os;
1098
1099         os << setw(3) << setfill('0') << bbt_time.bars;
1100         os << setw(2) << setfill('0') << bbt_time.beats;
1101         os << ' ';
1102         os << setw(1) << setfill('0') << bbt_time.ticks / 1000;
1103         os << setw(3) << setfill('0') << bbt_time.ticks % 1000;
1104
1105         return os.str();
1106 }
1107
1108 string
1109 MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
1110 {
1111         Timecode::Time timecode;
1112         session->timecode_time (now_frame, timecode);
1113
1114         // According to the Logic docs
1115         // digits: 888/88/88/888
1116         // Timecode mode: Hours/Minutes/Seconds/Frames
1117         ostringstream os;
1118         os << setw(2) << setfill('0') << timecode.hours;
1119         os << ' ';
1120         os << setw(2) << setfill('0') << timecode.minutes;
1121         os << setw(2) << setfill('0') << timecode.seconds;
1122         os << ' ';
1123         os << setw(2) << setfill('0') << timecode.frames;
1124
1125         return os.str();
1126 }
1127
1128 void
1129 MackieControlProtocol::update_timecode_display()
1130 {
1131         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1132
1133         if (surfaces.empty()) {
1134                 return;
1135         }
1136
1137         boost::shared_ptr<Surface> surface = _master_surface;
1138
1139         if (surface->type() != mcu || !_device_info.has_timecode_display() || !surface->active ()) {
1140                 return;
1141         }
1142
1143         // do assignment here so current_frame is fixed
1144         framepos_t current_frame = session->transport_frame();
1145         string timecode;
1146         // For large jumps in play head possition do full reset
1147         int moved = (current_frame - _frame_last) / session->frame_rate ();
1148         if (moved) {
1149                 DEBUG_TRACE (DEBUG::MackieControl, "Timecode reset\n");
1150                 _timecode_last = string (10, ' ');
1151         }
1152         _frame_last = current_frame;
1153
1154         switch (_timecode_type) {
1155         case ARDOUR::AnyTime::BBT:
1156                 timecode = format_bbt_timecode (current_frame);
1157                 break;
1158         case ARDOUR::AnyTime::Timecode:
1159                 timecode = format_timecode_timecode (current_frame);
1160                 break;
1161         default:
1162                 return;
1163         }
1164
1165         // only write the timecode string to the MCU if it's changed
1166         // since last time. This is to reduce midi bandwidth used.
1167         if (timecode != _timecode_last) {
1168                 surface->display_timecode (timecode, _timecode_last);
1169                 _timecode_last = timecode;
1170         }
1171 }
1172
1173 ///////////////////////////////////////////
1174 // Session signals
1175 ///////////////////////////////////////////
1176
1177 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
1178 {
1179         if (p == "punch-in") {
1180                 // no such button right now
1181                 // update_global_button (Button::PunchIn, session->config.get_punch_in());
1182         } else if (p == "punch-out") {
1183                 // no such button right now
1184                 // update_global_button (Button::PunchOut, session->config.get_punch_out());
1185         } else if (p == "clicking") {
1186                 update_global_button (Button::Click, Config->get_clicking());
1187         } else {
1188                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
1189         }
1190 }
1191
1192 void
1193 MackieControlProtocol::notify_route_added_or_removed ()
1194 {
1195         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1196         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1197                 (*s)->master_monitor_may_have_changed ();
1198         }
1199 }
1200
1201 // RouteList is the set of routes that have just been added
1202 void
1203 MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
1204 {
1205         {
1206                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1207
1208                 if (surfaces.empty()) {
1209                         return;
1210                 }
1211         }
1212
1213         /* special case: single route, and it is the monitor or master out */
1214
1215         if (rl.size() == 1 && (rl.front()->is_monitor() || rl.front()->is_master())) {
1216                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1217                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1218                         (*s)->master_monitor_may_have_changed ();
1219                 }
1220         }
1221
1222         // currently assigned banks are less than the full set of
1223         // strips, so activate the new strip now.
1224
1225         refresh_current_bank();
1226
1227         // otherwise route added, but current bank needs no updating
1228
1229         // make sure remote id changes in the new route are handled
1230         typedef ARDOUR::RouteList ARS;
1231
1232         for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
1233                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
1234         }
1235 }
1236
1237 void
1238 MackieControlProtocol::notify_solo_active_changed (bool active)
1239 {
1240         boost::shared_ptr<Surface> surface;
1241
1242         {
1243                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1244
1245                 if (surfaces.empty()) {
1246                         return;
1247                 }
1248
1249                 surface = _master_surface;
1250         }
1251
1252         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Led::RudeSolo);
1253         if (x != surface->controls_by_device_independent_id.end()) {
1254                 Led* rude_solo = dynamic_cast<Led*> (x->second);
1255                 if (rude_solo) {
1256                         surface->write (rude_solo->set_state (active ? flashing : off));
1257                 }
1258         }
1259 }
1260
1261 void
1262 MackieControlProtocol::notify_remote_id_changed()
1263 {
1264         {
1265                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1266
1267                 if (surfaces.empty()) {
1268                         return;
1269                 }
1270         }
1271
1272         Sorted sorted = get_sorted_routes();
1273         uint32_t sz = n_strips();
1274
1275         // if a remote id has been moved off the end, we need to shift
1276         // the current bank backwards.
1277
1278         if (sorted.size() - _current_initial_bank < sz) {
1279                 // but don't shift backwards past the zeroth channel
1280                 if (sorted.size() < sz) {  // avoid unsigned math mistake below
1281                         switch_banks(0, true);
1282                 } else {
1283                         switch_banks (max((Sorted::size_type) 0, sorted.size() - sz), true);
1284                 }
1285         } else {
1286                 // Otherwise just refresh the current bank
1287                 refresh_current_bank();
1288         }
1289 }
1290
1291 ///////////////////////////////////////////
1292 // Transport signals
1293 ///////////////////////////////////////////
1294
1295 void
1296 MackieControlProtocol::notify_loop_state_changed()
1297 {
1298         update_global_button (Button::Loop, session->get_play_loop());
1299 }
1300
1301 void
1302 MackieControlProtocol::notify_transport_state_changed()
1303 {
1304         if (!_device_info.has_global_controls()) {
1305                 return;
1306         }
1307
1308         // switch various play and stop buttons on / off
1309         update_global_button (Button::Loop, session->get_play_loop());
1310         update_global_button (Button::Play, session->transport_speed() == 1.0);
1311         update_global_button (Button::Stop, session->transport_stopped ());
1312         update_global_button (Button::Rewind, session->transport_speed() < 0.0);
1313         update_global_button (Button::Ffwd, session->transport_speed() > 1.0);
1314
1315         // sometimes a return to start leaves time code at old time
1316         _timecode_last = string (10, ' ');
1317
1318         notify_metering_state_changed ();
1319 }
1320
1321 void
1322 MackieControlProtocol::notify_metering_state_changed()
1323 {
1324         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1325
1326         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1327                 (*s)->notify_metering_state_changed ();
1328         }
1329 }
1330
1331 void
1332 MackieControlProtocol::notify_record_state_changed ()
1333 {
1334         if (!_device_info.has_global_controls()) {
1335                 return;
1336         }
1337
1338         boost::shared_ptr<Surface> surface;
1339
1340         {
1341                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1342                 if (surfaces.empty()) {
1343                         return;
1344                 }
1345                 surface = _master_surface;
1346         }
1347
1348         /* rec is a tristate */
1349
1350         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Button::Record);
1351         if (x != surface->controls_by_device_independent_id.end()) {
1352                 Button * rec = dynamic_cast<Button*> (x->second);
1353                 if (rec) {
1354                         LedState ls;
1355
1356                         switch (session->record_status()) {
1357                         case Session::Disabled:
1358                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to disabled, LED off\n");
1359                                 ls = off;
1360                                 break;
1361                         case Session::Recording:
1362                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to recording, LED on\n");
1363                                 ls = on;
1364                                 break;
1365                         case Session::Enabled:
1366                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to enabled, LED flashing\n");
1367                                 ls = flashing;
1368                                 break;
1369                         }
1370
1371                         surface->write (rec->set_state (ls));
1372                 }
1373         }
1374 }
1375
1376 list<boost::shared_ptr<ARDOUR::Bundle> >
1377 MackieControlProtocol::bundles ()
1378 {
1379         list<boost::shared_ptr<ARDOUR::Bundle> > b;
1380
1381         if (_input_bundle) {
1382                 b.push_back (_input_bundle);
1383                 b.push_back (_output_bundle);
1384         }
1385
1386         return b;
1387 }
1388
1389 void
1390 MackieControlProtocol::do_request (MackieControlUIRequest* req)
1391 {
1392         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("doing request type %1\n", req->type));
1393         if (req->type == CallSlot) {
1394
1395                 call_slot (MISSING_INVALIDATOR, req->the_slot);
1396
1397         } else if (req->type == Quit) {
1398
1399                 stop ();
1400         }
1401 }
1402
1403 int
1404 MackieControlProtocol::stop ()
1405 {
1406         BaseUI::quit ();
1407
1408         return 0;
1409 }
1410
1411 void
1412 MackieControlProtocol::update_led (Surface& surface, Button& button, Mackie::LedState ls)
1413 {
1414         if (ls != none) {
1415                 surface.port().write (button.set_state (ls));
1416         }
1417 }
1418
1419 void
1420 MackieControlProtocol::build_button_map ()
1421 {
1422         /* this maps our device-independent button codes to the methods that handle them.
1423          */
1424
1425 #define DEFINE_BUTTON_HANDLER(b,p,r) button_map.insert (pair<Button::ID,ButtonHandlers> ((b), ButtonHandlers ((p),(r))));
1426
1427         DEFINE_BUTTON_HANDLER (Button::Track, &MackieControlProtocol::track_press, &MackieControlProtocol::track_release);
1428         DEFINE_BUTTON_HANDLER (Button::Send, &MackieControlProtocol::send_press, &MackieControlProtocol::send_release);
1429         DEFINE_BUTTON_HANDLER (Button::Pan, &MackieControlProtocol::pan_press, &MackieControlProtocol::pan_release);
1430         DEFINE_BUTTON_HANDLER (Button::Plugin, &MackieControlProtocol::plugin_press, &MackieControlProtocol::plugin_release);
1431         DEFINE_BUTTON_HANDLER (Button::Eq, &MackieControlProtocol::eq_press, &MackieControlProtocol::eq_release);
1432         DEFINE_BUTTON_HANDLER (Button::Dyn, &MackieControlProtocol::dyn_press, &MackieControlProtocol::dyn_release);
1433         DEFINE_BUTTON_HANDLER (Button::Left, &MackieControlProtocol::left_press, &MackieControlProtocol::left_release);
1434         DEFINE_BUTTON_HANDLER (Button::Right, &MackieControlProtocol::right_press, &MackieControlProtocol::right_release);
1435         DEFINE_BUTTON_HANDLER (Button::ChannelLeft, &MackieControlProtocol::channel_left_press, &MackieControlProtocol::channel_left_release);
1436         DEFINE_BUTTON_HANDLER (Button::ChannelRight, &MackieControlProtocol::channel_right_press, &MackieControlProtocol::channel_right_release);
1437         DEFINE_BUTTON_HANDLER (Button::Flip, &MackieControlProtocol::flip_press, &MackieControlProtocol::flip_release);
1438         DEFINE_BUTTON_HANDLER (Button::View, &MackieControlProtocol::view_press, &MackieControlProtocol::view_release);
1439         DEFINE_BUTTON_HANDLER (Button::NameValue, &MackieControlProtocol::name_value_press, &MackieControlProtocol::name_value_release);
1440         DEFINE_BUTTON_HANDLER (Button::TimecodeBeats, &MackieControlProtocol::timecode_beats_press, &MackieControlProtocol::timecode_beats_release);
1441         DEFINE_BUTTON_HANDLER (Button::F1, &MackieControlProtocol::F1_press, &MackieControlProtocol::F1_release);
1442         DEFINE_BUTTON_HANDLER (Button::F2, &MackieControlProtocol::F2_press, &MackieControlProtocol::F2_release);
1443         DEFINE_BUTTON_HANDLER (Button::F3, &MackieControlProtocol::F3_press, &MackieControlProtocol::F3_release);
1444         DEFINE_BUTTON_HANDLER (Button::F4, &MackieControlProtocol::F4_press, &MackieControlProtocol::F4_release);
1445         DEFINE_BUTTON_HANDLER (Button::F5, &MackieControlProtocol::F5_press, &MackieControlProtocol::F5_release);
1446         DEFINE_BUTTON_HANDLER (Button::F6, &MackieControlProtocol::F6_press, &MackieControlProtocol::F6_release);
1447         DEFINE_BUTTON_HANDLER (Button::F7, &MackieControlProtocol::F7_press, &MackieControlProtocol::F7_release);
1448         DEFINE_BUTTON_HANDLER (Button::F8, &MackieControlProtocol::F8_press, &MackieControlProtocol::F8_release);
1449         DEFINE_BUTTON_HANDLER (Button::MidiTracks, &MackieControlProtocol::miditracks_press, &MackieControlProtocol::miditracks_release);
1450         DEFINE_BUTTON_HANDLER (Button::Inputs, &MackieControlProtocol::inputs_press, &MackieControlProtocol::inputs_release);
1451         DEFINE_BUTTON_HANDLER (Button::AudioTracks, &MackieControlProtocol::audiotracks_press, &MackieControlProtocol::audiotracks_release);
1452         DEFINE_BUTTON_HANDLER (Button::AudioInstruments, &MackieControlProtocol::audioinstruments_press, &MackieControlProtocol::audioinstruments_release);
1453         DEFINE_BUTTON_HANDLER (Button::Aux, &MackieControlProtocol::aux_press, &MackieControlProtocol::aux_release);
1454         DEFINE_BUTTON_HANDLER (Button::Busses, &MackieControlProtocol::busses_press, &MackieControlProtocol::busses_release);
1455         DEFINE_BUTTON_HANDLER (Button::Outputs, &MackieControlProtocol::outputs_press, &MackieControlProtocol::outputs_release);
1456         DEFINE_BUTTON_HANDLER (Button::User, &MackieControlProtocol::user_press, &MackieControlProtocol::user_release);
1457         DEFINE_BUTTON_HANDLER (Button::Shift, &MackieControlProtocol::shift_press, &MackieControlProtocol::shift_release);
1458         DEFINE_BUTTON_HANDLER (Button::Option, &MackieControlProtocol::option_press, &MackieControlProtocol::option_release);
1459         DEFINE_BUTTON_HANDLER (Button::Ctrl, &MackieControlProtocol::control_press, &MackieControlProtocol::control_release);
1460         DEFINE_BUTTON_HANDLER (Button::CmdAlt, &MackieControlProtocol::cmd_alt_press, &MackieControlProtocol::cmd_alt_release);
1461         DEFINE_BUTTON_HANDLER (Button::Read, &MackieControlProtocol::read_press, &MackieControlProtocol::read_release);
1462         DEFINE_BUTTON_HANDLER (Button::Write, &MackieControlProtocol::write_press, &MackieControlProtocol::write_release);
1463         DEFINE_BUTTON_HANDLER (Button::Trim, &MackieControlProtocol::trim_press, &MackieControlProtocol::trim_release);
1464         DEFINE_BUTTON_HANDLER (Button::Touch, &MackieControlProtocol::touch_press, &MackieControlProtocol::touch_release);
1465         DEFINE_BUTTON_HANDLER (Button::Latch, &MackieControlProtocol::latch_press, &MackieControlProtocol::latch_release);
1466         DEFINE_BUTTON_HANDLER (Button::Grp, &MackieControlProtocol::grp_press, &MackieControlProtocol::grp_release);
1467         DEFINE_BUTTON_HANDLER (Button::Save, &MackieControlProtocol::save_press, &MackieControlProtocol::save_release);
1468         DEFINE_BUTTON_HANDLER (Button::Undo, &MackieControlProtocol::undo_press, &MackieControlProtocol::undo_release);
1469         DEFINE_BUTTON_HANDLER (Button::Cancel, &MackieControlProtocol::cancel_press, &MackieControlProtocol::cancel_release);
1470         DEFINE_BUTTON_HANDLER (Button::Enter, &MackieControlProtocol::enter_press, &MackieControlProtocol::enter_release);
1471         DEFINE_BUTTON_HANDLER (Button::Marker, &MackieControlProtocol::marker_press, &MackieControlProtocol::marker_release);
1472         DEFINE_BUTTON_HANDLER (Button::Nudge, &MackieControlProtocol::nudge_press, &MackieControlProtocol::nudge_release);
1473         DEFINE_BUTTON_HANDLER (Button::Loop, &MackieControlProtocol::loop_press, &MackieControlProtocol::loop_release);
1474         DEFINE_BUTTON_HANDLER (Button::Drop, &MackieControlProtocol::drop_press, &MackieControlProtocol::drop_release);
1475         DEFINE_BUTTON_HANDLER (Button::Replace, &MackieControlProtocol::replace_press, &MackieControlProtocol::replace_release);
1476         DEFINE_BUTTON_HANDLER (Button::Click, &MackieControlProtocol::click_press, &MackieControlProtocol::click_release);
1477         DEFINE_BUTTON_HANDLER (Button::ClearSolo, &MackieControlProtocol::clearsolo_press, &MackieControlProtocol::clearsolo_release);
1478         DEFINE_BUTTON_HANDLER (Button::Rewind, &MackieControlProtocol::rewind_press, &MackieControlProtocol::rewind_release);
1479         DEFINE_BUTTON_HANDLER (Button::Ffwd, &MackieControlProtocol::ffwd_press, &MackieControlProtocol::ffwd_release);
1480         DEFINE_BUTTON_HANDLER (Button::Stop, &MackieControlProtocol::stop_press, &MackieControlProtocol::stop_release);
1481         DEFINE_BUTTON_HANDLER (Button::Play, &MackieControlProtocol::play_press, &MackieControlProtocol::play_release);
1482         DEFINE_BUTTON_HANDLER (Button::Record, &MackieControlProtocol::record_press, &MackieControlProtocol::record_release);
1483         DEFINE_BUTTON_HANDLER (Button::CursorUp, &MackieControlProtocol::cursor_up_press, &MackieControlProtocol::cursor_up_release);
1484         DEFINE_BUTTON_HANDLER (Button::CursorDown, &MackieControlProtocol::cursor_down_press, &MackieControlProtocol::cursor_down_release);
1485         DEFINE_BUTTON_HANDLER (Button::CursorLeft, &MackieControlProtocol::cursor_left_press, &MackieControlProtocol::cursor_left_release);
1486         DEFINE_BUTTON_HANDLER (Button::CursorRight, &MackieControlProtocol::cursor_right_press, &MackieControlProtocol::cursor_right_release);
1487         DEFINE_BUTTON_HANDLER (Button::Zoom, &MackieControlProtocol::zoom_press, &MackieControlProtocol::zoom_release);
1488         DEFINE_BUTTON_HANDLER (Button::Scrub, &MackieControlProtocol::scrub_press, &MackieControlProtocol::scrub_release);
1489         DEFINE_BUTTON_HANDLER (Button::UserA, &MackieControlProtocol::user_a_press, &MackieControlProtocol::user_a_release);
1490         DEFINE_BUTTON_HANDLER (Button::UserB, &MackieControlProtocol::user_b_press, &MackieControlProtocol::user_b_release);
1491         DEFINE_BUTTON_HANDLER (Button::MasterFaderTouch, &MackieControlProtocol::master_fader_touch_press, &MackieControlProtocol::master_fader_touch_release);
1492 }
1493
1494 void
1495 MackieControlProtocol::handle_button_event (Surface& surface, Button& button, ButtonState bs)
1496 {
1497         Button::ID button_id = button.bid();
1498
1499         if  (bs != press && bs != release) {
1500                 update_led (surface, button, none);
1501                 return;
1502         }
1503
1504         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2 (%3)\n", (bs == press ? "press" : "release"), button.id(),
1505                                                            Button::id_to_name (button.bid())));
1506
1507         /* check profile first */
1508
1509         string action = _device_profile.get_button_action (button.bid(), _modifier_state);
1510
1511         if (!action.empty()) {
1512
1513                 if (action.find ('/') != string::npos) { /* good chance that this is really an action */
1514
1515                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Looked up action for button %1 with modifier %2, got [%3]\n",
1516                                                                            button.bid(), _modifier_state, action));
1517
1518                         /* if there is a bound action for this button, and this is a press event,
1519                            carry out the action. If its a release event, do nothing since we
1520                            don't bind to them at all but don't want any other handling to
1521                            occur either.
1522                         */
1523                         if (bs == press) {
1524                                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("executing action %1\n", action));
1525                                 access_action (action);
1526                         }
1527
1528                         return;
1529
1530                 } else {
1531
1532                         /* "action" is more likely to be a button name. We use this to
1533                          * allow remapping buttons to different (builtin) functionality
1534                          * associated with an existing button. This is similar to the
1535                          * way that (for example) Nuendo moves the "Shift" function to
1536                          * the "Enter" key of the MCU Pro.
1537                          */
1538
1539                         int bid = Button::name_to_id (action);
1540
1541                         if (bid < 0) {
1542                                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("apparent button name %1 not found\n", action));
1543                                 return;
1544                         }
1545
1546                         button_id = (Button::ID) bid;
1547                         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)));
1548                 }
1549         }
1550
1551         /* lookup using the device-INDEPENDENT button ID */
1552
1553         ButtonMap::iterator b = button_map.find (button_id);
1554
1555         if (b != button_map.end()) {
1556
1557                 ButtonHandlers& bh (b->second);
1558
1559                 switch  (bs) {
1560                 case press:
1561                         surface.write (button.set_state ((this->*(bh.press)) (button)));
1562                         break;
1563                 case release:
1564                         surface.write (button.set_state ((this->*(bh.release)) (button)));
1565                         break;
1566                 default:
1567                         break;
1568                 }
1569         } else {
1570                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1571                                                                    button.bid(), button.id()));
1572                 error << string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1573                                          button.bid(), button.id()) << endmsg;
1574         }
1575 }
1576
1577 bool
1578 MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
1579 {
1580         if (ioc & ~IO_IN) {
1581                 DEBUG_TRACE (DEBUG::MackieControl, "MIDI port closed\n");
1582                 return false;
1583         }
1584
1585         if (ioc & IO_IN) {
1586
1587                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("something happend on  %1\n", port->name()));
1588
1589                 /* Devices using regular JACK MIDI ports will need to have
1590                    the x-thread FIFO drained to avoid burning endless CPU.
1591
1592                    Devices using ipMIDI have port->selectable() as the same
1593                    file descriptor that data arrives on, so doing this
1594                    for them will simply throw all incoming data away.
1595                 */
1596
1597                 if (!_device_info.uses_ipmidi()) {
1598                         AsyncMIDIPort* asp = dynamic_cast<AsyncMIDIPort*>(port);
1599                         if (asp) {
1600                                 asp->clear ();
1601                         }
1602                 }
1603
1604                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("data available on %1\n", port->name()));
1605                 framepos_t now = session->engine().sample_time();
1606                 port->parse (now);
1607         }
1608
1609         return true;
1610 }
1611
1612 void
1613 MackieControlProtocol::clear_ports ()
1614 {
1615         if (_input_bundle) {
1616                 _input_bundle->remove_channels ();
1617                 _output_bundle->remove_channels ();
1618         }
1619 }
1620
1621 void
1622 MackieControlProtocol::notify_subview_route_deleted ()
1623 {
1624         /* return to global/mixer view */
1625         _subview_route.reset ();
1626         set_view_mode (Mixer);
1627 }
1628
1629 void
1630 MackieControlProtocol::set_subview_mode (SubViewMode sm, boost::shared_ptr<Route> r)
1631 {
1632         SubViewMode old_mode = _subview_mode;
1633         boost::shared_ptr<Route> old_route = _subview_route;
1634
1635         _subview_mode = sm;
1636
1637         if (r) {
1638                 /* retain _subview_route even if it is reset to null implicitly */
1639                 _subview_route = r;
1640         }
1641
1642         if ((_subview_mode != old_mode) || (_subview_route != old_route)) {
1643
1644                 if (r != old_route) {
1645                         subview_route_connections.drop_connections ();
1646                         if (_subview_route) {
1647                                 _subview_route->DropReferences.connect (subview_route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_subview_route_deleted, this), this);
1648                         }
1649                 }
1650
1651                 /* subview mode did actually change */
1652
1653                 {
1654                         Surfaces copy; /* can't hold surfaces lock while calling Strip::subview_mode_changed */
1655
1656                         {
1657                                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1658                                 copy = surfaces;
1659                         }
1660
1661                         for (Surfaces::iterator s = copy.begin(); s != copy.end(); ++s) {
1662                                 (*s)->subview_mode_changed ();
1663                         }
1664                 }
1665
1666                 if (_subview_mode != old_mode) {
1667
1668                         /* turn buttons related to vpot mode on or off as required */
1669
1670                         switch (_subview_mode) {
1671                         case MackieControlProtocol::None:
1672                                 pot_mode_globals ();
1673                                 break;
1674                         case MackieControlProtocol::EQ:
1675                                 update_global_button (Button::Eq, on);
1676                                 update_global_button (Button::Dyn, off);
1677                                 update_global_button (Button::AudioInstruments, off); /* faking up Dyn */
1678                                 update_global_button (Button::Trim, off);
1679                                 update_global_button (Button::Send, off);
1680                                 update_global_button (Button::Pan, off);
1681                                 break;
1682                         case MackieControlProtocol::Dynamics:
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                         }
1691                 }
1692         }
1693 }
1694
1695 void
1696 MackieControlProtocol::set_view_mode (ViewMode m)
1697 {
1698         _last_bank[_view_mode] = _current_initial_bank;
1699
1700         _view_mode = m;
1701         set_subview_mode (None, boost::shared_ptr<Route>());
1702
1703         switch_banks(_last_bank[_view_mode], true);
1704         display_view_mode ();
1705 }
1706
1707 void
1708 MackieControlProtocol::display_view_mode ()
1709 {
1710         {
1711                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1712
1713                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1714                         (*s)->update_view_mode_display ();
1715                 }
1716         }
1717 }
1718
1719 void
1720 MackieControlProtocol::set_flip_mode (FlipMode fm)
1721 {
1722         if (_flip_mode != fm) {
1723                 if (fm == Normal) {
1724                         update_global_button (Button::Flip, off);
1725                 } else {
1726                         update_global_button (Button::Flip, on);
1727                 }
1728
1729                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1730
1731                 _flip_mode = fm;
1732
1733                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1734                         (*s)->update_flip_mode_display ();
1735                 }
1736         }
1737 }
1738
1739 void
1740 MackieControlProtocol::set_pot_mode (PotMode m)
1741 {
1742         // maybe not in flip mode.
1743         if (flip_mode()) {
1744                 return;
1745         }
1746
1747         _pot_mode = m;
1748
1749         {
1750                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1751
1752                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1753                         (*s)->update_potmode ();
1754
1755                 }
1756         }
1757
1758         pot_mode_globals ();
1759 }
1760
1761 void
1762 MackieControlProtocol::pot_mode_globals ()
1763 {
1764         update_global_button (Button::Eq, off);
1765         update_global_button (Button::Dyn, off);
1766         update_global_button (Button::AudioInstruments, off);
1767
1768         switch (_pot_mode) {
1769         case Trim:
1770                 update_global_button (Button::Track, on);
1771                 update_global_button (Button::Send, off);
1772                 update_global_button (Button::Pan, off);
1773                 break;
1774         case Send:
1775                 update_global_button (Button::Track, off);
1776                 update_global_button (Button::Send, on);
1777                 update_global_button (Button::Pan, off);
1778                 break;
1779         case Pan:
1780                 update_global_button (Button::Track, off);
1781                 update_global_button (Button::Send, off);
1782                 update_global_button (Button::Pan, on);
1783         };
1784 }
1785
1786 void
1787 MackieControlProtocol::set_master_on_surface_strip (uint32_t surface, uint32_t strip_number)
1788 {
1789         force_special_route_to_strip (session->master_out(), surface, strip_number);
1790 }
1791
1792 void
1793 MackieControlProtocol::set_monitor_on_surface_strip (uint32_t surface, uint32_t strip_number)
1794 {
1795         force_special_route_to_strip (session->monitor_out(), surface, strip_number);
1796 }
1797
1798 void
1799 MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r, uint32_t surface, uint32_t strip_number)
1800 {
1801         if (!r) {
1802                 return;
1803         }
1804
1805         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1806
1807         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1808                 if ((*s)->number() == surface) {
1809                         Strip* strip = (*s)->nth_strip (strip_number);
1810                         if (strip) {
1811                                 strip->set_route (session->master_out());
1812                                 strip->lock_controls ();
1813                         }
1814                 }
1815         }
1816 }
1817
1818 void
1819 MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl, bool save_list)
1820 {
1821         _gui_track_selection_changed (rl.get(), save_list, true);
1822 }
1823
1824 void
1825 MackieControlProtocol::_gui_track_selection_changed (ARDOUR::RouteNotificationList* rl, bool save_list, bool gui_selection_did_change)
1826 {
1827         /* We need to keep a list of the most recently selected routes around,
1828            but we are not allowed to keep shared_ptr<Route> unless we want to
1829            handle the complexities of route deletion. So instead, the GUI sends
1830            us a notification using weak_ptr<Route>, which we keep a copy
1831            of. For efficiency's sake, however, we convert the weak_ptr's into
1832            shared_ptr<Route> before passing them to however many surfaces (and
1833            thus strips) that we have.
1834         */
1835
1836         StrongRouteNotificationList srl;
1837
1838         for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
1839                 boost::shared_ptr<ARDOUR::Route> r = (*i).lock();
1840                 if (r) {
1841                         srl.push_back (r);
1842                 }
1843         }
1844
1845         {
1846                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1847
1848                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1849                         (*s)->gui_selection_changed (srl);
1850                 }
1851         }
1852
1853         if (save_list) {
1854                 _last_selected_routes = *rl;
1855         }
1856
1857         if (gui_selection_did_change) {
1858                 /* actual GUI selection changed */
1859                 set_subview_mode (_subview_mode, first_selected_route());
1860         }
1861 }
1862
1863 framepos_t
1864 MackieControlProtocol::transport_frame() const
1865 {
1866         return session->transport_frame();
1867 }
1868
1869 void
1870 MackieControlProtocol::add_down_select_button (int surface, int strip)
1871 {
1872         _down_select_buttons.insert ((surface<<8)|(strip&0xf));
1873 }
1874
1875 void
1876 MackieControlProtocol::remove_down_select_button (int surface, int strip)
1877 {
1878         DownButtonList::iterator x = find (_down_select_buttons.begin(), _down_select_buttons.end(), (uint32_t) (surface<<8)|(strip&0xf));
1879         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down select buttons\n", surface, strip));
1880         if (x != _down_select_buttons.end()) {
1881                 _down_select_buttons.erase (x);
1882         } else {
1883                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down select buttons\n",
1884                                                                    surface, strip));
1885         }
1886 }
1887
1888 void
1889 MackieControlProtocol::select_range ()
1890 {
1891         RouteList routes;
1892
1893         pull_route_range (_down_select_buttons, routes);
1894
1895         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("select range: found %1 routes\n", routes.size()));
1896
1897         if (!routes.empty()) {
1898                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1899
1900                         if (main_modifier_state() == MODIFIER_CONTROL) {
1901                                 ToggleRouteSelection ((*r)->remote_control_id ());
1902                         } else {
1903                                 if (r == routes.begin()) {
1904                                         SetRouteSelection ((*r)->remote_control_id());
1905                                 } else {
1906                                         AddRouteToSelection ((*r)->remote_control_id());
1907                                 }
1908                         }
1909                 }
1910         }
1911 }
1912
1913 void
1914 MackieControlProtocol::add_down_button (AutomationType a, int surface, int strip)
1915 {
1916         DownButtonMap::iterator m = _down_buttons.find (a);
1917
1918         if (m == _down_buttons.end()) {
1919                 _down_buttons[a] = DownButtonList();
1920         }
1921
1922         _down_buttons[a].insert ((surface<<8)|(strip&0xf));
1923 }
1924
1925 void
1926 MackieControlProtocol::remove_down_button (AutomationType a, int surface, int strip)
1927 {
1928         DownButtonMap::iterator m = _down_buttons.find (a);
1929
1930         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down buttons for %3\n", surface, strip, (int) a));
1931
1932         if (m == _down_buttons.end()) {
1933                 return;
1934         }
1935
1936         DownButtonList& l (m->second);
1937         DownButtonList::iterator x = find (l.begin(), l.end(), (surface<<8)|(strip&0xf));
1938
1939         if (x != l.end()) {
1940                 l.erase (x);
1941         } else {
1942                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down buttons for %3\n",
1943                                                                    surface, strip, (int) a));
1944         }
1945 }
1946
1947 MackieControlProtocol::ControlList
1948 MackieControlProtocol::down_controls (AutomationType p)
1949 {
1950         ControlList controls;
1951         RouteList routes;
1952
1953         DownButtonMap::iterator m = _down_buttons.find (p);
1954
1955         if (m == _down_buttons.end()) {
1956                 return controls;
1957         }
1958
1959         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("looking for down buttons for %1, got %2\n",
1960                                                            p, m->second.size()));
1961
1962         pull_route_range (m->second, routes);
1963
1964         switch (p) {
1965         case GainAutomation:
1966                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1967                         controls.push_back ((*r)->gain_control());
1968                 }
1969                 break;
1970         case SoloAutomation:
1971                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1972                         controls.push_back ((*r)->solo_control());
1973                 }
1974                 break;
1975         case MuteAutomation:
1976                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1977                         controls.push_back ((*r)->mute_control());
1978                 }
1979                 break;
1980         case RecEnableAutomation:
1981                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1982                         boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (*r);
1983                         if (trk) {
1984                                 controls.push_back (trk->rec_enable_control());
1985                         }
1986                 }
1987                 break;
1988         default:
1989                 break;
1990         }
1991
1992         return controls;
1993
1994 }
1995
1996 struct ButtonRangeSorter {
1997     bool operator() (const uint32_t& a, const uint32_t& b) {
1998             return (a>>8) < (b>>8) // a.surface < b.surface
1999                     ||
2000                     ((a>>8) == (b>>8) && (a&0xf) < (b&0xf)); // a.surface == b.surface && a.strip < b.strip
2001     }
2002 };
2003
2004 void
2005 MackieControlProtocol::pull_route_range (DownButtonList& down, RouteList& selected)
2006 {
2007         ButtonRangeSorter cmp;
2008
2009         if (down.empty()) {
2010                 return;
2011         }
2012
2013         list<uint32_t> ldown;
2014         ldown.insert (ldown.end(), down.begin(), down.end());
2015         ldown.sort (cmp);
2016
2017         uint32_t first = ldown.front();
2018         uint32_t last = ldown.back ();
2019
2020         uint32_t first_surface = first>>8;
2021         uint32_t first_strip = first&0xf;
2022
2023         uint32_t last_surface = last>>8;
2024         uint32_t last_strip = last&0xf;
2025
2026         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("PRR %5 in list %1.%2 - %3.%4\n", first_surface, first_strip, last_surface, last_strip,
2027                                                            down.size()));
2028
2029         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2030
2031         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2032
2033                 if ((*s)->number() >= first_surface && (*s)->number() <= last_surface) {
2034
2035                         uint32_t fs;
2036                         uint32_t ls;
2037
2038                         if ((*s)->number() == first_surface) {
2039                                 fs = first_strip;
2040                         } else {
2041                                 fs = 0;
2042                         }
2043
2044                         if ((*s)->number() == last_surface) {
2045                                 ls = last_strip;
2046                                 ls += 1;
2047                         } else {
2048                                 ls = (*s)->n_strips ();
2049                         }
2050
2051                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("adding strips for surface %1 (%2 .. %3)\n",
2052                                                                            (*s)->number(), fs, ls));
2053
2054                         for (uint32_t n = fs; n < ls; ++n) {
2055                                 boost::shared_ptr<Route> r = (*s)->nth_strip (n)->route();
2056                                 if (r) {
2057                                         selected.push_back (r);
2058                                 }
2059                         }
2060                 }
2061         }
2062 }
2063
2064 void
2065 MackieControlProtocol::set_ipmidi_base (int16_t portnum)
2066 {
2067         /* this will not be saved without a session save, so .. */
2068
2069         session->set_dirty ();
2070
2071         _ipmidi_base = portnum;
2072
2073         /* if the current device uses ipMIDI we need
2074            to restart.
2075         */
2076
2077         if (active() && _device_info.uses_ipmidi()) {
2078                 needs_ipmidi_restart = true;
2079         }
2080 }
2081
2082 int
2083 MackieControlProtocol::ipmidi_restart ()
2084 {
2085         clear_surfaces ();
2086         if (create_surfaces ()) {
2087                 return -1;
2088         }
2089         switch_banks (_current_initial_bank, true);
2090         needs_ipmidi_restart = false;
2091         return 0;
2092 }
2093
2094 void
2095 MackieControlProtocol::clear_surfaces ()
2096 {
2097         clear_ports ();
2098
2099         {
2100                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
2101                 _master_surface.reset ();
2102                 surfaces.clear ();
2103         }
2104 }
2105
2106 void
2107 MackieControlProtocol::set_touch_sensitivity (int sensitivity)
2108 {
2109         sensitivity = min (9, sensitivity);
2110         sensitivity = max (0, sensitivity);
2111
2112         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2113
2114         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2115                 (*s)->set_touch_sensitivity (sensitivity);
2116         }
2117 }
2118
2119 void
2120 MackieControlProtocol::recalibrate_faders ()
2121 {
2122         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2123
2124         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2125                 (*s)->recalibrate_faders ();
2126         }
2127 }
2128
2129 void
2130 MackieControlProtocol::toggle_backlight ()
2131 {
2132         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2133
2134         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2135                 (*s)->toggle_backlight ();
2136         }
2137 }
2138
2139 boost::shared_ptr<Surface>
2140 MackieControlProtocol::get_surface_by_raw_pointer (void* ptr) const
2141 {
2142         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2143
2144         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2145                 if ((*s).get() == (Surface*) ptr) {
2146                         return *s;
2147                 }
2148         }
2149
2150         return boost::shared_ptr<Surface> ();
2151 }
2152
2153 boost::shared_ptr<Surface>
2154 MackieControlProtocol::nth_surface (uint32_t n) const
2155 {
2156         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2157
2158         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s, --n) {
2159                 if (n == 0) {
2160                         return *s;
2161                 }
2162         }
2163
2164         return boost::shared_ptr<Surface> ();
2165 }
2166
2167 void
2168 MackieControlProtocol::connection_handler (boost::weak_ptr<ARDOUR::Port> wp1, std::string name1, boost::weak_ptr<ARDOUR::Port> wp2, std::string name2, bool yn)
2169 {
2170         Surfaces scopy;
2171         {
2172                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
2173                 scopy = surfaces;
2174         }
2175
2176         for (Surfaces::const_iterator s = scopy.begin(); s != scopy.end(); ++s) {
2177                 if ((*s)->connection_handler (wp1, name1, wp2, name2, yn)) {
2178                         ConnectionChange (*s);
2179                         break;
2180                 }
2181         }
2182 }
2183
2184 bool
2185 MackieControlProtocol::is_track (boost::shared_ptr<Route> r) const
2186 {
2187         return boost::dynamic_pointer_cast<Track>(r) != 0;
2188 }
2189
2190 bool
2191 MackieControlProtocol::is_audio_track (boost::shared_ptr<Route> r) const
2192 {
2193         return boost::dynamic_pointer_cast<AudioTrack>(r) != 0;
2194 }
2195
2196 bool
2197 MackieControlProtocol::is_midi_track (boost::shared_ptr<Route> r) const
2198 {
2199         return boost::dynamic_pointer_cast<MidiTrack>(r) != 0;
2200 }
2201
2202 bool
2203 MackieControlProtocol::selected (boost::shared_ptr<Route> r) const
2204 {
2205         const RouteNotificationList* rl = &_last_selected_routes;
2206
2207         for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
2208                 boost::shared_ptr<ARDOUR::Route> rt = (*i).lock();
2209                 if (rt == r) {
2210                         return true;
2211                 }
2212         }
2213         return false;
2214 }
2215
2216 bool
2217 MackieControlProtocol::is_hidden (boost::shared_ptr<Route> r) const
2218 {
2219         if (!r) {
2220                 return false;
2221         }
2222         return (((r->remote_control_id()) >>31) != 0);
2223 }
2224
2225 boost::shared_ptr<Route>
2226 MackieControlProtocol::first_selected_route () const
2227 {
2228         if (_last_selected_routes.empty()) {
2229                 return boost::shared_ptr<Route>();
2230         }
2231
2232         boost::shared_ptr<Route> r = _last_selected_routes.front().lock();
2233
2234         return r; /* may be null */
2235 }
2236
2237 boost::shared_ptr<Route>
2238 MackieControlProtocol::subview_route () const
2239 {
2240         return _subview_route;
2241 }
2242
2243 uint32_t
2244 MackieControlProtocol::global_index (Strip& strip)
2245 {
2246         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2247         uint32_t global = 0;
2248
2249         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2250                 if ((*s).get() == strip.surface()) {
2251                         return global + strip.index();
2252                 }
2253                 global += (*s)->n_strips ();
2254         }
2255
2256         return global;
2257 }
2258
2259 void*
2260 MackieControlProtocol::request_factory (uint32_t num_requests)
2261 {
2262         /* AbstractUI<T>::request_buffer_factory() is a template method only
2263            instantiated in this source module. To provide something visible for
2264            use in the interface/descriptor, we have this static method that is
2265            template-free.
2266         */
2267         return request_buffer_factory (num_requests);
2268 }