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