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