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