libs/surfaces/mackie/mackie_control_protocol.cc

   1 /*
   2         Copyright (C) 2006,2007 John Anderson
   3
   4         This program is free software; you can redistribute it and/or modify
   5         it under the terms of the GNU General Public License as published by
   6         the Free Software Foundation; either version 2 of the License, or
   7         (at your option) any later version.
   8
   9         This program is distributed in the hope that it will be useful,
  10         but WITHOUT ANY WARRANTY; without even the implied warranty of
  11         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12         GNU General Public License for more details.
  13
  14         You should have received a copy of the GNU General Public License
  15         along with this program; if not, write to the Free Software
  16         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #include <fcntl.h>
  20 #include <iostream>
  21 #include <algorithm>
  22 #include <cmath>
  23 #include <sstream>
  24 #include <vector>
  25 #include <iomanip>
  26
  27 #include <inttypes.h>
  28 #include <float.h>
  29 #include <sys/time.h>
  30 #include <errno.h>
  31 #include <poll.h>
  32
  33 #include <boost/shared_array.hpp>
  34
  35 #include "midi++/types.h"
  36 #include "midi++/port.h"
  37 #include "pbd/pthread_utils.h"
  38 #include "pbd/error.h"
  39 #include "pbd/memento_command.h"
  40 #include "pbd/convert.h"
  41
  42 #include "ardour/dB.h"
  43 #include "ardour/debug.h"
  44 #include "ardour/location.h"
  45 #include "ardour/meter.h"
  46 #include "ardour/panner.h"
  47 #include "ardour/panner_shell.h"
  48 #include "ardour/route.h"
  49 #include "ardour/session.h"
  50 #include "ardour/tempo.h"
  51 #include "ardour/types.h"
  52 #include "ardour/audioengine.h"
  53
  54 #include "mackie_control_protocol.h"
  55
  56 #include "midi_byte_array.h"
  57 #include "mackie_control_exception.h"
  58 #include "surface_port.h"
  59 #include "surface.h"
  60
  61 #include "strip.h"
  62 #include "control_group.h"
  63 #include "meter.h"
  64 #include "button.h"
  65 #include "fader.h"
  66 #include "pot.h"
  67
  68 using namespace ARDOUR;
  69 using namespace std;
  70 using namespace Mackie;
  71 using namespace PBD;
  72 using namespace Glib;
  73
  74 #include "i18n.h"
  75
  76 #include "pbd/abstract_ui.cc" // instantiate template
  77
  78 #define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
  79
  80 const int MackieControlProtocol::MODIFIER_OPTION = 0x1;
  81 const int MackieControlProtocol::MODIFIER_CONTROL = 0x2;
  82 const int MackieControlProtocol::MODIFIER_SHIFT = 0x3;
  83 const int MackieControlProtocol::MODIFIER_CMDALT = 0x4;
  84
  85 MackieControlProtocol* MackieControlProtocol::_instance = 0;
  86
  87 bool MackieControlProtocol::probe()
  88 {
  89         return true;
  90 }
  91
  92 MackieControlProtocol::MackieControlProtocol (Session& session)
  93         : ControlProtocol (session, X_("Mackie"), this)
  94         , AbstractUI<MackieControlUIRequest> ("mackie")
  95         , _current_initial_bank (0)
  96         , _timecode_type (ARDOUR::AnyTime::BBT)
  97         , _input_bundle (new ARDOUR::Bundle (_("Mackie Control In"), true))
  98         , _output_bundle (new ARDOUR::Bundle (_("Mackie Control Out"), false))
  99         , _gui (0)
 100         , _zoom_mode (false)
 101         , _scrub_mode (false)
 102         , _flip_mode (Normal)
 103         , _view_mode (Global)
 104         , _current_selected_track (-1)
 105 {
 106         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
 107
 108         AudioEngine::instance()->PortConnectedOrDisconnected.connect (
 109                 audio_engine_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::port_connected_or_disconnected, this, _2, _4, _5),
 110                 this
 111                 );
 112
 113         _instance = this;
 114
 115         build_button_map ();
 116 }
 117
 118 MackieControlProtocol::~MackieControlProtocol()
 119 {
 120         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol\n");
 121
 122         _active = false;
 123
 124         try {
 125                 close();
 126         }
 127         catch (exception & e) {
 128                 cout << "~MackieControlProtocol caught " << e.what() << endl;
 129         }
 130         catch (...) {
 131                 cout << "~MackieControlProtocol caught unknown" << endl;
 132         }
 133
 134         DEBUG_TRACE (DEBUG::MackieControl, "finished ~MackieControlProtocol::MackieControlProtocol\n");
 135
 136         _instance = 0;
 137 }
 138
 139 void
 140 MackieControlProtocol::thread_init ()
 141 {
 142         struct sched_param rtparam;
 143
 144         pthread_set_name (X_("MackieControl"));
 145
 146         PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("MackieControl"), 2048);
 147         ARDOUR::SessionEvent::create_per_thread_pool (X_("MackieControl"), 128);
 148
 149         memset (&rtparam, 0, sizeof (rtparam));
 150         rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
 151
 152         if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
 153                 // do we care? not particularly.
 154         }
 155 }
 156
 157 // go to the previous track.
 158 // Assume that get_sorted_routes().size() > route_table.size()
 159 void
 160 MackieControlProtocol::prev_track()
 161 {
 162         if (_current_initial_bank >= 1) {
 163                 switch_banks (_current_initial_bank - 1);
 164         }
 165 }
 166
 167 // go to the next track.
 168 // Assume that get_sorted_routes().size() > route_table.size()
 169 void
 170 MackieControlProtocol::next_track()
 171 {
 172         Sorted sorted = get_sorted_routes();
 173         if (_current_initial_bank + n_strips() < sorted.size()) {
 174                 switch_banks (_current_initial_bank + 1);
 175         }
 176 }
 177
 178 // predicate for sort call in get_sorted_routes
 179 struct RouteByRemoteId
 180 {
 181         bool operator () (const boost::shared_ptr<Route> & a, const boost::shared_ptr<Route> & b) const
 182         {
 183                 return a->remote_control_id() < b->remote_control_id();
 184         }
 185
 186         bool operator () (const Route & a, const Route & b) const
 187         {
 188                 return a.remote_control_id() < b.remote_control_id();
 189         }
 190
 191         bool operator () (const Route * a, const Route * b) const
 192         {
 193                 return a->remote_control_id() < b->remote_control_id();
 194         }
 195 };
 196
 197 MackieControlProtocol::Sorted
 198 MackieControlProtocol::get_sorted_routes()
 199 {
 200         Sorted sorted;
 201
 202         // fetch all routes
 203         boost::shared_ptr<RouteList> routes = session->get_routes();
 204         set<uint32_t> remote_ids;
 205
 206         // routes with remote_id 0 should never be added
 207         // TODO verify this with ardour devs
 208         // remote_ids.insert (0);
 209
 210         // sort in remote_id order, and exclude master, control and hidden routes
 211         // and any routes that are already set.
 212
 213         for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it) {
 214
 215                 Route & route = **it;
 216
 217                 if (remote_ids.find (route.remote_control_id()) != remote_ids.end()) {
 218                         continue;
 219                 }
 220
 221                 if (route.is_hidden() || route.is_master() || route.is_monitor()) {
 222                         continue;
 223                 }
 224
 225                 switch (_view_mode) {
 226                 case Global:
 227                         break;
 228                 case AudioTracks:
 229                         break;
 230                 case Busses:
 231                         break;
 232                 case MidiTracks:
 233                         break;
 234                 case Dynamics:
 235                         break;
 236                 case EQ:
 237                         break;
 238                 case Loop:
 239                         break;
 240                 case Sends:
 241                         break;
 242                 case Plugins:
 243                         break;
 244                 }
 245
 246                 sorted.push_back (*it);
 247                 remote_ids.insert (route.remote_control_id());
 248         }
 249
 250         sort (sorted.begin(), sorted.end(), RouteByRemoteId());
 251         return sorted;
 252 }
 253
 254 void
 255 MackieControlProtocol::refresh_current_bank()
 256 {
 257         switch_banks (_current_initial_bank, true);
 258 }
 259
 260 uint32_t
 261 MackieControlProtocol::n_strips() const
 262 {
 263         uint32_t strip_count = 0;
 264
 265         for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 266                 strip_count += (*si)->n_strips ();
 267         }
 268
 269         return strip_count;
 270 }
 271
 272 void
 273 MackieControlProtocol::switch_banks (uint32_t initial, bool force)
 274 {
 275         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch banking to start at %1 force ? %2 current = %3\n", initial, force, _current_initial_bank));
 276
 277         if (initial == _current_initial_bank && !force) {
 278                 return;
 279         }
 280
 281         Sorted sorted = get_sorted_routes();
 282         uint32_t strip_cnt = n_strips();
 283
 284         if (sorted.size() <= strip_cnt && !force) {
 285                 /* no banking - not enough routes to fill all strips */
 286                 return;
 287         }
 288
 289         uint32_t delta = sorted.size() - strip_cnt;
 290
 291         if (delta > 0 && initial > delta) {
 292                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("not switching to %1\n", initial));
 293                 return;
 294         }
 295
 296         _current_initial_bank = initial;
 297         _current_selected_track = -1;
 298
 299         for (Surfaces::iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 300                 (*si)->drop_routes ();
 301         }
 302
 303         // Map current bank of routes onto each surface(+strip)
 304
 305         if (_current_initial_bank <= sorted.size()) {
 306
 307                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch to %1, %2, available routes %3\n", _current_initial_bank, strip_cnt, sorted.size()));
 308
 309                 // link routes to strips
 310
 311                 Sorted::iterator r = sorted.begin() + _current_initial_bank;
 312
 313                 for (Surfaces::iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
 314                         vector<boost::shared_ptr<Route> > routes;
 315                         uint32_t added = 0;
 316
 317                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has %1 strips\n", (*si)->n_strips()));
 318
 319                         for (; r != sorted.end() && added < (*si)->n_strips(); ++r, ++added) {
 320                                 routes.push_back (*r);
 321                                 cerr << "\t\tadded " << (*r)->name() << endl;
 322                         }
 323
 324                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("give surface %1 routes\n", routes.size()));
 325
 326                         (*si)->map_routes (routes);
 327                 }
 328         }
 329
 330         /* reset this to get the right display of view mode after the switch */
 331         set_view_mode (_view_mode);
 332
 333         /* current bank has not been saved */
 334
 335         session->set_dirty();
 336 }
 337
 338 int
 339 MackieControlProtocol::set_active (bool yn)
 340 {
 341         if (yn == _active) {
 342                 return 0;
 343         }
 344
 345         try
 346         {
 347                 if (yn) {
 348
 349                         /* start event loop */
 350
 351                         BaseUI::run ();
 352
 353                         create_surfaces ();
 354                         connect_session_signals ();
 355
 356                         _active = true;
 357                         update_surfaces ();
 358
 359                         /* set up periodic task for metering and automation
 360                          */
 361
 362                         Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
 363                         periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
 364                         periodic_timeout->attach (main_loop()->get_context());
 365
 366                 } else {
 367                         BaseUI::quit ();
 368                         close();
 369                         _active = false;
 370                 }
 371         }
 372
 373         catch (exception & e) {
 374                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("set_active to false because exception caught: %1\n", e.what()));
 375                 _active = false;
 376                 throw;
 377         }
 378
 379         return 0;
 380 }
 381
 382 bool
 383 MackieControlProtocol::periodic ()
 384 {
 385         if (!_active) {
 386                 return false;
 387         }
 388
 389         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 390                 (*s)->periodic ();
 391         }
 392
 393         return true;
 394 }
 395
 396
 397 void
 398 MackieControlProtocol::update_timecode_beats_led()
 399 {
 400         switch (_timecode_type) {
 401                 case ARDOUR::AnyTime::BBT:
 402                         update_global_led ("beats", on);
 403                         update_global_led ("timecode", off);
 404                         break;
 405                 case ARDOUR::AnyTime::Timecode:
 406                         update_global_led ("timecode", on);
 407                         update_global_led ("beats", off);
 408                         break;
 409                 default:
 410                         ostringstream os;
 411                         os << "Unknown Anytime::Type " << _timecode_type;
 412                         throw runtime_error (os.str());
 413         }
 414 }
 415
 416 void
 417 MackieControlProtocol::update_global_button (const string & name, LedState ls)
 418 {
 419         boost::shared_ptr<Surface> surface = surfaces.front();
 420
 421         if (!surface->type() == mcu) {
 422                 return;
 423         }
 424
 425         if (surface->controls_by_name.find (name) != surface->controls_by_name.end()) {
 426                 Button * button = dynamic_cast<Button*> (surface->controls_by_name[name]);
 427                 surface->write (button->set_state (ls));
 428         } else {
 429                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", name));
 430         }
 431 }
 432
 433 void
 434 MackieControlProtocol::update_global_led (const string & name, LedState ls)
 435 {
 436         boost::shared_ptr<Surface> surface = surfaces.front();
 437
 438         if (!surface->type() == mcu) {
 439                 return;
 440         }
 441
 442         if (surface->controls_by_name.find (name) != surface->controls_by_name.end()) {
 443                 Led * led = dynamic_cast<Led*> (surface->controls_by_name[name]);
 444                 surface->write (led->set_state (ls));
 445         } else {
 446                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", name));
 447         }
 448 }
 449
 450 // send messages to surface to set controls to correct values
 451 void
 452 MackieControlProtocol::update_surfaces()
 453 {
 454         if (!_active) {
 455                 return;
 456         }
 457
 458         // do the initial bank switch to connect signals
 459         // _current_initial_bank is initialised by set_state
 460         switch_banks (_current_initial_bank, true);
 461
 462         // sometimes the jog wheel is a pot
 463         surfaces.front()->blank_jog_ring ();
 464
 465         // update global buttons and displays
 466
 467         notify_record_state_changed();
 468         notify_transport_state_changed();
 469         update_timecode_beats_led();
 470 }
 471
 472 void
 473 MackieControlProtocol::connect_session_signals()
 474 {
 475         // receive routes added
 476         session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_route_added, this, _1), this);
 477         // receive record state toggled
 478         session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_record_state_changed, this), this);
 479         // receive transport state changed
 480         session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
 481         session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
 482         // receive punch-in and punch-out
 483         Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
 484         session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
 485         // receive rude solo changed
 486         session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), this);
 487
 488         // make sure remote id changed signals reach here
 489         // see also notify_route_added
 490         Sorted sorted = get_sorted_routes();
 491
 492         for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
 493                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind(&MackieControlProtocol::notify_remote_id_changed, this), this);
 494         }
 495 }
 496
 497 void
 498 MackieControlProtocol::create_surfaces ()
 499 {
 500         string device_name = "mcu";
 501         surface_type_t stype = mcu;
 502
 503         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Create %1 surfaces\n",
 504                                                            1 + ARDOUR::Config->get_mackie_extenders()));
 505
 506         for (uint32_t n = 0; n < 1 + ARDOUR::Config->get_mackie_extenders(); ++n) {
 507
 508                 boost::shared_ptr<Surface> surface (new Surface (*this, session->engine().jack(), device_name, n, stype));
 509                 surfaces.push_back (surface);
 510
 511                 device_name = "mcu_xt";
 512                 stype = ext;
 513
 514                 _input_bundle->add_channel (
 515                         surface->port().input_port().name(),
 516                         ARDOUR::DataType::MIDI,
 517                         session->engine().make_port_name_non_relative (surface->port().input_port().name())
 518                         );
 519
 520                 _output_bundle->add_channel (
 521                         surface->port().output_port().name(),
 522                         ARDOUR::DataType::MIDI,
 523                         session->engine().make_port_name_non_relative (surface->port().output_port().name())
 524                         );
 525
 526                 int fd;
 527                 MIDI::Port& input_port (surface->port().input_port());
 528
 529                 if ((fd = input_port.selectable ()) >= 0) {
 530                         Glib::RefPtr<IOSource> psrc = IOSource::create (fd, IO_IN|IO_HUP|IO_ERR);
 531
 532                         psrc->connect (sigc::bind (sigc::mem_fun (this, &MackieControlProtocol::midi_input_handler), &input_port));
 533                         psrc->attach (main_loop()->get_context());
 534
 535                         // glibmm hack: for now, store only the GSource*
 536
 537                         port_sources.push_back (psrc->gobj());
 538                         g_source_ref (psrc->gobj());
 539                 }
 540         }
 541 }
 542
 543 void
 544 MackieControlProtocol::close()
 545 {
 546         clear_ports ();
 547
 548         port_connections.drop_connections ();
 549         session_connections.drop_connections ();
 550         route_connections.drop_connections ();
 551         periodic_connection.disconnect ();
 552
 553         surfaces.clear ();
 554 }
 555
 556 XMLNode&
 557 MackieControlProtocol::get_state()
 558 {
 559         DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state\n");
 560
 561         // add name of protocol
 562         XMLNode* node = new XMLNode (X_("Protocol"));
 563         node->add_property (X_("name"), ARDOUR::ControlProtocol::_name);
 564
 565         // add current bank
 566         ostringstream os;
 567         os << _current_initial_bank;
 568         node->add_property (X_("bank"), os.str());
 569
 570         for (uint32_t n = 0; n < 16; ++n) {
 571                 ostringstream s;
 572                 s << string_compose ("f%1-action", n+1);
 573                 node->add_property (s.str().c_str(), f_action (n));
 574         }
 575
 576         return *node;
 577 }
 578
 579 int
 580 MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
 581 {
 582         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", _active));
 583
 584         int retval = 0;
 585         const XMLProperty* prop;
 586         // fetch current bank
 587
 588         if ((prop = node.property (X_("bank"))) != 0) {
 589                 string bank = prop->value();
 590                 set_active (true);
 591                 uint32_t new_bank = atoi (bank.c_str());
 592                 if (_current_initial_bank != new_bank) {
 593                         switch_banks (new_bank);
 594                 }
 595         }
 596
 597         _f_actions.clear ();
 598         _f_actions.resize (16);
 599
 600         for (uint32_t n = 0; n < 16; ++n) {
 601                 string action;
 602                 if ((prop = node.property (string_compose ("f%1-action", n+1))) != 0) {
 603                         action = prop->value();
 604                 }
 605
 606                 if (action.empty()) {
 607                         /* default action if nothing is specified */
 608                         action = string_compose ("Editor/goto-visual-state-%1", n+1);
 609                 }
 610
 611                 _f_actions[n] = action;
 612         }
 613
 614         return retval;
 615 }
 616
 617
 618 /////////////////////////////////////////////////
 619 // handlers for Route signals
 620 // TODO should these be part of RouteSignal?
 621 // They started off as signal/slot handlers for signals
 622 // from Route, but they're also used in polling for automation
 623 /////////////////////////////////////////////////
 624
 625 // TODO handle plugin automation polling
 626 string
 627 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
 628 {
 629         Timecode::BBT_Time bbt_time;
 630         session->bbt_time (now_frame, bbt_time);
 631
 632         // According to the Logic docs
 633         // digits: 888/88/88/888
 634         // BBT mode: Bars/Beats/Subdivisions/Ticks
 635         ostringstream os;
 636         os << setw(3) << setfill('0') << bbt_time.bars;
 637         os << setw(2) << setfill('0') << bbt_time.beats;
 638
 639         // figure out subdivisions per beat
 640         const ARDOUR::Meter & meter = session->tempo_map().meter_at (now_frame);
 641         int subdiv = 2;
 642         if (meter.note_divisor() == 8 && (meter.divisions_per_bar() == 12.0 || meter.divisions_per_bar() == 9.0 || meter.divisions_per_bar() == 6.0)) {
 643                 subdiv = 3;
 644         }
 645
 646         uint32_t subdivisions = bbt_time.ticks / uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
 647         uint32_t ticks = bbt_time.ticks % uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
 648
 649         os << setw(2) << setfill('0') << subdivisions + 1;
 650         os << setw(3) << setfill('0') << ticks;
 651
 652         return os.str();
 653 }
 654
 655 string
 656 MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
 657 {
 658         Timecode::Time timecode;
 659         session->timecode_time (now_frame, timecode);
 660
 661         // According to the Logic docs
 662         // digits: 888/88/88/888
 663         // Timecode mode: Hours/Minutes/Seconds/Frames
 664         ostringstream os;
 665         os << setw(3) << setfill('0') << timecode.hours;
 666         os << setw(2) << setfill('0') << timecode.minutes;
 667         os << setw(2) << setfill('0') << timecode.seconds;
 668         os << setw(3) << setfill('0') << timecode.frames;
 669
 670         return os.str();
 671 }
 672
 673 void
 674 MackieControlProtocol::update_timecode_display()
 675 {
 676         boost::shared_ptr<Surface> surface = surfaces.front();
 677
 678         if (surface->type() != mcu || !surface->has_timecode_display()) {
 679                 return;
 680         }
 681
 682         // do assignment here so current_frame is fixed
 683         framepos_t current_frame = session->transport_frame();
 684         string timecode;
 685
 686         switch (_timecode_type) {
 687         case ARDOUR::AnyTime::BBT:
 688                 timecode = format_bbt_timecode (current_frame);
 689                 break;
 690         case ARDOUR::AnyTime::Timecode:
 691                 timecode = format_timecode_timecode (current_frame);
 692                 break;
 693         default:
 694                 return;
 695         }
 696
 697         // only write the timecode string to the MCU if it's changed
 698         // since last time. This is to reduce midi bandwidth used.
 699         if (timecode != _timecode_last) {
 700                 surface->display_timecode (timecode, _timecode_last);
 701                 _timecode_last = timecode;
 702         }
 703 }
 704
 705 ///////////////////////////////////////////
 706 // Session signals
 707 ///////////////////////////////////////////
 708
 709 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
 710 {
 711         if (p == "punch-in") {
 712                 update_global_button ("punch_in", session->config.get_punch_in());
 713         } else if (p == "punch-out") {
 714                 update_global_button ("punch_out", session->config.get_punch_out());
 715         } else if (p == "clicking") {
 716                 update_global_button ("clicking", Config->get_clicking());
 717         } else {
 718                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
 719         }
 720 }
 721
 722 // RouteList is the set of routes that have just been added
 723 void
 724 MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
 725 {
 726         // currently assigned banks are less than the full set of
 727         // strips, so activate the new strip now.
 728
 729         refresh_current_bank();
 730
 731         // otherwise route added, but current bank needs no updating
 732
 733         // make sure remote id changes in the new route are handled
 734         typedef ARDOUR::RouteList ARS;
 735
 736         for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
 737                 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
 738         }
 739 }
 740
 741 void
 742 MackieControlProtocol::notify_solo_active_changed (bool active)
 743 {
 744         boost::shared_ptr<Surface> surface = surfaces.front();
 745
 746         Led* rude_solo = dynamic_cast<Led*> (surface->controls_by_name["solo"]);
 747
 748         if (rude_solo) {
 749                 surface->write (rude_solo->set_state (active ? flashing : off));
 750         }
 751 }
 752
 753 void
 754 MackieControlProtocol::notify_remote_id_changed()
 755 {
 756         Sorted sorted = get_sorted_routes();
 757         uint32_t sz = n_strips();
 758
 759         // if a remote id has been moved off the end, we need to shift
 760         // the current bank backwards.
 761
 762         if (sorted.size() - _current_initial_bank < sz) {
 763                 // but don't shift backwards past the zeroth channel
 764                 switch_banks (max((Sorted::size_type) 0, sorted.size() - sz));
 765         } else {
 766                 // Otherwise just refresh the current bank
 767                 refresh_current_bank();
 768         }
 769 }
 770
 771 ///////////////////////////////////////////
 772 // Transport signals
 773 ///////////////////////////////////////////
 774
 775 void
 776 MackieControlProtocol::notify_loop_state_changed()
 777 {
 778         update_global_button ("loop", session->get_play_loop());
 779 }
 780
 781 void
 782 MackieControlProtocol::notify_transport_state_changed()
 783 {
 784         // switch various play and stop buttons on / off
 785         update_global_button ("play", session->transport_speed() == 1.0);
 786         update_global_button ("stop", !session->transport_rolling());
 787         update_global_button ("rewind", session->transport_speed() < 0.0);
 788         update_global_button ("ffwd", session->transport_speed() > 1.0);
 789
 790         _transport_previously_rolling = session->transport_rolling();
 791 }
 792
 793 void
 794 MackieControlProtocol::notify_record_state_changed ()
 795 {
 796         /* rec is a tristate */
 797
 798
 799         Button * rec = reinterpret_cast<Button*> (surfaces.front()->controls_by_name["record"]);
 800         if (rec) {
 801                 LedState ls;
 802
 803                 switch (session->record_status()) {
 804                 case Session::Disabled:
 805                         DEBUG_TRACE (DEBUG::MackieControl, "record state changed to disabled, LED off\n");
 806                         ls = off;
 807                         break;
 808                 case Session::Recording:
 809                         DEBUG_TRACE (DEBUG::MackieControl, "record state changed to recording, LED on\n");
 810                         ls = on;
 811                         break;
 812                 case Session::Enabled:
 813                         DEBUG_TRACE (DEBUG::MackieControl, "record state changed to enabled, LED flashing\n");
 814                         ls = flashing;
 815                         break;
 816                 }
 817
 818                 surfaces.front()->write (rec->set_state (ls));
 819         } else {
 820                 DEBUG_TRACE (DEBUG::MackieControl, "record button control not found\n");
 821         }
 822 }
 823
 824 list<boost::shared_ptr<ARDOUR::Bundle> >
 825 MackieControlProtocol::bundles ()
 826 {
 827         list<boost::shared_ptr<ARDOUR::Bundle> > b;
 828         b.push_back (_input_bundle);
 829         b.push_back (_output_bundle);
 830         return b;
 831 }
 832
 833 void
 834 MackieControlProtocol::port_connected_or_disconnected (string a, string b, bool connected)
 835 {
 836         /* If something is connected to one of our output ports, send MIDI to update the surface
 837            to whatever state it should have.
 838         */
 839
 840         if (!connected) {
 841                 return;
 842         }
 843
 844         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
 845                 string const n = AudioEngine::instance()->make_port_name_non_relative ((*s)->port().output_port().name ());
 846                 if (a == n || b == n) {
 847                         update_surfaces ();
 848                         return;
 849                 }
 850         }
 851 }
 852
 853 void
 854 MackieControlProtocol::do_request (MackieControlUIRequest* req)
 855 {
 856         if (req->type == CallSlot) {
 857
 858                 call_slot (MISSING_INVALIDATOR, req->the_slot);
 859
 860         } else if (req->type == Quit) {
 861
 862                 stop ();
 863         }
 864 }
 865
 866 int
 867 MackieControlProtocol::stop ()
 868 {
 869         BaseUI::quit ();
 870
 871         return 0;
 872 }
 873
 874 /** Add a timeout so that a control's in_use flag will be reset some time in the future.
 875  *  @param in_use_control the control whose in_use flag to reset.
 876  *  @param touch_control a touch control to emit an event for, or 0.
 877  */
 878 void
 879 MackieControlProtocol::add_in_use_timeout (Surface& surface, Control& in_use_control, Control* touch_control)
 880 {
 881         Glib::RefPtr<Glib::TimeoutSource> timeout (Glib::TimeoutSource::create (250)); // milliseconds
 882
 883         in_use_control.in_use_connection.disconnect ();
 884         in_use_control.in_use_connection = timeout->connect (
 885                 sigc::bind (sigc::mem_fun (*this, &MackieControlProtocol::control_in_use_timeout), &surface, &in_use_control, touch_control));
 886         in_use_control.in_use_touch_control = touch_control;
 887
 888         timeout->attach (main_loop()->get_context());
 889
 890         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("timeout queued for surface %1, control %2 touch control %3\n",
 891                                                            surface.number(), &in_use_control, touch_control));}
 892
 893 /** Handle timeouts to reset in_use for controls that can't
 894  *  do this by themselves (e.g. pots, and faders without touch support).
 895  *  @param in_use_control the control whose in_use flag to reset.
 896  *  @param touch_control a touch control to emit an event for, or 0.
 897  */
 898 bool
 899 MackieControlProtocol::control_in_use_timeout (Surface* surface, Control* in_use_control, Control* touch_control)
 900 {
 901         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("timeout elapsed for surface %1, control %2 touch control %3\n",
 902                                                            surface->number(), in_use_control, touch_control));
 903
 904         in_use_control->set_in_use (false);
 905
 906         if (touch_control) {
 907                 /* figure out what to do here */
 908         }
 909
 910         // only call this method once from the timer
 911         return false;
 912 }
 913
 914 void
 915 MackieControlProtocol::update_led (Surface& surface, Button& button, Mackie::LedState ls)
 916 {
 917         if (ls != none) {
 918                 surface.port().write (button.set_state (ls));
 919         }
 920 }
 921
 922 void
 923 MackieControlProtocol::build_button_map ()
 924 {
 925 #define DEFINE_BUTTON_HANDLER(b,p,r) button_map.insert (pair<int,ButtonHandlers> ((b), ButtonHandlers ((p),(r))));
 926
 927         DEFINE_BUTTON_HANDLER (Button::Io, &MackieControlProtocol::io_press, &MackieControlProtocol::io_release);
 928         DEFINE_BUTTON_HANDLER (Button::Sends, &MackieControlProtocol::sends_press, &MackieControlProtocol::sends_release);
 929         DEFINE_BUTTON_HANDLER (Button::Pan, &MackieControlProtocol::pan_press, &MackieControlProtocol::pan_release);
 930         DEFINE_BUTTON_HANDLER (Button::Plugin, &MackieControlProtocol::plugin_press, &MackieControlProtocol::plugin_release);
 931         DEFINE_BUTTON_HANDLER (Button::Eq, &MackieControlProtocol::eq_press, &MackieControlProtocol::eq_release);
 932         DEFINE_BUTTON_HANDLER (Button::Dyn, &MackieControlProtocol::dyn_press, &MackieControlProtocol::dyn_release);
 933         DEFINE_BUTTON_HANDLER (Button::Left, &MackieControlProtocol::left_press, &MackieControlProtocol::left_release);
 934         DEFINE_BUTTON_HANDLER (Button::Right, &MackieControlProtocol::right_press, &MackieControlProtocol::right_release);
 935         DEFINE_BUTTON_HANDLER (Button::ChannelLeft, &MackieControlProtocol::channel_left_press, &MackieControlProtocol::channel_left_release);
 936         DEFINE_BUTTON_HANDLER (Button::ChannelRight, &MackieControlProtocol::channel_right_press, &MackieControlProtocol::channel_right_release);
 937         DEFINE_BUTTON_HANDLER (Button::Flip, &MackieControlProtocol::flip_press, &MackieControlProtocol::flip_release);
 938         DEFINE_BUTTON_HANDLER (Button::Edit, &MackieControlProtocol::edit_press, &MackieControlProtocol::edit_release);
 939         DEFINE_BUTTON_HANDLER (Button::NameValue, &MackieControlProtocol::name_value_press, &MackieControlProtocol::name_value_release);
 940         DEFINE_BUTTON_HANDLER (Button::TimecodeBeats, &MackieControlProtocol::timecode_beats_press, &MackieControlProtocol::timecode_beats_release);
 941         DEFINE_BUTTON_HANDLER (Button::F1, &MackieControlProtocol::F1_press, &MackieControlProtocol::F1_release);
 942         DEFINE_BUTTON_HANDLER (Button::F2, &MackieControlProtocol::F2_press, &MackieControlProtocol::F2_release);
 943         DEFINE_BUTTON_HANDLER (Button::F3, &MackieControlProtocol::F3_press, &MackieControlProtocol::F3_release);
 944         DEFINE_BUTTON_HANDLER (Button::F4, &MackieControlProtocol::F4_press, &MackieControlProtocol::F4_release);
 945         DEFINE_BUTTON_HANDLER (Button::F5, &MackieControlProtocol::F5_press, &MackieControlProtocol::F5_release);
 946         DEFINE_BUTTON_HANDLER (Button::F6, &MackieControlProtocol::F6_press, &MackieControlProtocol::F6_release);
 947         DEFINE_BUTTON_HANDLER (Button::F7, &MackieControlProtocol::F7_press, &MackieControlProtocol::F7_release);
 948         DEFINE_BUTTON_HANDLER (Button::F8, &MackieControlProtocol::F8_press, &MackieControlProtocol::F8_release);
 949         DEFINE_BUTTON_HANDLER (Button::F9, &MackieControlProtocol::F9_press, &MackieControlProtocol::F9_release);
 950         DEFINE_BUTTON_HANDLER (Button::F10, &MackieControlProtocol::F10_press, &MackieControlProtocol::F10_release);
 951         DEFINE_BUTTON_HANDLER (Button::F11, &MackieControlProtocol::F11_press, &MackieControlProtocol::F11_release);
 952         DEFINE_BUTTON_HANDLER (Button::F12, &MackieControlProtocol::F12_press, &MackieControlProtocol::F12_release);
 953         DEFINE_BUTTON_HANDLER (Button::F13, &MackieControlProtocol::F13_press, &MackieControlProtocol::F13_release);
 954         DEFINE_BUTTON_HANDLER (Button::F14, &MackieControlProtocol::F14_press, &MackieControlProtocol::F14_release);
 955         DEFINE_BUTTON_HANDLER (Button::F15, &MackieControlProtocol::F15_press, &MackieControlProtocol::F15_release);
 956         DEFINE_BUTTON_HANDLER (Button::F16, &MackieControlProtocol::F16_press, &MackieControlProtocol::F16_release);
 957         DEFINE_BUTTON_HANDLER (Button::Shift, &MackieControlProtocol::shift_press, &MackieControlProtocol::shift_release);
 958         DEFINE_BUTTON_HANDLER (Button::Option, &MackieControlProtocol::option_press, &MackieControlProtocol::option_release);
 959         DEFINE_BUTTON_HANDLER (Button::Ctrl, &MackieControlProtocol::control_press, &MackieControlProtocol::control_release);
 960         DEFINE_BUTTON_HANDLER (Button::CmdAlt, &MackieControlProtocol::cmd_alt_press, &MackieControlProtocol::cmd_alt_release);
 961         DEFINE_BUTTON_HANDLER (Button::On, &MackieControlProtocol::on_press, &MackieControlProtocol::on_release);
 962         DEFINE_BUTTON_HANDLER (Button::RecReady, &MackieControlProtocol::rec_ready_press, &MackieControlProtocol::rec_ready_release);
 963         DEFINE_BUTTON_HANDLER (Button::Undo, &MackieControlProtocol::undo_press, &MackieControlProtocol::undo_release);
 964         DEFINE_BUTTON_HANDLER (Button::Save, &MackieControlProtocol::save_press, &MackieControlProtocol::save_release);
 965         DEFINE_BUTTON_HANDLER (Button::Touch, &MackieControlProtocol::touch_press, &MackieControlProtocol::touch_release);
 966         DEFINE_BUTTON_HANDLER (Button::Redo, &MackieControlProtocol::redo_press, &MackieControlProtocol::redo_release);
 967         DEFINE_BUTTON_HANDLER (Button::Marker, &MackieControlProtocol::marker_press, &MackieControlProtocol::marker_release);
 968         DEFINE_BUTTON_HANDLER (Button::Enter, &MackieControlProtocol::enter_press, &MackieControlProtocol::enter_release);
 969         DEFINE_BUTTON_HANDLER (Button::Cancel, &MackieControlProtocol::cancel_press, &MackieControlProtocol::cancel_release);
 970         DEFINE_BUTTON_HANDLER (Button::Mixer, &MackieControlProtocol::mixer_press, &MackieControlProtocol::mixer_release);
 971         DEFINE_BUTTON_HANDLER (Button::FrmLeft, &MackieControlProtocol::frm_left_press, &MackieControlProtocol::frm_left_release);
 972         DEFINE_BUTTON_HANDLER (Button::FrmRight, &MackieControlProtocol::frm_right_press, &MackieControlProtocol::frm_right_release);
 973         DEFINE_BUTTON_HANDLER (Button::Loop, &MackieControlProtocol::loop_press, &MackieControlProtocol::loop_release);
 974         DEFINE_BUTTON_HANDLER (Button::PunchIn, &MackieControlProtocol::punch_in_press, &MackieControlProtocol::punch_in_release);
 975         DEFINE_BUTTON_HANDLER (Button::PunchOut, &MackieControlProtocol::punch_out_press, &MackieControlProtocol::punch_out_release);
 976         DEFINE_BUTTON_HANDLER (Button::Home, &MackieControlProtocol::home_press, &MackieControlProtocol::home_release);
 977         DEFINE_BUTTON_HANDLER (Button::End, &MackieControlProtocol::end_press, &MackieControlProtocol::end_release);
 978         DEFINE_BUTTON_HANDLER (Button::Rewind, &MackieControlProtocol::rewind_press, &MackieControlProtocol::rewind_release);
 979         DEFINE_BUTTON_HANDLER (Button::Ffwd, &MackieControlProtocol::ffwd_press, &MackieControlProtocol::ffwd_release);
 980         DEFINE_BUTTON_HANDLER (Button::Stop, &MackieControlProtocol::stop_press, &MackieControlProtocol::stop_release);
 981         DEFINE_BUTTON_HANDLER (Button::Play, &MackieControlProtocol::play_press, &MackieControlProtocol::play_release);
 982         DEFINE_BUTTON_HANDLER (Button::Record, &MackieControlProtocol::record_press, &MackieControlProtocol::record_release);
 983         DEFINE_BUTTON_HANDLER (Button::CursorUp, &MackieControlProtocol::cursor_up_press, &MackieControlProtocol::cursor_up_release);
 984         DEFINE_BUTTON_HANDLER (Button::CursorDown, &MackieControlProtocol::cursor_down_press, &MackieControlProtocol::cursor_down_release);
 985         DEFINE_BUTTON_HANDLER (Button::CursorLeft, &MackieControlProtocol::cursor_left_press, &MackieControlProtocol::cursor_left_release);
 986         DEFINE_BUTTON_HANDLER (Button::CursorRight, &MackieControlProtocol::cursor_right_press, &MackieControlProtocol::cursor_right_release);
 987         DEFINE_BUTTON_HANDLER (Button::Zoom, &MackieControlProtocol::zoom_press, &MackieControlProtocol::zoom_release);
 988         DEFINE_BUTTON_HANDLER (Button::Scrub, &MackieControlProtocol::scrub_press, &MackieControlProtocol::scrub_release);
 989         DEFINE_BUTTON_HANDLER (Button::UserA, &MackieControlProtocol::user_a_press, &MackieControlProtocol::user_a_release);
 990         DEFINE_BUTTON_HANDLER (Button::UserB, &MackieControlProtocol::user_b_press, &MackieControlProtocol::user_b_release);
 991 }
 992
 993 void
 994 MackieControlProtocol::handle_button_event (Surface& surface, Button& button, ButtonState bs)
 995 {
 996         if  (bs != press && bs != release) {
 997                 update_led (surface, button, none);
 998                 return;
 999         }
1000
1001         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2\n", (bs == press ? "press" : "release"), button.id()));
1002
1003         ButtonMap::iterator b = button_map.find (button.id());
1004
1005         if (b != button_map.end()) {
1006
1007                 ButtonHandlers& bh (b->second);
1008
1009                 switch  (bs) {
1010                 case press:
1011                         surface.write (button.set_state ((this->*(bh.press)) (button)));
1012                 case release:
1013                         surface.write (button.set_state ((this->*(bh.release)) (button)));
1014                         break;
1015                 default:
1016                         break;
1017                 }
1018         } else {
1019                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button handlers for ID %1\n", button.id()));
1020         }
1021 }
1022
1023 void
1024 MackieControlProtocol::select_track (boost::shared_ptr<Route> r)
1025 {
1026         if (_modifier_state == MODIFIER_SHIFT) {
1027                 r->gain_control()->set_value (0.0);
1028         } else {
1029                 if (_current_selected_track > 0 && r->remote_control_id() == (uint32_t) _current_selected_track) {
1030                         UnselectTrack (); /* EMIT SIGNAL */
1031                         _current_selected_track = -1;
1032                 } else {
1033                         SelectByRID (r->remote_control_id()); /* EMIT SIGNAL */
1034                         _current_selected_track = r->remote_control_id();;
1035                 }
1036         }
1037 }
1038
1039 bool
1040 MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
1041 {
1042         DEBUG_TRACE (DEBUG::MidiIO, string_compose ("something happend on  %1\n", port->name()));
1043
1044         if (ioc & ~IO_IN) {
1045                 return false;
1046         }
1047
1048         if (ioc & IO_IN) {
1049
1050                 CrossThreadChannel::drain (port->selectable());
1051
1052                 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("data available on %1\n", port->name()));
1053                 framepos_t now = session->engine().frame_time();
1054                 port->parse (now);
1055         }
1056
1057         return true;
1058 }
1059
1060 void
1061 MackieControlProtocol::clear_ports ()
1062 {
1063         for (PortSources::iterator i = port_sources.begin(); i != port_sources.end(); ++i) {
1064                 g_source_destroy (*i);
1065                 g_source_unref (*i);
1066         }
1067
1068         port_sources.clear ();
1069 }
1070
1071 string
1072 MackieControlProtocol::f_action (uint32_t fn)
1073 {
1074         if (fn >= _f_actions.size()) {
1075                 return string();
1076         }
1077
1078         return _f_actions[fn];
1079 }
1080
1081 void
1082 MackieControlProtocol::f_press (uint32_t fn)
1083 {
1084         string action = f_action (0);
1085         if (!action.empty()) {
1086                 access_action (action);
1087         }
1088 }
1089
1090 void
1091 MackieControlProtocol::set_view_mode (ViewMode m)
1092 {
1093         _view_mode = m;
1094
1095         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1096                 (*s)->update_view_mode_display ();
1097         }
1098
1099 }
1100
1101 void
1102 MackieControlProtocol::set_master_on_surface_strip (uint32_t surface, uint32_t strip_number)
1103 {
1104         force_special_route_to_strip (session->master_out(), surface, strip_number);
1105 }
1106
1107 void
1108 MackieControlProtocol::set_monitor_on_surface_strip (uint32_t surface, uint32_t strip_number)
1109 {
1110         force_special_route_to_strip (session->monitor_out(), surface, strip_number);
1111 }
1112
1113 void
1114 MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r, uint32_t surface, uint32_t strip_number)
1115 {
1116         if (!r) {
1117                 return;
1118         }
1119
1120         for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1121                 if ((*s)->number() == surface) {
1122                         Strip* strip = (*s)->nth_strip (strip_number);
1123                         if (strip) {
1124                                 strip->set_route (session->master_out());
1125                                 strip->lock_route ();
1126                         }
1127                 }
1128         }
1129 }