libs/surfaces/mackie/mackie_control_protocol.cc

   1 /*
   2         Copyright (C) 2006,2007 John Anderson
   3
   4         This program is free software; you can redistribute it and/or modify
   5         it under the terms of the GNU General Public License as published by
   6         the Free Software Foundation; either version 2 of the License, or
   7         (at your option) any later version.
   8
   9         This program is distributed in the hope that it will be useful,
  10         but WITHOUT ANY WARRANTY; without even the implied warranty of
  11         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12         GNU General Public License for more details.
  13
  14         You should have received a copy of the GNU General Public License
  15         along with this program; if not, write to the Free Software
  16         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #include <fcntl.h>
  20 #include <iostream>
  21 #include <algorithm>
  22 #include <cmath>
  23 #include <sstream>
  24 #include <vector>
  25 #include <iomanip>
  26
  27 #include <inttypes.h>
  28 #include <float.h>
  29 #include <sys/time.h>
  30 #include <errno.h>
  31 #include <poll.h>
  32
  33 #include <boost/shared_array.hpp>
  34
  35 #include "midi++/types.h"
  36 #include "midi++/port.h"
  37 #include "midi++/manager.h"
  38 #include "pbd/pthread_utils.h"
  39 #include "pbd/error.h"
  40 #include "pbd/memento_command.h"
  41 #include "pbd/convert.h"
  42
  43 #include "ardour/dB.h"
  44 #include "ardour/debug.h"
  45 #include "ardour/location.h"
  46 #include "ardour/midi_ui.h"
  47 #include "ardour/panner.h"
  48 #include "ardour/panner_shell.h"
  49 #include "ardour/route.h"
  50 #include "ardour/session.h"
  51 #include "ardour/tempo.h"
  52 #include "ardour/types.h"
  53 #include "ardour/audioengine.h"
  54
  55 #include "mackie_control_protocol.h"
  56
  57 #include "midi_byte_array.h"
  58 #include "mackie_control_exception.h"
  59 #include "route_signal.h"
  60 #include "mackie_midi_builder.h"
  61 #include "surface_port.h"
  62 #include "surface.h"
  63 #include "bcf_surface.h"
  64 #include "mackie_surface.h"
  65
  66 using namespace ARDOUR;
  67 using namespace std;
  68 using namespace Mackie;
  69 using namespace PBD;
  70
  71 #include "i18n.h"
  72
  73 MackieMidiBuilder builder;
  74
  75 #define midi_ui_context() MidiControlUI::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
  76 #define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
  77
  78 MackieControlProtocol::MackieControlProtocol (Session& session)
  79         : ControlProtocol (session, X_("Mackie"), MidiControlUI::instance())
  80         , _current_initial_bank (0)
  81         , _surface (0)
  82         , _jog_wheel (*this)
  83         , _timecode_type (ARDOUR::AnyTime::BBT)
  84         , _input_bundle (new ARDOUR::Bundle (_("Mackie Control In"), true))
  85         , _output_bundle (new ARDOUR::Bundle (_("Mackie Control Out"), false))
  86         , _gui (0)
  87 {
  88         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
  89 }
  90
  91 MackieControlProtocol::~MackieControlProtocol()
  92 {
  93         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol\n");
  94
  95         try {
  96                 close();
  97         }
  98         catch (exception & e) {
  99                 cout << "~MackieControlProtocol caught " << e.what() << endl;
 100         }
 101         catch (...) {
 102                 cout << "~MackieControlProtocol caught unknown" << endl;
 103         }
 104
 105         DEBUG_TRACE (DEBUG::MackieControl, "finished ~MackieControlProtocol::MackieControlProtocol\n");
 106 }
 107
 108 Mackie::Surface&
 109 MackieControlProtocol::surface()
 110 {
 111         if (_surface == 0) {
 112                 throw MackieControlException ("_surface is 0 in MackieControlProtocol::surface");
 113         }
 114         return *_surface;
 115 }
 116
 117 const Mackie::SurfacePort&
 118 MackieControlProtocol::mcu_port() const
 119 {
 120         if (_ports.size() < 1) {
 121                 return _dummy_port;
 122         } else {
 123                 return dynamic_cast<const MackiePort &> (*_ports[0]);
 124         }
 125 }
 126
 127 Mackie::SurfacePort&
 128 MackieControlProtocol::mcu_port()
 129 {
 130         if (_ports.size() < 1) {
 131                 return _dummy_port;
 132         } else {
 133                 return dynamic_cast<MackiePort &> (*_ports[0]);
 134         }
 135 }
 136
 137 // go to the previous track.
 138 // Assume that get_sorted_routes().size() > route_table.size()
 139 void
 140 MackieControlProtocol::prev_track()
 141 {
 142         if (_current_initial_bank >= 1) {
 143                 session->set_dirty();
 144                 switch_banks (_current_initial_bank - 1);
 145         }
 146 }
 147
 148 // go to the next track.
 149 // Assume that get_sorted_routes().size() > route_table.size()
 150 void
 151 MackieControlProtocol::next_track()
 152 {
 153         Sorted sorted = get_sorted_routes();
 154         if (_current_initial_bank + route_table.size() < sorted.size())
 155         {
 156                 session->set_dirty();
 157                 switch_banks (_current_initial_bank + 1);
 158         }
 159 }
 160
 161 void
 162 MackieControlProtocol::clear_route_signals()
 163 {
 164         for (RouteSignals::iterator it = route_signals.begin(); it != route_signals.end(); ++it) {
 165                 delete *it;
 166         }
 167         route_signals.clear();
 168 }
 169
 170 // return the port for a given id - 0 based
 171 // throws an exception if no port found
 172 MackiePort&
 173 MackieControlProtocol::port_for_id (uint32_t index)
 174 {
 175         uint32_t current_max = 0;
 176         for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
 177                 current_max += (*it)->strips();
 178                 if (index < current_max) return **it;
 179         }
 180
 181         // oops - no matching port
 182         ostringstream os;
 183         os << "No port for index " << index;
 184         throw MackieControlException (os.str());
 185 }
 186
 187 // predicate for sort call in get_sorted_routes
 188 struct RouteByRemoteId
 189 {
 190         bool operator () (const boost::shared_ptr<Route> & a, const boost::shared_ptr<Route> & b) const
 191         {
 192                 return a->remote_control_id() < b->remote_control_id();
 193         }
 194
 195         bool operator () (const Route & a, const Route & b) const
 196         {
 197                 return a.remote_control_id() < b.remote_control_id();
 198         }
 199
 200         bool operator () (const Route * a, const Route * b) const
 201         {
 202                 return a->remote_control_id() < b->remote_control_id();
 203         }
 204 };
 205
 206 MackieControlProtocol::Sorted
 207 MackieControlProtocol::get_sorted_routes()
 208 {
 209         Sorted sorted;
 210
 211         // fetch all routes
 212         boost::shared_ptr<RouteList> routes = session->get_routes();
 213         set<uint32_t> remote_ids;
 214
 215         // routes with remote_id 0 should never be added
 216         // TODO verify this with ardour devs
 217         // remote_ids.insert (0);
 218
 219         // sort in remote_id order, and exclude master, control and hidden routes
 220         // and any routes that are already set.
 221         for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it)
 222         {
 223                 Route & route = **it;
 224                 if (
 225                                 route.active()
 226                                 && !route.is_master()
 227                                 && !route.is_hidden()
 228                                 && !route.is_monitor()
 229                                 && remote_ids.find (route.remote_control_id()) == remote_ids.end()
 230                 )
 231                 {
 232                         sorted.push_back (*it);
 233                         remote_ids.insert (route.remote_control_id());
 234                 }
 235         }
 236         sort (sorted.begin(), sorted.end(), RouteByRemoteId());
 237         return sorted;
 238 }
 239
 240 void
 241 MackieControlProtocol::refresh_current_bank()
 242 {
 243         switch_banks (_current_initial_bank);
 244 }
 245
 246 void
 247 MackieControlProtocol::switch_banks (int initial)
 248 {
 249         // DON'T prevent bank switch if initial == _current_initial_bank
 250         // because then this method can't be used as a refresh
 251
 252         // sanity checking
 253         Sorted sorted = get_sorted_routes();
 254         int delta = sorted.size() - route_table.size();
 255         if (initial < 0 || (delta > 0 && initial > delta))
 256         {
 257                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("not switching to %1\n", initial));
 258                 return;
 259         }
 260         _current_initial_bank = initial;
 261
 262         // first clear the signals from old routes
 263         // taken care of by the RouteSignal destructors
 264         clear_route_signals();
 265
 266         // now set the signals for new routes
 267         if (_current_initial_bank <= sorted.size())
 268         {
 269                 // fetch the bank start and end to switch to
 270                 uint32_t end_pos = min (route_table.size(), sorted.size());
 271                 Sorted::iterator it = sorted.begin() + _current_initial_bank;
 272                 Sorted::iterator end = sorted.begin() + _current_initial_bank + end_pos;
 273
 274                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch to %1, %2\n", _current_initial_bank, end_pos));
 275
 276                 // link routes to strips
 277                 uint32_t i = 0;
 278                 for (; it != end && it != sorted.end(); ++it, ++i)
 279                 {
 280                         boost::shared_ptr<Route> route = *it;
 281
 282                         assert (surface().strips[i]);
 283                         Strip & strip = *surface().strips[i];
 284
 285                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("remote id %1 connecting %2 to %3 with port %4\n",
 286                                                                            route->remote_control_id(), route->name(), strip.name(), port_for_id(i)));
 287                         route_table[i] = route;
 288                         RouteSignal * rs = new RouteSignal (route, *this, strip, port_for_id(i));
 289                         route_signals.push_back (rs);
 290                         // update strip from route
 291                         rs->notify_all();
 292                 }
 293
 294                 // create dead strips if there aren't enough routes to
 295                 // fill a bank
 296                 for (; i < route_table.size(); ++i)
 297                 {
 298                         Strip & strip = *surface().strips[i];
 299                         // send zero for this strip
 300                         MackiePort & port = port_for_id(i);
 301                         port.write (builder.zero_strip (port, strip));
 302                 }
 303         }
 304
 305         // display the current start bank.
 306         surface().display_bank_start (mcu_port(), builder, _current_initial_bank);
 307 }
 308
 309 void
 310 MackieControlProtocol::zero_all()
 311 {
 312         // TODO turn off Timecode displays
 313
 314         // zero all strips
 315         for (Surface::Strips::iterator it = surface().strips.begin(); it != surface().strips.end(); ++it)
 316         {
 317                 MackiePort & port = port_for_id ((*it)->index());
 318                 port.write (builder.zero_strip (port, **it));
 319         }
 320
 321         // and the master strip
 322         mcu_port().write (builder.zero_strip (dynamic_cast<MackiePort&> (mcu_port()), master_strip()));
 323
 324         // turn off global buttons and leds
 325         // global buttons are only ever on mcu_port, so we don't have
 326         // to figure out which port.
 327         for (Surface::Controls::iterator it = surface().controls.begin(); it != surface().controls.end(); ++it)
 328         {
 329                 Control & control = **it;
 330                 if (!control.group().is_strip() && control.accepts_feedback())
 331                 {
 332                         mcu_port().write (builder.zero_control (control));
 333                 }
 334         }
 335
 336         // any hardware-specific stuff
 337         surface().zero_all (mcu_port(), builder);
 338 }
 339
 340 int
 341 MackieControlProtocol::set_active (bool yn)
 342 {
 343         if (yn != _active)
 344         {
 345                 try
 346                 {
 347                         // the reason for the locking and unlocking is that
 348                         // glibmm can't do a condition wait on a RecMutex
 349                         if (yn)
 350                         {
 351                                 // TODO what happens if this fails half way?
 352
 353                                 // create MackiePorts
 354                                 {
 355                                         Glib::Mutex::Lock lock (update_mutex);
 356                                         create_ports();
 357                                 }
 358
 359                                 // now initialise MackiePorts - ie exchange sysex messages
 360                                 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
 361                                         (*it)->open();
 362                                 }
 363
 364                                 // wait until all ports are active
 365                                 // TODO a more sophisticated approach would
 366                                 // allow things to start up with only an MCU, even if
 367                                 // extenders were specified but not responding.
 368                                 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
 369                                         (*it)->wait_for_init();
 370                                 }
 371
 372                                 // create surface object. This depends on the ports being
 373                                 // correctly initialised
 374                                 initialize_surface();
 375                                 connect_session_signals();
 376
 377                                 // yeehah!
 378                                 _active = true;
 379
 380                                 // send current control positions to surface
 381                                 // must come after _active = true otherwise it won't run
 382                                 update_surface();
 383                         } else {
 384                                 close();
 385                                 _active = false;
 386                         }
 387                 }
 388
 389                 catch (exception & e) {
 390                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("set_active to false because exception caught: %1\n", e.what()));
 391                         _active = false;
 392                         throw;
 393                 }
 394         }
 395
 396         return 0;
 397 }
 398
 399 bool
 400 MackieControlProtocol::handle_strip_button (SurfacePort & port, Control & control, ButtonState bs, boost::shared_ptr<Route> route)
 401 {
 402         bool state = false;
 403
 404         if (bs == press)
 405         {
 406                 if (control.name() == "recenable")
 407                 {
 408                         state = !route->record_enabled();
 409                         route->set_record_enabled (state, this);
 410                 }
 411                 else if (control.name() == "mute")
 412                 {
 413                         state = !route->muted();
 414                         route->set_mute (state, this);
 415                 }
 416                 else if (control.name() == "solo")
 417                 {
 418                         state = !route->soloed();
 419                         route->set_solo (state, this);
 420                 }
 421                 else if (control.name() == "select")
 422                 {
 423                         // TODO make the track selected. Whatever that means.
 424                         //state = default_button_press (dynamic_cast<Button&> (control));
 425                 }
 426                 else if (control.name() == "vselect")
 427                 {
 428                         // TODO could be used to select different things to apply the pot to?
 429                         //state = default_button_press (dynamic_cast<Button&> (control));
 430                 }
 431         }
 432
 433         if (control.name() == "fader_touch")
 434         {
 435                 state = bs == press;
 436                 control.strip().gain().set_in_use (state);
 437
 438                 if (ARDOUR::Config->get_mackie_emulation() == "bcf" && state) {
 439                         /* BCF faders don't support touch, so add a timeout to reset
 440                            their `in_use' state.
 441                         */
 442                         port.add_in_use_timeout (control.strip().gain(), &control.strip().fader_touch());
 443                 }
 444         }
 445
 446         return state;
 447 }
 448
 449 void
 450 MackieControlProtocol::update_led (Mackie::Button & button, Mackie::LedState ls)
 451 {
 452         if (ls != none)
 453         {
 454                 SurfacePort * port = 0;
 455                 if (button.group().is_strip())
 456                 {
 457                         if (button.group().is_master())
 458                         {
 459                                 port = &mcu_port();
 460                         }
 461                         else
 462                         {
 463                                 port = &port_for_id (dynamic_cast<const Strip&> (button.group()).index());
 464                         }
 465                 }
 466                 else
 467                 {
 468                         port = &mcu_port();
 469                 }
 470                 port->write (builder.build_led (button, ls));
 471         }
 472 }
 473
 474 void
 475 MackieControlProtocol::update_timecode_beats_led()
 476 {
 477         switch (_timecode_type)
 478         {
 479                 case ARDOUR::AnyTime::BBT:
 480                         update_global_led ("beats", on);
 481                         update_global_led ("timecode", off);
 482                         break;
 483                 case ARDOUR::AnyTime::Timecode:
 484                         update_global_led ("timecode", on);
 485                         update_global_led ("beats", off);
 486                         break;
 487                 default:
 488                         ostringstream os;
 489                         os << "Unknown Anytime::Type " << _timecode_type;
 490                         throw runtime_error (os.str());
 491         }
 492 }
 493
 494 void
 495 MackieControlProtocol::update_global_button (const string & name, LedState ls)
 496 {
 497         if (surface().controls_by_name.find (name) != surface().controls_by_name.end())
 498         {
 499                 Button * button = dynamic_cast<Button*> (surface().controls_by_name[name]);
 500                 mcu_port().write (builder.build_led (button->led(), ls));
 501         }
 502         else
 503         {
 504                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", name));
 505         }
 506 }
 507
 508 void
 509 MackieControlProtocol::update_global_led (const string & name, LedState ls)
 510 {
 511         if (surface().controls_by_name.find (name) != surface().controls_by_name.end())
 512         {
 513                 Led * led = dynamic_cast<Led*> (surface().controls_by_name[name]);
 514                 mcu_port().write (builder.build_led (*led, ls));
 515         }
 516         else
 517         {
 518                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", name));
 519         }
 520 }
 521
 522 // send messages to surface to set controls to correct values
 523 void
 524 MackieControlProtocol::update_surface()
 525 {
 526         if (_active)
 527         {
 528                 // do the initial bank switch to connect signals
 529                 // _current_initial_bank is initialised by set_state
 530                 switch_banks (_current_initial_bank);
 531
 532                 // create a RouteSignal for the master route
 533
 534  boost::shared_ptr<Route> mr = master_route ();
 535  if (mr) {
 536  master_route_signal = boost::shared_ptr<RouteSignal> (new RouteSignal (mr, *this, master_strip(), mcu_port()));
 537  // update strip from route
 538  master_route_signal->notify_all();
 539  }
 540
 541                 // sometimes the jog wheel is a pot
 542                 surface().blank_jog_ring (mcu_port(), builder);
 543
 544                 // update global buttons and displays
 545                 notify_record_state_changed();
 546                 notify_transport_state_changed();
 547                 update_timecode_beats_led();
 548         }
 549 }
 550
 551 void
 552 MackieControlProtocol::connect_session_signals()
 553 {
 554         // receive routes added
 555         session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_route_added, this, _1), midi_ui_context());
 556         // receive record state toggled
 557         session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_record_state_changed, this), midi_ui_context());
 558         // receive transport state changed
 559         session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_transport_state_changed, this), midi_ui_context());
 560         // receive punch-in and punch-out
 561         Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), midi_ui_context());
 562         session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), midi_ui_context());
 563         // receive rude solo changed
 564         session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), midi_ui_context());
 565
 566         // make sure remote id changed signals reach here
 567         // see also notify_route_added
 568         Sorted sorted = get_sorted_routes();
 569
 570         for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
 571                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind(&MackieControlProtocol::notify_remote_id_changed, this), midi_ui_context());
 572         }
 573 }
 574
 575 void
 576 MackieControlProtocol::add_port (MIDI::Port & midi_input_port, MIDI::Port & midi_output_port, int number)
 577 {
 578         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("add port %1 %2\n", midi_input_port.name(), midi_output_port.name()));
 579
 580         MackiePort * sport = new MackiePort (*this, midi_input_port, midi_output_port, number);
 581         _ports.push_back (sport);
 582
 583         sport->init_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_port_init, this, sport));
 584         sport->active_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_port_active, this, sport));
 585         sport->inactive_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_port_inactive, this, sport));
 586
 587         _input_bundle->add_channel (
 588                 midi_input_port.name(),
 589                 ARDOUR::DataType::MIDI,
 590                 session->engine().make_port_name_non_relative (midi_input_port.name())
 591                 );
 592
 593         _output_bundle->add_channel (
 594                 midi_output_port.name(),
 595                 ARDOUR::DataType::MIDI,
 596                 session->engine().make_port_name_non_relative (midi_output_port.name())
 597                 );
 598 }
 599
 600 void
 601 MackieControlProtocol::create_ports()
 602 {
 603         MIDI::Manager * mm = MIDI::Manager::instance();
 604         MIDI::Port * midi_input_port = mm->add_port (
 605                 new MIDI::Port (string_compose (_("%1 in"), default_port_name), MIDI::Port::IsInput, session->engine().jack())
 606                 );
 607         MIDI::Port * midi_output_port = mm->add_port (
 608                 new MIDI::Port (string_compose (_("%1 out"), default_port_name), MIDI::Port::IsOutput, session->engine().jack())
 609                 );
 610
 611         /* Create main port */
 612
 613         if (!midi_input_port->ok() || !midi_output_port->ok()) {
 614                 ostringstream os;
 615                 os << _("Mackie control MIDI ports could not be created; Mackie control disabled");
 616                 error << os.str() << endmsg;
 617                 throw MackieControlException (os.str());
 618         }
 619
 620         add_port (*midi_input_port, *midi_output_port, 0);
 621
 622         /* Create extender ports */
 623
 624         for (uint32_t index = 1; index <= Config->get_mackie_extenders(); ++index) {
 625                 MIDI::Port * midi_input_port = mm->add_port (
 626                         new MIDI::Port (string_compose (_("mcu_xt_%1 in"), index), MIDI::Port::IsInput, session->engine().jack())
 627                         );
 628                 MIDI::Port * midi_output_port = mm->add_port (
 629                         new MIDI::Port (string_compose (_("mcu_xt_%1 out"), index), MIDI::Port::IsOutput, session->engine().jack())
 630                         );
 631                 if (midi_input_port->ok() && midi_output_port->ok()) {
 632                         add_port (*midi_input_port, *midi_output_port, index);
 633                 }
 634         }
 635 }
 636
 637 boost::shared_ptr<Route>
 638 MackieControlProtocol::master_route()
 639 {
 640         return session->master_out ();
 641 }
 642
 643 Strip&
 644 MackieControlProtocol::master_strip()
 645 {
 646         return dynamic_cast<Strip&> (*surface().groups["master"]);
 647 }
 648
 649 void
 650 MackieControlProtocol::initialize_surface()
 651 {
 652         // set up the route table
 653         int strips = 0;
 654         for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
 655                 strips += (*it)->strips();
 656         }
 657
 658         set_route_table_size (strips);
 659
 660         // TODO same as code in mackie_port.cc
 661         string emulation = ARDOUR::Config->get_mackie_emulation();
 662         if (emulation == "bcf")
 663         {
 664                 _surface = new BcfSurface (strips);
 665         }
 666         else if (emulation == "mcu")
 667         {
 668                 _surface = new MackieSurface (strips);
 669         }
 670         else
 671         {
 672                 ostringstream os;
 673                 os << "no Surface class found for emulation: " << emulation;
 674                 throw MackieControlException (os.str());
 675         }
 676
 677         _surface->init();
 678
 679         // Connect events. Must be after route table otherwise there will be trouble
 680
 681         for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
 682                 (*it)->control_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_control_event, this, _1, _2, _3));
 683         }
 684 }
 685
 686 void
 687 MackieControlProtocol::close()
 688 {
 689
 690         // must be before other shutdown otherwise polling loop
 691         // calls methods on objects that are deleted
 692
 693         port_connections.drop_connections ();
 694         session_connections.drop_connections ();
 695         route_connections.drop_connections ();
 696
 697         if (_surface != 0) {
 698                 // These will fail if the port has gone away.
 699                 // So catch the exception and do the rest of the
 700                 // close afterwards
 701                 // because the bcf doesn't respond to the next 3 sysex messages
 702                 try {
 703                         zero_all();
 704                 }
 705
 706                 catch (exception & e) {
 707                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::close caught exception: %1\n", e.what()));
 708                 }
 709
 710                 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
 711                         try {
 712                                 MackiePort & port = **it;
 713                                 // faders to minimum
 714                                 port.write_sysex (0x61);
 715                                 // All LEDs off
 716                                 port.write_sysex (0x62);
 717                                 // Reset (reboot into offline mode)
 718                                 port.write_sysex (0x63);
 719                         }
 720                         catch (exception & e) {
 721                                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::close caught exception: %1\n", e.what()));
 722                         }
 723                 }
 724
 725                 // disconnect routes from strips
 726                 clear_route_signals();
 727                 delete _surface;
 728                 _surface = 0;
 729         }
 730
 731         // shut down MackiePorts
 732         for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
 733                 delete *it;
 734         }
 735
 736         _ports.clear();
 737 }
 738
 739 XMLNode&
 740 MackieControlProtocol::get_state()
 741 {
 742         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state\n");
 743
 744         // add name of protocol
 745         XMLNode* node = new XMLNode (X_("Protocol"));
 746         node->add_property (X_("name"), _name);
 747
 748         // add current bank
 749         ostringstream os;
 750         os << _current_initial_bank;
 751         node->add_property (X_("bank"), os.str());
 752
 753         return *node;
 754 }
 755
 756 int
 757 MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
 758 {
 759         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", _active));
 760
 761         int retval = 0;
 762
 763         // fetch current bank
 764
 765         if (node.property (X_("bank")) != 0) {
 766                 string bank = node.property (X_("bank"))->value();
 767                 try {
 768                         set_active (true);
 769                         uint32_t new_bank = atoi (bank.c_str());
 770                         if (_current_initial_bank != new_bank) {
 771                                 switch_banks (new_bank);
 772                         }
 773                 }
 774                 catch (exception & e) {
 775                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("exception in MackieControlProtocol::set_state: %1\n", e.what()));
 776                         return -1;
 777                 }
 778         }
 779
 780         return retval;
 781 }
 782
 783 void
 784 MackieControlProtocol::handle_control_event (SurfacePort & port, Control & control, const ControlState & state)
 785 {
 786         // find the route for the control, if there is one
 787         boost::shared_ptr<Route> route;
 788         if (control.group().is_strip()) {
 789                 if (control.group().is_master()) {
 790                         route = master_route();
 791                 } else {
 792                         uint32_t index = control.ordinal() - 1 + (port.number() * port.strips());
 793                         if (index < route_table.size())
 794                                 route = route_table[index];
 795                         else
 796                                 cerr << "Warning: index is " << index << " which is not in the route table, size: " << route_table.size() << endl;
 797                 }
 798         }
 799
 800         // This handles control element events from the surface
 801         // the state of the controls on the surface is usually updated
 802         // from UI events.
 803         switch (control.type()) {
 804                 case Control::type_fader:
 805                         // find the route in the route table for the id
 806                         // if the route isn't available, skip it
 807                         // at which point the fader should just reset itself
 808                         if (route != 0)
 809                         {
 810                                 route->gain_control()->set_value (slider_position_to_gain (state.pos));
 811
 812                                 if (ARDOUR::Config->get_mackie_emulation() == "bcf") {
 813                                         /* reset the timeout while we're still moving the fader */
 814                                         port.add_in_use_timeout (control, control.in_use_touch_control);
 815                                 }
 816
 817                                 // must echo bytes back to slider now, because
 818                                 // the notifier only works if the fader is not being
 819                                 // touched. Which it is if we're getting input.
 820                                 port.write (builder.build_fader ((Fader&)control, state.pos));
 821                         }
 822                         break;
 823
 824                 case Control::type_button:
 825                         if (control.group().is_strip()) {
 826                                 // strips
 827                                 if (route != 0) {
 828                                         handle_strip_button (port, control, state.button_state, route);
 829                                 } else {
 830                                         // no route so always switch the light off
 831                                         // because no signals will be emitted by a non-route
 832                                         port.write (builder.build_led (control.led(), off));
 833                                 }
 834                         } else if (control.group().is_master()) {
 835                                 // master fader touch
 836                                 if (route != 0) {
 837                                         handle_strip_button (port, control, state.button_state, route);
 838                                 }
 839                         } else {
 840                                 // handle all non-strip buttons
 841                                 surface().handle_button (*this, state.button_state, dynamic_cast<Button&> (control));
 842                         }
 843                         break;
 844
 845                 // pot (jog wheel, external control)
 846                 case Control::type_pot:
 847                         if (control.group().is_strip()) {
 848                                 if (route) {
 849                                         boost::shared_ptr<Panner> panner = route->panner_shell()->panner();
 850                                         // pan for mono input routes, or stereo linked panners
 851                                         if (panner) {
 852                                                 double p = panner->position ();
 853
 854                                                 // calculate new value, and adjust
 855                                                 p += state.delta * state.sign;
 856                                                 p = min (1.0, p);
 857                                                 p = max (0.0, p);
 858                                                 panner->set_position (p);
 859                                         }
 860                                 }
 861                                 else
 862                                 {
 863                                         // it's a pot for an umnapped route, so turn all the lights off
 864                                         port.write (builder.build_led_ring (dynamic_cast<Pot &> (control), off));
 865                                 }
 866                         }
 867                         else
 868                         {
 869                                 if (control.is_jog())
 870                                 {
 871                                         _jog_wheel.jog_event (port, control, state);
 872                                 }
 873                                 else
 874                                 {
 875                                         cout << "external controller" << state.ticks * state.sign << endl;
 876                                 }
 877                         }
 878                         break;
 879
 880                 default:
 881                         cout << "Control::type not handled: " << control.type() << endl;
 882         }
 883 }
 884
 885 /////////////////////////////////////////////////
 886 // handlers for Route signals
 887 // TODO should these be part of RouteSignal?
 888 // They started off as signal/slot handlers for signals
 889 // from Route, but they're also used in polling for automation
 890 /////////////////////////////////////////////////
 891
 892 void
 893 MackieControlProtocol::notify_solo_changed (RouteSignal * route_signal)
 894 {
 895         try
 896         {
 897                 Button & button = route_signal->strip().solo();
 898                 route_signal->port().write (builder.build_led (button, route_signal->route()->soloed()));
 899         }
 900         catch (exception & e)
 901         {
 902                 cout << e.what() << endl;
 903         }
 904 }
 905
 906 void
 907 MackieControlProtocol::notify_mute_changed (RouteSignal * route_signal)
 908 {
 909         try
 910         {
 911                 Button & button = route_signal->strip().mute();
 912                 route_signal->port().write (builder.build_led (button, route_signal->route()->muted()));
 913         }
 914         catch (exception & e)
 915         {
 916                 cout << e.what() << endl;
 917         }
 918 }
 919
 920 void
 921 MackieControlProtocol::notify_record_enable_changed (RouteSignal * route_signal)
 922 {
 923         try
 924         {
 925                 Button & button = route_signal->strip().recenable();
 926                 route_signal->port().write (builder.build_led (button, route_signal->route()->record_enabled()));
 927         }
 928         catch (exception & e)
 929         {
 930                 cout << e.what() << endl;
 931         }
 932 }
 933
 934 void MackieControlProtocol::notify_active_changed (RouteSignal *)
 935 {
 936         try
 937         {
 938                 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::notify_active_changed\n");
 939                 refresh_current_bank();
 940         }
 941         catch (exception & e)
 942         {
 943                 cout << e.what() << endl;
 944         }
 945 }
 946
 947 void
 948 MackieControlProtocol::notify_gain_changed (RouteSignal * route_signal, bool force_update)
 949 {
 950         try
 951         {
 952                 Fader & fader = route_signal->strip().gain();
 953                 if (!fader.in_use())
 954                 {
 955                         float gain_value = gain_to_slider_position (route_signal->route()->gain_control()->get_value());
 956                         // check that something has actually changed
 957                         if (force_update || gain_value != route_signal->last_gain_written())
 958                         {
 959                                 route_signal->port().write (builder.build_fader (fader, gain_value));
 960                                 route_signal->last_gain_written (gain_value);
 961                         }
 962                 }
 963         }
 964         catch (exception & e)
 965         {
 966                 cout << e.what() << endl;
 967         }
 968 }
 969
 970 void
 971 MackieControlProtocol::notify_property_changed (const PropertyChange& what_changed, RouteSignal * route_signal)
 972 {
 973         if (!what_changed.contains (Properties::name)) {
 974                 return;
 975         }
 976
 977         try
 978         {
 979                 Strip & strip = route_signal->strip();
 980
 981                 /* XXX: not sure about this check to only display stuff for strips of index < 8 */
 982                 if (!strip.is_master() && strip.index() < 8)
 983                 {
 984                         string line1;
 985                         string fullname = route_signal->route()->name();
 986
 987                         if (fullname.length() <= 6)
 988                         {
 989                                 line1 = fullname;
 990                         }
 991                         else
 992                         {
 993                                 line1 = PBD::short_version (fullname, 6);
 994                         }
 995
 996                         SurfacePort & port = route_signal->port();
 997                         port.write (builder.strip_display (port, strip, 0, line1));
 998                         port.write (builder.strip_display_blank (port, strip, 1));
 999                 }
1000         }
1001         catch (exception & e)
1002         {
1003                 cout << e.what() << endl;
1004         }
1005 }
1006
1007 void
1008 MackieControlProtocol::notify_panner_changed (RouteSignal * route_signal, bool force_update)
1009 {
1010         try
1011         {
1012                 Pot & pot = route_signal->strip().vpot();
1013                 boost::shared_ptr<Panner> panner = route_signal->route()->panner();
1014                 if (panner) {
1015                         double pos = panner->position ();
1016
1017                         // cache the MidiByteArray here, because the mackie led control is much lower
1018                         // resolution than the panner control. So we save lots of byte
1019                         // sends in spite of more work on the comparison
1020                         MidiByteArray bytes = builder.build_led_ring (pot, ControlState (on, pos), MackieMidiBuilder::midi_pot_mode_dot);
1021                         // check that something has actually changed
1022                         if (force_update || bytes != route_signal->last_pan_written())
1023                         {
1024                                 route_signal->port().write (bytes);
1025                                 route_signal->last_pan_written (bytes);
1026                         }
1027                 }
1028                 else
1029                 {
1030                         route_signal->port().write (builder.zero_control (pot));
1031                 }
1032         }
1033         catch (exception & e)
1034         {
1035                 cout << e.what() << endl;
1036         }
1037 }
1038
1039 // TODO handle plugin automation polling
1040 void
1041 MackieControlProtocol::update_automation (RouteSignal & rs)
1042 {
1043         ARDOUR::AutoState gain_state = rs.route()->gain_control()->automation_state();
1044
1045         if (gain_state == Touch || gain_state == Play)
1046         {
1047                 notify_gain_changed (&rs, false);
1048         }
1049
1050         if (rs.route()->panner()) {
1051                 ARDOUR::AutoState panner_state = rs.route()->panner()->automation_state();
1052                 if (panner_state == Touch || panner_state == Play)
1053                 {
1054                         notify_panner_changed (&rs, false);
1055                 }
1056         }
1057 }
1058
1059 string
1060 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
1061 {
1062         Timecode::BBT_Time bbt_time;
1063         session->bbt_time (now_frame, bbt_time);
1064
1065         // According to the Logic docs
1066         // digits: 888/88/88/888
1067         // BBT mode: Bars/Beats/Subdivisions/Ticks
1068         ostringstream os;
1069         os << setw(3) << setfill('0') << bbt_time.bars;
1070         os << setw(2) << setfill('0') << bbt_time.beats;
1071
1072         // figure out subdivisions per beat
1073         const Meter & meter = session->tempo_map().meter_at (now_frame);
1074         int subdiv = 2;
1075         if (meter.note_divisor() == 8 && (meter.beats_per_bar() == 12.0 || meter.beats_per_bar() == 9.0 || meter.beats_per_bar() == 6.0))
1076         {
1077                 subdiv = 3;
1078         }
1079
1080         uint32_t subdivisions = bbt_time.ticks / uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
1081         uint32_t ticks = bbt_time.ticks % uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
1082
1083         os << setw(2) << setfill('0') << subdivisions + 1;
1084         os << setw(3) << setfill('0') << ticks;
1085
1086         return os.str();
1087 }
1088
1089 string
1090 MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
1091 {
1092         Timecode::Time timecode;
1093         session->timecode_time (now_frame, timecode);
1094
1095         // According to the Logic docs
1096         // digits: 888/88/88/888
1097         // Timecode mode: Hours/Minutes/Seconds/Frames
1098         ostringstream os;
1099         os << setw(3) << setfill('0') << timecode.hours;
1100         os << setw(2) << setfill('0') << timecode.minutes;
1101         os << setw(2) << setfill('0') << timecode.seconds;
1102         os << setw(3) << setfill('0') << timecode.frames;
1103
1104         return os.str();
1105 }
1106
1107 void
1108 MackieControlProtocol::update_timecode_display()
1109 {
1110         if (surface().has_timecode_display())
1111         {
1112                 // do assignment here so current_frame is fixed
1113                 framepos_t current_frame = session->transport_frame();
1114                 string timecode;
1115
1116                 switch (_timecode_type)
1117                 {
1118                         case ARDOUR::AnyTime::BBT:
1119                                 timecode = format_bbt_timecode (current_frame);
1120                                 break;
1121                         case ARDOUR::AnyTime::Timecode:
1122                                 timecode = format_timecode_timecode (current_frame);
1123                                 break;
1124                         default:
1125                                 ostringstream os;
1126                                 os << "Unknown timecode: " << _timecode_type;
1127                                 throw runtime_error (os.str());
1128                 }
1129
1130                 // only write the timecode string to the MCU if it's changed
1131                 // since last time. This is to reduce midi bandwidth used.
1132                 if (timecode != _timecode_last)
1133                 {
1134                         surface().display_timecode (mcu_port(), builder, timecode, _timecode_last);
1135                         _timecode_last = timecode;
1136                 }
1137         }
1138 }
1139
1140 void
1141 MackieControlProtocol::poll_session_data()
1142 {
1143         // XXX need to attach this to a timer in the MIDI UI event loop (20msec)
1144
1145         if (_active) {
1146                 // do all currently mapped routes
1147                 for (RouteSignals::iterator it = route_signals.begin(); it != route_signals.end(); ++it) {
1148                         update_automation (**it);
1149                 }
1150
1151                 // and the master strip
1152                 if (master_route_signal != 0) {
1153                         update_automation (*master_route_signal);
1154                 }
1155
1156                 update_timecode_display();
1157         }
1158 }
1159
1160 /////////////////////////////////////
1161 // Transport Buttons
1162 /////////////////////////////////////
1163
1164 LedState
1165 MackieControlProtocol::frm_left_press (Button &)
1166 {
1167         // can use first_mark_before/after as well
1168         unsigned long elapsed = _frm_left_last.restart();
1169
1170         Location * loc = session->locations()->first_location_before (
1171                 session->transport_frame()
1172         );
1173
1174         // allow a quick double to go past a previous mark
1175         if (session->transport_rolling() && elapsed < 500 && loc != 0)
1176         {
1177                 Location * loc_two_back = session->locations()->first_location_before (loc->start());
1178                 if (loc_two_back != 0)
1179                 {
1180                         loc = loc_two_back;
1181                 }
1182         }
1183
1184         // move to the location, if it's valid
1185         if (loc != 0)
1186         {
1187                 session->request_locate (loc->start(), session->transport_rolling());
1188         }
1189
1190         return on;
1191 }
1192
1193 LedState
1194 MackieControlProtocol::frm_left_release (Button &)
1195 {
1196         return off;
1197 }
1198
1199 LedState
1200 MackieControlProtocol::frm_right_press (Button &)
1201 {
1202         // can use first_mark_before/after as well
1203         Location * loc = session->locations()->first_location_after (
1204                 session->transport_frame()
1205         );
1206         if (loc != 0) session->request_locate (loc->start(), session->transport_rolling());
1207         return on;
1208 }
1209
1210 LedState
1211 MackieControlProtocol::frm_right_release (Button &)
1212 {
1213         return off;
1214 }
1215
1216 LedState
1217 MackieControlProtocol::stop_press (Button &)
1218 {
1219         session->request_stop();
1220         return on;
1221 }
1222
1223 LedState
1224 MackieControlProtocol::stop_release (Button &)
1225 {
1226         return session->transport_stopped();
1227 }
1228
1229 LedState
1230 MackieControlProtocol::play_press (Button &)
1231 {
1232         session->request_transport_speed (1.0);
1233         return on;
1234 }
1235
1236 LedState
1237 MackieControlProtocol::play_release (Button &)
1238 {
1239         return session->transport_rolling();
1240 }
1241
1242 LedState
1243 MackieControlProtocol::record_press (Button &)
1244 {
1245         if (session->get_record_enabled()) {
1246                 session->disable_record (false);
1247         } else {
1248                 session->maybe_enable_record();
1249         }
1250         return on;
1251 }
1252
1253 LedState
1254 MackieControlProtocol::record_release (Button &)
1255 {
1256         if (session->get_record_enabled()) {
1257                 if (session->transport_rolling()) {
1258                         return on;
1259                 } else {
1260                         return flashing;
1261                 }
1262         } else {
1263                 return off;
1264         }
1265 }
1266
1267 LedState
1268 MackieControlProtocol::rewind_press (Button &)
1269 {
1270         _jog_wheel.push (JogWheel::speed);
1271         _jog_wheel.transport_direction (-1);
1272         session->request_transport_speed (-_jog_wheel.transport_speed());
1273         return on;
1274 }
1275
1276 LedState
1277 MackieControlProtocol::rewind_release (Button &)
1278 {
1279         _jog_wheel.pop();
1280         _jog_wheel.transport_direction (0);
1281         if (_transport_previously_rolling)
1282                 session->request_transport_speed (1.0);
1283         else
1284                 session->request_stop();
1285         return off;
1286 }
1287
1288 LedState
1289 MackieControlProtocol::ffwd_press (Button &)
1290 {
1291         _jog_wheel.push (JogWheel::speed);
1292         _jog_wheel.transport_direction (1);
1293         session->request_transport_speed (_jog_wheel.transport_speed());
1294         return on;
1295 }
1296
1297 LedState
1298 MackieControlProtocol::ffwd_release (Button &)
1299 {
1300         _jog_wheel.pop();
1301         _jog_wheel.transport_direction (0);
1302         if (_transport_previously_rolling)
1303                 session->request_transport_speed (1.0);
1304         else
1305                 session->request_stop();
1306         return off;
1307 }
1308
1309 LedState
1310 MackieControlProtocol::loop_press (Button &)
1311 {
1312         session->request_play_loop (!session->get_play_loop());
1313         return on;
1314 }
1315
1316 LedState
1317 MackieControlProtocol::loop_release (Button &)
1318 {
1319         return session->get_play_loop();
1320 }
1321
1322 LedState
1323 MackieControlProtocol::punch_in_press (Button &)
1324 {
1325         bool state = !session->config.get_punch_in();
1326         session->config.set_punch_in (state);
1327         return state;
1328 }
1329
1330 LedState
1331 MackieControlProtocol::punch_in_release (Button &)
1332 {
1333         return session->config.get_punch_in();
1334 }
1335
1336 LedState
1337 MackieControlProtocol::punch_out_press (Button &)
1338 {
1339         bool state = !session->config.get_punch_out();
1340         session->config.set_punch_out (state);
1341         return state;
1342 }
1343
1344 LedState
1345 MackieControlProtocol::punch_out_release (Button &)
1346 {
1347         return session->config.get_punch_out();
1348 }
1349
1350 LedState
1351 MackieControlProtocol::home_press (Button &)
1352 {
1353         session->goto_start();
1354         return on;
1355 }
1356
1357 LedState
1358 MackieControlProtocol::home_release (Button &)
1359 {
1360         return off;
1361 }
1362
1363 LedState
1364 MackieControlProtocol::end_press (Button &)
1365 {
1366         session->goto_end();
1367         return on;
1368 }
1369
1370 LedState
1371 MackieControlProtocol::end_release (Button &)
1372 {
1373         return off;
1374 }
1375
1376 LedState
1377 MackieControlProtocol::clicking_press (Button &)
1378 {
1379         bool state = !Config->get_clicking();
1380         Config->set_clicking (state);
1381         return state;
1382 }
1383
1384 LedState
1385 MackieControlProtocol::clicking_release (Button &)
1386 {
1387         return Config->get_clicking();
1388 }
1389
1390 LedState MackieControlProtocol::global_solo_press (Button &)
1391 {
1392         bool state = !session->soloing();
1393         session->set_solo (session->get_routes(), state);
1394         return state;
1395 }
1396
1397 LedState MackieControlProtocol::global_solo_release (Button &)
1398 {
1399         return session->soloing();
1400 }
1401
1402 ///////////////////////////////////////////
1403 // Session signals
1404 ///////////////////////////////////////////
1405
1406 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
1407 {
1408         if (p == "punch-in")
1409         {
1410                 update_global_button ("punch_in", session->config.get_punch_in());
1411         }
1412         else if (p == "punch-out")
1413         {
1414                 update_global_button ("punch_out", session->config.get_punch_out());
1415         }
1416         else if (p == "clicking")
1417         {
1418                 update_global_button ("clicking", Config->get_clicking());
1419         }
1420         else
1421         {
1422                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
1423         }
1424 }
1425
1426 // RouteList is the set of routes that have just been added
1427 void
1428 MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
1429 {
1430         // currently assigned banks are less than the full set of
1431         // strips, so activate the new strip now.
1432         if (route_signals.size() < route_table.size())
1433         {
1434                 refresh_current_bank();
1435         }
1436         // otherwise route added, but current bank needs no updating
1437
1438         // make sure remote id changes in the new route are handled
1439         typedef ARDOUR::RouteList ARS;
1440
1441         for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
1442                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_remote_id_changed, this), midi_ui_context());
1443         }
1444 }
1445
1446 void
1447 MackieControlProtocol::notify_solo_active_changed (bool active)
1448 {
1449         Button * rude_solo = reinterpret_cast<Button*> (surface().controls_by_name["solo"]);
1450         mcu_port().write (builder.build_led (*rude_solo, active ? flashing : off));
1451 }
1452
1453 void
1454 MackieControlProtocol::notify_remote_id_changed()
1455 {
1456         Sorted sorted = get_sorted_routes();
1457
1458         // if a remote id has been moved off the end, we need to shift
1459         // the current bank backwards.
1460         if (sorted.size() - _current_initial_bank < route_signals.size())
1461         {
1462                 // but don't shift backwards past the zeroth channel
1463                 switch_banks (max((Sorted::size_type) 0, sorted.size() - route_signals.size()));
1464         }
1465         // Otherwise just refresh the current bank
1466         else
1467         {
1468                 refresh_current_bank();
1469         }
1470 }
1471
1472 ///////////////////////////////////////////
1473 // Transport signals
1474 ///////////////////////////////////////////
1475
1476 void
1477 MackieControlProtocol::notify_record_state_changed()
1478 {
1479         // switch rec button on / off / flashing
1480         Button * rec = reinterpret_cast<Button*> (surface().controls_by_name["record"]);
1481         mcu_port().write (builder.build_led (*rec, record_release (*rec)));
1482 }
1483
1484 void
1485 MackieControlProtocol::notify_transport_state_changed()
1486 {
1487         // switch various play and stop buttons on / off
1488         update_global_button ("play", session->transport_rolling());
1489         update_global_button ("stop", !session->transport_rolling());
1490         update_global_button ("loop", session->get_play_loop());
1491
1492         _transport_previously_rolling = session->transport_rolling();
1493
1494         // rec is special because it's tristate
1495         Button * rec = reinterpret_cast<Button*> (surface().controls_by_name["record"]);
1496         mcu_port().write (builder.build_led (*rec, record_release (*rec)));
1497 }
1498
1499 /////////////////////////////////////
1500 // Bank Switching
1501 /////////////////////////////////////
1502 LedState
1503 MackieControlProtocol::left_press (Button &)
1504 {
1505         Sorted sorted = get_sorted_routes();
1506         if (sorted.size() > route_table.size())
1507         {
1508                 int new_initial = _current_initial_bank - route_table.size();
1509                 if (new_initial < 0) {
1510                         new_initial = 0;
1511                 }
1512
1513                 if (new_initial != int (_current_initial_bank)) {
1514                         session->set_dirty();
1515                         switch_banks (new_initial);
1516                 }
1517
1518                 return on;
1519         }
1520         else
1521         {
1522                 return flashing;
1523         }
1524 }
1525
1526 LedState
1527 MackieControlProtocol::left_release (Button &)
1528 {
1529         return off;
1530 }
1531
1532 LedState
1533 MackieControlProtocol::right_press (Button &)
1534 {
1535         Sorted sorted = get_sorted_routes();
1536         if (sorted.size() > route_table.size()) {
1537                 uint32_t delta = sorted.size() - (route_table.size() + _current_initial_bank);
1538
1539                 if (delta > route_table.size()) {
1540                         delta = route_table.size();
1541                 }
1542
1543                 if (delta > 0) {
1544                         session->set_dirty();
1545                         switch_banks (_current_initial_bank + delta);
1546                 }
1547
1548                 return on;
1549         } else {
1550                 return flashing;
1551         }
1552 }
1553
1554 LedState
1555 MackieControlProtocol::right_release (Button &)
1556 {
1557         return off;
1558 }
1559
1560 LedState
1561 MackieControlProtocol::channel_left_press (Button &)
1562 {
1563         Sorted sorted = get_sorted_routes();
1564         if (sorted.size() > route_table.size())
1565         {
1566                 prev_track();
1567                 return on;
1568         }
1569         else
1570         {
1571                 return flashing;
1572         }
1573 }
1574
1575 LedState
1576 MackieControlProtocol::channel_left_release (Button &)
1577 {
1578         return off;
1579 }
1580
1581 LedState
1582 MackieControlProtocol::channel_right_press (Button &)
1583 {
1584         Sorted sorted = get_sorted_routes();
1585         if (sorted.size() > route_table.size())
1586         {
1587                 next_track();
1588                 return on;
1589         }
1590         else
1591         {
1592                 return flashing;
1593         }
1594 }
1595
1596 LedState
1597 MackieControlProtocol::channel_right_release (Button &)
1598 {
1599         return off;
1600 }
1601
1602 /////////////////////////////////////
1603 // Functions
1604 /////////////////////////////////////
1605 LedState
1606 MackieControlProtocol::marker_press (Button &)
1607 {
1608         // cut'n'paste from LocationUI::add_new_location()
1609         string markername;
1610         framepos_t where = session->audible_frame();
1611         session->locations()->next_available_name(markername,"mcu");
1612         Location *location = new Location (*session, where, where, markername, Location::IsMark);
1613         session->begin_reversible_command (_("add marker"));
1614         XMLNode &before = session->locations()->get_state();
1615         session->locations()->add (location, true);
1616         XMLNode &after = session->locations()->get_state();
1617         session->add_command (new MementoCommand<Locations>(*(session->locations()), &before, &after));
1618         session->commit_reversible_command ();
1619         return on;
1620 }
1621
1622 LedState
1623 MackieControlProtocol::marker_release (Button &)
1624 {
1625         return off;
1626 }
1627
1628 void
1629 jog_wheel_state_display (JogWheel::State state, SurfacePort & port)
1630 {
1631         switch (state)
1632         {
1633                 case JogWheel::zoom: port.write (builder.two_char_display ("Zm")); break;
1634                 case JogWheel::scroll: port.write (builder.two_char_display ("Sc")); break;
1635                 case JogWheel::scrub: port.write (builder.two_char_display ("Sb")); break;
1636                 case JogWheel::shuttle: port.write (builder.two_char_display ("Sh")); break;
1637                 case JogWheel::speed: port.write (builder.two_char_display ("Sp")); break;
1638                 case JogWheel::select: port.write (builder.two_char_display ("Se")); break;
1639         }
1640 }
1641
1642 Mackie::LedState
1643 MackieControlProtocol::zoom_press (Mackie::Button &)
1644 {
1645         _jog_wheel.zoom_state_toggle();
1646         update_global_button ("scrub", _jog_wheel.jog_wheel_state() == JogWheel::scrub);
1647         jog_wheel_state_display (_jog_wheel.jog_wheel_state(), mcu_port());
1648         return _jog_wheel.jog_wheel_state() == JogWheel::zoom;
1649 }
1650
1651 Mackie::LedState
1652 MackieControlProtocol::zoom_release (Mackie::Button &)
1653 {
1654         return _jog_wheel.jog_wheel_state() == JogWheel::zoom;
1655 }
1656
1657 Mackie::LedState
1658 MackieControlProtocol::scrub_press (Mackie::Button &)
1659 {
1660         _jog_wheel.scrub_state_cycle();
1661         update_global_button ("zoom", _jog_wheel.jog_wheel_state() == JogWheel::zoom);
1662         jog_wheel_state_display (_jog_wheel.jog_wheel_state(), mcu_port());
1663         return
1664                 _jog_wheel.jog_wheel_state() == JogWheel::scrub
1665                 ||
1666                 _jog_wheel.jog_wheel_state() == JogWheel::shuttle
1667         ;
1668 }
1669
1670 Mackie::LedState
1671 MackieControlProtocol::scrub_release (Mackie::Button &)
1672 {
1673         return
1674                 _jog_wheel.jog_wheel_state() == JogWheel::scrub
1675                 ||
1676                 _jog_wheel.jog_wheel_state() == JogWheel::shuttle
1677         ;
1678 }
1679
1680 LedState
1681 MackieControlProtocol::drop_press (Button &)
1682 {
1683         session->remove_last_capture();
1684         return on;
1685 }
1686
1687 LedState
1688 MackieControlProtocol::drop_release (Button &)
1689 {
1690         return off;
1691 }
1692
1693 LedState
1694 MackieControlProtocol::save_press (Button &)
1695 {
1696         session->save_state ("");
1697         return on;
1698 }
1699
1700 LedState
1701 MackieControlProtocol::save_release (Button &)
1702 {
1703         return off;
1704 }
1705
1706 LedState
1707 MackieControlProtocol::timecode_beats_press (Button &)
1708 {
1709         switch (_timecode_type)
1710         {
1711                 case ARDOUR::AnyTime::BBT:
1712                         _timecode_type = ARDOUR::AnyTime::Timecode;
1713                         break;
1714                 case ARDOUR::AnyTime::Timecode:
1715                         _timecode_type = ARDOUR::AnyTime::BBT;
1716                         break;
1717                 default:
1718                         ostringstream os;
1719                         os << "Unknown Anytime::Type " << _timecode_type;
1720                         throw runtime_error (os.str());
1721         }
1722         update_timecode_beats_led();
1723         return on;
1724 }
1725
1726 LedState
1727 MackieControlProtocol::timecode_beats_release (Button &)
1728 {
1729         return off;
1730 }
1731
1732 list<boost::shared_ptr<ARDOUR::Bundle> >
1733 MackieControlProtocol::bundles ()
1734 {
1735         list<boost::shared_ptr<ARDOUR::Bundle> > b;
1736         b.push_back (_input_bundle);
1737         b.push_back (_output_bundle);
1738         return b;
1739 }