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