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) {
113 /* don't delete the port, because we want its output to remain queued */
117 Surface::sysex_hdr() const
120 case mcu: return mackie_sysex_hdr;
121 case ext: return mackie_sysex_hdr_xt;
123 cout << "SurfacePort::sysex_hdr _port_type not known" << endl;
124 return mackie_sysex_hdr;
127 static GlobalControlDefinition mackie_global_controls[] = {
128 { "external", Pot::External, Pot::factory, "none" },
129 { "fader_touch", Led::FaderTouch, Led::factory, "master" },
130 { "timecode", Led::Timecode, Led::factory, "none" },
131 { "beats", Led::Beats, Led::factory, "none" },
132 { "solo", Led::RudeSolo, Led::factory, "none" },
133 { "relay_click", Led::RelayClick, Led::factory, "none" },
134 { "", 0, Led::factory, "" }
138 Surface::init_controls()
142 groups["assignment"] = new Group ("assignment");
143 groups["automation"] = new Group ("automation");
144 groups["bank"] = new Group ("bank");
145 groups["cursor"] = new Group ("cursor");
146 groups["display"] = new Group ("display");
147 groups["functions"] = new Group ("functions");
148 groups["modifiers"] = new Group ("modifiers");
149 groups["none"] = new Group ("none");
150 groups["transport"] = new Group ("transport");
151 groups["user"] = new Group ("user");
152 groups["master"] = new Group ("master");
153 groups["view"] = new Group ("view");
155 if (_mcp.device_info().has_jog_wheel()) {
156 _jog_wheel = new Mackie::JogWheel (_mcp);
159 for (uint32_t n = 0; mackie_global_controls[n].name[0]; ++n) {
160 group = groups[mackie_global_controls[n].group_name];
161 Control* control = mackie_global_controls[n].factory (*this, mackie_global_controls[n].id, mackie_global_controls[n].name, *group);
162 controls_by_device_independent_id[mackie_global_controls[n].id] = control;
165 /* add global buttons */
167 const map<Button::ID,GlobalButtonInfo>& global_buttons (_mcp.device_info().global_buttons());
169 for (map<Button::ID,GlobalButtonInfo>::const_iterator b = global_buttons.begin(); b != global_buttons.end(); ++b){
170 group = groups[b->second.group];
171 controls_by_device_independent_id[b->first] = Button::factory (*this, b->first, b->second.id, b->second.label, *group);
176 Surface::init_strips (uint32_t n)
178 const map<Button::ID,StripButtonInfo>& strip_buttons (_mcp.device_info().strip_buttons());
180 for (uint32_t i = 0; i < n; ++i) {
184 snprintf (name, sizeof (name), "strip_%d", (8* _number) + i);
186 Strip* strip = new Strip (*this, name, i, strip_buttons);
188 groups[name] = strip;
189 strips.push_back (strip);
194 Surface::setup_master ()
196 _master_fader = dynamic_cast<Fader*> (Fader::factory (*this, 8, "master", *groups["master"]));
198 boost::shared_ptr<Route> m;
200 if ((m = _mcp.get_session().monitor_out()) == 0) {
201 m = _mcp.get_session().master_out();
208 _master_fader->set_control (m->gain_control());
209 m->gain_control()->Changed.connect (*this, MISSING_INVALIDATOR, ui_bind (&Surface::master_gain_changed, this), ui_context());
213 Surface::master_gain_changed ()
215 boost::shared_ptr<AutomationControl> ac = _master_fader->control();
216 float pos = ac->internal_to_interface (ac->get_value());
217 _port->write (_master_fader->set_position (pos));
221 Surface::scaled_delta (float delta, float current_speed)
223 /* XXX needs work before use */
224 const float sign = delta < 0.0 ? -1.0 : 1.0;
226 return ((sign * std::pow (delta + 1.0, 2.0)) + current_speed) / 100.0;
230 Surface::display_bank_start (uint32_t current_bank)
232 if (current_bank == 0) {
233 // send Ar. to 2-char display on the master
234 show_two_char_display ("Ar", "..");
236 // write the current first remote_id to the 2-char display
237 show_two_char_display (current_bank);
242 Surface::blank_jog_ring ()
244 Control* control = controls_by_device_independent_id[Jog::ID];
247 Pot* pot = dynamic_cast<Pot*> (control);
249 _port->write (pot->set (0.0, false, Pot::spread));
255 Surface::scrub_scaling_factor () const
261 Surface::connect_to_signals ()
266 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 connecting to signals on port %2\n",
267 number(), _port->input_port().name()));
269 MIDI::Parser* p = _port->input_port().parser();
272 p->sysex.connect_same_thread (*this, boost::bind (&Surface::handle_midi_sysex, this, _1, _2, _3));
273 /* V-Pot messages are Controller */
274 p->controller.connect_same_thread (*this, boost::bind (&Surface::handle_midi_controller_message, this, _1, _2));
275 /* Button messages are NoteOn */
276 p->note_on.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2));
277 /* Button messages are NoteOn. libmidi++ sends note-on w/velocity = 0 as note-off so catch them too */
278 p->note_off.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2));
279 /* Fader messages are Pitchbend */
280 p->channel_pitchbend[0].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 0U));
281 p->channel_pitchbend[1].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 1U));
282 p->channel_pitchbend[2].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 2U));
283 p->channel_pitchbend[3].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 3U));
284 p->channel_pitchbend[4].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 4U));
285 p->channel_pitchbend[5].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 5U));
286 p->channel_pitchbend[6].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 6U));
287 p->channel_pitchbend[7].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 7U));
294 Surface::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb, uint32_t fader_id)
296 /* Pitchbend messages are fader messages. Nothing in the data we get
297 * from the MIDI::Parser conveys the fader ID, which was given by the
298 * channel ID in the status byte.
300 * Instead, we have used bind() to supply the fader-within-strip ID
301 * when we connected to the per-channel pitchbend events.
304 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handle_midi pitchbend on port %3, fader = %1 value = %2\n",
305 fader_id, pb, _number));
307 Fader* fader = faders[fader_id];
310 Strip* strip = dynamic_cast<Strip*> (&fader->group());
311 float pos = (pb >> 4)/1023.0; // only the top 10 bytes are used
313 strip->handle_fader (*fader, pos);
316 fader->set_value (pos); // alter master gain
317 _port->write (fader->set_position (pos)); // write back value (required for servo)
320 DEBUG_TRACE (DEBUG::MackieControl, "fader not found\n");
325 Surface::handle_midi_note_on_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
327 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_note_on %1 = %2\n", (int) ev->note_number, (int) ev->velocity));
329 Button* button = buttons[ev->note_number];
332 Strip* strip = dynamic_cast<Strip*> (&button->group());
335 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip %1 button %2 pressed ? %3\n",
336 strip->index(), button->name(), (ev->velocity > 64)));
337 strip->handle_button (*button, ev->velocity > 64 ? press : release);
340 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("global button %1\n", button->id()));
341 _mcp.handle_button_event (*this, *button, ev->velocity > 64 ? press : release);
344 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button found for %1\n", ev->note_number));
349 Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
351 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_midi_controller %1 = %2\n", (int) ev->controller_number, (int) ev->value));
353 Pot* pot = pots[ev->controller_number];
356 if (ev->controller_number == Jog::ID && _jog_wheel) {
358 // bit 6 gives the sign
359 float sign = (ev->value & 0x40) == 0 ? 1.0 : -1.0;
360 // bits 0..5 give the velocity. we interpret this as "ticks
361 // moved before this message was sent"
362 float ticks = (ev->value & 0x3f);
364 /* euphonix and perhaps other devices send zero
365 when they mean 1, we think.
369 float delta = sign * (ticks / (float) 0x3f);
371 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Jog wheel moved %1\n", ticks));
372 _jog_wheel->jog_event (delta);
378 // bit 6 gives the sign
379 float sign = (ev->value & 0x40) == 0 ? 1.0 : -1.0;
380 // bits 0..5 give the velocity. we interpret this as "ticks
381 // moved before this message was sent"
382 float ticks = (ev->value & 0x3f);
384 /* euphonix and perhaps other devices send zero
385 when they mean 1, we think.
389 float delta = sign * (ticks / (float) 0x3f);
391 Strip* strip = dynamic_cast<Strip*> (&pot->group());
394 strip->handle_pot (*pot, delta);
397 DEBUG_TRACE (DEBUG::MackieControl, "pot not found\n");
402 Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count)
404 MidiByteArray bytes (count, raw_bytes);
406 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handle_midi_sysex: %1\n", bytes));
408 /* always save the device type ID so that our outgoing sysex messages
413 mackie_sysex_hdr[3] = bytes[4];
415 mackie_sysex_hdr_xt[3] = bytes[4];
421 LCP: Connection Challenge
423 if (bytes[4] == 0x10 || bytes[4] == 0x11) {
424 write_sysex (host_connection_query (bytes));
428 std::cerr << "Surface " << _number << " Now active!\n";
430 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
433 update_view_mode_display ();
438 case 0x03: /* LCP Connection Confirmation */
439 if (bytes[4] == 0x10 || bytes[4] == 0x11) {
440 write_sysex (host_connection_confirmation (bytes));
445 case 0x04: /* LCP: Confirmation Denied */
449 error << "MCP: unknown sysex: " << bytes << endmsg;
454 calculate_challenge_response (MidiByteArray::iterator begin, MidiByteArray::iterator end)
457 back_insert_iterator<MidiByteArray> back (l);
458 copy (begin, end, back);
460 MidiByteArray retval;
462 // this is how to calculate the response to the challenge.
463 // from the Logic docs.
464 retval << (0x7f & (l[0] + (l[1] ^ 0xa) - l[3]));
465 retval << (0x7f & ( (l[2] >> l[3]) ^ (l[0] + l[3])));
466 retval << (0x7f & ((l[3] - (l[2] << 2)) ^ (l[0] | l[1])));
467 retval << (0x7f & (l[1] - l[2] + (0xf0 ^ (l[3] << 4))));
472 // not used right now
474 Surface::host_connection_query (MidiByteArray & bytes)
476 MidiByteArray response;
478 if (bytes[4] != 0x10 && bytes[4] != 0x11) {
479 /* not a Logic Control device - no response required */
483 // handle host connection query
484 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("host connection query: %1\n", bytes));
486 if (bytes.size() != 18) {
487 cerr << "expecting 18 bytes, read " << bytes << " from " << _port->input_port().name() << endl;
491 // build and send host connection reply
493 copy (bytes.begin() + 6, bytes.begin() + 6 + 7, back_inserter (response));
494 response << calculate_challenge_response (bytes.begin() + 6 + 7, bytes.begin() + 6 + 7 + 4);
498 // not used right now
500 Surface::host_connection_confirmation (const MidiByteArray & bytes)
502 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("host_connection_confirmation: %1\n", bytes));
504 // decode host connection confirmation
505 if (bytes.size() != 14) {
507 os << "expecting 14 bytes, read " << bytes << " from " << _port->input_port().name();
508 throw MackieControlException (os.str());
511 // send version request
512 return MidiByteArray (2, 0x13, 0x00);
516 Surface::handle_port_inactive (SurfacePort * port)
522 Surface::write_sysex (const MidiByteArray & mba)
529 buf << sysex_hdr() << mba << MIDI::eox;
534 Surface::write_sysex (MIDI::byte msg)
537 buf << sysex_hdr() << msg << MIDI::eox;
542 Surface::n_strips () const
544 return strips.size();
548 Surface::nth_strip (uint32_t n) const
550 if (n > n_strips()) {
559 // TODO turn off Timecode displays
561 std::cerr << "Surface " << number() << " ZERO\n";
564 for (Strips::iterator it = strips.begin(); it != strips.end(); ++it) {
572 Surface::zero_controls ()
574 if (_stype != mcu || !_mcp.device_info().has_global_controls()) {
578 // turn off global buttons and leds
579 // global buttons are only ever on mcu_port, so we don't have
580 // to figure out which port.
582 for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) {
583 Control & control = **it;
584 if (!control.group().is_strip()) {
585 _port->write (control.zero());
589 if (_number == 0 && _mcp.device_info().has_two_character_display()) {
590 // any hardware-specific stuff
591 // clear 2-char display
592 show_two_char_display ("aa");
595 // and the led ring for the master strip
600 Surface::periodic (uint64_t now_usecs)
602 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
603 (*s)->periodic (now_usecs);
608 Surface::write (const MidiByteArray& data)
616 Surface::map_routes (const vector<boost::shared_ptr<Route> >& routes)
618 vector<boost::shared_ptr<Route> >::const_iterator r;
621 for (r = routes.begin(), s = strips.begin(); r != routes.end() && s != strips.end(); ++r, ++s) {
622 (*s)->set_route (*r);
625 for (; s != strips.end(); ++s) {
626 (*s)->set_route (boost::shared_ptr<Route>());
633 translate_seven_segment (char achar)
635 achar = toupper (achar);
637 if (achar >= 0x40 && achar <= 0x60) {
639 } else if (achar >= 0x21 && achar <= 0x3f) {
647 Surface::show_two_char_display (const std::string & msg, const std::string & dots)
649 if (_stype != mcu || !_mcp.device_info().has_two_character_display() || msg.length() != 2 || dots.length() != 2) {
653 MidiByteArray right (3, 0xb0, 0x4b, 0x00);
654 MidiByteArray left (3, 0xb0, 0x4a, 0x00);
656 right[2] = translate_seven_segment (msg[0]) + (dots[0] == '.' ? 0x40 : 0x00);
657 left[2] = translate_seven_segment (msg[1]) + (dots[1] == '.' ? 0x40 : 0x00);
659 _port->write (right);
664 Surface::show_two_char_display (unsigned int value, const std::string & /*dots*/)
667 os << setfill('0') << setw(2) << value % 100;
668 show_two_char_display (os.str());
672 Surface::display_timecode (const std::string & timecode, const std::string & timecode_last)
674 if (_active && _mcp.device_info().has_timecode_display()) {
675 _port->write (timecode_display (timecode, timecode_last));
680 Surface::timecode_display (const std::string & timecode, const std::string & last_timecode)
682 // if there's no change, send nothing, not even sysex header
683 if (timecode == last_timecode) return MidiByteArray();
685 // length sanity checking
686 string local_timecode = timecode;
688 // truncate to 10 characters
689 if (local_timecode.length() > 10) {
690 local_timecode = local_timecode.substr (0, 10);
693 // pad to 10 characters
694 while (local_timecode.length() < 10) {
695 local_timecode += " ";
698 // find the suffix of local_timecode that differs from last_timecode
699 std::pair<string::const_iterator,string::iterator> pp = mismatch (last_timecode.begin(), last_timecode.end(), local_timecode.begin());
701 MidiByteArray retval;
704 retval << sysex_hdr();
706 // code for timecode display
709 // translate characters. These are sent in reverse order of display
710 // hence the reverse iterators
711 string::reverse_iterator rend = reverse_iterator<string::iterator> (pp.second);
712 for (string::reverse_iterator it = local_timecode.rbegin(); it != rend; ++it) {
713 retval << translate_seven_segment (*it);
723 Surface::update_flip_mode_display ()
725 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
726 (*s)->flip_mode_changed (true);
731 Surface::update_view_mode_display ()
740 switch (_mcp.view_mode()) {
741 case MackieControlProtocol::Mixer:
742 show_two_char_display ("Mx");
743 button = buttons[Button::Pan];
745 case MackieControlProtocol::Dynamics:
746 show_two_char_display ("Dy");
747 button = buttons[Button::Dyn];
749 case MackieControlProtocol::EQ:
750 show_two_char_display ("EQ");
751 button = buttons[Button::Eq];
753 case MackieControlProtocol::Loop:
754 show_two_char_display ("LP");
755 button = buttons[Button::Loop];
757 case MackieControlProtocol::AudioTracks:
758 show_two_char_display ("AT");
760 case MackieControlProtocol::MidiTracks:
761 show_two_char_display ("MT");
763 case MackieControlProtocol::Sends:
764 show_two_char_display ("Sn");
765 button = buttons[Button::Sends];
767 case MackieControlProtocol::Plugins:
768 show_two_char_display ("Pl");
769 button = buttons[Button::Plugin];
776 _port->write (button->set_state (on));
780 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
781 _port->write ((*s)->display (1, text));
787 Surface::gui_selection_changed (ARDOUR::RouteNotificationListPtr routes)
789 for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
790 (*s)->gui_selection_changed (routes);
795 Surface::say_hello ()
797 /* wakeup for Mackie Control */
798 MidiByteArray wakeup (7, MIDI::sysex, 0x00, 0x00, 0x66, 0x14, 0x00, MIDI::eox);
799 _port->write (wakeup);
800 wakeup[4] = 0x15; /* wakup Mackie XT */
801 _port->write (wakeup);
802 wakeup[4] = 0x10; /* wakupe Logic Control */
803 _port->write (wakeup);
804 wakeup[4] = 0x11; /* wakeup Logic Control XT */
805 _port->write (wakeup);
809 Surface::next_jog_mode ()
814 Surface::set_jog_mode (JogWheel::Mode m)