libs/surfaces/mackie/mackie_control_protocol.cc

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