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