7 #include "midi++/port.h"
8 #include "midi++/manager.h"
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"
19 #include "control_group.h"
20 #include "surface_port.h"
23 #include "mackie_control_protocol.h"
24 #include "jog_wheel.h"
38 using namespace Mackie;
41 using ARDOUR::Pannable;
42 using ARDOUR::AutomationControl;
44 #define ui_context() MackieControlProtocol::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
45 #define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
47 // The MCU sysex header.4th byte Will be overwritten
48 // when we get an incoming sysex that identifies
50 static MidiByteArray mackie_sysex_hdr (5, MIDI::sysex, 0x0, 0x0, 0x66, 0x14);
52 // The MCU extender sysex header.4th byte Will be overwritten
53 // when we get an incoming sysex that identifies
55 static MidiByteArray mackie_sysex_hdr_xt (5, MIDI::sysex, 0x0, 0x0, 0x66, 0x15);
57 static MidiByteArray empty_midi_byte_array;
59 Surface::Surface (MackieControlProtocol& mcp, const std::string& device_name, uint32_t number, surface_type_t stype)
68 DEBUG_TRACE (DEBUG::MackieControl, "Surface::init\n");
70 _port = new SurfacePort (*this);
72 /* only the first Surface object has global controls */
75 if (_mcp.device_info().has_global_controls()) {
79 if (_mcp.device_info().has_master_fader()) {
84 uint32_t n = _mcp.device_info().strip_cnt();
90 connect_to_signals ();
92 DEBUG_TRACE (DEBUG::MackieControl, "Surface::init finish\n");
97 DEBUG_TRACE (DEBUG::MackieControl, "Surface: destructor\n");
102 for (Groups::iterator it = groups.begin(); it != groups.end(); ++it) {
107 for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) {
116 Surface::sysex_hdr() const
119 case mcu: return mackie_sysex_hdr;
120 case ext: return mackie_sysex_hdr_xt;
122 cout << "SurfacePort::sysex_hdr _port_type not known" << endl;
123 return mackie_sysex_hdr;
126 static GlobalControlDefinition mackie_global_controls[] = {
127 { "external", Pot::External, Pot::factory, "none" },
128 { "fader_touch", Led::FaderTouch, Led::factory, "master" },
129 { "timecode", Led::Timecode, Led::factory, "none" },
130 { "beats", Led::Beats, Led::factory, "none" },
131 { "solo", Led::RudeSolo, Led::factory, "none" },
132 { "relay_click", Led::RelayClick, Led::factory, "none" },
133 { "", 0, Led::factory, "" }
137 Surface::init_controls()
141 groups["assignment"] = new Group ("assignment");
142 groups["automation"] = new Group ("automation");
143 groups["bank"] = new Group ("bank");
144 groups["cursor"] = new Group ("cursor");
145 groups["display"] = new Group ("display");
146 groups["functions"] = new Group ("functions");
147 groups["modifiers"] = new Group ("modifiers");
148 groups["none"] = new Group ("none");
149 groups["transport"] = new Group ("transport");
150 groups["user"] = new Group ("user");
151 groups["master"] = new Group ("master");
152 groups["view"] = new Group ("view");
154 if (_mcp.device_info().has_jog_wheel()) {
155 _jog_wheel = new Mackie::JogWheel (_mcp);
158 for (uint32_t n = 0; mackie_global_controls[n].name[0]; ++n) {
159 group = groups[mackie_global_controls[n].group_name];
160 Control* control = mackie_global_controls[n].factory (*this, mackie_global_controls[n].id, mackie_global_controls[n].name, *group);
161 controls_by_device_independent_id[mackie_global_controls[n].id] = control;
164 /* add global buttons */
166 const map<Button::ID,GlobalButtonInfo>& global_buttons (_mcp.device_info().global_buttons());
168 for (map<Button::ID,GlobalButtonInfo>::const_iterator b = global_buttons.begin(); b != global_buttons.end(); ++b){
169 group = groups[b->second.group];
170 controls_by_device_independent_id[b->first] = Button::factory (*this, b->first, b->second.id, b->second.label, *group);
175 Surface::init_strips (uint32_t n)
177 const map<Button::ID,StripButtonInfo>& strip_buttons (_mcp.device_info().strip_buttons());
179 for (uint32_t i = 0; i < n; ++i) {
183 snprintf (name, sizeof (name), "strip_%d", (8* _number) + i);
185 Strip* strip = new Strip (*this, name, i, strip_buttons);
187 groups[name] = strip;
188 strips.push_back (strip);
193 Surface::setup_master ()
195 _master_fader = dynamic_cast<Fader*> (Fader::factory (*this, 8, "master", *groups["master"]));
197 boost::shared_ptr<Route> m;
199 if ((m = _mcp.get_session().monitor_out()) == 0) {
200 m = _mcp.get_session().master_out();
207 _master_fader->set_control (m->gain_control());
208 m->gain_control()->Changed.connect (*this, MISSING_INVALIDATOR, ui_bind (&Surface::master_gain_changed, this), ui_context());
212 Surface::master_gain_changed ()
214 boost::shared_ptr<AutomationControl> ac = _master_fader->control();
215 float pos = ac->internal_to_interface (ac->get_value());
216 _port->write (_master_fader->set_position (pos));
220 Surface::scaled_delta (float delta, float current_speed)
222 /* XXX needs work before use */
223 const float sign = delta < 0.0 ? -1.0 : 1.0;
225 return ((sign * std::pow (delta + 1.0, 2.0)) + current_speed) / 100.0;
229 Surface::display_bank_start (uint32_t current_bank)
231 if (current_bank == 0) {
232 // send Ar. to 2-char display on the master
233 show_two_char_display ("Ar", "..");
235 // write the current first remote_id to the 2-char display
236 show_two_char_display (current_bank);
241 Surface::blank_jog_ring ()
243 Control* control = controls_by_device_independent_id[Jog::ID];
246 Pot* pot = dynamic_cast<Pot*> (control);
248 _port->write (pot->set (0.0, false, Pot::spread));
254 Surface::scrub_scaling_factor () const
260 Surface::connect_to_signals ()
265 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 connecting to signals on port %2\n",
266 number(), _port->input_port().name()));
268 MIDI::Parser* p = _port->input_port().parser();
271 p->sysex.connect_same_thread (*this, boost::bind (&Surface::handle_midi_sysex, this, _1, _2, _3));
272 /* V-Pot messages are Controller */
273 p->controller.connect_same_thread (*this, boost::bind (&Surface::handle_midi_controller_message, this, _1, _2));
274 /* Button messages are NoteOn */
275 p->note_on.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2));
276 /* Button messages are NoteOn. libmidi++ sends note-on w/velocity = 0 as note-off so catch them too */
277 p->note_off.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2));
278 /* Fader messages are Pitchbend */
279 p->channel_pitchbend[0].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 0U));
280 p->channel_pitchbend[1].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 1U));
281 p->channel_pitchbend[2].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 2U));
282 p->channel_pitchbend[3].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 3U));
283 p->channel_pitchbend[4].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 4U));
284 p->channel_pitchbend[5].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 5U));
285 p->channel_pitchbend[6].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 6U));
286 p->channel_pitchbend[7].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 7U));
293 Surface::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb, uint32_t fader_id)
295 /* Pitchbend messages are fader messages. Nothing in the data we get
296 * from the MIDI::Parser conveys the fader ID, which was given by the
297 * channel ID in the status byte.
299 * Instead, we have used bind() to supply the fader-within-strip ID
300 * when we connected to the per-channel pitchbend events.
303 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handle_midi pitchbend on port %3, fader = %1 value = %2\n",
304 fader_id, pb, _number));
306 Fader* fader = faders[fader_id];
309 Strip* strip = dynamic_cast<Strip*> (&fader->group());
310 float pos = (pb >> 4)/1023.0; // only the top 10 bytes are used
312 strip->handle_fader (*fader, pos);
315 fader->set_value (pos); // alter master gain
316 _port->write (fader->set_position (pos)); // write back value (required for servo)
319 DEBUG_TRACE (DEBUG::MackieControl, "fader not found\n");
324 Surface::handle_midi_note_on_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
326 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_note_on %1 = %2\n", (int) ev->note_number, (int) ev->velocity));
328 Button* button = buttons[ev->note_number];
331 Strip* strip = dynamic_cast<Strip*> (&button->group());
334 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip %1 button %2 pressed ? %3\n",
335 strip->index(), button->name(), (ev->velocity > 64)));
336 strip->handle_button (*button, ev->velocity > 64 ? press : release);
339 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("global button %1\n", button->id()));
340 _mcp.handle_button_event (*this, *button, ev->velocity > 64 ? press : release);
343 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button found for %1\n", ev->note_number));
348 Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
350 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_midi_controller %1 = %2\n", (int) ev->controller_number, (int) ev->value));
352 Pot* pot = pots[ev->controller_number];
355 if (ev->controller_number == Jog::ID && _jog_wheel) {
357 // bit 6 gives the sign
358 float sign = (ev->value & 0x40) == 0 ? 1.0 : -1.0;
359 // bits 0..5 give the velocity. we interpret this as "ticks
360 // moved before this message was sent"
361 float ticks = (ev->value & 0x3f);
363 /* euphonix and perhaps other devices send zero
364 when they mean 1, we think.
368 float delta = sign * (ticks / (float) 0x3f);
370 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Jog wheel moved %1\n", ticks));
371 _jog_wheel->jog_event (delta);
377 // bit 6 gives the sign
378 float sign = (ev->value & 0x40) == 0 ? 1.0 : -1.0;
379 // bits 0..5 give the velocity. we interpret this as "ticks
380 // moved before this message was sent"
381 float ticks = (ev->value & 0x3f);
383 /* euphonix and perhaps other devices send zero
384 when they mean 1, we think.
388 float delta = sign * (ticks / (float) 0x3f);
390 Strip* strip = dynamic_cast<Strip*> (&pot->group());
393 strip->handle_pot (*pot, delta);
396 DEBUG_TRACE (DEBUG::MackieControl, "pot not found\n");
401 Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count)
403 MidiByteArray bytes (count, raw_bytes);
405 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handle_midi_sysex: %1\n", bytes));
407 /* always save the device type ID so that our outgoing sysex messages
412 mackie_sysex_hdr[3] = bytes[4];
414 mackie_sysex_hdr_xt[3] = bytes[4];
420 LCP: Connection Challenge
422 if (bytes[4] == 0x10 || bytes[4] == 0x11) {
423 write_sysex (host_connection_query (bytes));
428 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
431 update_view_mode_display ();
436 case 0x03: /* LCP Connection Confirmation */
437 if (bytes[4] == 0x10 || bytes[4] == 0x11) {
438 write_sysex (host_connection_confirmation (bytes));
443 case 0x04: /* LCP: Confirmation Denied */
447 error << "MCP: unknown sysex: " << bytes << endmsg;
452 calculate_challenge_response (MidiByteArray::iterator begin, MidiByteArray::iterator end)
455 back_insert_iterator<MidiByteArray> back (l);
456 copy (begin, end, back);
458 MidiByteArray retval;
460 // this is how to calculate the response to the challenge.
461 // from the Logic docs.
462 retval << (0x7f & (l[0] + (l[1] ^ 0xa) - l[3]));
463 retval << (0x7f & ( (l[2] >> l[3]) ^ (l[0] + l[3])));
464 retval << (0x7f & ((l[3] - (l[2] << 2)) ^ (l[0] | l[1])));
465 retval << (0x7f & (l[1] - l[2] + (0xf0 ^ (l[3] << 4))));
470 // not used right now
472 Surface::host_connection_query (MidiByteArray & bytes)
474 MidiByteArray response;
476 if (bytes[4] != 0x10 && bytes[4] != 0x11) {
477 /* not a Logic Control device - no response required */
481 // handle host connection query
482 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("host connection query: %1\n", bytes));
484 if (bytes.size() != 18) {
485 cerr << "expecting 18 bytes, read " << bytes << " from " << _port->input_port().name() << endl;
489 // build and send host connection reply
491 copy (bytes.begin() + 6, bytes.begin() + 6 + 7, back_inserter (response));
492 response << calculate_challenge_response (bytes.begin() + 6 + 7, bytes.begin() + 6 + 7 + 4);
496 // not used right now
498 Surface::host_connection_confirmation (const MidiByteArray & bytes)
500 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("host_connection_confirmation: %1\n", bytes));
502 // decode host connection confirmation
503 if (bytes.size() != 14) {
505 os << "expecting 14 bytes, read " << bytes << " from " << _port->input_port().name();
506 throw MackieControlException (os.str());
509 // send version request
510 return MidiByteArray (2, 0x13, 0x00);
514 Surface::handle_port_inactive (SurfacePort * port)
520 Surface::write_sysex (const MidiByteArray & mba)
527 buf << sysex_hdr() << mba << MIDI::eox;
532 Surface::write_sysex (MIDI::byte msg)
535 buf << sysex_hdr() << msg << MIDI::eox;
540 Surface::n_strips () const
542 return strips.size();
546 Surface::nth_strip (uint32_t n) const
548 if (n > n_strips()) {
557 // TODO turn off Timecode displays
560 for (Strips::iterator it = strips.begin(); it != strips.end(); ++it) {
568 Surface::zero_controls ()
570 if (_stype != mcu || !_mcp.device_info().has_global_controls()) {
574 // turn off global buttons and leds
575 // global buttons are only ever on mcu_port, so we don't have
576 // to figure out which port.
578 for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) {
579 Control & control = **it;
580 if (!control.group().is_strip()) {
581 _port->write (control.zero());
585 if (_number == 0 && _mcp.device_info().has_two_character_display()) {
586 // any hardware-specific stuff
587 // clear 2-char display
588 show_two_char_display ("aa");
591 // and the led ring for the master strip
596 Surface::periodic (uint64_t now_usecs)
598 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
599 (*s)->periodic (now_usecs);
604 Surface::write (const MidiByteArray& data)
612 Surface::map_routes (const vector<boost::shared_ptr<Route> >& routes)
614 vector<boost::shared_ptr<Route> >::const_iterator r;
617 for (r = routes.begin(), s = strips.begin(); r != routes.end() && s != strips.end(); ++r, ++s) {
618 (*s)->set_route (*r);
621 for (; s != strips.end(); ++s) {
622 (*s)->set_route (boost::shared_ptr<Route>());
629 translate_seven_segment (char achar)
631 achar = toupper (achar);
633 if (achar >= 0x40 && achar <= 0x60) {
635 } else if (achar >= 0x21 && achar <= 0x3f) {
643 Surface::show_two_char_display (const std::string & msg, const std::string & dots)
645 if (_stype != mcu || !_mcp.device_info().has_two_character_display() || msg.length() != 2 || dots.length() != 2) {
649 MidiByteArray right (3, 0xb0, 0x4b, 0x00);
650 MidiByteArray left (3, 0xb0, 0x4a, 0x00);
652 right[2] = translate_seven_segment (msg[0]) + (dots[0] == '.' ? 0x40 : 0x00);
653 left[2] = translate_seven_segment (msg[1]) + (dots[1] == '.' ? 0x40 : 0x00);
655 _port->write (right);
660 Surface::show_two_char_display (unsigned int value, const std::string & /*dots*/)
663 os << setfill('0') << setw(2) << value % 100;
664 show_two_char_display (os.str());
668 Surface::display_timecode (const std::string & timecode, const std::string & timecode_last)
670 if (_active && _mcp.device_info().has_timecode_display()) {
671 _port->write (timecode_display (timecode, timecode_last));
676 Surface::timecode_display (const std::string & timecode, const std::string & last_timecode)
678 // if there's no change, send nothing, not even sysex header
679 if (timecode == last_timecode) return MidiByteArray();
681 // length sanity checking
682 string local_timecode = timecode;
684 // truncate to 10 characters
685 if (local_timecode.length() > 10) {
686 local_timecode = local_timecode.substr (0, 10);
689 // pad to 10 characters
690 while (local_timecode.length() < 10) {
691 local_timecode += " ";
694 // find the suffix of local_timecode that differs from last_timecode
695 std::pair<string::const_iterator,string::iterator> pp = mismatch (last_timecode.begin(), last_timecode.end(), local_timecode.begin());
697 MidiByteArray retval;
700 retval << sysex_hdr();
702 // code for timecode display
705 // translate characters. These are sent in reverse order of display
706 // hence the reverse iterators
707 string::reverse_iterator rend = reverse_iterator<string::iterator> (pp.second);
708 for (string::reverse_iterator it = local_timecode.rbegin(); it != rend; ++it) {
709 retval << translate_seven_segment (*it);
719 Surface::update_flip_mode_display ()
721 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
722 (*s)->flip_mode_changed (true);
727 Surface::update_view_mode_display ()
736 switch (_mcp.view_mode()) {
737 case MackieControlProtocol::Mixer:
738 show_two_char_display ("Mx");
739 button = buttons[Button::Pan];
741 case MackieControlProtocol::Dynamics:
742 show_two_char_display ("Dy");
743 button = buttons[Button::Dyn];
745 case MackieControlProtocol::EQ:
746 show_two_char_display ("EQ");
747 button = buttons[Button::Eq];
749 case MackieControlProtocol::Loop:
750 show_two_char_display ("LP");
751 button = buttons[Button::Loop];
753 case MackieControlProtocol::AudioTracks:
754 show_two_char_display ("AT");
756 case MackieControlProtocol::MidiTracks:
757 show_two_char_display ("MT");
759 case MackieControlProtocol::Sends:
760 show_two_char_display ("Sn");
761 button = buttons[Button::Sends];
763 case MackieControlProtocol::Plugins:
764 show_two_char_display ("Pl");
765 button = buttons[Button::Plugin];
772 _port->write (button->set_state (on));
776 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
777 _port->write ((*s)->display (1, text));
783 Surface::gui_selection_changed (ARDOUR::RouteNotificationListPtr routes)
785 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
786 (*s)->gui_selection_changed (routes);
791 Surface::say_hello ()
793 /* wakeup for Mackie Control */
794 MidiByteArray wakeup (7, MIDI::sysex, 0x00, 0x00, 0x66, 0x14, 0x00, MIDI::eox);
795 _port->write (wakeup);
796 wakeup[4] = 0x15; /* wakup Mackie XT */
797 _port->write (wakeup);
798 wakeup[4] = 0x10; /* wakupe Logic Control */
799 _port->write (wakeup);
800 wakeup[4] = 0x11; /* wakeup Logic Control XT */
801 _port->write (wakeup);
805 Surface::next_jog_mode ()
810 Surface::set_jog_mode (JogWheel::Mode m)