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