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/route.h"
  55 #include "ardour/route_group.h"
  56 #include "ardour/session.h"
  57 #include "ardour/tempo.h"
  58 #include "ardour/track.h"
  59 #include "ardour/types.h"
  60 #include "ardour/audioengine.h"
  61
  62 #include "mackie_control_protocol.h"
  63
  64 #include "midi_byte_array.h"
  65 #include "mackie_control_exception.h"
  66 #include "device_profile.h"
  67 #include "surface_port.h"
  68 #include "surface.h"
  69 #include "strip.h"
  70 #include "control_group.h"
  71 #include "meter.h"
  72 #include "button.h"
  73 #include "fader.h"
  74 #include "pot.h"
  75
  76 using namespace ARDOUR;
  77 using namespace std;
  78 using namespace PBD;
  79 using namespace Glib;
  80 using namespace ArdourSurface;
  81 using namespace Mackie;
  82
  83 #include "i18n.h"
  84
  85 #include "pbd/abstract_ui.cc" // instantiate template
  86
  87 const int MackieControlProtocol::MODIFIER_OPTION = 0x1;
  88 const int MackieControlProtocol::MODIFIER_CONTROL = 0x2;
  89 const int MackieControlProtocol::MODIFIER_SHIFT = 0x4;
  90 const int MackieControlProtocol::MODIFIER_CMDALT = 0x8;
  91 const int MackieControlProtocol::MODIFIER_ZOOM = 0x10;
  92 const int MackieControlProtocol::MODIFIER_SCRUB = 0x20;
  93 const int MackieControlProtocol::MAIN_MODIFIER_MASK = (MackieControlProtocol::MODIFIER_OPTION|
  94                                                        MackieControlProtocol::MODIFIER_CONTROL|
  95                                                        MackieControlProtocol::MODIFIER_SHIFT|
  96                                                        MackieControlProtocol::MODIFIER_CMDALT);
  97
  98 MackieControlProtocol* MackieControlProtocol::_instance = 0;
  99
 100 bool MackieControlProtocol::probe()
 101 {
 102         return true;
 103 }
 104
 105 MackieControlProtocol::MackieControlProtocol (Session& session)
 106         : ControlProtocol (session, X_("Mackie"))
 107         , AbstractUI<MackieControlUIRequest> ("mackie")
 108         , _current_initial_bank (0)
 109         , _timecode_type (ARDOUR::AnyTime::BBT)
 110         , _gui (0)
 111         , _scrub_mode (false)
 112         , _flip_mode (Normal)
 113         , _view_mode (Mixer)
 114         , _pot_mode (Pan)
 115         , _current_selected_track (-1)
 116         , _modifier_state (0)
 117         , _ipmidi_base (MIDI::IPMIDIPort::lowest_ipmidi_port_default)
 118         , needs_ipmidi_restart (false)
 119         , _metering_active (true)
 120         , _initialized (false)
 121         , configuration_state (0)
 122         , state_version (0)
 123 {
 124         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
 125
 126         DeviceInfo::reload_device_info ();
 127         DeviceProfile::reload_device_profiles ();
 128
 129         for (int i = 0; i < 9; i++) {
 130                 _last_bank[i] = 0;
 131         }
 132
 133         _last_bank[Mixer] = _current_selected_track;
 134
 135         TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::gui_track_selection_changed, this, _1, true), this);
 136
 137         _instance = this;
 138
 139         build_button_map ();
 140 }
 141
 142 MackieControlProtocol::~MackieControlProtocol()
 143 {
 144         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol init\n");
 145
 146         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 147                 (*si)->reset ();
 148         }
 149
 150         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol drop_connections ()\n");
 151         drop_connections ();
 152
 153         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol tear_down_gui ()\n");
 154         tear_down_gui ();
 155
 156         delete configuration_state;
 157
 158         /* stop event loop */
 159         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol BaseUI::quit ()\n");
 160         BaseUI::quit ();
 161
 162         try {
 163                 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol close()\n");
 164                 close();
 165         }
 166         catch (exception & e) {
 167                 cout << "~MackieControlProtocol caught " << e.what() << endl;
 168         }
 169         catch (...) {
 170                 cout << "~MackieControlProtocol caught unknown" << endl;
 171         }
 172
 173         _instance = 0;
 174
 175         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol done\n");
 176 }
 177
 178 void
 179 MackieControlProtocol::thread_init ()
 180 {
 181         struct sched_param rtparam;
 182
 183         pthread_set_name (X_("MackieControl"));
 184
 185         PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("MackieControl"), 2048);
 186         ARDOUR::SessionEvent::create_per_thread_pool (X_("MackieControl"), 128);
 187
 188         memset (&rtparam, 0, sizeof (rtparam));
 189         rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
 190
 191         if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
 192                 // do we care? not particularly.
 193         }
 194 }
 195
 196 void
 197 MackieControlProtocol::ping_devices ()
 198 {
 199         /* should not be called if surfaces are not connected, but will not
 200          * malfunction if it is.
 201          */
 202
 203         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 204                 (*si)->connected ();
 205         }
 206 }
 207
 208 // go to the previous track.
 209 // Assume that get_sorted_routes().size() > route_table.size()
 210 void
 211 MackieControlProtocol::prev_track()
 212 {
 213         if (_current_initial_bank >= 1) {
 214                 switch_banks (_current_initial_bank - 1);
 215         }
 216 }
 217
 218 // go to the next track.
 219 // Assume that get_sorted_routes().size() > route_table.size()
 220 void
 221 MackieControlProtocol::next_track()
 222 {
 223         Sorted sorted = get_sorted_routes();
 224         if (_current_initial_bank + n_strips() < sorted.size()) {
 225                 switch_banks (_current_initial_bank + 1);
 226         }
 227 }
 228
 229 bool
 230 MackieControlProtocol::route_is_locked_to_strip (boost::shared_ptr<Route> r) const
 231 {
 232         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 233                 if ((*si)->route_is_locked_to_strip (r)) {
 234                         return true;
 235                 }
 236         }
 237         return false;
 238 }
 239
 240 // predicate for sort call in get_sorted_routes
 241 struct RouteByRemoteId
 242 {
 243         bool operator () (const boost::shared_ptr<Route> & a, const boost::shared_ptr<Route> & b) const
 244         {
 245                 return a->remote_control_id() < b->remote_control_id();
 246         }
 247
 248         bool operator () (const Route & a, const Route & b) const
 249         {
 250                 return a.remote_control_id() < b.remote_control_id();
 251         }
 252
 253         bool operator () (const Route * a, const Route * b) const
 254         {
 255                 return a->remote_control_id() < b->remote_control_id();
 256         }
 257 };
 258
 259 MackieControlProtocol::Sorted
 260 MackieControlProtocol::get_sorted_routes()
 261 {
 262         Sorted sorted;
 263
 264         // fetch all routes
 265         boost::shared_ptr<RouteList> routes = session->get_routes();
 266         set<uint32_t> remote_ids;
 267
 268         // routes with remote_id 0 should never be added
 269         // TODO verify this with ardour devs
 270         // remote_ids.insert (0);
 271
 272         // sort in remote_id order, and exclude master, control and hidden routes
 273         // and any routes that are already set.
 274
 275         for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it) {
 276
 277                 boost::shared_ptr<Route> route = *it;
 278
 279                 if (remote_ids.find (route->remote_control_id()) != remote_ids.end()) {
 280                         continue;
 281                 }
 282
 283                 if (route->is_auditioner() || route->is_master() || route->is_monitor()) {
 284                         continue;
 285                 }
 286
 287                 /* don't include locked routes */
 288
 289                 if (route_is_locked_to_strip(route)) {
 290                         continue;
 291                 }
 292
 293                 switch (_view_mode) {
 294                 case Mixer:
 295                         if (route->route_group()) {
 296                                 route->route_group()->set_active (true, this);
 297                         }
 298                         sorted.push_back (route);
 299                         remote_ids.insert (route->remote_control_id());
 300                         break;
 301                 case AudioTracks:
 302                         if (is_audio_track(route)) {
 303                                 if (route->route_group()) {
 304                                         route->route_group()->set_active (true, this);
 305                                 }
 306                                 sorted.push_back (route);
 307                                 remote_ids.insert (route->remote_control_id());
 308                         }
 309                         break;
 310                 case Busses:
 311                         if (!is_track(route)) {
 312                                 if (route->route_group()) {
 313                                         route->route_group()->set_active (true, this);
 314                                 }
 315                                 sorted.push_back (route);
 316                                 remote_ids.insert (route->remote_control_id());
 317                         }
 318                         break;
 319                 case MidiTracks:
 320                         if (is_midi_track(route)) {
 321                                 if (route->route_group()) {
 322                                         route->route_group()->set_active (true, this);
 323                                 }
 324                                 sorted.push_back (route);
 325                                 remote_ids.insert (route->remote_control_id());
 326                         }
 327                         break;
 328                 case Plugins:
 329                         break;
 330                 case Auxes: // for now aux and buss are same
 331                         if (!is_track(route)) {
 332                                 if (route->route_group()) {
 333                                         route->route_group()->set_active (true, this);
 334                                 }
 335                                 sorted.push_back (route);
 336                                 remote_ids.insert (route->remote_control_id());
 337                         }
 338                         break;
 339                 case Selected: // For example: a group
 340                         if (selected(route)) {
 341                                 /* Selected may be a group in which case we want to
 342                                  * control each track separately.
 343                                  */
 344                                 if (route->route_group()) {
 345                                         route->route_group()->set_active (false, this);
 346                                 }
 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         /* reset this to get the right display of view mode after the switch */
 428         display_view_mode ();
 429
 430         /* make sure selection is correct */
 431
 432         _gui_track_selection_changed (&_last_selected_routes, false);
 433
 434         /* current bank has not been saved */
 435         session->set_dirty();
 436 }
 437
 438 int
 439 MackieControlProtocol::set_active (bool yn)
 440 {
 441         DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active init with yn: '%1'\n", yn));
 442
 443         if (yn == active()) {
 444                 return 0;
 445         }
 446
 447         if (yn) {
 448
 449                 /* start event loop */
 450
 451                 BaseUI::run ();
 452
 453                 connect_session_signals ();
 454
 455                 if (!_device_info.name().empty()) {
 456                         set_device (_device_info.name(), true);
 457                 }
 458
 459                 /* set up periodic task for metering and automation
 460                  */
 461
 462                 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
 463                 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
 464                 periodic_timeout->attach (main_loop()->get_context());
 465
 466                 /* a faster periodic task used to display parameter updates */
 467
 468                 Glib::RefPtr<Glib::TimeoutSource> redisplay_timeout = Glib::TimeoutSource::create (10); // milliseconds
 469                 redisplay_connection = redisplay_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::redisplay));
 470                 redisplay_timeout->attach (main_loop()->get_context());
 471
 472         } else {
 473
 474                 BaseUI::quit ();
 475                 close ();
 476
 477         }
 478
 479         ControlProtocol::set_active (yn);
 480
 481         DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active done with yn: '%1'\n", yn));
 482
 483         return 0;
 484 }
 485
 486 bool
 487 MackieControlProtocol::hui_heartbeat ()
 488 {
 489         Glib::Threads::Mutex::Lock lm (surfaces_lock);
 490
 491         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 492                 (*s)->hui_heartbeat ();
 493         }
 494
 495         return true;
 496 }
 497
 498 bool
 499 MackieControlProtocol::periodic ()
 500 {
 501         if (!active()) {
 502                 return false;
 503         }
 504
 505         if (needs_ipmidi_restart) {
 506                 ipmidi_restart ();
 507                 return true;
 508         }
 509
 510         if (!_initialized) {
 511                 initialize();
 512         }
 513
 514         ARDOUR::microseconds_t now_usecs = ARDOUR::get_microseconds ();
 515
 516         {
 517                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 518
 519                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 520                         (*s)->periodic (now_usecs);
 521                 }
 522         }
 523
 524         update_timecode_display ();
 525
 526         return true;
 527 }
 528
 529 bool
 530 MackieControlProtocol::redisplay ()
 531 {
 532         if (!active()) {
 533                 return false;
 534         }
 535
 536         if (needs_ipmidi_restart) {
 537                 ipmidi_restart ();
 538                 return true;
 539         }
 540
 541         if (!_initialized) {
 542                 initialize();
 543         }
 544
 545         ARDOUR::microseconds_t now = ARDOUR::get_microseconds ();
 546
 547         {
 548                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 549
 550                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 551                         (*s)->redisplay (now);
 552                 }
 553         }
 554
 555         return true;
 556 }
 557
 558 void
 559 MackieControlProtocol::update_timecode_beats_led()
 560 {
 561         if (!_device_info.has_timecode_display()) {
 562                 return;
 563         }
 564
 565         DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::update_timecode_beats_led(): %1\n", _timecode_type));
 566         switch (_timecode_type) {
 567                 case ARDOUR::AnyTime::BBT:
 568                         update_global_led (Led::Beats, on);
 569                         update_global_led (Led::Timecode, off);
 570                         break;
 571                 case ARDOUR::AnyTime::Timecode:
 572                         update_global_led (Led::Timecode, on);
 573                         update_global_led (Led::Beats, off);
 574                         break;
 575                 default:
 576                         ostringstream os;
 577                         os << "Unknown Anytime::Type " << _timecode_type;
 578                         throw runtime_error (os.str());
 579         }
 580 }
 581
 582 void
 583 MackieControlProtocol::update_global_button (int id, LedState ls)
 584 {
 585         boost::shared_ptr<Surface> surface;
 586
 587         {
 588                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 589
 590                 if (surfaces.empty()) {
 591                         return;
 592                 }
 593
 594                 if (!_device_info.has_global_controls()) {
 595                         return;
 596                 }
 597                 // surface needs to be master surface
 598                 surface = _master_surface;
 599         }
 600
 601         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
 602         if (x != surface->controls_by_device_independent_id.end()) {
 603                 Button * button = dynamic_cast<Button*> (x->second);
 604                 surface->write (button->set_state (ls));
 605         } else {
 606                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", id));
 607         }
 608 }
 609
 610 void
 611 MackieControlProtocol::update_global_led (int id, LedState ls)
 612 {
 613         Glib::Threads::Mutex::Lock lm (surfaces_lock);
 614
 615         if (surfaces.empty()) {
 616                 return;
 617         }
 618
 619         if (!_device_info.has_global_controls()) {
 620                 return;
 621         }
 622         boost::shared_ptr<Surface> surface = _master_surface;
 623
 624         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
 625
 626         if (x != surface->controls_by_device_independent_id.end()) {
 627                 Led * led = dynamic_cast<Led*> (x->second);
 628                 DEBUG_TRACE (DEBUG::MackieControl, "Writing LedState\n");
 629                 surface->write (led->set_state (ls));
 630         } else {
 631                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", id));
 632         }
 633 }
 634
 635 void
 636 MackieControlProtocol::device_ready ()
 637 {
 638         /* this is not required to be called, but for devices which do
 639          * handshaking, it can be called once the device has verified the
 640          * connection.
 641          */
 642
 643         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("device ready init (active=%1)\n", active()));
 644         update_surfaces ();
 645         set_pot_mode (_pot_mode);
 646 }
 647
 648 // send messages to surface to set controls to correct values
 649 void
 650 MackieControlProtocol::update_surfaces()
 651 {
 652         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::update_surfaces() init (active=%1)\n", active()));
 653         if (!active()) {
 654                 return;
 655         }
 656
 657         // do the initial bank switch to connect signals
 658         // _current_initial_bank is initialised by set_state
 659         switch_banks (_current_initial_bank, true);
 660
 661         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::update_surfaces() finished\n");
 662 }
 663
 664 void
 665 MackieControlProtocol::initialize()
 666 {
 667         {
 668                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 669
 670                 if (surfaces.empty()) {
 671                         return;
 672                 }
 673
 674                 if (!_master_surface->active ()) {
 675                         return;
 676                 }
 677
 678                 // sometimes the jog wheel is a pot
 679                 if (_device_info.has_jog_wheel()) {
 680                         _master_surface->blank_jog_ring ();
 681                 }
 682         }
 683
 684         // update global buttons and displays
 685
 686         notify_record_state_changed();
 687         notify_transport_state_changed();
 688         update_timecode_beats_led();
 689
 690         _initialized = true;
 691 }
 692
 693 void
 694 MackieControlProtocol::connect_session_signals()
 695 {
 696         // receive routes added
 697         session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_route_added, this, _1), this);
 698         // receive record state toggled
 699         session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_record_state_changed, this), this);
 700         // receive transport state changed
 701         session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
 702         session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
 703         // receive punch-in and punch-out
 704         Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
 705         session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
 706         // receive rude solo changed
 707         session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), 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
