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
  35 #include "midi++/types.h"
  36 #include "midi++/port.h"
  37 #include "midi++/ipmidi_port.h"
  38 #include "pbd/pthread_utils.h"
  39 #include "pbd/error.h"
  40 #include "pbd/memento_command.h"
  41 #include "pbd/convert.h"
  42
  43 #include "ardour/automation_control.h"
  44 #include "ardour/dB.h"
  45 #include "ardour/debug.h"
  46 #include "ardour/location.h"
  47 #include "ardour/meter.h"
  48 #include "ardour/panner.h"
  49 #include "ardour/panner_shell.h"
  50 #include "ardour/route.h"
  51 #include "ardour/session.h"
  52 #include "ardour/tempo.h"
  53 #include "ardour/track.h"
  54 #include "ardour/types.h"
  55 #include "ardour/audioengine.h"
  56
  57 #include "mackie_control_protocol.h"
  58
  59 #include "midi_byte_array.h"
  60 #include "mackie_control_exception.h"
  61 #include "device_profile.h"
  62 #include "surface_port.h"
  63 #include "surface.h"
  64 #include "strip.h"
  65 #include "control_group.h"
  66 #include "meter.h"
  67 #include "button.h"
  68 #include "fader.h"
  69 #include "pot.h"
  70
  71 using namespace ARDOUR;
  72 using namespace std;
  73 using namespace Mackie;
  74 using namespace PBD;
  75 using namespace Glib;
  76
  77 #include "i18n.h"
  78
  79 #include "pbd/abstract_ui.cc" // instantiate template
  80
  81 const int MackieControlProtocol::MODIFIER_OPTION = 0x1;
  82 const int MackieControlProtocol::MODIFIER_CONTROL = 0x2;
  83 const int MackieControlProtocol::MODIFIER_SHIFT = 0x4;
  84 const int MackieControlProtocol::MODIFIER_CMDALT = 0x8;
  85
  86 MackieControlProtocol* MackieControlProtocol::_instance = 0;
  87
  88 bool MackieControlProtocol::probe()
  89 {
  90         return true;
  91 }
  92
  93 MackieControlProtocol::MackieControlProtocol (Session& session)
  94         : ControlProtocol (session, X_("Mackie"))
  95         , AbstractUI<MackieControlUIRequest> ("mackie")
  96         , _current_initial_bank (0)
  97         , _timecode_type (ARDOUR::AnyTime::BBT)
  98         , _gui (0)
  99         , _zoom_mode (false)
 100         , _scrub_mode (false)
 101         , _flip_mode (Normal)
 102         , _view_mode (Mixer)
 103         , _current_selected_track (-1)
 104         , _modifier_state (0)
 105         , _ipmidi_base (MIDI::IPMIDIPort::lowest_ipmidi_port_default)
 106         , needs_ipmidi_restart (false)
 107         , _metering_active (true)
 108         , _initialized (false)
 109         , _surfaces_state (0)
 110         , _surfaces_version (0)
 111 {
 112         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
 113
 114         DeviceInfo::reload_device_info ();
 115         DeviceProfile::reload_device_profiles ();
 116
 117         TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::gui_track_selection_changed, this, _1, true), this);
 118
 119         _instance = this;
 120
 121         build_button_map ();
 122 }
 123
 124 MackieControlProtocol::~MackieControlProtocol()
 125 {
 126         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol init\n");
 127
 128         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol drop_connections ()\n");
 129         drop_connections ();
 130
 131         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol tear_down_gui ()\n");
 132         tear_down_gui ();
 133
 134         delete _surfaces_state;
 135
 136         /* stop event loop */
 137         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol BaseUI::quit ()\n");
 138         BaseUI::quit ();
 139
 140         try {
 141                 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol close()\n");
 142                 close();
 143         }
 144         catch (exception & e) {
 145                 cout << "~MackieControlProtocol caught " << e.what() << endl;
 146         }
 147         catch (...) {
 148                 cout << "~MackieControlProtocol caught unknown" << endl;
 149         }
 150
 151         _instance = 0;
 152
 153         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol done\n");
 154 }
 155
 156 void
 157 MackieControlProtocol::thread_init ()
 158 {
 159         struct sched_param rtparam;
 160
 161         pthread_set_name (X_("MackieControl"));
 162
 163         PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("MackieControl"), 2048);
 164         ARDOUR::SessionEvent::create_per_thread_pool (X_("MackieControl"), 128);
 165
 166         memset (&rtparam, 0, sizeof (rtparam));
 167         rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
 168
 169         if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
 170                 // do we care? not particularly.
 171         }
 172 }
 173
 174 void
 175 MackieControlProtocol::midi_connectivity_established ()
 176 {
 177         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 178                 (*si)->say_hello ();
 179         }
 180
 181         if (_device_info.no_handshake()) {
 182                 for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 183                         (*si)->turn_it_on ();
 184                 }
 185         }
 186 }
 187
 188 // go to the previous track.
 189 // Assume that get_sorted_routes().size() > route_table.size()
 190 void
 191 MackieControlProtocol::prev_track()
 192 {
 193         if (_current_initial_bank >= 1) {
 194                 switch_banks (_current_initial_bank - 1);
 195         }
 196 }
 197
 198 // go to the next track.
 199 // Assume that get_sorted_routes().size() > route_table.size()
 200 void
 201 MackieControlProtocol::next_track()
 202 {
 203         Sorted sorted = get_sorted_routes();
 204         if (_current_initial_bank + n_strips() < sorted.size()) {
 205                 switch_banks (_current_initial_bank + 1);
 206         }
 207 }
 208
 209 bool
 210 MackieControlProtocol::route_is_locked_to_strip (boost::shared_ptr<Route> r) const
 211 {
 212         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 213                 if ((*si)->route_is_locked_to_strip (r)) {
 214                         return true;
 215                 }
 216         }
 217         return false;
 218 }
 219
 220 // predicate for sort call in get_sorted_routes
 221 struct RouteByRemoteId
 222 {
 223         bool operator () (const boost::shared_ptr<Route> & a, const boost::shared_ptr<Route> & b) const
 224         {
 225                 return a->remote_control_id() < b->remote_control_id();
 226         }
 227
 228         bool operator () (const Route & a, const Route & b) const
 229         {
 230                 return a.remote_control_id() < b.remote_control_id();
 231         }
 232
 233         bool operator () (const Route * a, const Route * b) const
 234         {
 235                 return a->remote_control_id() < b->remote_control_id();
 236         }
 237 };
 238
 239 MackieControlProtocol::Sorted
 240 MackieControlProtocol::get_sorted_routes()
 241 {
 242         Sorted sorted;
 243
 244         // fetch all routes
 245         boost::shared_ptr<RouteList> routes = session->get_routes();
 246         set<uint32_t> remote_ids;
 247
 248         // routes with remote_id 0 should never be added
 249         // TODO verify this with ardour devs
 250         // remote_ids.insert (0);
 251
 252         // sort in remote_id order, and exclude master, control and hidden routes
 253         // and any routes that are already set.
 254
 255         for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it) {
 256
 257                 boost::shared_ptr<Route> route = *it;
 258
 259                 if (remote_ids.find (route->remote_control_id()) != remote_ids.end()) {
 260                         continue;
 261                 }
 262
 263                 if (route->is_auditioner() || route->is_master() || route->is_monitor()) {
 264                         continue;
 265                 }
 266
 267                 /* don't include locked routes */
 268
 269                 if (route_is_locked_to_strip(route)) {
 270                         continue;
 271                 }
 272
 273                 switch (_view_mode) {
 274                 case Mixer:
 275                         break;
 276                 case AudioTracks:
 277                         break;
 278                 case Busses:
 279                         break;
 280                 case MidiTracks:
 281                         break;
 282                 case Dynamics:
 283                         break;
 284                 case EQ:
 285                         break;
 286                 case Loop:
 287                         break;
 288                 case Sends:
 289                         break;
 290                 case Plugins:
 291                         break;
 292                 }
 293
 294                 sorted.push_back (*it);
 295                 remote_ids.insert (route->remote_control_id());
 296         }
 297
 298         sort (sorted.begin(), sorted.end(), RouteByRemoteId());
 299         return sorted;
 300 }
 301
 302 void
 303 MackieControlProtocol::refresh_current_bank()
 304 {
 305         switch_banks (_current_initial_bank, true);
 306 }
 307
 308 uint32_t
 309 MackieControlProtocol::n_strips (bool with_locked_strips) const
 310 {
 311         uint32_t strip_count = 0;
 312
 313         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 314                 strip_count += (*si)->n_strips (with_locked_strips);
 315         }
 316
 317         return strip_count;
 318 }
 319
 320 void
 321 MackieControlProtocol::switch_banks (uint32_t initial, bool force)
 322 {
 323         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch banking to start at %1 force ? %2 current = %3\n", initial, force, _current_initial_bank));
 324
 325         if (initial == _current_initial_bank && !force) {
 326                 return;
 327         }
 328
 329         Sorted sorted = get_sorted_routes();
 330         uint32_t strip_cnt = n_strips (false); // do not include locked strips
 331                                                // in this count
 332
 333         if (sorted.size() <= strip_cnt && _current_initial_bank == 0 && !force) {
 334                 /* no banking - not enough routes to fill all strips and we're
 335                  * not at the first one.
 336                  */
 337                 return;
 338         }
 339
 340         _current_initial_bank = initial;
 341         _current_selected_track = -1;
 342
 343         // Map current bank of routes onto each surface(+strip)
 344
 345         if (_current_initial_bank <= sorted.size()) {
 346
 347                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch to %1, %2, available routes %3 on %4 surfaces\n",
 348                                                                    _current_initial_bank, strip_cnt, sorted.size(),
 349                                                                    surfaces.size()));
 350
 351                 // link routes to strips
 352
 353                 Sorted::iterator r = sorted.begin() + _current_initial_bank;
 354
 355                 for (Surfaces::iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 356                         vector<boost::shared_ptr<Route> > routes;
 357                         uint32_t added = 0;
 358
 359                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has %1 unlockedstrips\n", (*si)->n_strips (false)));
 360
 361                         for (; r != sorted.end() && added < (*si)->n_strips (false); ++r, ++added) {
 362                                 routes.push_back (*r);
 363                         }
 364
 365                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("give surface %1 routes\n", routes.size()));
 366
 367                         (*si)->map_routes (routes);
 368                 }
 369         }
 370
 371         /* reset this to get the right display of view mode after the switch */
 372         set_view_mode (_view_mode);
 373
 374         /* make sure selection is correct */
 375
 376         _gui_track_selection_changed (&_last_selected_routes, false);
 377
 378         /* current bank has not been saved */
 379         session->set_dirty();
 380 }
 381
 382 int
 383 MackieControlProtocol::set_active (bool yn)
 384 {
 385         DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active init with yn: '%1'\n", yn));
 386
 387         if (yn == active()) {
 388                 return 0;
 389         }
 390
 391         if (yn) {
 392
 393                 /* start event loop */
 394
 395                 BaseUI::run ();
 396
 397                 if (create_surfaces ()) {
 398                         return -1;
 399                 }
 400                 connect_session_signals ();
 401                 update_surfaces ();
 402
 403                 /* set up periodic task for metering and automation
 404                  */
 405
 406                 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
 407                 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
 408                 periodic_timeout->attach (main_loop()->get_context());
 409
 410         } else {
 411
 412                 BaseUI::quit ();
 413                 close ();
 414
 415         }
 416
 417         ControlProtocol::set_active (yn);
 418
 419         DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active done with yn: '%1'\n", yn));
 420
 421         return 0;
 422 }
 423
 424 bool
 425 MackieControlProtocol::periodic ()
 426 {
 427         if (!active()) {
 428                 return false;
 429         }
 430
 431         if (needs_ipmidi_restart) {
 432                 ipmidi_restart ();
 433                 return true;
 434         }
 435
 436         if (!_initialized) {
 437                 initialize();
 438         }
 439
 440         struct timeval now;
 441         uint64_t now_usecs;
 442         gettimeofday (&now, 0);
 443
 444         now_usecs = (now.tv_sec * 1000000) + now.tv_usec;
 445
 446         {
 447                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 448
 449                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 450                         (*s)->periodic (now_usecs);
 451                 }
 452         }
 453
 454         update_timecode_display ();
 455
 456         return true;
 457 }
 458
 459 void
 460 MackieControlProtocol::update_timecode_beats_led()
 461 {
 462         if (!_device_info.has_timecode_display()) {
 463                 return;
 464         }
 465
 466         DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::update_timecode_beats_led(): %1\n", _timecode_type));
 467         switch (_timecode_type) {
 468                 case ARDOUR::AnyTime::BBT:
 469                         update_global_led (Led::Beats, on);
 470                         update_global_led (Led::Timecode, off);
 471                         break;
 472                 case ARDOUR::AnyTime::Timecode:
 473                         update_global_led (Led::Timecode, on);
 474                         update_global_led (Led::Beats, off);
 475                         break;
 476                 default:
 477                         ostringstream os;
 478                         os << "Unknown Anytime::Type " << _timecode_type;
 479                         throw runtime_error (os.str());
 480         }
 481 }
 482
 483 void
 484 MackieControlProtocol::update_global_button (int id, LedState ls)
 485 {
 486         Glib::Threads::Mutex::Lock lm (surfaces_lock);
 487
 488         if (!_device_info.has_global_controls()) {
 489                 return;
 490         }
 491
 492         boost::shared_ptr<Surface> surface = surfaces.front();
 493
 494         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
 495         if (x != surface->controls_by_device_independent_id.end()) {
 496                 Button * button = dynamic_cast<Button*> (x->second);
 497                 surface->write (button->set_state (ls));
 498         } else {
 499                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", id));
 500         }
 501 }
 502
 503 void
 504 MackieControlProtocol::update_global_led (int id, LedState ls)
 505 {
 506         Glib::Threads::Mutex::Lock lm (surfaces_lock);
 507
 508         if (!_device_info.has_global_controls()) {
 509                 return;
 510         }
 511
 512         boost::shared_ptr<Surface> surface = surfaces.front();
 513
 514         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
 515
 516         if (x != surface->controls_by_device_independent_id.end()) {
 517                 Led * led = dynamic_cast<Led*> (x->second);
 518                 DEBUG_TRACE (DEBUG::MackieControl, "Writing LedState\n");
 519                 surface->write (led->set_state (ls));
 520         } else {
 521                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", id));
 522         }
 523 }
 524
 525 void
 526 MackieControlProtocol::device_ready ()
 527 {
 528         /* this is not required to be called, but for devices which do
 529          * handshaking, it can be called once the device has verified the
 530          * connection.
 531          */
 532
 533         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("device ready init (active=%1)\n", active()));
 534         update_surfaces ();
 535 }
 536
 537 // send messages to surface to set controls to correct values
 538 void
 539 MackieControlProtocol::update_surfaces()
 540 {
 541         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::update_surfaces() init (active=%1)\n", active()));
 542         if (!active()) {
 543                 return;
 544         }
 545
 546         // do the initial bank switch to connect signals
 547         // _current_initial_bank is initialised by set_state
 548         switch_banks (_current_initial_bank, true);
 549
 550         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::update_surfaces() finished\n");
 551 }
 552
 553 void
 554 MackieControlProtocol::initialize()
 555 {
 556         {
 557                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 558
 559                 if (surfaces.empty()) {
 560                         return;
 561                 }
 562
 563                 if (!surfaces.front()->active ()) {
 564                         return;
 565                 }
 566
 567                 // sometimes the jog wheel is a pot
 568                 if (_device_info.has_jog_wheel()) {
 569                         surfaces.front()->blank_jog_ring ();
 570                 }
 571         }
 572
 573         // update global buttons and displays
 574
 575         notify_record_state_changed();
 576         notify_transport_state_changed();
 577         update_timecode_beats_led();
 578
 579         _initialized = true;
 580 }
 581
 582 void
 583 MackieControlProtocol::connect_session_signals()
 584 {
 585         // receive routes added
 586         session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_route_added, this, _1), this);
 587         // receive record state toggled
 588         session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_record_state_changed, this), this);
 589         // receive transport state changed
 590         session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
 591         session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
 592         // receive punch-in and punch-out
 593         Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
 594         session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
 595         // receive rude solo changed
 596         session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), this);
 597
 598         // make sure remote id changed signals reach here
 599         // see also notify_route_added
 600         Sorted sorted = get_sorted_routes();
 601
 602         for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
 603                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
 604         }
 605 }
 606
 607 void
 608 MackieControlProtocol::set_profile (const string& profile_name)
 609 {
 610         if (profile_name == "default") {
 611                 /* reset to default */
 612                 _device_profile = DeviceProfile (profile_name);
 613         }
 614
 615         map<string,DeviceProfile>::iterator d = DeviceProfile::device_profiles.find (profile_name);
 616
 617         if (d == DeviceProfile::device_profiles.end()) {
 618                 return;
 619         }
 620
 621         _device_profile = d->second;
 622 }
 623
 624 int
 625 MackieControlProtocol::set_device_info (const string& device_name)
 626 {
 627         map<string,DeviceInfo>::iterator d = DeviceInfo::device_info.find (device_name);
 628
 629         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("new device chosen %1\n", device_name));
 630
 631         if (d == DeviceInfo::device_info.end()) {
 632                 return -1;
 633         }
 634
 635         _device_info = d->second;
 636
 637         return 0;
 638 }
 639
 640 int
 641 MackieControlProtocol::set_device (const string& device_name)
 642 {
 643         if (set_device_info (device_name)) {
 644                 return -1;
 645         }
 646
 647         clear_surfaces ();
 648
 649         if (create_surfaces ()) {
 650                 return -1;
 651         }
 652
 653         switch_banks (0, true);
 654
 655         return 0;
 656 }
 657
 658 int
 659 MackieControlProtocol::create_surfaces ()
 660 {
 661         string device_name;
 662         surface_type_t stype = mcu;
 663         char buf[128];
 664
 665         if (_device_info.extenders() == 0) {
 666                 device_name = X_("mackie control");
 667         } else {
 668                 device_name = X_("mackie control #1");
 669         }
 670
 671         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Create %1 surfaces\n", 1 + _device_info.extenders()));
 672
 673         for (uint32_t n = 0; n < 1 + _device_info.extenders(); ++n) {
 674
 675                 boost::shared_ptr<Surface> surface;
 676
 677                 try {
 678                         surface.reset (new Surface (*this, device_name, n, stype));
 679                 } catch (...) {
 680                         return -1;
 681                 }
 682
 683                 if (_surfaces_state) {
 684                         surface->set_state (*_surfaces_state, _surfaces_version);
 685                 }
 686
 687                 {
 688                         Glib::Threads::Mutex::Lock lm (surfaces_lock);
 689                         surfaces.push_back (surface);
 690                 }
 691
 692                 /* next device will be an extender */
 693
 694                 if (_device_info.extenders() < 2) {
 695                         device_name = X_("mackie control #2");
 696                 } else {
 697                         snprintf (buf, sizeof (buf), X_("mackie control #%d"), n+2);
 698                         device_name = buf;
 699                 }
 700                 stype = ext;
 701
 702                 if (!_device_info.uses_ipmidi()) {
 703
 704                         _input_bundle.reset (new ARDOUR::Bundle (_("Mackie Control In"), true));
 705                         _output_bundle.reset (new ARDOUR::Bundle (_("Mackie Control Out"), false));
 706
 707                         _input_bundle->add_channel (
 708                                 surface->port().input_port().name(),
 709                                 ARDOUR::DataType::MIDI,
 710                                 session->engine().make_port_name_non_relative (surface->port().input_port().name())
 711                                 );
 712
 713                         _output_bundle->add_channel (
 714                                 surface->port().output_port().name(),
 715                                 ARDOUR::DataType::MIDI,
 716                                 session->engine().make_port_name_non_relative (surface->port().output_port().name())
 717                                 );
 718
 719                         session->BundleAdded (_input_bundle);
 720                         session->BundleAdded (_output_bundle);
 721
 722                 } else {
 723                         _input_bundle.reset ((ARDOUR::Bundle*) 0);
 724                         _output_bundle.reset ((ARDOUR::Bundle*) 0);
 725
 726                         session->BundleRemoved (_input_bundle);
 727                         session->BundleRemoved (_output_bundle);
 728                 }
 729
 730                 int fd;
 731                 MIDI::Port& input_port (surface->port().input_port());
 732
 733                 if ((fd = input_port.selectable ()) >= 0) {
 734                         Glib::RefPtr<IOSource> psrc = IOSource::create (fd, IO_IN|IO_HUP|IO_ERR);
 735
 736                         psrc->connect (sigc::bind (sigc::mem_fun (this, &MackieControlProtocol::midi_input_handler), &input_port));
 737                         psrc->attach (main_loop()->get_context());
 738
 739                         // glibmm hack: for now, store only the GSource*
 740
 741                         port_sources.push_back (psrc->gobj());
 742                         g_source_ref (psrc->gobj());
 743                 }
 744         }
 745
 746         return 0;
 747 }
 748
 749 void
 750 MackieControlProtocol::close()
 751 {
 752         session_connections.drop_connections ();
 753         route_connections.drop_connections ();
 754         periodic_connection.disconnect ();
 755
 756         clear_surfaces();
 757 }
 758
 759 XMLNode&
 760 MackieControlProtocol::get_state()
 761 {
 762         XMLNode& node (ControlProtocol::get_state());
 763
 764         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state init\n");
 765         char buf[16];
 766
 767         // add current bank
 768         snprintf (buf, sizeof (buf), "%d", _current_initial_bank);
 769         node.add_property (X_("bank"), buf);
 770
 771         // ipMIDI base port (possibly not used)
 772         snprintf (buf, sizeof (buf), "%d", _ipmidi_base);
 773         node.add_property (X_("ipmidi-base"), buf);
 774
 775         node.add_property (X_("device-profile"), _device_profile.name());
 776         node.add_property (X_("device-name"), _device_info.name());
 777
 778         XMLNode* snode = new XMLNode (X_("Surfaces"));
 779         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 780                 snode->add_child_nocopy ((*s)->get_state());
 781         }
 782
 783         node.add_child_nocopy (*snode);
 784
 785         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state done\n");
 786
 787         return node;
 788 }
 789
 790 int
 791 MackieControlProtocol::set_state (const XMLNode & node, int version)
 792 {
 793         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", active()));
 794
 795         int retval = 0;
 796         const XMLProperty* prop;
 797         uint32_t bank = 0;
 798
 799         if ((prop = node.property (X_("ipmidi-base"))) != 0) {
 800                 set_ipmidi_base (atoi (prop->value()));
 801         }
 802
 803         // fetch current bank
 804         if ((prop = node.property (X_("bank"))) != 0) {
 805                 bank = atoi (prop->value());
 806         }
 807
 808         if ((prop = node.property (X_("device-name"))) != 0) {
 809                 set_device_info (prop->value());
 810         }
 811
 812         if ((prop = node.property (X_("device-profile"))) != 0) {
 813                 set_profile (prop->value());
 814         }
 815
 816         XMLNode* snode = node.child (X_("Surfaces"));
 817
 818         delete _surfaces_state;
 819         _surfaces_state = 0;
 820
 821         if (snode) {
 822                 _surfaces_state = new XMLNode (*snode);
 823                 _surfaces_version = version;
 824         }
 825
 826         switch_banks (bank, true);
 827
 828         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::set_state done\n");
 829
 830         return retval;
 831 }
 832
 833 string
 834 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
 835 {
 836         Timecode::BBT_Time bbt_time;
 837
 838         session->bbt_time (now_frame, bbt_time);
 839
 840         // The Mackie protocol spec is built around a BBT time display of
 841         //
 842         // digits:     888/88/88/888
 843         // semantics:  BBB/bb/ss/ttt
 844         //
 845         // The third field is "subdivisions" which is a concept found in Logic
 846         // but not present in Ardour. Instead Ardour displays a 4 digit tick
 847         // count, which we need to spread across the 5 digits of ss/ttt.
 848
 849         ostringstream os;
 850
 851         os << setw(3) << setfill('0') << bbt_time.bars;
 852         os << setw(2) << setfill('0') << bbt_time.beats;
 853         os << ' ';
 854         os << setw(1) << setfill('0') << bbt_time.ticks / 1000;
 855         os << setw(3) << setfill('0') << bbt_time.ticks % 1000;
 856
 857         return os.str();
 858 }
 859
 860 string
 861 MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
 862 {
 863         Timecode::Time timecode;
 864         session->timecode_time (now_frame, timecode);
 865
 866         // According to the Logic docs
 867         // digits: 888/88/88/888
 868         // Timecode mode: Hours/Minutes/Seconds/Frames
 869         ostringstream os;
 870         os << setw(2) << setfill('0') << timecode.hours;
 871         os << ' ';
 872         os << setw(2) << setfill('0') << timecode.minutes;
 873         os << setw(2) << setfill('0') << timecode.seconds;
 874         os << ' ';
 875         os << setw(2) << setfill('0') << timecode.frames;
 876
 877         return os.str();
 878 }
 879
 880 void
 881 MackieControlProtocol::update_timecode_display()
 882 {
 883         Glib::Threads::Mutex::Lock lm (surfaces_lock);
 884
 885         if (surfaces.empty()) {
 886                 return;
 887         }
 888
 889         boost::shared_ptr<Surface> surface = surfaces.front();
 890
 891         if (surface->type() != mcu || !_device_info.has_timecode_display() || !surface->active ()) {
 892                 return;
 893         }
 894
 895         // do assignment here so current_frame is fixed
 896         framepos_t current_frame = session->transport_frame();
 897         string timecode;
 898
 899         switch (_timecode_type) {
 900         case ARDOUR::AnyTime::BBT:
 901                 timecode = format_bbt_timecode (current_frame);
 902                 break;
 903         case ARDOUR::AnyTime::Timecode:
 904                 timecode = format_timecode_timecode (current_frame);
 905                 break;
 906         default:
 907                 return;
 908         }
 909
 910         // only write the timecode string to the MCU if it's changed
 911         // since last time. This is to reduce midi bandwidth used.
 912         if (timecode != _timecode_last) {
 913                 surface->display_timecode (timecode, _timecode_last);
 914                 _timecode_last = timecode;
 915         }
 916 }
 917
 918 ///////////////////////////////////////////
 919 // Session signals
 920 ///////////////////////////////////////////
 921
 922 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
 923 {
 924         if (p == "punch-in") {
 925                 update_global_button (Button::PunchIn, session->config.get_punch_in());
 926         } else if (p == "punch-out") {
 927                 update_global_button (Button::PunchOut, session->config.get_punch_out());
 928         } else if (p == "clicking") {
 929                 // update_global_button (Button::RelayClick, Config->get_clicking());
 930         } else {
 931                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
 932         }
 933 }
 934
 935 // RouteList is the set of routes that have just been added
 936 void
 937 MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
 938 {
 939         // currently assigned banks are less than the full set of
 940         // strips, so activate the new strip now.
 941
 942         refresh_current_bank();
 943
 944         // otherwise route added, but current bank needs no updating
 945
 946         // make sure remote id changes in the new route are handled
 947         typedef ARDOUR::RouteList ARS;
 948
 949         for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
 950                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
 951         }
 952 }
 953
 954 void
 955 MackieControlProtocol::notify_solo_active_changed (bool active)
 956 {
 957         boost::shared_ptr<Surface> surface;
 958
 959         {
 960                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
 961                 surface = surfaces.front ();
 962         }
 963
 964         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Led::RudeSolo);
 965         if (x != surface->controls_by_device_independent_id.end()) {
 966                 Led* rude_solo = dynamic_cast<Led*> (x->second);
 967                 if (rude_solo) {
 968                         surface->write (rude_solo->set_state (active ? flashing : off));
 969                 }
 970         }
 971 }
 972
 973 void
 974 MackieControlProtocol::notify_remote_id_changed()
 975 {
 976         Sorted sorted = get_sorted_routes();
 977         uint32_t sz = n_strips();
 978
 979         // if a remote id has been moved off the end, we need to shift
 980         // the current bank backwards.
 981
 982         if (sorted.size() - _current_initial_bank < sz) {
 983                 // but don't shift backwards past the zeroth channel
 984                 switch_banks (max((Sorted::size_type) 0, sorted.size() - sz));
 985         } else {
 986                 // Otherwise just refresh the current bank
 987                 refresh_current_bank();
 988         }
 989 }
 990
 991 ///////////////////////////////////////////
 992 // Transport signals
 993 ///////////////////////////////////////////
 994
 995 void
 996 MackieControlProtocol::notify_loop_state_changed()
 997 {
 998         update_global_button (Button::Loop, session->get_play_loop());
 999 }
