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