1147         switch (_timecode_type) {
1148         case ARDOUR::AnyTime::BBT:
1149                 timecode = format_bbt_timecode (current_frame);
1150                 break;
1151         case ARDOUR::AnyTime::Timecode:
1152                 timecode = format_timecode_timecode (current_frame);
1153                 break;
1154         default:
1155                 return;
1156         }
1157
1158         // only write the timecode string to the MCU if it's changed
1159         // since last time. This is to reduce midi bandwidth used.
1160         if (timecode != _timecode_last) {
1161                 surface->display_timecode (timecode, _timecode_last);
1162                 _timecode_last = timecode;
1163         }
1164 }
1165
1166 ///////////////////////////////////////////
1167 // Session signals
1168 ///////////////////////////////////////////
1169
1170 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
1171 {
1172         if (p == "punch-in") {
1173                 // no such button right now
1174                 // update_global_button (Button::PunchIn, session->config.get_punch_in());
1175         } else if (p == "punch-out") {
1176                 // no such button right now
1177                 // update_global_button (Button::PunchOut, session->config.get_punch_out());
1178         } else if (p == "clicking") {
1179                 update_global_button (Button::Click, Config->get_clicking());
1180         } else {
1181                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
1182         }
1183 }
1184
1185 // RouteList is the set of routes that have just been added
1186 void
1187 MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
1188 {
1189         {
1190                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1191
1192                 if (surfaces.empty()) {
1193                         return;
1194                 }
1195         }
1196
1197         // currently assigned banks are less than the full set of
1198         // strips, so activate the new strip now.
1199
1200         refresh_current_bank();
1201
1202         // otherwise route added, but current bank needs no updating
1203
1204         // make sure remote id changes in the new route are handled
1205         typedef ARDOUR::RouteList ARS;
1206
1207         for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
1208                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
1209         }
1210 }
1211
1212 void
1213 MackieControlProtocol::notify_solo_active_changed (bool active)
1214 {
1215         boost::shared_ptr<Surface> surface;
1216
1217         {
1218                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1219
1220                 if (surfaces.empty()) {
1221                         return;
1222                 }
1223
1224                 surface = _master_surface;
1225         }
1226
1227         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Led::RudeSolo);
1228         if (x != surface->controls_by_device_independent_id.end()) {
1229                 Led* rude_solo = dynamic_cast<Led*> (x->second);
1230                 if (rude_solo) {
1231                         surface->write (rude_solo->set_state (active ? flashing : off));
1232                 }
1233         }
1234 }
1235
1236 void
1237 MackieControlProtocol::notify_remote_id_changed()
1238 {
1239         {
1240                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1241
1242                 if (surfaces.empty()) {
1243                         return;
1244                 }
1245         }
1246
1247         Sorted sorted = get_sorted_routes();
1248         uint32_t sz = n_strips();
1249
1250         // if a remote id has been moved off the end, we need to shift
1251         // the current bank backwards.
1252
1253         if (sorted.size() - _current_initial_bank < sz) {
1254                 // but don't shift backwards past the zeroth channel
1255                 switch_banks (max((Sorted::size_type) 0, sorted.size() - sz));
1256         } else {
1257                 // Otherwise just refresh the current bank
1258                 refresh_current_bank();
1259         }
1260 }
1261
1262 ///////////////////////////////////////////
1263 // Transport signals
1264 ///////////////////////////////////////////
1265
1266 void
1267 MackieControlProtocol::notify_loop_state_changed()
1268 {
1269         update_global_button (Button::Loop, session->get_play_loop());
1270 }
1271
1272 void
1273 MackieControlProtocol::notify_transport_state_changed()
1274 {
1275         if (!_device_info.has_global_controls()) {
1276                 return;
1277         }
1278
1279         // switch various play and stop buttons on / off
1280         update_global_button (Button::Loop, session->get_play_loop());
1281         update_global_button (Button::Play, session->transport_speed() == 1.0);
1282         update_global_button (Button::Stop, session->transport_stopped ());
1283         update_global_button (Button::Rewind, session->transport_speed() < 0.0);
1284         update_global_button (Button::Ffwd, session->transport_speed() > 1.0);
1285
1286         notify_metering_state_changed ();
1287 }
1288
1289 void
1290 MackieControlProtocol::notify_metering_state_changed()
1291 {
1292         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1293
1294         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1295                 (*s)->notify_metering_state_changed ();
1296         }
1297 }
1298
1299 void
1300 MackieControlProtocol::notify_record_state_changed ()
1301 {
1302         if (!_device_info.has_global_controls()) {
1303                 return;
1304         }
1305
1306         boost::shared_ptr<Surface> surface;
1307
1308         {
1309                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1310                 if (surfaces.empty()) {
1311                         return;
1312                 }
1313                 surface = _master_surface;
1314         }
1315
1316         /* rec is a tristate */
1317
1318         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Button::Record);
1319         if (x != surface->controls_by_device_independent_id.end()) {
1320                 Button * rec = dynamic_cast<Button*> (x->second);
1321                 if (rec) {
1322                         LedState ls;
1323
1324                         switch (session->record_status()) {
1325                         case Session::Disabled:
1326                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to disabled, LED off\n");
1327                                 ls = off;
1328                                 break;
1329                         case Session::Recording:
1330                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to recording, LED on\n");
1331                                 ls = on;
1332                                 break;
1333                         case Session::Enabled:
1334                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to enabled, LED flashing\n");
1335                                 ls = flashing;
1336                                 break;
1337                         }
1338
1339                         surface->write (rec->set_state (ls));
1340                 }
1341         }
1342 }
1343
1344 list<boost::shared_ptr<ARDOUR::Bundle> >
1345 MackieControlProtocol::bundles ()
1346 {
1347         list<boost::shared_ptr<ARDOUR::Bundle> > b;
1348
1349         if (_input_bundle) {
1350                 b.push_back (_input_bundle);
1351                 b.push_back (_output_bundle);
1352         }
1353
1354         return b;
1355 }
1356
1357 void
1358 MackieControlProtocol::do_request (MackieControlUIRequest* req)
1359 {
1360         if (req->type == CallSlot) {
1361
1362                 call_slot (MISSING_INVALIDATOR, req->the_slot);
1363
1364         } else if (req->type == Quit) {
1365
1366                 stop ();
1367         }
1368 }
1369
1370 int
1371 MackieControlProtocol::stop ()
1372 {
1373         BaseUI::quit ();
1374
1375         return 0;
1376 }
1377
1378 void
1379 MackieControlProtocol::update_led (Surface& surface, Button& button, Mackie::LedState ls)
1380 {
1381         if (ls != none) {
1382                 surface.port().write (button.set_state (ls));
1383         }
1384 }
1385
1386 void
1387 MackieControlProtocol::build_button_map ()
1388 {
1389         /* this maps our device-independent button codes to the methods that handle them.
1390          */
1391
1392 #define DEFINE_BUTTON_HANDLER(b,p,r) button_map.insert (pair<Button::ID,ButtonHandlers> ((b), ButtonHandlers ((p),(r))));
1393
1394         DEFINE_BUTTON_HANDLER (Button::Track, &MackieControlProtocol::track_press, &MackieControlProtocol::track_release);
1395         DEFINE_BUTTON_HANDLER (Button::Send, &MackieControlProtocol::send_press, &MackieControlProtocol::send_release);
1396         DEFINE_BUTTON_HANDLER (Button::Pan, &MackieControlProtocol::pan_press, &MackieControlProtocol::pan_release);
1397         DEFINE_BUTTON_HANDLER (Button::Plugin, &MackieControlProtocol::plugin_press, &MackieControlProtocol::plugin_release);
1398         DEFINE_BUTTON_HANDLER (Button::Eq, &MackieControlProtocol::eq_press, &MackieControlProtocol::eq_release);
1399         DEFINE_BUTTON_HANDLER (Button::Dyn, &MackieControlProtocol::dyn_press, &MackieControlProtocol::dyn_release);
1400         DEFINE_BUTTON_HANDLER (Button::Left, &MackieControlProtocol::left_press, &MackieControlProtocol::left_release);
1401         DEFINE_BUTTON_HANDLER (Button::Right, &MackieControlProtocol::right_press, &MackieControlProtocol::right_release);
1402         DEFINE_BUTTON_HANDLER (Button::ChannelLeft, &MackieControlProtocol::channel_left_press, &MackieControlProtocol::channel_left_release);
1403         DEFINE_BUTTON_HANDLER (Button::ChannelRight, &MackieControlProtocol::channel_right_press, &MackieControlProtocol::channel_right_release);
1404         DEFINE_BUTTON_HANDLER (Button::Flip, &MackieControlProtocol::flip_press, &MackieControlProtocol::flip_release);
1405         DEFINE_BUTTON_HANDLER (Button::View, &MackieControlProtocol::view_press, &MackieControlProtocol::view_release);
1406         DEFINE_BUTTON_HANDLER (Button::NameValue, &MackieControlProtocol::name_value_press, &MackieControlProtocol::name_value_release);
1407         DEFINE_BUTTON_HANDLER (Button::TimecodeBeats, &MackieControlProtocol::timecode_beats_press, &MackieControlProtocol::timecode_beats_release);
1408         DEFINE_BUTTON_HANDLER (Button::F1, &MackieControlProtocol::F1_press, &MackieControlProtocol::F1_release);
1409         DEFINE_BUTTON_HANDLER (Button::F2, &MackieControlProtocol::F2_press, &MackieControlProtocol::F2_release);
1410         DEFINE_BUTTON_HANDLER (Button::F3, &MackieControlProtocol::F3_press, &MackieControlProtocol::F3_release);
1411         DEFINE_BUTTON_HANDLER (Button::F4, &MackieControlProtocol::F4_press, &MackieControlProtocol::F4_release);
1412         DEFINE_BUTTON_HANDLER (Button::F5, &MackieControlProtocol::F5_press, &MackieControlProtocol::F5_release);
1413         DEFINE_BUTTON_HANDLER (Button::F6, &MackieControlProtocol::F6_press, &MackieControlProtocol::F6_release);
1414         DEFINE_BUTTON_HANDLER (Button::F7, &MackieControlProtocol::F7_press, &MackieControlProtocol::F7_release);
1415         DEFINE_BUTTON_HANDLER (Button::F8, &MackieControlProtocol::F8_press, &MackieControlProtocol::F8_release);
1416         DEFINE_BUTTON_HANDLER (Button::MidiTracks, &MackieControlProtocol::miditracks_press, &MackieControlProtocol::miditracks_release);
1417         DEFINE_BUTTON_HANDLER (Button::Inputs, &MackieControlProtocol::inputs_press, &MackieControlProtocol::inputs_release);
1418         DEFINE_BUTTON_HANDLER (Button::AudioTracks, &MackieControlProtocol::audiotracks_press, &MackieControlProtocol::audiotracks_release);
1419         DEFINE_BUTTON_HANDLER (Button::AudioInstruments, &MackieControlProtocol::audioinstruments_press, &MackieControlProtocol::audioinstruments_release);
1420         DEFINE_BUTTON_HANDLER (Button::Aux, &MackieControlProtocol::aux_press, &MackieControlProtocol::aux_release);
1421         DEFINE_BUTTON_HANDLER (Button::Busses, &MackieControlProtocol::busses_press, &MackieControlProtocol::busses_release);
1422         DEFINE_BUTTON_HANDLER (Button::Outputs, &MackieControlProtocol::outputs_press, &MackieControlProtocol::outputs_release);
1423         DEFINE_BUTTON_HANDLER (Button::User, &MackieControlProtocol::user_press, &MackieControlProtocol::user_release);
1424         DEFINE_BUTTON_HANDLER (Button::Shift, &MackieControlProtocol::shift_press, &MackieControlProtocol::shift_release);
1425         DEFINE_BUTTON_HANDLER (Button::Option, &MackieControlProtocol::option_press, &MackieControlProtocol::option_release);
1426         DEFINE_BUTTON_HANDLER (Button::Ctrl, &MackieControlProtocol::control_press, &MackieControlProtocol::control_release);
1427         DEFINE_BUTTON_HANDLER (Button::CmdAlt, &MackieControlProtocol::cmd_alt_press, &MackieControlProtocol::cmd_alt_release);
1428         DEFINE_BUTTON_HANDLER (Button::Read, &MackieControlProtocol::read_press, &MackieControlProtocol::read_release);
1429         DEFINE_BUTTON_HANDLER (Button::Write, &MackieControlProtocol::write_press, &MackieControlProtocol::write_release);
1430         DEFINE_BUTTON_HANDLER (Button::Trim, &MackieControlProtocol::trim_press, &MackieControlProtocol::trim_release);
1431         DEFINE_BUTTON_HANDLER (Button::Touch, &MackieControlProtocol::touch_press, &MackieControlProtocol::touch_release);
1432         DEFINE_BUTTON_HANDLER (Button::Latch, &MackieControlProtocol::latch_press, &MackieControlProtocol::latch_release);
1433         DEFINE_BUTTON_HANDLER (Button::Grp, &MackieControlProtocol::grp_press, &MackieControlProtocol::grp_release);
1434         DEFINE_BUTTON_HANDLER (Button::Save, &MackieControlProtocol::save_press, &MackieControlProtocol::save_release);
1435         DEFINE_BUTTON_HANDLER (Button::Undo, &MackieControlProtocol::undo_press, &MackieControlProtocol::undo_release);
1436         DEFINE_BUTTON_HANDLER (Button::Cancel, &MackieControlProtocol::cancel_press, &MackieControlProtocol::cancel_release);
1437         DEFINE_BUTTON_HANDLER (Button::Enter, &MackieControlProtocol::enter_press, &MackieControlProtocol::enter_release);
1438         DEFINE_BUTTON_HANDLER (Button::Marker, &MackieControlProtocol::marker_press, &MackieControlProtocol::marker_release);
1439         DEFINE_BUTTON_HANDLER (Button::Nudge, &MackieControlProtocol::nudge_press, &MackieControlProtocol::nudge_release);
1440         DEFINE_BUTTON_HANDLER (Button::Loop, &MackieControlProtocol::loop_press, &MackieControlProtocol::loop_release);
1441         DEFINE_BUTTON_HANDLER (Button::Drop, &MackieControlProtocol::drop_press, &MackieControlProtocol::drop_release);
1442         DEFINE_BUTTON_HANDLER (Button::Replace, &MackieControlProtocol::replace_press, &MackieControlProtocol::replace_release);
1443         DEFINE_BUTTON_HANDLER (Button::Click, &MackieControlProtocol::click_press, &MackieControlProtocol::click_release);
1444         DEFINE_BUTTON_HANDLER (Button::ClearSolo, &MackieControlProtocol::clearsolo_press, &MackieControlProtocol::clearsolo_release);
1445         DEFINE_BUTTON_HANDLER (Button::Rewind, &MackieControlProtocol::rewind_press, &MackieControlProtocol::rewind_release);
1446         DEFINE_BUTTON_HANDLER (Button::Ffwd, &MackieControlProtocol::ffwd_press, &MackieControlProtocol::ffwd_release);
1447         DEFINE_BUTTON_HANDLER (Button::Stop, &MackieControlProtocol::stop_press, &MackieControlProtocol::stop_release);
1448         DEFINE_BUTTON_HANDLER (Button::Play, &MackieControlProtocol::play_press, &MackieControlProtocol::play_release);
1449         DEFINE_BUTTON_HANDLER (Button::Record, &MackieControlProtocol::record_press, &MackieControlProtocol::record_release);
1450         DEFINE_BUTTON_HANDLER (Button::CursorUp, &MackieControlProtocol::cursor_up_press, &MackieControlProtocol::cursor_up_release);
1451         DEFINE_BUTTON_HANDLER (Button::CursorDown, &MackieControlProtocol::cursor_down_press, &MackieControlProtocol::cursor_down_release);
1452         DEFINE_BUTTON_HANDLER (Button::CursorLeft, &MackieControlProtocol::cursor_left_press, &MackieControlProtocol::cursor_left_release);
1453         DEFINE_BUTTON_HANDLER (Button::CursorRight, &MackieControlProtocol::cursor_right_press, &MackieControlProtocol::cursor_right_release);
1454         DEFINE_BUTTON_HANDLER (Button::Zoom, &MackieControlProtocol::zoom_press, &MackieControlProtocol::zoom_release);
1455         DEFINE_BUTTON_HANDLER (Button::Scrub, &MackieControlProtocol::scrub_press, &MackieControlProtocol::scrub_release);
1456         DEFINE_BUTTON_HANDLER (Button::UserA, &MackieControlProtocol::user_a_press, &MackieControlProtocol::user_a_release);
1457         DEFINE_BUTTON_HANDLER (Button::UserB, &MackieControlProtocol::user_b_press, &MackieControlProtocol::user_b_release);
1458         DEFINE_BUTTON_HANDLER (Button::MasterFaderTouch, &MackieControlProtocol::master_fader_touch_press, &MackieControlProtocol::master_fader_touch_release);
1459
1460 }
1461
1462 void
1463 MackieControlProtocol::handle_button_event (Surface& surface, Button& button, ButtonState bs)
1464 {
1465         Button::ID button_id = button.bid();
1466
1467         if  (bs != press && bs != release) {
1468                 update_led (surface, button, none);
1469                 return;
1470         }
1471
1472         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2 (%3)\n", (bs == press ? "press" : "release"), button.id(),
1473                                                            Button::id_to_name (button.bid())));
1474
1475         /* check profile first */
1476
1477         string action = _device_profile.get_button_action (button.bid(), _modifier_state);
1478
1479         if (!action.empty()) {
1480
1481                 if (action.find ('/') != string::npos) { /* good chance that this is really an action */
1482
1483                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Looked up action for button %1 with modifier %2, got [%3]\n",
1484                                                                            button.bid(), _modifier_state, action));
1485
1486                         /* if there is a bound action for this button, and this is a press event,
1487                            carry out the action. If its a release event, do nothing since we
1488                            don't bind to them at all but don't want any other handling to
1489                            occur either.
1490                         */
1491                         if (bs == press) {
1492                                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("executing action %1\n", action));
1493                                 access_action (action);
1494                         }
1495
1496                         return;
1497
1498                 } else {
1499
1500                         /* "action" is more likely to be a button name. We use this to
1501                          * allow remapping buttons to different (builtin) functionality
1502                          * associated with an existing button. This is similar to the
1503                          * way that (for example) Nuendo moves the "Shift" function to
1504                          * the "Enter" key of the MCU Pro.
1505                          */
1506
1507                         int bid = Button::name_to_id (action);
1508
1509                         if (bid < 0) {
1510                                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("apparent button name %1 not found\n", action));
1511                                 return;
1512                         }
1513
1514                         button_id = (Button::ID) bid;
1515                         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)));
1516                 }
1517         }
1518
1519         /* lookup using the device-INDEPENDENT button ID */
1520
1521         ButtonMap::iterator b = button_map.find (button_id);
1522
1523         if (b != button_map.end()) {
1524
1525                 ButtonHandlers& bh (b->second);
1526
1527                 switch  (bs) {
1528                 case press:
1529                         surface.write (button.set_state ((this->*(bh.press)) (button)));
1530                         break;
1531                 case release:
1532                         surface.write (button.set_state ((this->*(bh.release)) (button)));
1533                         break;
1534                 default:
1535                         break;
1536                 }
1537         } else {
1538                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1539                                                                    button.bid(), button.id()));
1540                 error << string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1541                                          button.bid(), button.id()) << endmsg;
1542         }
1543 }
1544
1545 bool
1546 MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
1547 {
1548         if (ioc & ~IO_IN) {
1549                 DEBUG_TRACE (DEBUG::MackieControl, "MIDI port closed\n");
1550                 return false;
1551         }
1552
1553         if (ioc & IO_IN) {
1554
1555                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("something happend on  %1\n", port->name()));
1556
1557                 /* Devices using regular JACK MIDI ports will need to have
1558                    the x-thread FIFO drained to avoid burning endless CPU.
1559
1560                    Devices using ipMIDI have port->selectable() as the same
1561                    file descriptor that data arrives on, so doing this
1562                    for them will simply throw all incoming data away.
1563                 */
1564
1565                 if (!_device_info.uses_ipmidi()) {
1566                         AsyncMIDIPort* asp = dynamic_cast<AsyncMIDIPort*>(port);
1567                         if (asp) {
1568                                 asp->clear ();
1569                         }
1570                 }
1571
1572                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("data available on %1\n", port->name()));
1573                 framepos_t now = session->engine().sample_time();
1574                 port->parse (now);
1575         }
1576
1577         return true;
1578 }
1579
1580 void
1581 MackieControlProtocol::clear_ports ()
1582 {
1583         if (_input_bundle) {
1584                 _input_bundle->remove_channels ();
1585                 _output_bundle->remove_channels ();
1586         }
1587 }
1588
1589 void
1590 MackieControlProtocol::set_view_mode (ViewMode m)
1591 {
1592         _last_bank[_view_mode] = _current_initial_bank;
1593
1594         _view_mode = m;
1595
1596         switch_banks(_last_bank[_view_mode], true);
1597 }
1598
1599 void
1600 MackieControlProtocol::display_view_mode ()
1601 {
1602         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1603
1604         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1605                 (*s)->update_view_mode_display ();
1606         }
1607
1608 }
1609
1610 void
1611 MackieControlProtocol::set_flip_mode (FlipMode fm)
1612 {
1613         if (_flip_mode != fm) {
1614                 if (fm == Normal) {
1615                         update_global_button (Button::Flip, off);
1616                 } else {
1617                         update_global_button (Button::Flip, on);
1618                 }
1619
1620                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1621
1622                 _flip_mode = fm;
1623
1624                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1625                         (*s)->update_flip_mode_display ();
1626                 }
1627         }
1628 }
1629
1630 void
1631 MackieControlProtocol::set_pot_mode (PotMode m)
1632 {
1633         // maybe not in flip mode.
1634         if (flip_mode()) {
1635                 return;
1636         }
1637         _pot_mode = m;
1638
1639         {
1640                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1641
1642                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1643                         (*s)->update_potmode ();
1644
1645                 }
1646         }
1647
1648         switch (_pot_mode) {
1649         case Trim:
1650                 update_global_button (Button::Track, on);
1651                 update_global_button (Button::Send, off);
1652                 update_global_button (Button::Pan, off);
1653                 break;
1654         case Send:
1655                 update_global_button (Button::Track, off);
1656                 update_global_button (Button::Send, on);
1657                 update_global_button (Button::Pan, off);
1658                 break;
1659         case Pan:
1660                 update_global_button (Button::Track, off);
1661                 update_global_button (Button::Send, off);
1662                 update_global_button (Button::Pan, on);
1663         };
1664 }
1665
1666 void
1667 MackieControlProtocol::set_master_on_surface_strip (uint32_t surface, uint32_t strip_number)
1668 {
1669         force_special_route_to_strip (session->master_out(), surface, strip_number);
1670 }
1671
1672 void
1673 MackieControlProtocol::set_monitor_on_surface_strip (uint32_t surface, uint32_t strip_number)
1674 {
1675         force_special_route_to_strip (session->monitor_out(), surface, strip_number);
1676 }
1677
1678 void
1679 MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r, uint32_t surface, uint32_t strip_number)
1680 {
1681         if (!r) {
1682                 return;
1683         }
1684
1685         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1686
1687         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1688                 if ((*s)->number() == surface) {
1689                         Strip* strip = (*s)->nth_strip (strip_number);
1690                         if (strip) {
1691                                 strip->set_route (session->master_out());
1692                                 strip->lock_controls ();
1693                         }
1694                 }
1695         }
1696 }
1697
1698 void
1699 MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl, bool save_list)
1700 {
1701         _gui_track_selection_changed (rl.get(), save_list);
1702 }
1703
1704 void
1705 MackieControlProtocol::_gui_track_selection_changed (ARDOUR::RouteNotificationList* rl, bool save_list)
1706 {
1707         /* We need to keep a list of the most recently selected routes around,
1708            but we are not allowed to keep shared_ptr<Route> unless we want to
1709            handle the complexities of route deletion. So instead, the GUI sends
1710            us a notification using weak_ptr<Route>, which we keep a copy
1711            of. For efficiency's sake, however, we convert the weak_ptr's into
1712            shared_ptr<Route> before passing them to however many surfaces (and
1713            thus strips) that we have.
1714         */
1715
1716         StrongRouteNotificationList srl;
1717
1718         for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
1719                 boost::shared_ptr<ARDOUR::Route> r = (*i).lock();
1720                 if (r) {
1721                         srl.push_back (r);
1722                 }
1723         }
1724
1725         {
1726                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1727
1728                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1729                         (*s)->gui_selection_changed (srl);
1730                 }
1731         }
1732
1733         if (save_list) {
1734                 _last_selected_routes = *rl;
1735         }
1736 }
1737
1738 framepos_t
1739 MackieControlProtocol::transport_frame() const
1740 {
1741         return session->transport_frame();
1742 }
1743
1744 void
1745 MackieControlProtocol::add_down_select_button (int surface, int strip)
1746 {
1747         _down_select_buttons.insert ((surface<<8)|(strip&0xf));
1748 }
1749
1750 void
1751 MackieControlProtocol::remove_down_select_button (int surface, int strip)
1752 {
1753         DownButtonList::iterator x = find (_down_select_buttons.begin(), _down_select_buttons.end(), (uint32_t) (surface<<8)|(strip&0xf));
1754         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down select buttons\n", surface, strip));
1755         if (x != _down_select_buttons.end()) {
1756                 _down_select_buttons.erase (x);
1757         } else {
1758                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down select buttons\n",
1759                                                                    surface, strip));
1760         }
1761 }
1762
1763 void
1764 MackieControlProtocol::select_range ()
1765 {
1766         RouteList routes;
1767
1768         pull_route_range (_down_select_buttons, routes);
1769
1770         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("select range: found %1 routes\n", routes.size()));
1771
1772         if (!routes.empty()) {
1773                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1774
1775                         if (main_modifier_state() == MODIFIER_CONTROL) {
1776                                 ToggleRouteSelection ((*r)->remote_control_id ());
1777                         } else {
1778                                 if (r == routes.begin()) {
1779                                         SetRouteSelection ((*r)->remote_control_id());
1780                                 } else {
1781                                         AddRouteToSelection ((*r)->remote_control_id());
1782                                 }
1783                         }
1784                 }
1785         }
1786 }
1787
1788 void
1789 MackieControlProtocol::add_down_button (AutomationType a, int surface, int strip)
1790 {
1791         DownButtonMap::iterator m = _down_buttons.find (a);
1792
1793         if (m == _down_buttons.end()) {
1794                 _down_buttons[a] = DownButtonList();
1795         }
1796
1797         _down_buttons[a].insert ((surface<<8)|(strip&0xf));
1798 }
1799
1800 void
1801 MackieControlProtocol::remove_down_button (AutomationType a, int surface, int strip)
1802 {
1803         DownButtonMap::iterator m = _down_buttons.find (a);
1804
1805         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down buttons for %3\n", surface, strip, (int) a));
1806
1807         if (m == _down_buttons.end()) {
1808                 return;
1809         }
1810
1811         DownButtonList& l (m->second);
1812         DownButtonList::iterator x = find (l.begin(), l.end(), (surface<<8)|(strip&0xf));
1813
1814         if (x != l.end()) {
1815                 l.erase (x);
1816         } else {
1817                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down buttons for %3\n",
1818                                                                    surface, strip, (int) a));
1819         }
1820 }
1821
1822 MackieControlProtocol::ControlList
1823 MackieControlProtocol::down_controls (AutomationType p)
1824 {
1825         ControlList controls;
1826         RouteList routes;
1827
1828         DownButtonMap::iterator m = _down_buttons.find (p);
1829
1830         if (m == _down_buttons.end()) {
1831                 return controls;
1832         }
1833
1834         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("looking for down buttons for %1, got %2\n",
1835                                                            p, m->second.size()));
1836
1837         pull_route_range (m->second, routes);
1838
1839         switch (p) {
1840         case GainAutomation:
1841                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1842                         controls.push_back ((*r)->gain_control());
1843                 }
1844                 break;
1845         case SoloAutomation:
1846                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1847                         controls.push_back ((*r)->solo_control());
1848                 }
1849                 break;
1850         case MuteAutomation:
1851                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1852                         controls.push_back ((*r)->mute_control());
1853                 }
1854                 break;
1855         case RecEnableAutomation:
1856                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1857                         boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (*r);
1858                         if (trk) {
1859                                 controls.push_back (trk->rec_enable_control());
1860                         }
1861                 }
1862                 break;
1863         default:
1864                 break;
1865         }
1866
1867         return controls;
1868
1869 }
1870
1871 struct ButtonRangeSorter {
1872     bool operator() (const uint32_t& a, const uint32_t& b) {
1873             return (a>>8) < (b>>8) // a.surface < b.surface
1874                     ||
1875                     ((a>>8) == (b>>8) && (a&0xf) < (b&0xf)); // a.surface == b.surface && a.strip < b.strip
1876     }
1877 };
1878
1879 void
1880 MackieControlProtocol::pull_route_range (DownButtonList& down, RouteList& selected)
1881 {
1882         ButtonRangeSorter cmp;
1883
1884         if (down.empty()) {
1885                 return;
1886         }
1887
1888         list<uint32_t> ldown;
1889         ldown.insert (ldown.end(), down.begin(), down.end());
1890         ldown.sort (cmp);
1891
1892         uint32_t first = ldown.front();
1893         uint32_t last = ldown.back ();
1894
1895         uint32_t first_surface = first>>8;
1896         uint32_t first_strip = first&0xf;
1897
1898         uint32_t last_surface = last>>8;
1899         uint32_t last_strip = last&0xf;
1900
1901         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("PRR %5 in list %1.%2 - %3.%4\n", first_surface, first_strip, last_surface, last_strip,
1902                                                            down.size()));
1903
1904         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1905
1906         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1907
1908                 if ((*s)->number() >= first_surface && (*s)->number() <= last_surface) {
1909
1910                         uint32_t fs;
1911                         uint32_t ls;
1912
1913                         if ((*s)->number() == first_surface) {
1914                                 fs = first_strip;
1915                         } else {
1916                                 fs = 0;
1917                         }
1918
1919                         if ((*s)->number() == last_surface) {
1920                                 ls = last_strip;
1921                                 ls += 1;
1922                         } else {
1923                                 ls = (*s)->n_strips ();
1924                         }
1925
1926                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("adding strips for surface %1 (%2 .. %3)\n",
1927                                                                            (*s)->number(), fs, ls));
1928
1929                         for (uint32_t n = fs; n < ls; ++n) {
1930                                 boost::shared_ptr<Route> r = (*s)->nth_strip (n)->route();
1931                                 if (r) {
1932                                         selected.push_back (r);
1933                                 }
1934                         }
1935                 }
1936         }
1937 }
1938
1939 void
1940 MackieControlProtocol::set_ipmidi_base (int16_t portnum)
1941 {
1942         /* this will not be saved without a session save, so .. */
1943
1944         session->set_dirty ();
1945
1946         _ipmidi_base = portnum;
1947
1948         /* if the current device uses ipMIDI we need
1949            to restart.
1950         */
1951
1952         if (active() && _device_info.uses_ipmidi()) {
1953                 needs_ipmidi_restart = true;
1954         }
1955 }
1956
1957 int
1958 MackieControlProtocol::ipmidi_restart ()
1959 {
1960         clear_surfaces ();
1961         if (create_surfaces ()) {
1962                 return -1;
1963         }
1964         switch_banks (_current_initial_bank, true);
1965         needs_ipmidi_restart = false;
1966         return 0;
1967 }
1968
1969 void
1970 MackieControlProtocol::clear_surfaces ()
1971 {
1972         clear_ports ();
1973
1974         {
1975                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1976                 _master_surface.reset ();
1977                 surfaces.clear ();
1978         }
1979 }
1980
1981 void
1982 MackieControlProtocol::set_touch_sensitivity (int sensitivity)
1983 {
1984         sensitivity = min (9, sensitivity);
1985         sensitivity = max (0, sensitivity);
1986
1987         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1988
1989         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1990                 (*s)->set_touch_sensitivity (sensitivity);
1991         }
1992 }
1993
1994 void
1995 MackieControlProtocol::recalibrate_faders ()
1996 {
1997         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1998
1999         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2000                 (*s)->recalibrate_faders ();
2001         }
2002 }
2003
2004 void
2005 MackieControlProtocol::toggle_backlight ()
2006 {
2007         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2008
2009         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2010                 (*s)->toggle_backlight ();
2011         }
2012 }
2013
2014 boost::shared_ptr<Surface>
2015 MackieControlProtocol::get_surface_by_raw_pointer (void* ptr) const
2016 {
2017         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2018
2019         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
2020                 if ((*s).get() == (Surface*) ptr) {
2021                         return *s;
2022                 }
2023         }
2024
2025         return boost::shared_ptr<Surface> ();
2026 }
2027
2028 boost::shared_ptr<Surface>
2029 MackieControlProtocol::nth_surface (uint32_t n) const
2030 {
2031         Glib::Threads::Mutex::Lock lm (surfaces_lock);
2032
2033         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s, --n) {
2034                 if (n == 0) {
2035                         return *s;
2036                 }
2037         }
2038
2039         return boost::shared_ptr<Surface> ();
2040 }
2041
2042 void
2043 MackieControlProtocol::connection_handler (boost::weak_ptr<ARDOUR::Port> wp1, std::string name1, boost::weak_ptr<ARDOUR::Port> wp2, std::string name2, bool yn)
2044 {
2045         Surfaces scopy;
2046         {
2047                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
2048                 scopy = surfaces;
2049         }
2050
2051         for (Surfaces::const_iterator s = scopy.begin(); s != scopy.end(); ++s) {
2052                 if ((*s)->connection_handler (wp1, name1, wp2, name2, yn)) {
2053                         ConnectionChange (*s);
2054                         break;
2055                 }
2056         }
2057 }
2058
2059 bool
2060 MackieControlProtocol::is_track (boost::shared_ptr<Route> r) const
2061 {
2062         return boost::dynamic_pointer_cast<Track>(r) != 0;
2063 }
2064
2065 bool
2066 MackieControlProtocol::is_audio_track (boost::shared_ptr<Route> r) const
2067 {
2068         return boost::dynamic_pointer_cast<AudioTrack>(r) != 0;
2069 }
2070
2071 bool
2072 MackieControlProtocol::is_midi_track (boost::shared_ptr<Route> r) const
2073 {
2074         return boost::dynamic_pointer_cast<MidiTrack>(r) != 0;
2075 }
2076
2077 bool
2078 MackieControlProtocol::selected (boost::shared_ptr<Route> r) const
2079 {
2080         const RouteNotificationList* rl = &_last_selected_routes;
2081
2082         for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
2083                 boost::shared_ptr<ARDOUR::Route> rt = (*i).lock();
2084                 if (rt == r) {
2085                         return true;
2086                 }
2087         }
2088         return false;
2089 }