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