add a (potentially temporary) discover button for mackie devices
[ardour.git] / libs / surfaces / mackie / surface.cc
1 #include <sstream>
2 #include <iomanip>
3 #include <iostream>
4 #include <cstdio>
5 #include <cmath>
6
7 #include "midi++/port.h"
8 #include "midi++/manager.h"
9
10 #include "ardour/automation_control.h"
11 #include "ardour/debug.h"
12 #include "ardour/route.h"
13 #include "ardour/panner.h"
14 #include "ardour/panner_shell.h"
15 #include "ardour/rc_configuration.h"
16 #include "ardour/session.h"
17 #include "ardour/utils.h"
18
19 #include "control_group.h"
20 #include "surface_port.h"
21 #include "surface.h"
22 #include "strip.h"
23 #include "mackie_control_protocol.h"
24 #include "jog_wheel.h"
25
26 #include "strip.h"
27 #include "button.h"
28 #include "led.h"
29 #include "pot.h"
30 #include "fader.h"
31 #include "jog.h"
32 #include "meter.h"
33
34 #include "i18n.h"
35
36 using namespace std;
37 using namespace PBD;
38 using namespace Mackie;
39 using ARDOUR::Route;
40 using ARDOUR::Panner;
41 using ARDOUR::Pannable;
42 using ARDOUR::AutomationControl;
43
44 #define ui_context() MackieControlProtocol::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
45
46 // The MCU sysex header.4th byte Will be overwritten
47 // when we get an incoming sysex that identifies
48 // the device type
49 static MidiByteArray mackie_sysex_hdr  (5, MIDI::sysex, 0x0, 0x0, 0x66, 0x14);
50
51 // The MCU extender sysex header.4th byte Will be overwritten
52 // when we get an incoming sysex that identifies
53 // the device type
54 static MidiByteArray mackie_sysex_hdr_xt  (5, MIDI::sysex, 0x0, 0x0, 0x66, 0x15);
55
56 static MidiByteArray empty_midi_byte_array;
57
58 Surface::Surface (MackieControlProtocol& mcp, const std::string& device_name, uint32_t number, surface_type_t stype)
59         : _mcp (mcp)
60         , _stype (stype)
61         , _number (number)
62         , _name (device_name)
63         , _active (false)
64         , _connected (false)
65         , _jog_wheel (0)
66 {
67         DEBUG_TRACE (DEBUG::MackieControl, "Surface::init\n");
68         
69         _port = new SurfacePort (*this);
70
71         /* only the first Surface object has global controls */
72
73         if (_number == 0) {
74                 if (_mcp.device_info().has_global_controls()) {
75                         init_controls ();
76                 }
77
78                 if (_mcp.device_info().has_master_fader()) {
79                         setup_master ();
80                 }
81         }
82
83         uint32_t n = _mcp.device_info().strip_cnt();
84         
85         if (n) {
86                 init_strips (n);
87         }
88         
89         connect_to_signals ();
90
91         DEBUG_TRACE (DEBUG::MackieControl, "Surface::init finish\n");
92 }
93
94 Surface::~Surface ()
95 {
96         DEBUG_TRACE (DEBUG::MackieControl, "Surface: destructor\n");
97
98         zero_all ();
99
100         // delete groups
101         for (Groups::iterator it = groups.begin(); it != groups.end(); ++it) {
102                 delete it->second;
103         }
104         
105         // delete controls
106         for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) {
107                 delete *it;
108         }
109         
110         delete _jog_wheel;
111         delete _port;
112 }
113
114 const MidiByteArray& 
115 Surface::sysex_hdr() const
116 {
117         switch  (_stype) {
118         case mcu: return mackie_sysex_hdr;
119         case ext: return mackie_sysex_hdr_xt;
120         }
121         cout << "SurfacePort::sysex_hdr _port_type not known" << endl;
122         return mackie_sysex_hdr;
123 }
124
125 static GlobalControlDefinition mackie_global_controls[] = {
126         { "external", Pot::External, Pot::factory, "none" },
127         { "fader_touch", Led::FaderTouch, Led::factory, "master" },
128         { "timecode", Led::Timecode, Led::factory, "none" },
129         { "beats", Led::Beats, Led::factory, "none" },
130         { "solo", Led::RudeSolo, Led::factory, "none" },
131         { "relay_click", Led::RelayClick, Led::factory, "none" },
132         { "", 0, Led::factory, "" }
133 };
134
135 void 
136 Surface::init_controls()
137 {
138         Group* group;
139
140         groups["assignment"] = new Group  ("assignment");
141         groups["automation"] = new Group  ("automation");
142         groups["bank"] = new Group  ("bank");
143         groups["cursor"] = new Group  ("cursor");
144         groups["display"] = new Group  ("display");
145         groups["functions"] = new Group  ("functions");
146         groups["modifiers"] = new Group  ("modifiers");
147         groups["none"] = new Group  ("none");
148         groups["transport"] = new Group  ("transport");
149         groups["user"] = new Group  ("user");
150         groups["master"] = new Group ("master");
151         groups["view"] = new Group ("view");
152                 
153         if (_mcp.device_info().has_jog_wheel()) {
154                 _jog_wheel = new Mackie::JogWheel (_mcp);
155         }
156
157         for (uint32_t n = 0; mackie_global_controls[n].name[0]; ++n) {
158                 group = groups[mackie_global_controls[n].group_name];
159                 Control* control = mackie_global_controls[n].factory (*this, mackie_global_controls[n].id, mackie_global_controls[n].name, *group);
160                 controls_by_device_independent_id[mackie_global_controls[n].id] = control;
161         }
162
163         /* add global buttons */
164
165         const map<Button::ID,GlobalButtonInfo>& global_buttons (_mcp.device_info().global_buttons());
166
167         for (map<Button::ID,GlobalButtonInfo>::const_iterator b = global_buttons.begin(); b != global_buttons.end(); ++b){
168                 group = groups[b->second.group];
169                 controls_by_device_independent_id[b->first] = Button::factory (*this, b->first, b->second.id, b->second.label, *group);
170         }
171 }
172
173 void 
174 Surface::init_strips (uint32_t n)
175 {
176         const map<Button::ID,StripButtonInfo>& strip_buttons (_mcp.device_info().strip_buttons());
177
178         for (uint32_t i = 0; i < n; ++i) {
179
180                 char name[32];
181                 
182                 snprintf (name, sizeof (name), "strip_%d", (8* _number) + i);
183
184                 Strip* strip = new Strip (*this, name, i, strip_buttons);
185                 
186                 groups[name] = strip;
187                 strips.push_back (strip);
188         }
189 }
190
191 void
192 Surface::setup_master ()
193 {
194         _master_fader = dynamic_cast<Fader*> (Fader::factory (*this, 8, "master", *groups["master"]));
195         
196         boost::shared_ptr<Route> m;
197         
198         if ((m = _mcp.get_session().monitor_out()) == 0) {
199                 m = _mcp.get_session().master_out();
200         } 
201         
202         if (!m) {
203                 return;
204         }
205         
206         _master_fader->set_control (m->gain_control());
207         m->gain_control()->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&Surface::master_gain_changed, this), ui_context());
208 }
209
210 void
211 Surface::master_gain_changed ()
212 {
213         boost::shared_ptr<AutomationControl> ac = _master_fader->control();
214         float pos = ac->internal_to_interface (ac->get_value());
215         _port->write (_master_fader->set_position (pos));
216 }
217
218 float 
219 Surface::scaled_delta (float delta, float current_speed)
220 {
221         /* XXX needs work before use */
222         const float sign = delta < 0.0 ? -1.0 : 1.0;
223
224         return ((sign * std::pow (delta + 1.0, 2.0)) + current_speed) / 100.0;
225 }
226
227 void 
228 Surface::display_bank_start (uint32_t current_bank)
229 {
230         if  (current_bank == 0) {
231                 // send Ar. to 2-char display on the master
232                 show_two_char_display ("Ar", "..");
233         } else {
234                 // write the current first remote_id to the 2-char display
235                 show_two_char_display (current_bank);
236         }
237 }
238
239 void 
240 Surface::blank_jog_ring ()
241 {
242         Control* control = controls_by_device_independent_id[Jog::ID];
243
244         if (control) {
245                 Pot* pot = dynamic_cast<Pot*> (control);
246                 if (pot) {
247                         _port->write (pot->set (0.0, false, Pot::spread));
248                 }
249         }
250 }
251
252 float
253 Surface::scrub_scaling_factor () const
254 {
255         return 100.0;
256 }
257
258 void 
259 Surface::connect_to_signals ()
260 {
261         if (!_connected) {
262
263
264                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 connecting to signals on port %2\n", 
265                                                                    number(), _port->input_port().name()));
266
267                 MIDI::Parser* p = _port->input_port().parser();
268
269                 /* Incoming sysex */
270                 p->sysex.connect_same_thread (*this, boost::bind (&Surface::handle_midi_sysex, this, _1, _2, _3));
271                 /* V-Pot messages are Controller */
272                 p->controller.connect_same_thread (*this, boost::bind (&Surface::handle_midi_controller_message, this, _1, _2));
273                 /* Button messages are NoteOn */
274                 p->note_on.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2));
275                 /* Button messages are NoteOn. libmidi++ sends note-on w/velocity = 0 as note-off so catch them too */
276                 p->note_off.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2));
277                 /* Fader messages are Pitchbend */
278                 p->channel_pitchbend[0].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 0U));
279                 p->channel_pitchbend[1].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 1U));
280                 p->channel_pitchbend[2].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 2U));
281                 p->channel_pitchbend[3].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 3U));
282                 p->channel_pitchbend[4].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 4U));
283                 p->channel_pitchbend[5].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 5U));
284                 p->channel_pitchbend[6].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 6U));
285                 p->channel_pitchbend[7].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 7U));
286                 
287                 _connected = true;
288         }
289 }
290
291 void
292 Surface::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb, uint32_t fader_id)
293 {
294         /* Pitchbend messages are fader messages. Nothing in the data we get
295          * from the MIDI::Parser conveys the fader ID, which was given by the
296          * channel ID in the status byte.
297          *
298          * Instead, we have used bind() to supply the fader-within-strip ID 
299          * when we connected to the per-channel pitchbend events.
300          */
301
302         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handle_midi pitchbend on port %3, fader = %1 value = %2\n", 
303                                                            fader_id, pb, _number));
304         
305         Fader* fader = faders[fader_id];
306
307         if (fader) {
308                 Strip* strip = dynamic_cast<Strip*> (&fader->group());
309                 float pos = (pb >> 4)/1023.0; // only the top 10 bytes are used
310                 if (strip) {
311                         strip->handle_fader (*fader, pos);
312                 } else {
313                         /* master fader */
314                         fader->set_value (pos); // alter master gain
315                         _port->write (fader->set_position (pos)); // write back value (required for servo)
316                 }
317         } else {
318                 DEBUG_TRACE (DEBUG::MackieControl, "fader not found\n");
319         }
320 }
321
322 void 
323 Surface::handle_midi_note_on_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
324 {
325         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_note_on %1 = %2\n", (int) ev->note_number, (int) ev->velocity));
326         
327         Button* button = buttons[ev->note_number];
328
329         if (button) {
330                 Strip* strip = dynamic_cast<Strip*> (&button->group());
331
332                 if (strip) {
333                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip %1 button %2 pressed ? %3\n",
334                                                                            strip->index(), button->name(), (ev->velocity > 64)));
335                         strip->handle_button (*button, ev->velocity > 64 ? press : release);
336                 } else {
337                         /* global button */
338                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("global button %1\n", button->id()));
339                         _mcp.handle_button_event (*this, *button, ev->velocity > 64 ? press : release);
340                 }
341         } else {
342                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button found for %1\n", ev->note_number));
343         }
344 }
345
346 void 
347 Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
348 {
349         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_midi_controller %1 = %2\n", (int) ev->controller_number, (int) ev->value));
350
351         Pot* pot = pots[ev->controller_number];
352
353         // bit 6 gives the sign
354         float sign = (ev->value & 0x40) == 0 ? 1.0 : -1.0; 
355         // bits 0..5 give the velocity. we interpret this as "ticks
356         // moved before this message was sent"
357         float ticks = (ev->value & 0x3f);
358         if (ticks == 0) {
359                 /* euphonix and perhaps other devices send zero
360                    when they mean 1, we think.
361                 */
362                 ticks = 1;
363         }
364         float delta = sign * (ticks / (float) 0x3f);
365         
366         if (!pot) {
367                 if (ev->controller_number == Jog::ID && _jog_wheel) {
368
369                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Jog wheel moved %1\n", ticks));
370                         _jog_wheel->jog_event (delta);
371                         return;
372                 }
373
374                 return;
375         }
376
377         Strip* strip = dynamic_cast<Strip*> (&pot->group());
378         if (strip) {
379                 strip->handle_pot (*pot, delta);
380         } 
381 }
382
383 void 
384 Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count)
385 {
386         MidiByteArray bytes (count, raw_bytes);
387
388         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handle_midi_sysex: %1\n", bytes));
389
390         /* always save the device type ID so that our outgoing sysex messages
391          * are correct 
392          */
393
394         if (_stype == mcu) {
395                 mackie_sysex_hdr[3] = bytes[4];
396         } else {
397                 mackie_sysex_hdr_xt[3] = bytes[4];
398         }
399
400         switch (bytes[5]) {
401         case 0x01:
402                 /* MCP: Device Ready 
403                    LCP: Connection Challenge 
404                 */
405                 if (bytes[4] == 0x10 || bytes[4] == 0x11) {
406                         write_sysex (host_connection_query (bytes));
407                 } else {
408                         if (!_active) {
409                                 _active = true;
410                                 zero_controls ();
411                                 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
412                                         (*s)->notify_all ();
413                                 }
414                                 update_view_mode_display ();
415                         }
416                 }
417                 break;
418
419         case 0x03: /* LCP Connection Confirmation */
420                 if (bytes[4] == 0x10 || bytes[4] == 0x11) {
421                         write_sysex (host_connection_confirmation (bytes));
422                         _active = true;
423                 }
424                 break;
425
426         case 0x04: /* LCP: Confirmation Denied */
427                 _active = false;
428                 break;
429         default:
430                 error << "MCP: unknown sysex: " << bytes << endmsg;
431         }
432 }
433
434 static MidiByteArray 
435 calculate_challenge_response (MidiByteArray::iterator begin, MidiByteArray::iterator end)
436 {
437         MidiByteArray l;
438         back_insert_iterator<MidiByteArray> back  (l);
439         copy (begin, end, back);
440         
441         MidiByteArray retval;
442         
443         // this is how to calculate the response to the challenge.
444         // from the Logic docs.
445         retval <<  (0x7f &  (l[0] +  (l[1] ^ 0xa) - l[3]));
446         retval <<  (0x7f &  ( (l[2] >> l[3]) ^  (l[0] + l[3])));
447         retval <<  (0x7f &  ((l[3] -  (l[2] << 2)) ^  (l[0] | l[1])));
448         retval <<  (0x7f &  (l[1] - l[2] +  (0xf0 ^  (l[3] << 4))));
449         
450         return retval;
451 }
452
453 // not used right now
454 MidiByteArray 
455 Surface::host_connection_query (MidiByteArray & bytes)
456 {
457         MidiByteArray response;
458         
459         if (bytes[4] != 0x10 && bytes[4] != 0x11) {
460                 /* not a Logic Control device - no response required */
461                 return response;
462         }
463
464         // handle host connection query
465         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("host connection query: %1\n", bytes));
466         
467         if  (bytes.size() != 18) {
468                 cerr << "expecting 18 bytes, read " << bytes << " from " << _port->input_port().name() << endl;
469                 return response;
470         }
471
472         // build and send host connection reply
473         response << 0x02;
474         copy (bytes.begin() + 6, bytes.begin() + 6 + 7, back_inserter (response));
475         response << calculate_challenge_response (bytes.begin() + 6 + 7, bytes.begin() + 6 + 7 + 4);
476         return response;
477 }
478
479 // not used right now
480 MidiByteArray 
481 Surface::host_connection_confirmation (const MidiByteArray & bytes)
482 {
483         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("host_connection_confirmation: %1\n", bytes));
484         
485         // decode host connection confirmation
486         if  (bytes.size() != 14) {
487                 ostringstream os;
488                 os << "expecting 14 bytes, read " << bytes << " from " << _port->input_port().name();
489                 throw MackieControlException (os.str());
490         }
491         
492         // send version request
493         return MidiByteArray (2, 0x13, 0x00);
494 }
495
496 void 
497 Surface::handle_port_inactive (SurfacePort*)
498 {
499         _active = false;
500 }
501
502 void 
503 Surface::write_sysex (const MidiByteArray & mba)
504 {
505         if (mba.empty()) {
506                 return;
507         }
508
509         MidiByteArray buf;
510         buf << sysex_hdr() << mba << MIDI::eox;
511         _port->write (buf);
512 }
513
514 void 
515 Surface::write_sysex (MIDI::byte msg)
516 {
517         MidiByteArray buf;
518         buf << sysex_hdr() << msg << MIDI::eox;
519         _port->write (buf);
520 }
521
522 uint32_t
523 Surface::n_strips (bool with_locked_strips) const
524 {
525         if (with_locked_strips) {
526                 return strips.size();
527         } 
528
529         uint32_t n = 0;
530
531         for (Strips::const_iterator it = strips.begin(); it != strips.end(); ++it) {
532                 if (!(*it)->locked()) {
533                         ++n;
534                 }
535         }
536         return n;
537 }
538
539 Strip*
540 Surface::nth_strip (uint32_t n) const
541 {
542         if (n > n_strips()) {
543                 return 0;
544         }
545         return strips[n];
546 }
547
548 void
549 Surface::zero_all ()
550 {
551         // TODO turn off Timecode displays
552
553         // zero all strips
554         for (Strips::iterator it = strips.begin(); it != strips.end(); ++it) {
555                 (*it)->zero();
556         }
557
558         zero_controls ();
559 }
560
561 void
562 Surface::zero_controls ()
563 {
564         if (_stype != mcu || !_mcp.device_info().has_global_controls()) {
565                 return;
566         }
567
568         // turn off global buttons and leds
569         // global buttons are only ever on mcu_port, so we don't have
570         // to figure out which port.
571
572         for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) {
573                 Control & control = **it;
574                 if (!control.group().is_strip()) {
575                         _port->write (control.zero());
576                 }
577         }
578
579         if (_number == 0 && _mcp.device_info().has_two_character_display()) {
580                 // any hardware-specific stuff
581                 // clear 2-char display
582                 show_two_char_display (" ");
583         }
584
585         // and the led ring for the master strip
586         blank_jog_ring ();
587 }
588
589 void
590 Surface::periodic (uint64_t now_usecs)
591 {
592         for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
593                 (*s)->periodic (now_usecs);
594         }
595 }
596
597 void
598 Surface::write (const MidiByteArray& data) 
599 {
600         if (_active) {
601                 _port->write (data);
602         }
603 }
604
605 void
606 Surface::map_routes (const vector<boost::shared_ptr<Route> >& routes)
607 {
608         vector<boost::shared_ptr<Route> >::const_iterator r;
609         Strips::iterator s = strips.begin();
610
611         for (r = routes.begin(); r != routes.end() && s != strips.end(); ++s) {
612
613                 /* don't try to assign routes to a locked strip. it won't
614                    use it anyway, but if we do, then we get out of sync
615                    with the proposed mapping.
616                 */
617
618                 if (!(*s)->locked()) {
619                         (*s)->set_route (*r);
620                         ++r;
621                 }
622         }
623
624         for (; s != strips.end(); ++s) {
625                 (*s)->set_route (boost::shared_ptr<Route>());
626         }
627
628
629 }
630
631 static char 
632 translate_seven_segment (char achar)
633 {
634         achar = toupper (achar);
635
636         if  (achar >= 0x40 && achar <= 0x60) {
637                 return achar - 0x40;
638         } else if  (achar >= 0x21 && achar <= 0x3f) {
639                 return achar;
640         } else {
641                 return 0x00;
642         }
643 }
644
645 void
646 Surface::show_two_char_display (const std::string & msg, const std::string & dots)
647 {
648         if (_stype != mcu || !_mcp.device_info().has_two_character_display() || msg.length() != 2 || dots.length() != 2) {
649                 return;
650         }
651         
652         MidiByteArray right (3, 0xb0, 0x4b, 0x00);
653         MidiByteArray left (3, 0xb0, 0x4a, 0x00);
654         
655         right[2] = translate_seven_segment (msg[0]) +  (dots[0] == '.' ? 0x40 : 0x00);
656         left[2] = translate_seven_segment (msg[1]) +  (dots[1] == '.' ? 0x40 : 0x00);
657         
658         _port->write (right);
659         _port->write (left);
660 }
661
662 void
663 Surface::show_two_char_display (unsigned int value, const std::string & /*dots*/)
664 {
665         ostringstream os;
666         os << setfill('0') << setw(2) << value % 100;
667         show_two_char_display (os.str());
668 }
669
670 void 
671 Surface::display_timecode (const std::string & timecode, const std::string & timecode_last)
672 {
673         if (_active && _mcp.device_info().has_timecode_display()) {
674                 _port->write (timecode_display (timecode, timecode_last));
675         }
676 }
677
678 MidiByteArray 
679 Surface::timecode_display (const std::string & timecode, const std::string & last_timecode)
680 {
681         // if there's no change, send nothing, not even sysex header
682         if  (timecode == last_timecode) return MidiByteArray();
683         
684         // length sanity checking
685         string local_timecode = timecode;
686
687         // truncate to 10 characters
688         if  (local_timecode.length() > 10) {
689                 local_timecode = local_timecode.substr (0, 10);
690         }
691
692         // pad to 10 characters
693         while  (local_timecode.length() < 10) { 
694                 local_timecode += " ";
695         }
696                 
697         // find the suffix of local_timecode that differs from last_timecode
698         std::pair<string::const_iterator,string::iterator> pp = mismatch (last_timecode.begin(), last_timecode.end(), local_timecode.begin());
699         
700         MidiByteArray retval;
701         
702         // sysex header
703         retval << sysex_hdr();
704         
705         // code for timecode display
706         retval << 0x10;
707         
708         // translate characters. These are sent in reverse order of display
709         // hence the reverse iterators
710         string::reverse_iterator rend = reverse_iterator<string::iterator> (pp.second);
711         for  (string::reverse_iterator it = local_timecode.rbegin(); it != rend; ++it) {
712                 retval << translate_seven_segment (*it);
713         }
714         
715         // sysex trailer
716         retval << MIDI::eox;
717         
718         return retval;
719 }
720
721 void
722 Surface::update_flip_mode_display ()
723 {
724         for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
725                 (*s)->flip_mode_changed (true);
726         }
727 }
728
729 void
730 Surface::update_view_mode_display ()
731 {
732         string text;
733         int id = -1;
734
735         if (!_active) {
736                 return;
737         }
738
739         switch (_mcp.view_mode()) {
740         case MackieControlProtocol::Mixer:
741                 show_two_char_display ("Mx");
742                 id = Button::Pan;
743                 break;
744         case MackieControlProtocol::Dynamics:
745                 show_two_char_display ("Dy");
746                 id = Button::Dyn;
747                 break;
748         case MackieControlProtocol::EQ:
749                 show_two_char_display ("EQ");
750                 id = Button::Eq;
751                 break;
752         case MackieControlProtocol::Loop:
753                 show_two_char_display ("LP");
754                 id = Button::Loop;
755                 break;
756         case MackieControlProtocol::AudioTracks:
757                 show_two_char_display ("AT");
758                 break;
759         case MackieControlProtocol::MidiTracks:
760                 show_two_char_display ("MT");
761                 break;
762         case MackieControlProtocol::Sends:
763                 show_two_char_display ("Sn");
764                 id = Button::Sends;
765                 break;
766         case MackieControlProtocol::Plugins:
767                 show_two_char_display ("Pl");
768                 id = Button::Plugin;
769                 break;
770         default:
771                 break;
772         }
773
774         if (id >= 0) {
775                 
776                 /* we are attempting to turn a global button/LED on */
777
778                 map<int,Control*>::iterator x = controls_by_device_independent_id.find (id);
779
780                 if (x != controls_by_device_independent_id.end()) {
781                         Button* button = dynamic_cast<Button*> (x->second);
782                         if (button) {
783                                 _port->write (button->set_state (on));
784                         }
785                 }
786         }
787
788         if (!text.empty()) {
789                 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
790                         _port->write ((*s)->display (1, text));
791                 }
792         }
793 }
794
795 void
796 Surface::gui_selection_changed (const ARDOUR::StrongRouteNotificationList& routes)
797 {
798         for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
799                 (*s)->gui_selection_changed (routes);
800         }
801 }
802
803 void
804 Surface::say_hello ()
805 {
806         cerr << "Sending hello to port " << _port->output_port().name() << endl;
807
808         /* wakeup for Mackie Control */
809         MidiByteArray wakeup (7, MIDI::sysex, 0x00, 0x00, 0x66, 0x14, 0x00, MIDI::eox);
810         _port->write (wakeup);
811         wakeup[4] = 0x15; /* wakup Mackie XT */
812         _port->write (wakeup);
813         wakeup[4] = 0x10; /* wakupe Logic Control */
814         _port->write (wakeup);
815         wakeup[4] = 0x11; /* wakeup Logic Control XT */
816         _port->write (wakeup);
817 }
818
819 void
820 Surface::next_jog_mode ()
821 {
822 }
823
824 void
825 Surface::set_jog_mode (JogWheel::Mode)
826 {
827 }       
828
829 bool
830 Surface::route_is_locked_to_strip (boost::shared_ptr<Route> r) const
831 {
832         for (Strips::const_iterator s = strips.begin(); s != strips.end(); ++s) {
833                 if ((*s)->route() == r && (*s)->locked()) {
834                         return true;
835                 }
836         }
837         return false;
838 }