1000
1001 void
1002 MackieControlProtocol::notify_transport_state_changed()
1003 {
1004         if (!_device_info.has_global_controls()) {
1005                 return;
1006         }
1007
1008         // switch various play and stop buttons on / off
1009         update_global_button (Button::Loop, session->get_play_loop());
1010         update_global_button (Button::Play, session->transport_speed() == 1.0);
1011         update_global_button (Button::Stop, session->transport_stopped ());
1012         update_global_button (Button::Rewind, session->transport_speed() < 0.0);
1013         update_global_button (Button::Ffwd, session->transport_speed() > 1.0);
1014
1015         notify_metering_state_changed ();
1016 }
1017
1018 void
1019 MackieControlProtocol::notify_metering_state_changed()
1020 {
1021         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1022
1023         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1024                 (*s)->notify_metering_state_changed ();
1025         }
1026 }
1027
1028 void
1029 MackieControlProtocol::notify_record_state_changed ()
1030 {
1031         if (!_device_info.has_global_controls()) {
1032                 return;
1033         }
1034
1035         boost::shared_ptr<Surface> surface;
1036
1037         {
1038                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1039                 surface = surfaces.front();
1040         }
1041
1042         /* rec is a tristate */
1043
1044         map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Button::Record);
1045         if (x != surface->controls_by_device_independent_id.end()) {
1046                 Button * rec = dynamic_cast<Button*> (x->second);
1047                 if (rec) {
1048                         LedState ls;
1049
1050                         switch (session->record_status()) {
1051                         case Session::Disabled:
1052                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to disabled, LED off\n");
1053                                 ls = off;
1054                                 break;
1055                         case Session::Recording:
1056                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to recording, LED on\n");
1057                                 ls = on;
1058                                 break;
1059                         case Session::Enabled:
1060                                 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to enabled, LED flashing\n");
1061                                 ls = flashing;
1062                                 break;
1063                         }
1064
1065                         surface->write (rec->set_state (ls));
1066                 }
1067         }
1068 }
1069
1070 list<boost::shared_ptr<ARDOUR::Bundle> >
1071 MackieControlProtocol::bundles ()
1072 {
1073         list<boost::shared_ptr<ARDOUR::Bundle> > b;
1074
1075         if (_input_bundle) {
1076                 b.push_back (_input_bundle);
1077                 b.push_back (_output_bundle);
1078         }
1079
1080         return b;
1081 }
1082
1083 void
1084 MackieControlProtocol::do_request (MackieControlUIRequest* req)
1085 {
1086         if (req->type == CallSlot) {
1087
1088                 call_slot (MISSING_INVALIDATOR, req->the_slot);
1089
1090         } else if (req->type == Quit) {
1091
1092                 stop ();
1093         }
1094 }
1095
1096 int
1097 MackieControlProtocol::stop ()
1098 {
1099         BaseUI::quit ();
1100
1101         return 0;
1102 }
1103
1104 void
1105 MackieControlProtocol::update_led (Surface& surface, Button& button, Mackie::LedState ls)
1106 {
1107         if (ls != none) {
1108                 surface.port().write (button.set_state (ls));
1109         }
1110 }
1111
1112 void
1113 MackieControlProtocol::build_button_map ()
1114 {
1115         /* this maps our device-independent button codes to the methods that handle them.
1116          */
1117
1118 #define DEFINE_BUTTON_HANDLER(b,p,r) button_map.insert (pair<Button::ID,ButtonHandlers> ((b), ButtonHandlers ((p),(r))));
1119
1120         DEFINE_BUTTON_HANDLER (Button::IO, &MackieControlProtocol::io_press, &MackieControlProtocol::io_release);
1121         DEFINE_BUTTON_HANDLER (Button::Sends, &MackieControlProtocol::sends_press, &MackieControlProtocol::sends_release);
1122         DEFINE_BUTTON_HANDLER (Button::Pan, &MackieControlProtocol::pan_press, &MackieControlProtocol::pan_release);
1123         DEFINE_BUTTON_HANDLER (Button::Plugin, &MackieControlProtocol::plugin_press, &MackieControlProtocol::plugin_release);
1124         DEFINE_BUTTON_HANDLER (Button::Eq, &MackieControlProtocol::eq_press, &MackieControlProtocol::eq_release);
1125         DEFINE_BUTTON_HANDLER (Button::Dyn, &MackieControlProtocol::dyn_press, &MackieControlProtocol::dyn_release);
1126         DEFINE_BUTTON_HANDLER (Button::Left, &MackieControlProtocol::left_press, &MackieControlProtocol::left_release);
1127         DEFINE_BUTTON_HANDLER (Button::Right, &MackieControlProtocol::right_press, &MackieControlProtocol::right_release);
1128         DEFINE_BUTTON_HANDLER (Button::ChannelLeft, &MackieControlProtocol::channel_left_press, &MackieControlProtocol::channel_left_release);
1129         DEFINE_BUTTON_HANDLER (Button::ChannelRight, &MackieControlProtocol::channel_right_press, &MackieControlProtocol::channel_right_release);
1130         DEFINE_BUTTON_HANDLER (Button::Flip, &MackieControlProtocol::flip_press, &MackieControlProtocol::flip_release);
1131         DEFINE_BUTTON_HANDLER (Button::Edit, &MackieControlProtocol::edit_press, &MackieControlProtocol::edit_release);
1132         DEFINE_BUTTON_HANDLER (Button::NameValue, &MackieControlProtocol::name_value_press, &MackieControlProtocol::name_value_release);
1133         DEFINE_BUTTON_HANDLER (Button::TimecodeBeats, &MackieControlProtocol::timecode_beats_press, &MackieControlProtocol::timecode_beats_release);
1134         DEFINE_BUTTON_HANDLER (Button::F1, &MackieControlProtocol::F1_press, &MackieControlProtocol::F1_release);
1135         DEFINE_BUTTON_HANDLER (Button::F2, &MackieControlProtocol::F2_press, &MackieControlProtocol::F2_release);
1136         DEFINE_BUTTON_HANDLER (Button::F3, &MackieControlProtocol::F3_press, &MackieControlProtocol::F3_release);
1137         DEFINE_BUTTON_HANDLER (Button::F4, &MackieControlProtocol::F4_press, &MackieControlProtocol::F4_release);
1138         DEFINE_BUTTON_HANDLER (Button::F5, &MackieControlProtocol::F5_press, &MackieControlProtocol::F5_release);
1139         DEFINE_BUTTON_HANDLER (Button::F6, &MackieControlProtocol::F6_press, &MackieControlProtocol::F6_release);
1140         DEFINE_BUTTON_HANDLER (Button::F7, &MackieControlProtocol::F7_press, &MackieControlProtocol::F7_release);
1141         DEFINE_BUTTON_HANDLER (Button::F8, &MackieControlProtocol::F8_press, &MackieControlProtocol::F8_release);
1142         DEFINE_BUTTON_HANDLER (Button::F9, &MackieControlProtocol::F9_press, &MackieControlProtocol::F9_release);
1143         DEFINE_BUTTON_HANDLER (Button::F10, &MackieControlProtocol::F10_press, &MackieControlProtocol::F10_release);
1144         DEFINE_BUTTON_HANDLER (Button::F11, &MackieControlProtocol::F11_press, &MackieControlProtocol::F11_release);
1145         DEFINE_BUTTON_HANDLER (Button::F12, &MackieControlProtocol::F12_press, &MackieControlProtocol::F12_release);
1146         DEFINE_BUTTON_HANDLER (Button::F13, &MackieControlProtocol::F13_press, &MackieControlProtocol::F13_release);
1147         DEFINE_BUTTON_HANDLER (Button::F14, &MackieControlProtocol::F14_press, &MackieControlProtocol::F14_release);
1148         DEFINE_BUTTON_HANDLER (Button::F15, &MackieControlProtocol::F15_press, &MackieControlProtocol::F15_release);
1149         DEFINE_BUTTON_HANDLER (Button::F16, &MackieControlProtocol::F16_press, &MackieControlProtocol::F16_release);
1150         DEFINE_BUTTON_HANDLER (Button::Shift, &MackieControlProtocol::shift_press, &MackieControlProtocol::shift_release);
1151         DEFINE_BUTTON_HANDLER (Button::Option, &MackieControlProtocol::option_press, &MackieControlProtocol::option_release);
1152         DEFINE_BUTTON_HANDLER (Button::Ctrl, &MackieControlProtocol::control_press, &MackieControlProtocol::control_release);
1153         DEFINE_BUTTON_HANDLER (Button::CmdAlt, &MackieControlProtocol::cmd_alt_press, &MackieControlProtocol::cmd_alt_release);
1154         DEFINE_BUTTON_HANDLER (Button::On, &MackieControlProtocol::on_press, &MackieControlProtocol::on_release);
1155         DEFINE_BUTTON_HANDLER (Button::RecReady, &MackieControlProtocol::rec_ready_press, &MackieControlProtocol::rec_ready_release);
1156         DEFINE_BUTTON_HANDLER (Button::Undo, &MackieControlProtocol::undo_press, &MackieControlProtocol::undo_release);
1157         DEFINE_BUTTON_HANDLER (Button::Save, &MackieControlProtocol::save_press, &MackieControlProtocol::save_release);
1158         DEFINE_BUTTON_HANDLER (Button::Touch, &MackieControlProtocol::touch_press, &MackieControlProtocol::touch_release);
1159         DEFINE_BUTTON_HANDLER (Button::Redo, &MackieControlProtocol::redo_press, &MackieControlProtocol::redo_release);
1160         DEFINE_BUTTON_HANDLER (Button::Marker, &MackieControlProtocol::marker_press, &MackieControlProtocol::marker_release);
1161         DEFINE_BUTTON_HANDLER (Button::Enter, &MackieControlProtocol::enter_press, &MackieControlProtocol::enter_release);
1162         DEFINE_BUTTON_HANDLER (Button::Cancel, &MackieControlProtocol::cancel_press, &MackieControlProtocol::cancel_release);
1163         DEFINE_BUTTON_HANDLER (Button::Mixer, &MackieControlProtocol::mixer_press, &MackieControlProtocol::mixer_release);
1164         DEFINE_BUTTON_HANDLER (Button::FrmLeft, &MackieControlProtocol::frm_left_press, &MackieControlProtocol::frm_left_release);
1165         DEFINE_BUTTON_HANDLER (Button::FrmRight, &MackieControlProtocol::frm_right_press, &MackieControlProtocol::frm_right_release);
1166         DEFINE_BUTTON_HANDLER (Button::Loop, &MackieControlProtocol::loop_press, &MackieControlProtocol::loop_release);
1167         DEFINE_BUTTON_HANDLER (Button::PunchIn, &MackieControlProtocol::punch_in_press, &MackieControlProtocol::punch_in_release);
1168         DEFINE_BUTTON_HANDLER (Button::PunchOut, &MackieControlProtocol::punch_out_press, &MackieControlProtocol::punch_out_release);
1169         DEFINE_BUTTON_HANDLER (Button::Home, &MackieControlProtocol::home_press, &MackieControlProtocol::home_release);
1170         DEFINE_BUTTON_HANDLER (Button::End, &MackieControlProtocol::end_press, &MackieControlProtocol::end_release);
1171         DEFINE_BUTTON_HANDLER (Button::Rewind, &MackieControlProtocol::rewind_press, &MackieControlProtocol::rewind_release);
1172         DEFINE_BUTTON_HANDLER (Button::Ffwd, &MackieControlProtocol::ffwd_press, &MackieControlProtocol::ffwd_release);
1173         DEFINE_BUTTON_HANDLER (Button::Stop, &MackieControlProtocol::stop_press, &MackieControlProtocol::stop_release);
1174         DEFINE_BUTTON_HANDLER (Button::Play, &MackieControlProtocol::play_press, &MackieControlProtocol::play_release);
1175         DEFINE_BUTTON_HANDLER (Button::Record, &MackieControlProtocol::record_press, &MackieControlProtocol::record_release);
1176         DEFINE_BUTTON_HANDLER (Button::CursorUp, &MackieControlProtocol::cursor_up_press, &MackieControlProtocol::cursor_up_release);
1177         DEFINE_BUTTON_HANDLER (Button::CursorDown, &MackieControlProtocol::cursor_down_press, &MackieControlProtocol::cursor_down_release);
1178         DEFINE_BUTTON_HANDLER (Button::CursorLeft, &MackieControlProtocol::cursor_left_press, &MackieControlProtocol::cursor_left_release);
1179         DEFINE_BUTTON_HANDLER (Button::CursorRight, &MackieControlProtocol::cursor_right_press, &MackieControlProtocol::cursor_right_release);
1180         DEFINE_BUTTON_HANDLER (Button::Zoom, &MackieControlProtocol::zoom_press, &MackieControlProtocol::zoom_release);
1181         DEFINE_BUTTON_HANDLER (Button::Scrub, &MackieControlProtocol::scrub_press, &MackieControlProtocol::scrub_release);
1182         DEFINE_BUTTON_HANDLER (Button::UserA, &MackieControlProtocol::user_a_press, &MackieControlProtocol::user_a_release);
1183         DEFINE_BUTTON_HANDLER (Button::UserB, &MackieControlProtocol::user_b_press, &MackieControlProtocol::user_b_release);
1184         DEFINE_BUTTON_HANDLER (Button::MasterFaderTouch, &MackieControlProtocol::master_fader_touch_press, &MackieControlProtocol::master_fader_touch_release);
1185
1186         DEFINE_BUTTON_HANDLER (Button::Snapshot, &MackieControlProtocol::snapshot_press, &MackieControlProtocol::snapshot_release);
1187         DEFINE_BUTTON_HANDLER (Button::Read, &MackieControlProtocol::read_press, &MackieControlProtocol::read_release);
1188         DEFINE_BUTTON_HANDLER (Button::Write, &MackieControlProtocol::write_press, &MackieControlProtocol::write_release);
1189         DEFINE_BUTTON_HANDLER (Button::FdrGroup, &MackieControlProtocol::fdrgroup_press, &MackieControlProtocol::fdrgroup_release);
1190         DEFINE_BUTTON_HANDLER (Button::ClearSolo, &MackieControlProtocol::clearsolo_press, &MackieControlProtocol::clearsolo_release);
1191         DEFINE_BUTTON_HANDLER (Button::Track, &MackieControlProtocol::track_press, &MackieControlProtocol::track_release);
1192         DEFINE_BUTTON_HANDLER (Button::Send, &MackieControlProtocol::send_press, &MackieControlProtocol::send_release);
1193         DEFINE_BUTTON_HANDLER (Button::MidiTracks, &MackieControlProtocol::miditracks_press, &MackieControlProtocol::miditracks_release);
1194         DEFINE_BUTTON_HANDLER (Button::Inputs, &MackieControlProtocol::inputs_press, &MackieControlProtocol::inputs_release);
1195         DEFINE_BUTTON_HANDLER (Button::AudioTracks, &MackieControlProtocol::audiotracks_press, &MackieControlProtocol::audiotracks_release);
1196         DEFINE_BUTTON_HANDLER (Button::AudioInstruments, &MackieControlProtocol::audioinstruments_press, &MackieControlProtocol::audioinstruments_release);
1197         DEFINE_BUTTON_HANDLER (Button::Aux, &MackieControlProtocol::aux_press, &MackieControlProtocol::aux_release);
1198         DEFINE_BUTTON_HANDLER (Button::Busses, &MackieControlProtocol::busses_press, &MackieControlProtocol::busses_release);
1199         DEFINE_BUTTON_HANDLER (Button::Outputs, &MackieControlProtocol::outputs_press, &MackieControlProtocol::outputs_release);
1200         DEFINE_BUTTON_HANDLER (Button::User, &MackieControlProtocol::user_press, &MackieControlProtocol::user_release);
1201         DEFINE_BUTTON_HANDLER (Button::Trim, &MackieControlProtocol::trim_press, &MackieControlProtocol::trim_release);
1202         DEFINE_BUTTON_HANDLER (Button::Latch, &MackieControlProtocol::latch_press, &MackieControlProtocol::latch_release);
1203         DEFINE_BUTTON_HANDLER (Button::Grp, &MackieControlProtocol::grp_press, &MackieControlProtocol::grp_release);
1204         DEFINE_BUTTON_HANDLER (Button::Nudge, &MackieControlProtocol::nudge_press, &MackieControlProtocol::nudge_release);
1205         DEFINE_BUTTON_HANDLER (Button::Drop, &MackieControlProtocol::drop_press, &MackieControlProtocol::drop_release);
1206         DEFINE_BUTTON_HANDLER (Button::Replace, &MackieControlProtocol::replace_press, &MackieControlProtocol::replace_release);
1207         DEFINE_BUTTON_HANDLER (Button::Click, &MackieControlProtocol::click_press, &MackieControlProtocol::click_release);
1208         DEFINE_BUTTON_HANDLER (Button::View, &MackieControlProtocol::view_press, &MackieControlProtocol::view_release);
1209 }
1210
1211 void
1212 MackieControlProtocol::handle_button_event (Surface& surface, Button& button, ButtonState bs)
1213 {
1214         if  (bs != press && bs != release) {
1215                 update_led (surface, button, none);
1216                 return;
1217         }
1218
1219         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2 (%3)\n", (bs == press ? "press" : "release"), button.id(),
1220                                                            Button::id_to_name (button.bid())));
1221
1222         /* check profile first */
1223
1224         string action = _device_profile.get_button_action (button.bid(), _modifier_state);
1225
1226         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Looked up action for button %1 with modifier %2, got [%3]\n",
1227                                                            button.bid(), _modifier_state, action));
1228
1229         if (!action.empty()) {
1230                 /* if there is a bound action for this button, and this is a press event,
1231                    carry out the action. If its a release event, do nothing since we
1232                    don't bind to them at all but don't want any other handling to
1233                    occur either.
1234                 */
1235                 if (bs == press) {
1236                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("executing action %1\n", action));
1237                         access_action (action);
1238                 }
1239                 return;
1240         }
1241
1242         /* lookup using the device-INDEPENDENT button ID */
1243
1244         ButtonMap::iterator b = button_map.find (button.bid());
1245
1246         if (b != button_map.end()) {
1247
1248                 ButtonHandlers& bh (b->second);
1249
1250                 switch  (bs) {
1251                 case press:
1252                         surface.write (button.set_state ((this->*(bh.press)) (button)));
1253                         break;
1254                 case release:
1255                         surface.write (button.set_state ((this->*(bh.release)) (button)));
1256                         break;
1257                 default:
1258                         break;
1259                 }
1260         } else {
1261                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1262                                                                    button.bid(), button.id()));
1263                 error << string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1264                                          button.bid(), button.id()) << endmsg;
1265         }
1266 }
1267
1268 bool
1269 MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
1270 {
1271         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("something happend on  %1\n", port->name()));
1272
1273         if (ioc & ~IO_IN) {
1274                 return false;
1275         }
1276
1277         if (ioc & IO_IN) {
1278
1279                 /* Devices using regular JACK MIDI ports will need to have
1280                    the x-thread FIFO drained to avoid burning endless CPU.
1281
1282                    Devices using ipMIDI have port->selectable() as the same
1283                    file descriptor that data arrives on, so doing this
1284                    for them will simply throw all incoming data away.
1285                 */
1286
1287                 if (!_device_info.uses_ipmidi()) {
1288 #ifndef PLATFORM_WINDOWS
1289                         CrossThreadChannel::drain (port->selectable());
1290 #endif
1291                 }
1292
1293                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("data available on %1\n", port->name()));
1294                 framepos_t now = session->engine().sample_time();
1295                 port->parse (now);
1296         }
1297
1298         return true;
1299 }
1300
1301 void
1302 MackieControlProtocol::clear_ports ()
1303 {
1304         if (_input_bundle) {
1305                 _input_bundle->remove_channels ();
1306                 _output_bundle->remove_channels ();
1307         }
1308
1309         for (PortSources::iterator i = port_sources.begin(); i != port_sources.end(); ++i) {
1310                 g_source_destroy (*i);
1311                 g_source_unref (*i);
1312         }
1313
1314         port_sources.clear ();
1315 }
1316
1317 void
1318 MackieControlProtocol::set_view_mode (ViewMode m)
1319 {
1320         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1321
1322         _view_mode = m;
1323
1324         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1325                 (*s)->update_view_mode_display ();
1326         }
1327
1328 }
1329
1330 void
1331 MackieControlProtocol::set_flip_mode (FlipMode fm)
1332 {
1333         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1334
1335         _flip_mode = fm;
1336
1337         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1338                 (*s)->update_flip_mode_display ();
1339         }
1340 }
1341
1342 void
1343 MackieControlProtocol::set_master_on_surface_strip (uint32_t surface, uint32_t strip_number)
1344 {
1345         force_special_route_to_strip (session->master_out(), surface, strip_number);
1346 }
1347
1348 void
1349 MackieControlProtocol::set_monitor_on_surface_strip (uint32_t surface, uint32_t strip_number)
1350 {
1351         force_special_route_to_strip (session->monitor_out(), surface, strip_number);
1352 }
1353
1354 void
1355 MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r, uint32_t surface, uint32_t strip_number)
1356 {
1357         if (!r) {
1358                 return;
1359         }
1360
1361         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1362
1363         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1364                 if ((*s)->number() == surface) {
1365                         Strip* strip = (*s)->nth_strip (strip_number);
1366                         if (strip) {
1367                                 strip->set_route (session->master_out());
1368                                 strip->lock_controls ();
1369                         }
1370                 }
1371         }
1372 }
1373
1374 void
1375 MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl, bool save_list)
1376 {
1377         _gui_track_selection_changed (rl.get(), save_list);
1378 }
1379
1380 void
1381 MackieControlProtocol::_gui_track_selection_changed (ARDOUR::RouteNotificationList* rl, bool save_list)
1382 {
1383         /* We need to keep a list of the most recently selected routes around,
1384            but we are not allowed to keep shared_ptr<Route> unless we want to
1385            handle the complexities of route deletion. So instead, the GUI sends
1386            us a notification using weak_ptr<Route>, which we keep a copy
1387            of. For efficiency's sake, however, we convert the weak_ptr's into
1388            shared_ptr<Route> before passing them to however many surfaces (and
1389            thus strips) that we have.
1390         */
1391
1392         StrongRouteNotificationList srl;
1393
1394         for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
1395                 boost::shared_ptr<ARDOUR::Route> r = (*i).lock();
1396                 if (r) {
1397                         srl.push_back (r);
1398                 }
1399         }
1400
1401         {
1402                 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1403
1404                 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1405                         (*s)->gui_selection_changed (srl);
1406                 }
1407         }
1408
1409         if (save_list) {
1410                 _last_selected_routes = *rl;
1411         }
1412 }
1413
1414 framepos_t
1415 MackieControlProtocol::transport_frame() const
1416 {
1417         return session->transport_frame();
1418 }
1419
1420 void
1421 MackieControlProtocol::add_down_select_button (int surface, int strip)
1422 {
1423         _down_select_buttons.insert ((surface<<8)|(strip&0xf));
1424 }
1425
1426 void
1427 MackieControlProtocol::remove_down_select_button (int surface, int strip)
1428 {
1429         DownButtonList::iterator x = find (_down_select_buttons.begin(), _down_select_buttons.end(), (uint32_t) (surface<<8)|(strip&0xf));
1430         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down select buttons\n", surface, strip));
1431         if (x != _down_select_buttons.end()) {
1432                 _down_select_buttons.erase (x);
1433         } else {
1434                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down select buttons\n",
1435                                                                    surface, strip));
1436         }
1437 }
1438
1439 void
1440 MackieControlProtocol::select_range ()
1441 {
1442         RouteList routes;
1443
1444         pull_route_range (_down_select_buttons, routes);
1445
1446         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("select range: found %1 routes\n", routes.size()));
1447
1448         if (!routes.empty()) {
1449                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1450
1451                         if (_modifier_state == MODIFIER_CONTROL) {
1452                                 ToggleRouteSelection ((*r)->remote_control_id ());
1453                         } else {
1454                                 if (r == routes.begin()) {
1455                                         SetRouteSelection ((*r)->remote_control_id());
1456                                 } else {
1457                                         AddRouteToSelection ((*r)->remote_control_id());
1458                                 }
1459                         }
1460                 }
1461         }
1462 }
1463
1464 void
1465 MackieControlProtocol::add_down_button (AutomationType a, int surface, int strip)
1466 {
1467         DownButtonMap::iterator m = _down_buttons.find (a);
1468
1469         if (m == _down_buttons.end()) {
1470                 _down_buttons[a] = DownButtonList();
1471         }
1472
1473         _down_buttons[a].insert ((surface<<8)|(strip&0xf));
1474 }
1475
1476 void
1477 MackieControlProtocol::remove_down_button (AutomationType a, int surface, int strip)
1478 {
1479         DownButtonMap::iterator m = _down_buttons.find (a);
1480
1481         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down buttons for %3\n", surface, strip, (int) a));
1482
1483         if (m == _down_buttons.end()) {
1484                 return;
1485         }
1486
1487         DownButtonList& l (m->second);
1488         DownButtonList::iterator x = find (l.begin(), l.end(), (surface<<8)|(strip&0xf));
1489
1490         if (x != l.end()) {
1491                 l.erase (x);
1492         } else {
1493                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down buttons for %3\n",
1494                                                                    surface, strip, (int) a));
1495         }
1496 }
1497
1498 MackieControlProtocol::ControlList
1499 MackieControlProtocol::down_controls (AutomationType p)
1500 {
1501         ControlList controls;
1502         RouteList routes;
1503
1504         DownButtonMap::iterator m = _down_buttons.find (p);
1505
1506         if (m == _down_buttons.end()) {
1507                 return controls;
1508         }
1509
1510         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("looking for down buttons for %1, got %2\n",
1511                                                            p, m->second.size()));
1512
1513         pull_route_range (m->second, routes);
1514
1515         switch (p) {
1516         case GainAutomation:
1517                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1518                         controls.push_back ((*r)->gain_control());
1519                 }
1520                 break;
1521         case SoloAutomation:
1522                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1523                         controls.push_back ((*r)->solo_control());
1524                 }
1525                 break;
1526         case MuteAutomation:
1527                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1528                         controls.push_back ((*r)->mute_control());
1529                 }
1530                 break;
1531         case RecEnableAutomation:
1532                 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1533                         boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (*r);
1534                         if (trk) {
1535                                 controls.push_back (trk->rec_enable_control());
1536                         }
1537                 }
1538                 break;
1539         default:
1540                 break;
1541         }
1542
1543         return controls;
1544
1545 }
1546
1547 struct ButtonRangeSorter {
1548     bool operator() (const uint32_t& a, const uint32_t& b) {
1549             return (a>>8) < (b>>8) // a.surface < b.surface
1550                     ||
1551                     ((a>>8) == (b>>8) && (a&0xf) < (b&0xf)); // a.surface == b.surface && a.strip < b.strip
1552     }
1553 };
1554
1555 void
1556 MackieControlProtocol::pull_route_range (DownButtonList& down, RouteList& selected)
1557 {
1558         ButtonRangeSorter cmp;
1559
1560         if (down.empty()) {
1561                 return;
1562         }
1563
1564         list<uint32_t> ldown;
1565         ldown.insert (ldown.end(), down.begin(), down.end());
1566         ldown.sort (cmp);
1567
1568         uint32_t first = ldown.front();
1569         uint32_t last = ldown.back ();
1570
1571         uint32_t first_surface = first>>8;
1572         uint32_t first_strip = first&0xf;
1573
1574         uint32_t last_surface = last>>8;
1575         uint32_t last_strip = last&0xf;
1576
1577         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("PRR %5 in list %1.%2 - %3.%4\n", first_surface, first_strip, last_surface, last_strip,
1578                                                            down.size()));
1579
1580         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1581
1582         for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1583
1584                 if ((*s)->number() >= first_surface && (*s)->number() <= last_surface) {
1585
1586                         uint32_t fs;
1587                         uint32_t ls;
1588
1589                         if ((*s)->number() == first_surface) {
1590                                 fs = first_strip;
1591                         } else {
1592                                 fs = 0;
1593                         }
1594
1595                         if ((*s)->number() == last_surface) {
1596                                 ls = last_strip;
1597                                 ls += 1;
1598                         } else {
1599                                 ls = (*s)->n_strips ();
1600                         }
1601
1602                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("adding strips for surface %1 (%2 .. %3)\n",
1603                                                                            (*s)->number(), fs, ls));
1604
1605                         for (uint32_t n = fs; n < ls; ++n) {
1606                                 boost::shared_ptr<Route> r = (*s)->nth_strip (n)->route();
1607                                 if (r) {
1608                                         selected.push_back (r);
1609                                 }
1610                         }
1611                 }
1612         }
1613 }
1614
1615 void
1616 MackieControlProtocol::set_ipmidi_base (int16_t portnum)
1617 {
1618         /* this will not be saved without a session save, so .. */
1619
1620         session->set_dirty ();
1621
1622         _ipmidi_base = portnum;
1623
1624         /* if the current device uses ipMIDI we need
1625            to restart.
1626         */
1627
1628         if (active() && _device_info.uses_ipmidi()) {
1629                 needs_ipmidi_restart = true;
1630         }
1631 }
1632
1633 int
1634 MackieControlProtocol::ipmidi_restart ()
1635 {
1636         clear_surfaces ();
1637         if (create_surfaces ()) {
1638                 return -1;
1639         }
1640         switch_banks (_current_initial_bank, true);
1641         needs_ipmidi_restart = false;
1642         return 0;
1643 }
1644
1645 void
1646 MackieControlProtocol::clear_surfaces ()
1647 {
1648         clear_ports ();
1649         Glib::Threads::Mutex::Lock lm (surfaces_lock);
1650         surfaces.clear ();
1651 }