X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fsurfaces%2Fmackie%2Fsurface.cc;h=5ee2e81abd0a57c04a487a16ab2382b826468f87;hb=0c448c387bf4fc11c1bc2494055303ed12a15208;hp=c237cfcb25a1d5bb31c9aba84df8b4dd1a178363;hpb=0ee737f12901f37ac0933263aa778b6b1a9973c6;p=ardour.git diff --git a/libs/surfaces/mackie/surface.cc b/libs/surfaces/mackie/surface.cc index c237cfcb25..5ee2e81abd 100644 --- a/libs/surfaces/mackie/surface.cc +++ b/libs/surfaces/mackie/surface.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012 Paul Davis + Copyright (C) 2012 Paul Davis This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -23,8 +23,11 @@ #include #include +#include + #include "midi++/port.h" +#include "ardour/audioengine.h" #include "ardour/automation_control.h" #include "ardour/debug.h" #include "ardour/route.h" @@ -51,6 +54,10 @@ #include "i18n.h" +#ifdef PLATFORM_WINDOWS +#define random() rand() +#endif + using namespace std; using namespace PBD; using ARDOUR::Route; @@ -84,9 +91,10 @@ Surface::Surface (MackieControlProtocol& mcp, const std::string& device_name, ui , _jog_wheel (0) , _master_fader (0) , _last_master_gain_written (-0.0f) + , connection_state (0) { DEBUG_TRACE (DEBUG::MackieControl, "Surface::Surface init\n"); - + try { _port = new SurfacePort (*this); } catch (...) { @@ -110,12 +118,17 @@ Surface::Surface (MackieControlProtocol& mcp, const std::string& device_name, ui } uint32_t n = _mcp.device_info().strip_cnt(); - + if (n) { init_strips (n); DEBUG_TRACE (DEBUG::MackieControl, "init_strips done\n"); } - + + /* + */ + + ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&Surface::connection_handler, this, _1, _2, _3, _4, _5), &_mcp); + connect_to_signals (); DEBUG_TRACE (DEBUG::MackieControl, "Surface::Surface done\n"); @@ -131,18 +144,78 @@ Surface::~Surface () for (Groups::iterator it = groups.begin(); it != groups.end(); ++it) { delete it->second; } - + // delete controls for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) { delete *it; } - + + port_connection.disconnect (); + delete _jog_wheel; delete _port; DEBUG_TRACE (DEBUG::MackieControl, "Surface::~Surface done\n"); } +void +Surface::connection_handler (boost::weak_ptr, std::string name1, boost::weak_ptr, std::string name2, bool yn) +{ + if (!_port) { + return; + } + + string ni = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (_port->input_name()); + string no = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (_port->output_name()); + + if (ni == name1 || ni == name2) { + if (yn) { + connection_state |= InputConnected; + } else { + connection_state &= ~InputConnected; + } + } else if (no == name1 || no == name2) { + if (yn) { + connection_state |= OutputConnected; + } else { + connection_state &= ~OutputConnected; + } + } + + if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) { + + /* this will send a device query message, which should + result in a response that will kick off device type + discovery and activation of the surface(s). + + The intended order of events is: + + - each surface sends a device query message + - devices respond with either MCP or LCP response (sysex in both + cases) + - sysex message causes Surface::turn_it_on() which tells the + MCP object that the surface is ready, and sets up strip + displays and binds faders and buttons for that surface + + In the case of LCP, where this is a handshake process that could + fail, the response process to the initial sysex after a device query + will mark the surface inactive, which won't shut anything down + but will stop any writes to the device. + + Note: there are no known cases of the handshake process failing. + + We actually can't initiate this in this callback, so we have + to queue it with the MCP event loop. + */ + + connected (); + + } else { + DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 disconnected (input or output or both)\n", _name)); + _active = false; + } +} + XMLNode& Surface::get_state() { @@ -176,7 +249,7 @@ Surface::set_state (const XMLNode& node, int version) return 0; } -const MidiByteArray& +const MidiByteArray& Surface::sysex_hdr() const { switch (_stype) { @@ -197,11 +270,11 @@ static GlobalControlDefinition mackie_global_controls[] = { { "", 0, Led::factory, "" } }; -void +void Surface::init_controls() { Group* group; - + DEBUG_TRACE (DEBUG::MackieControl, "Surface::init_controls: creating groups\n"); groups["assignment"] = new Group ("assignment"); groups["automation"] = new Group ("automation"); @@ -216,7 +289,7 @@ Surface::init_controls() groups["transport"] = new Group ("transport"); groups["user"] = new Group ("user"); groups["utilities"] = new Group ("utilities"); - + DEBUG_TRACE (DEBUG::MackieControl, "Surface::init_controls: creating jog wheel\n"); if (_mcp.device_info().has_jog_wheel()) { _jog_wheel = new Mackie::JogWheel (_mcp); @@ -239,7 +312,7 @@ Surface::init_controls() } } -void +void Surface::init_strips (uint32_t n) { const map& strip_buttons (_mcp.device_info().strip_buttons()); @@ -247,11 +320,11 @@ Surface::init_strips (uint32_t n) for (uint32_t i = 0; i < n; ++i) { char name[32]; - + snprintf (name, sizeof (name), "strip_%d", (8* _number) + i); Strip* strip = new Strip (*this, name, i, strip_buttons); - + groups[name] = strip; strips.push_back (strip); } @@ -261,17 +334,17 @@ void Surface::setup_master () { boost::shared_ptr m; - + if ((m = _mcp.get_session().monitor_out()) == 0) { m = _mcp.get_session().master_out(); - } - + } + if (!m) { return; } _master_fader = dynamic_cast (Fader::factory (*this, _mcp.device_info().strip_cnt(), "master", *groups["master"])); - + _master_fader->set_control (m->gain_control()); m->gain_control()->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&Surface::master_gain_changed, this), ui_context()); @@ -314,7 +387,7 @@ Surface::master_gain_changed () _last_master_gain_written = normalized_position; } -float +float Surface::scaled_delta (float delta, float current_speed) { /* XXX needs work before use */ @@ -323,7 +396,7 @@ Surface::scaled_delta (float delta, float current_speed) return ((sign * std::pow (delta + 1.0, 2.0)) + current_speed) / 100.0; } -void +void Surface::display_bank_start (uint32_t current_bank) { if (current_bank == 0) { @@ -335,7 +408,7 @@ Surface::display_bank_start (uint32_t current_bank) } } -void +void Surface::blank_jog_ring () { Control* control = controls_by_device_independent_id[Jog::ID]; @@ -354,13 +427,13 @@ Surface::scrub_scaling_factor () const return 100.0; } -void +void Surface::connect_to_signals () { if (!_connected) { - DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 connecting to signals on port %2\n", + DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 connecting to signals on port %2\n", number(), _port->input_port().name())); MIDI::Parser* p = _port->input_port().parser(); @@ -380,7 +453,7 @@ Surface::connect_to_signals () } // Master fader p->channel_pitchbend[_mcp.device_info().strip_cnt()].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, _mcp.device_info().strip_cnt())); - + _connected = true; } } @@ -392,13 +465,13 @@ Surface::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb, uin * from the MIDI::Parser conveys the fader ID, which was given by the * channel ID in the status byte. * - * Instead, we have used bind() to supply the fader-within-strip ID + * Instead, we have used bind() to supply the fader-within-strip ID * when we connected to the per-channel pitchbend events. */ DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface::handle_midi_pitchbend_message on port %3, fader = %1 value = %2 (%4)\n", - fader_id, pb, _number, pb/16384.0)); - + fader_id, pb, _number, pb/16384.0)); + if (_mcp.device_info().no_handshake()) { turn_it_on (); } @@ -429,17 +502,21 @@ Surface::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb, uin } } -void +void Surface::handle_midi_note_on_message (MIDI::Parser &, MIDI::EventTwoBytes* ev) { DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface::handle_midi_note_on_message %1 = %2\n", (int) ev->note_number, (int) ev->velocity)); - + if (_mcp.device_info().no_handshake()) { turn_it_on (); } + if (_mcp.device_info().device_type() == DeviceInfo::HUI && ev->note_number == 0 && ev->velocity == 127) { + turn_it_on (); + } + /* fader touch sense is given by "buttons" 0xe..0xe7 and 0xe8 for the - * master. + * master. */ if (ev->note_number >= 0xE0 && ev->note_number <= 0xE8) { @@ -463,6 +540,11 @@ Surface::handle_midi_note_on_message (MIDI::Parser &, MIDI::EventTwoBytes* ev) Button* button = buttons[ev->note_number]; if (button) { + + if (ev->velocity > 64) { + button->pressed (); + } + Strip* strip = dynamic_cast (&button->group()); if (strip) { @@ -474,12 +556,19 @@ Surface::handle_midi_note_on_message (MIDI::Parser &, MIDI::EventTwoBytes* ev) DEBUG_TRACE (DEBUG::MackieControl, string_compose ("global button %1\n", button->id())); _mcp.handle_button_event (*this, *button, ev->velocity > 64 ? press : release); } + + if (ev->velocity <= 64) { + button->released (); + } + } else { DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button found for %1\n", (int) ev->note_number)); } + + /* button release should reset timer AFTER handler(s) have run */ } -void +void Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev) { DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_midi_controller %1 = %2\n", (int) ev->controller_number, (int) ev->value)); @@ -491,7 +580,7 @@ Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev Pot* pot = pots[ev->controller_number]; // bit 6 gives the sign - float sign = (ev->value & 0x40) == 0 ? 1.0 : -1.0; + float sign = (ev->value & 0x40) == 0 ? 1.0 : -1.0; // bits 0..5 give the velocity. we interpret this as "ticks // moved before this message was sent" float ticks = (ev->value & 0x3f); @@ -508,7 +597,7 @@ Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev } else { delta = sign * (ticks / (float) 0x3f); } - + if (!pot) { if (ev->controller_number == Jog::ID && _jog_wheel) { @@ -524,10 +613,10 @@ Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev Strip* strip = dynamic_cast (&pot->group()); if (strip) { strip->handle_pot (*pot, delta); - } + } } -void +void Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count) { MidiByteArray bytes (count, raw_bytes); @@ -539,7 +628,7 @@ Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count } /* always save the device type ID so that our outgoing sysex messages - * are correct + * are correct */ if (_stype == mcu) { @@ -550,8 +639,8 @@ Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count switch (bytes[5]) { case 0x01: - /* MCP: Device Ready - LCP: Connection Challenge + /* MCP: Device Ready + LCP: Connection Challenge */ if (bytes[4] == 0x10 || bytes[4] == 0x11) { DEBUG_TRACE (DEBUG::MackieControl, "Logic Control Device connection challenge\n"); @@ -581,31 +670,30 @@ Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count } } -static MidiByteArray +static MidiByteArray calculate_challenge_response (MidiByteArray::iterator begin, MidiByteArray::iterator end) { MidiByteArray l; back_insert_iterator back (l); copy (begin, end, back); - + MidiByteArray retval; - + // this is how to calculate the response to the challenge. // from the Logic docs. retval << (0x7f & (l[0] + (l[1] ^ 0xa) - l[3])); retval << (0x7f & ( (l[2] >> l[3]) ^ (l[0] + l[3]))); retval << (0x7f & ((l[3] - (l[2] << 2)) ^ (l[0] | l[1]))); retval << (0x7f & (l[1] - l[2] + (0xf0 ^ (l[3] << 4)))); - + return retval; } -// not used right now -MidiByteArray +MidiByteArray Surface::host_connection_query (MidiByteArray & bytes) { MidiByteArray response; - + if (bytes[4] != 0x10 && bytes[4] != 0x11) { /* not a Logic Control device - no response required */ return response; @@ -613,7 +701,7 @@ Surface::host_connection_query (MidiByteArray & bytes) // handle host connection query DEBUG_TRACE (DEBUG::MackieControl, string_compose ("host connection query: %1\n", bytes)); - + if (bytes.size() != 18) { cerr << "expecting 18 bytes, read " << bytes << " from " << _port->input_port().name() << endl; return response; @@ -626,19 +714,18 @@ Surface::host_connection_query (MidiByteArray & bytes) return response; } -// not used right now -MidiByteArray +MidiByteArray Surface::host_connection_confirmation (const MidiByteArray & bytes) { DEBUG_TRACE (DEBUG::MackieControl, string_compose ("host_connection_confirmation: %1\n", bytes)); - + // decode host connection confirmation if (bytes.size() != 14) { ostringstream os; os << "expecting 14 bytes, read " << bytes << " from " << _port->input_port().name(); throw MackieControlException (os.str()); } - + // send version request return MidiByteArray (2, 0x13, 0x00); } @@ -665,7 +752,7 @@ Surface::turn_it_on () } } -void +void Surface::write_sysex (const MidiByteArray & mba) { if (mba.empty()) { @@ -677,7 +764,7 @@ Surface::write_sysex (const MidiByteArray & mba) _port->write (buf); } -void +void Surface::write_sysex (MIDI::byte msg) { MidiByteArray buf; @@ -690,7 +777,7 @@ Surface::n_strips (bool with_locked_strips) const { if (with_locked_strips) { return strips.size(); - } + } uint32_t n = 0; @@ -717,7 +804,7 @@ Surface::zero_all () if (_mcp.device_info().has_timecode_display ()) { display_timecode (string (10, '0'), string (10, ' ')); } - + if (_mcp.device_info().has_two_character_display()) { show_two_char_display (string (2, '0'), string (2, ' ')); } @@ -766,15 +853,15 @@ Surface::periodic (uint64_t now_usecs) } void -Surface::redisplay () +Surface::redisplay (ARDOUR::microseconds_t now) { for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) { - (*s)->redisplay (); + (*s)->redisplay (now); } } void -Surface::write (const MidiByteArray& data) +Surface::write (const MidiByteArray& data) { if (_active) { _port->write (data); @@ -811,7 +898,7 @@ Surface::map_routes (const vector >& routes) } -static char +static char translate_seven_segment (char achar) { achar = toupper (achar); @@ -831,13 +918,13 @@ Surface::show_two_char_display (const std::string & msg, const std::string & dot if (_stype != mcu || !_mcp.device_info().has_two_character_display() || msg.length() != 2 || dots.length() != 2) { return; } - + MidiByteArray right (3, 0xb0, 0x4b, 0x00); MidiByteArray left (3, 0xb0, 0x4a, 0x00); - + right[2] = translate_seven_segment (msg[0]) + (dots[0] == '.' ? 0x40 : 0x00); left[2] = translate_seven_segment (msg[1]) + (dots[1] == '.' ? 0x40 : 0x00); - + _port->write (right); _port->write (left); } @@ -858,7 +945,7 @@ Surface::display_timecode (const std::string & timecode, const std::string & las } // if there's no change, send nothing, not even sysex header if (timecode == last_timecode) return; - + // length sanity checking string local_timecode = timecode; @@ -868,10 +955,10 @@ Surface::display_timecode (const std::string & timecode, const std::string & las } // pad to 10 characters - while (local_timecode.length() < 10) { + while (local_timecode.length() < 10) { local_timecode += " "; } - + // translate characters. // Only the characters that actually changed are sent. int position = 0x3f; @@ -895,6 +982,14 @@ Surface::update_flip_mode_display () } } + void +Surface::update_potmode () +{ + for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) { + (*s)->potmode_changed (false); + } +} + void Surface::update_view_mode_display () { @@ -908,15 +1003,7 @@ Surface::update_view_mode_display () switch (_mcp.view_mode()) { case MackieControlProtocol::Mixer: show_two_char_display ("Mx"); - id = Button::Pan; - break; - case MackieControlProtocol::Dynamics: - show_two_char_display ("Dy"); - id = Button::Dyn; - break; - case MackieControlProtocol::EQ: - show_two_char_display ("EQ"); - id = Button::Eq; + //id = Button::Pan; break; case MackieControlProtocol::Loop: show_two_char_display ("LP"); @@ -928,20 +1015,12 @@ Surface::update_view_mode_display () case MackieControlProtocol::MidiTracks: show_two_char_display ("MT"); break; - case MackieControlProtocol::Sends: - show_two_char_display ("Sn"); - id = Button::Send; - break; - case MackieControlProtocol::Plugins: - show_two_char_display ("Pl"); - id = Button::Plugin; - break; default: break; } if (id >= 0) { - + /* we are attempting to turn a global button/LED on */ map::iterator x = controls_by_device_independent_id.find (id); @@ -991,7 +1070,7 @@ Surface::next_jog_mode () void Surface::set_jog_mode (JogWheel::Mode) { -} +} bool Surface::route_is_locked_to_strip (boost::shared_ptr r) const @@ -1004,7 +1083,7 @@ Surface::route_is_locked_to_strip (boost::shared_ptr r) const return false; } -void +void Surface::notify_metering_state_changed() { for (Strips::const_iterator s = strips.begin(); s != strips.end(); ++s) { @@ -1017,13 +1096,11 @@ Surface::reset () { if (_port) { /* reset msg for Mackie Control */ - MidiByteArray msg (8, MIDI::sysex, 0x00, 0x00, 0x66, 0x14, 0x08, 0x00, MIDI::eox); - _port->write (msg); - msg[4] = 0x15; /* reset Mackie XT */ - _port->write (msg); - msg[4] = 0x10; /* reset Logic Control */ - _port->write (msg); - msg[4] = 0x11; /* reset Logic Control XT */ + MidiByteArray msg; + msg << sysex_hdr(); + msg << 0x08; + msg << 0x00; + msg << MIDI::eox; _port->write (msg); } } @@ -1033,13 +1110,11 @@ Surface::toggle_backlight () { if (_port) { int onoff = random() %2; - MidiByteArray msg (8, MIDI::sysex, 0x00, 0x00, 0x66, 0x14, 0x0a, onoff, MIDI::eox); - _port->write (msg); - msg[4] = 0x15; /* reset Mackie XT */ - _port->write (msg); - msg[4] = 0x10; /* reset Logic Control */ - _port->write (msg); - msg[4] = 0x11; /* reset Logic Control XT */ + MidiByteArray msg; + msg << sysex_hdr (); + msg << 0xa; + msg << (onoff ? 0x1 : 0x0); + msg << MIDI::eox; _port->write (msg); } } @@ -1048,38 +1123,129 @@ void Surface::recalibrate_faders () { if (_port) { - MidiByteArray msg (8, MIDI::sysex, 0x00, 0x00, 0x66, 0x14, 0x09, 0x00, MIDI::eox); - _port->write (msg); - msg[4] = 0x15; /* reset Mackie XT */ - _port->write (msg); - msg[4] = 0x10; /* reset Logic Control */ - _port->write (msg); - msg[4] = 0x11; /* reset Logic Control XT */ + MidiByteArray msg; + msg << sysex_hdr (); + msg << 0x09; + msg << 0x00; + msg << MIDI::eox; _port->write (msg); } -} +} void Surface::set_touch_sensitivity (int sensitivity) { /* NOTE: assumed called from GUI code, hence sleep() */ - + /* sensitivity already clamped by caller */ if (_port) { - MidiByteArray msg (9, MIDI::sysex, 0x00, 0x00, 0x66, 0x14, 0x0e, 0xff, sensitivity, MIDI::eox); + MidiByteArray msg; + + msg << sysex_hdr (); + msg << 0x0e; + msg << 0xff; /* overwritten for each fader below */ + msg << (sensitivity & 0x7f); + msg << MIDI::eox; for (int fader = 0; fader < 9; ++fader) { msg[6] = fader; - - _port->write (msg); - msg[4] = 0x15; /* reset Mackie XT */ - _port->write (msg); - msg[4] = 0x10; /* reset Logic Control */ _port->write (msg); - msg[4] = 0x11; /* reset Logic Control XT */ + } + } +} + +void +Surface::hui_heartbeat () +{ + if (!_port) { + return; + } + + MidiByteArray msg (3, MIDI::on, 0x0, 0x0); + _port->write (msg); +} + +void +Surface::connected () +{ + DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 now connected, trying to ping device...\n", _name)); + + say_hello (); + + if (_mcp.device_info().no_handshake()) { + turn_it_on (); + } +} + +MidiByteArray +Surface::display_line (string const& msg, int line_num) +{ + MidiByteArray midi_msg; + midi_msg << sysex_hdr (); + midi_msg << 0x12; + midi_msg << (line_num ? 0x38 : 0x0); /* offsets into char array + * on device that + * correspond to line + * starts + */ + if (msg.empty()) { + + midi_msg.insert (midi_msg.end(), 55, ' '); + + } else { + + /* ascii data to display. @param msg is UTF-8 which is not legal. */ + string ascii = Glib::convert_with_fallback (msg, "UTF-8", "ISO-8859-1", "_"); + string::size_type len = ascii.length(); + + if (len > 55) { + midi_msg << ascii.substr (0, 55); + } else { + midi_msg << ascii; - g_usleep (1000); /* milliseconds */ + for (string::size_type i = len; i < 55; ++i) { + midi_msg << ' '; + } } } + + midi_msg << MIDI::eox; + + return midi_msg; +} + +/** display @param msg on the 55x2 screen for @param msecs milliseconds + * + * @param msg is assumed to be UTF-8 encoded, and will be converted + * to ASCII with an underscore as fallback character before being + * sent to the device. + */ +void +Surface::display_message_for (string const& msg, uint64_t msecs) +{ + string::size_type newline; + + if ((newline = msg.find ('\n')) == string::npos) { + + _port->write (display_line (msg, 0)); + _port->write (display_line (string(), 1)); + + } else if (newline == 0) { + + _port->write (display_line (string(), 0)); + _port->write (display_line (msg.substr (1), 1)); + + } else { + + string first_line = msg.substr (0, newline-1); + string second_line = msg.substr (newline+1); + + _port->write (display_line (first_line, 0)); + _port->write (display_line (second_line.substr (0, second_line.find_first_of ('\n')), 1)); + } + + for (Strips::const_iterator s = strips.begin(); s != strips.end(); ++s) { + (*s)->block_screen_display_for (msecs); + } }