X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fsurfaces%2Fmackie%2Fsurface.cc;h=694c73b1bcb638f49bb3772bceeb6a55159f33cb;hb=316973d7c7bc99bfef6367d42009883d0de2abbd;hp=7322050d6a61716241b9efac74db24edc712508b;hpb=79799023f5df9bec8c48dc1292a1bc2d996a28ab;p=ardour.git diff --git a/libs/surfaces/mackie/surface.cc b/libs/surfaces/mackie/surface.cc index 7322050d6a..694c73b1bc 100644 --- a/libs/surfaces/mackie/surface.cc +++ b/libs/surfaces/mackie/surface.cc @@ -1,37 +1,130 @@ +/* + 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 + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +*/ + #include #include #include #include +#include -#include "ardour/debug.h" +#include "midi++/port.h" -#include "mackie_button_handler.h" +#include "ardour/automation_control.h" +#include "ardour/debug.h" +#include "ardour/route.h" +#include "ardour/panner.h" +#include "ardour/panner_shell.h" +#include "ardour/rc_configuration.h" +#include "ardour/session.h" +#include "ardour/utils.h" + +#include "control_group.h" #include "surface_port.h" #include "surface.h" +#include "strip.h" +#include "mackie_control_protocol.h" +#include "jog_wheel.h" + +#include "strip.h" +#include "button.h" +#include "led.h" +#include "pot.h" +#include "fader.h" +#include "jog.h" +#include "meter.h" + +#include "i18n.h" using namespace std; using namespace PBD; using namespace Mackie; - -Surface::Surface (uint32_t max_strips, uint32_t unit_strips) - : _max_strips (max_strips) - , _unit_strips( unit_strips ) +using ARDOUR::Route; +using ARDOUR::Panner; +using ARDOUR::Pannable; +using ARDOUR::AutomationControl; + +#define ui_context() MackieControlProtocol::instance() /* a UICallback-derived object that specifies the event loop for signal handling */ + +// The MCU sysex header.4th byte Will be overwritten +// when we get an incoming sysex that identifies +// the device type +static MidiByteArray mackie_sysex_hdr (5, MIDI::sysex, 0x0, 0x0, 0x66, 0x14); + +// The MCU extender sysex header.4th byte Will be overwritten +// when we get an incoming sysex that identifies +// the device type +static MidiByteArray mackie_sysex_hdr_xt (5, MIDI::sysex, 0x0, 0x0, 0x66, 0x15); + +static MidiByteArray empty_midi_byte_array; + +Surface::Surface (MackieControlProtocol& mcp, const std::string& device_name, uint32_t number, surface_type_t stype) + : _mcp (mcp) + , _stype (stype) + , _number (number) + , _name (device_name) + , _active (false) + , _connected (false) + , _jog_wheel (0) + , _master_fader (0) + , _last_master_gain_written (-0.0f) { -} + DEBUG_TRACE (DEBUG::MackieControl, "Surface::Surface init\n"); + + try { + _port = new SurfacePort (*this); + } catch (...) { + throw failed_constructor (); + } -void Surface::init () -{ - DEBUG_TRACE (DEBUG::MackieControl, "Surface::init\n"); + /* only the first Surface object has global controls */ + + if (_number == 0) { + DEBUG_TRACE (DEBUG::MackieControl, "Surface is first. Might have global controls.\n"); + if (_mcp.device_info().has_global_controls()) { + init_controls (); + DEBUG_TRACE (DEBUG::MackieControl, "init_controls done\n"); + } + + if (_mcp.device_info().has_master_fader()) { + setup_master (); + DEBUG_TRACE (DEBUG::MackieControl, "setup_master done\n"); + } + } - strips.resize (_max_strips); - init_controls (); - init_strips (); + uint32_t n = _mcp.device_info().strip_cnt(); + + if (n) { + init_strips (n); + DEBUG_TRACE (DEBUG::MackieControl, "init_strips done\n"); + } + + connect_to_signals (); - DEBUG_TRACE (DEBUG::MackieControl, "Surface::init finish\n"); + DEBUG_TRACE (DEBUG::MackieControl, "Surface::Surface done\n"); } Surface::~Surface () { + DEBUG_TRACE (DEBUG::MackieControl, "Surface::~Surface init\n"); + + zero_all (); + // delete groups for (Groups::iterator it = groups.begin(); it != groups.end(); ++it) { delete it->second; @@ -41,663 +134,828 @@ Surface::~Surface () for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) { delete *it; } + + delete _jog_wheel; + delete _port; + + DEBUG_TRACE (DEBUG::MackieControl, "Surface::~Surface done\n"); +} + +XMLNode& +Surface::get_state() +{ + char buf[64]; + snprintf (buf, sizeof (buf), X_("surface-%u"), _number); + XMLNode* node = new XMLNode (buf); + + node->add_child_nocopy (_port->get_state()); + + return *node; +} + +int +Surface::set_state (const XMLNode& node, int version) +{ + char buf[64]; + snprintf (buf, sizeof (buf), X_("surface-%u"), _number); + XMLNode* mynode = node.child (buf); + + if (!mynode) { + return 0; + } + + XMLNode* portnode = mynode->child (X_("Port")); + if (portnode) { + if (_port->set_state (*portnode, version)) { + return -1; + } + } + + return 0; +} + +const MidiByteArray& +Surface::sysex_hdr() const +{ + switch (_stype) { + case mcu: return mackie_sysex_hdr; + case ext: return mackie_sysex_hdr_xt; + } + cout << "SurfacePort::sysex_hdr _port_type not known" << endl; + return mackie_sysex_hdr; } static GlobalControlDefinition mackie_global_controls[] = { - { "jog", 0x3c, Jog::factory, "none" }, - { "external", 0x2e, Pot::factory, "none" }, - { "io", 0x28, Button::factory, "assignment" }, - { "sends", 0x29, Button::factory, "assignment" }, - { "pan", 0x2a, Button::factory, "assignment" }, - { "plugin", 0x2b, Button::factory, "assignment" }, - { "eq", 0x2c, Button::factory, "assignment" }, - { "dyn", 0x2d, Button::factory, "assignment" }, - { "left", 0x2e, Button::factory, "bank" }, - { "right", 0x2f, Button::factory, "bank" }, - { "channel_left", 0x30, Button::factory, "bank" }, - { "channel_right", 0x31, Button::factory, "bank" }, - { "flip", 0x32, Button::factory, "none" }, - { "edit", 0x33, Button::factory, "none" }, - { "name_value", 0x34, Button::factory, "display" }, - { "timecode_beats", 0x35, Button::factory, "display" }, - { "F1", 0x36, Button::factory, "none" }, - { "F2", 0x37, Button::factory, "none" }, - { "F3", 0x38, Button::factory, "none" }, - { "F4", 0x39, Button::factory, "none" }, - { "F5", 0x3a, Button::factory, "none" }, - { "F6", 0x3b, Button::factory, "none" }, - { "F7", 0x3c, Button::factory, "none" }, - { "F8", 0x3d, Button::factory, "none" }, - { "F9", 0x3e, Button::factory, "none" }, - { "F10", 0x3f, Button::factory, "none" }, - { "F11", 0x40, Button::factory, "none" }, - { "F12", 0x41, Button::factory, "none" }, - { "F13", 0x42, Button::factory, "none" }, - { "F14", 0x43, Button::factory, "none" }, - { "F15", 0x44, Button::factory, "none" }, - { "F16", 0x45, Button::factory, "none" }, - { "shift", 0x46, Button::factory, "modifiers" }, - { "option", 0x47, Button::factory, "modifiers" }, - { "control", 0x48, Button::factory, "modifiers" }, - { "cmd_alt", 0x49, Button::factory, "modifiers" }, - { "on", 0x4a, Button::factory, "automation" }, - { "rec_ready", 0x4b, Button::factory, "automation" }, - { "undo", 0x4c, Button::factory, "functions" }, - { "snapshot", 0x4d, Button::factory, "automation" }, - { "touch", 0x4e, Button::factory, "automation" }, - { "redo", 0x4f, Button::factory, "functions" }, - { "marker", 0x50, Button::factory, "functions" }, - { "enter", 0x51, Button::factory, "functions" }, - { "cancel", 0x52, Button::factory, "functions" }, - { "mixer", 0x53, Button::factory, "functions" }, - { "frm_left", 0x54, Button::factory, "transport" }, - { "frm_right", 0x55, Button::factory, "transport" }, - { "loop", 0x56, Button::factory, "transport" }, - { "punch_in", 0x57, Button::factory, "transport" }, - { "punch_out", 0x58, Button::factory, "transport" }, - { "home", 0x59, Button::factory, "transport" }, - { "end", 0x5a, Button::factory, "transport" }, - { "rewind", 0x5b, Button::factory, "transport" }, - { "ffwd", 0x5c, Button::factory, "transport" }, - { "stop", 0x5d, Button::factory, "transport" }, - { "play", 0x5e, Button::factory, "transport" }, - { "record", 0x5f, Button::factory, "transport" }, - { "cursor_up", 0x60, Button::factory, "cursor" }, - { "cursor_down", 0x61, Button::factory, "cursor" }, - { "cursor_left", 0x62, Button::factory, "cursor" }, - { "cursor_right", 0x63, Button::factory, "cursor" }, - { "zoom", 0x64, Button::factory, "none" }, - { "scrub", 0x65, Button::factory, "none" }, - { "user_a", 0x66, Button::factory, "user" }, - { "user_b", 0x67, Button::factory, "user" }, - { "fader_touch", 0x70, Led::factory, "master" }, - { "timecode", 0x71, Led::factory, "none" }, - { "beats", 0x72, Led::factory, "none" }, - { "solo", 0x73, Led::factory, "none" }, - { "relay_click", 0x73, Led::factory, "none" }, - { "", 0, Button::factory, "" } + { "external", Pot::External, Pot::factory, "none" }, + { "fader_touch", Led::FaderTouch, Led::factory, "master" }, + { "timecode", Led::Timecode, Led::factory, "none" }, + { "beats", Led::Beats, Led::factory, "none" }, + { "solo", Led::RudeSolo, Led::factory, "none" }, + { "relay_click", Led::RelayClick, Led::factory, "none" }, + { "", 0, Led::factory, "" } }; - + 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"); groups["bank"] = new Group ("bank"); groups["cursor"] = new Group ("cursor"); groups["display"] = new Group ("display"); - groups["functions"] = new Group ("functions"); + groups["function select"] = new Group ("function select"); + groups["global view"] = new Group ("global view"); + groups["master"] = new Group ("master"); groups["modifiers"] = new Group ("modifiers"); groups["none"] = new Group ("none"); 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); + } - group = new MasterStrip ("master", 0); - groups["master"] = group; - strips[0] = dynamic_cast (group); - + DEBUG_TRACE (DEBUG::MackieControl, "Surface::init_controls: creating global controls\n"); for (uint32_t n = 0; mackie_global_controls[n].name[0]; ++n) { group = groups[mackie_global_controls[n].group_name]; - Control* control = mackie_global_controls[n].factory (*this, mackie_global_controls[n].id, 1, mackie_global_controls[n].name, *group); - controls_by_name[mackie_global_controls[n].name] = control; - group->add (*control); - } -} - -static StripControlDefinition mackie_strip_controls[] = { - { "gain", Control::fader_base_id, Fader::factory, }, - { "vpot", Control::pot_base_id, Pot::factory, }, - { "recenable", Control::recenable_button_base_id, Button::factory, }, - { "solo", Control::solo_button_base_id, Button::factory, }, - { "mute", Control::mute_button_base_id, Button::factory, }, - { "select", Control::select_button_base_id, Button::factory, }, - { "vselect", Control::vselect_button_base_id, Button::factory, }, - { "fader_touch", Control::fader_touch_button_base_id, Button::factory, }, - { "", 0, Button::factory, } -}; + Control* control = mackie_global_controls[n].factory (*this, mackie_global_controls[n].id, mackie_global_controls[n].name, *group); + controls_by_device_independent_id[mackie_global_controls[n].id] = control; + } + + /* add global buttons */ + DEBUG_TRACE (DEBUG::MackieControl, "Surface::init_controls: adding global buttons\n"); + const map& global_buttons (_mcp.device_info().global_buttons()); + + for (map::const_iterator b = global_buttons.begin(); b != global_buttons.end(); ++b){ + group = groups[b->second.group]; + controls_by_device_independent_id[b->first] = Button::factory (*this, b->first, b->second.id, b->second.label, *group); + } +} void -Surface::init_strips () +Surface::init_strips (uint32_t n) { - for (uint32_t i = 0; i < _max_strips; ++i) { + const map& strip_buttons (_mcp.device_info().strip_buttons()); + + for (uint32_t i = 0; i < n; ++i) { char name[32]; - uint32_t unit_index = i % _unit_strips; - - snprintf (name, sizeof (name), "strip_%d", unit_index+1); - - Strip* strip = new Strip (*this, name, i, unit_index, mackie_strip_controls); + snprintf (name, sizeof (name), "strip_%d", (8* _number) + i); + + Strip* strip = new Strip (*this, name, i, strip_buttons); groups[name] = strip; - strips[i] = strip; + strips.push_back (strip); } } -void -Surface::handle_button (MackieButtonHandler & mbh, ButtonState bs, Button & button) +void +Surface::setup_master () { - if (bs != press && bs != release) { - mbh.update_led (button, none); + 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"])); - LedState ls; - switch (button.id()) { - case 0x9028: // io - switch (bs) { - case press: ls = mbh.io_press (button); break; - case release: ls = mbh.io_release (button); break; - case neither: break; - } - break; - - case 0x9029: // sends - switch (bs) { - case press: ls = mbh.sends_press (button); break; - case release: ls = mbh.sends_release (button); break; - case neither: break; - } - break; - - case 0x902a: // pan - switch (bs) { - case press: ls = mbh.pan_press (button); break; - case release: ls = mbh.pan_release (button); break; - case neither: break; - } - break; - - case 0x902b: // plugin - switch (bs) { - case press: ls = mbh.plugin_press (button); break; - case release: ls = mbh.plugin_release (button); break; - case neither: break; - } - break; - - case 0x902c: // eq - switch (bs) { - case press: ls = mbh.eq_press (button); break; - case release: ls = mbh.eq_release (button); break; - case neither: break; - } - break; - - case 0x902d: // dyn - switch (bs) { - case press: ls = mbh.dyn_press (button); break; - case release: ls = mbh.dyn_release (button); break; - case neither: break; - } - break; - - case 0x902e: // left - switch (bs) { - case press: ls = mbh.left_press (button); break; - case release: ls = mbh.left_release (button); break; - case neither: break; - } - break; - - case 0x902f: // right - switch (bs) { - case press: ls = mbh.right_press (button); break; - case release: ls = mbh.right_release (button); break; - case neither: break; - } - break; - - case 0x9030: // channel_left - switch (bs) { - case press: ls = mbh.channel_left_press (button); break; - case release: ls = mbh.channel_left_release (button); break; - case neither: break; + _master_fader->set_control (m->gain_control()); + m->gain_control()->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&Surface::master_gain_changed, this), ui_context()); + + Groups::iterator group_it; + group_it = groups.find("master"); + + DeviceInfo device_info = _mcp.device_info(); + GlobalButtonInfo master_button = device_info.get_global_button(Button::MasterFaderTouch); + Button* bb = dynamic_cast (Button::factory ( + *this, + Button::MasterFaderTouch, + master_button.id, + master_button.label, + *(group_it->second) +)); + DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 Master Fader new button BID %2 id %3\n", + number(), Button::MasterFaderTouch, bb->id())); +} + +void +Surface::master_gain_changed () +{ + if (!_master_fader) { + return; + } + + boost::shared_ptr ac = _master_fader->control(); + if (!ac) { + return; + } + + float normalized_position = ac->internal_to_interface (ac->get_value()); + if (normalized_position == _last_master_gain_written) { + return; + } + + DEBUG_TRACE (DEBUG::MackieControl, "Surface::master_gain_changed: updating surface master fader\n"); + + _port->write (_master_fader->set_position (normalized_position)); + _last_master_gain_written = normalized_position; +} + +float +Surface::scaled_delta (float delta, float current_speed) +{ + /* XXX needs work before use */ + const float sign = delta < 0.0 ? -1.0 : 1.0; + + return ((sign * std::pow (delta + 1.0, 2.0)) + current_speed) / 100.0; +} + +void +Surface::display_bank_start (uint32_t current_bank) +{ + if (current_bank == 0) { + // send Ar. to 2-char display on the master + show_two_char_display ("Ar", ".."); + } else { + // write the current first remote_id to the 2-char display + show_two_char_display (current_bank); + } +} + +void +Surface::blank_jog_ring () +{ + Control* control = controls_by_device_independent_id[Jog::ID]; + + if (control) { + Pot* pot = dynamic_cast (control); + if (pot) { + _port->write (pot->set (0.0, false, Pot::spread)); } - break; - - case 0x9031: // channel_right - switch (bs) { - case press: ls = mbh.channel_right_press (button); break; - case release: ls = mbh.channel_right_release (button); break; - case neither: break; + } +} + +float +Surface::scrub_scaling_factor () const +{ + return 100.0; +} + +void +Surface::connect_to_signals () +{ + if (!_connected) { + + + 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(); + + /* Incoming sysex */ + p->sysex.connect_same_thread (*this, boost::bind (&Surface::handle_midi_sysex, this, _1, _2, _3)); + /* V-Pot messages are Controller */ + p->controller.connect_same_thread (*this, boost::bind (&Surface::handle_midi_controller_message, this, _1, _2)); + /* Button messages are NoteOn */ + p->note_on.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2)); + /* Button messages are NoteOn. libmidi++ sends note-on w/velocity = 0 as note-off so catch them too */ + p->note_off.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2)); + /* Fader messages are Pitchbend */ + uint32_t i; + for (i = 0; i < _mcp.device_info().strip_cnt(); i++) { + p->channel_pitchbend[i].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, i)); } - break; + // 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())); - case 0x9032: // flip - switch (bs) { - case press: ls = mbh.flip_press (button); break; - case release: ls = mbh.flip_release (button); break; - case neither: break; - } - break; + _connected = true; + } +} - case 0x9033: // edit - switch (bs) { - case press: ls = mbh.edit_press (button); break; - case release: ls = mbh.edit_release (button); break; - case neither: break; - } - break; +void +Surface::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb, uint32_t fader_id) +{ + /* Pitchbend messages are fader messages. Nothing in the data we get + * 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 + * when we connected to the per-channel pitchbend events. + */ - case 0x9034: // name_value - switch (bs) { - case press: ls = mbh.name_value_press (button); break; - case release: ls = mbh.name_value_release (button); break; - case neither: break; - } - break; - case 0x9035: // timecode_beats - switch (bs) { - case press: ls = mbh.timecode_beats_press (button); break; - case release: ls = mbh.timecode_beats_release (button); break; - case neither: break; - } - break; + DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface::handle_midi_pitchbend_message on port %3, fader = %1 value = %2\n", + fader_id, pb, _number)); + + if (_mcp.device_info().no_handshake()) { + turn_it_on (); + } - case 0x9036: // F1 - switch (bs) { - case press: ls = mbh.F1_press (button); break; - case release: ls = mbh.F1_release (button); break; - case neither: break; - } - break; + Fader* fader = faders[fader_id]; + + if (fader) { + Strip* strip = dynamic_cast (&fader->group()); + float pos = (pb >> 4)/1023.0; // only the top 10 bytes are used + if (strip) { + strip->handle_fader (*fader, pos); + } else { + DEBUG_TRACE (DEBUG::MackieControl, "Handling master fader\n"); + /* master fader */ + fader->set_value (pos); // alter master gain + _port->write (fader->set_position (pos)); // write back value (required for servo) + } + } else { + DEBUG_TRACE (DEBUG::MackieControl, "fader not found\n"); + } +} - case 0x9037: // F2 - switch (bs) { - case press: ls = mbh.F2_press (button); break; - case release: ls = mbh.F2_release (button); break; - case neither: break; - } - break; +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 (); + } - case 0x9038: // F3 - switch (bs) { - case press: ls = mbh.F3_press (button); break; - case release: ls = mbh.F3_release (button); break; - case neither: break; - } - break; + Button* button = buttons[ev->note_number]; - case 0x9039: // F4 - switch (bs) { - case press: ls = mbh.F4_press (button); break; - case release: ls = mbh.F4_release (button); break; - case neither: break; - } - break; + if (button) { + Strip* strip = dynamic_cast (&button->group()); - case 0x903a: // F5 - switch (bs) { - case press: ls = mbh.F5_press (button); break; - case release: ls = mbh.F5_release (button); break; - case neither: break; + if (strip) { + DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip %1 button %2 pressed ? %3\n", + strip->index(), button->name(), (ev->velocity > 64))); + strip->handle_button (*button, ev->velocity > 64 ? press : release); + } else { + /* global button */ + DEBUG_TRACE (DEBUG::MackieControl, string_compose ("global button %1\n", button->id())); + _mcp.handle_button_event (*this, *button, ev->velocity > 64 ? press : release); } - break; + } else { + DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button found for %1\n", (int) ev->note_number)); + } +} - case 0x903b: // F6 - switch (bs) { - case press: ls = mbh.F6_press (button); break; - case release: ls = mbh.F6_release (button); break; - case neither: break; - } - break; +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)); - case 0x903c: // F7 - switch (bs) { - case press: ls = mbh.F7_press (button); break; - case release: ls = mbh.F7_release (button); break; - case neither: break; - } - break; + if (_mcp.device_info().no_handshake()) { + turn_it_on (); + } - case 0x903d: // F8 - switch (bs) { - case press: ls = mbh.F8_press (button); break; - case release: ls = mbh.F8_release (button); break; - case neither: break; - } - break; + Pot* pot = pots[ev->controller_number]; + + // bit 6 gives the sign + 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); + if (ticks == 0) { + /* euphonix and perhaps other devices send zero + when they mean 1, we think. + */ + ticks = 1; + } + float delta = sign * (ticks / (float) 0x3f); + + if (!pot) { + if (ev->controller_number == Jog::ID && _jog_wheel) { - case 0x903e: // F9 - switch (bs) { - case press: ls = mbh.F9_press (button); break; - case release: ls = mbh.F9_release (button); break; - case neither: break; + DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Jog wheel moved %1\n", ticks)); + _jog_wheel->jog_event (delta); + return; } - break; - case 0x903f: // F10 - switch (bs) { - case press: ls = mbh.F10_press (button); break; - case release: ls = mbh.F10_release (button); break; - case neither: break; - } - break; + return; + } - case 0x9040: // F11 - switch (bs) { - case press: ls = mbh.F11_press (button); break; - case release: ls = mbh.F11_release (button); break; - case neither: break; - } - break; + Strip* strip = dynamic_cast (&pot->group()); + if (strip) { + strip->handle_pot (*pot, delta); + } +} - case 0x9041: // F12 - switch (bs) { - case press: ls = mbh.F12_press (button); break; - case release: ls = mbh.F12_release (button); break; - case neither: break; - } - break; +void +Surface::handle_midi_sysex (MIDI::Parser &, MIDI::byte * raw_bytes, size_t count) +{ + MidiByteArray bytes (count, raw_bytes); - case 0x9042: // F13 - switch (bs) { - case press: ls = mbh.F13_press (button); break; - case release: ls = mbh.F13_release (button); break; - case neither: break; - } - break; + DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handle_midi_sysex: %1\n", bytes)); - case 0x9043: // F14 - switch (bs) { - case press: ls = mbh.F14_press (button); break; - case release: ls = mbh.F14_release (button); break; - case neither: break; - } - break; + if (_mcp.device_info().no_handshake()) { + turn_it_on (); + } - case 0x9044: // F15 - switch (bs) { - case press: ls = mbh.F15_press (button); break; - case release: ls = mbh.F15_release (button); break; - case neither: break; - } - break; + /* always save the device type ID so that our outgoing sysex messages + * are correct + */ - case 0x9045: // F16 - switch (bs) { - case press: ls = mbh.F16_press (button); break; - case release: ls = mbh.F16_release (button); break; - case neither: break; - } - break; + if (_stype == mcu) { + mackie_sysex_hdr[4] = bytes[4]; + } else { + mackie_sysex_hdr_xt[4] = bytes[4]; + } - case 0x9046: // shift - switch (bs) { - case press: ls = mbh.shift_press (button); break; - case release: ls = mbh.shift_release (button); break; - case neither: break; + switch (bytes[5]) { + case 0x01: + /* MCP: Device Ready + LCP: Connection Challenge + */ + if (bytes[4] == 0x10 || bytes[4] == 0x11) { + write_sysex (host_connection_query (bytes)); + } else { + if (!_active) { + turn_it_on (); + } } break; - case 0x9047: // option - switch (bs) { - case press: ls = mbh.option_press (button); break; - case release: ls = mbh.option_release (button); break; - case neither: break; + case 0x03: /* LCP Connection Confirmation */ + if (bytes[4] == 0x10 || bytes[4] == 0x11) { + write_sysex (host_connection_confirmation (bytes)); + _active = true; } break; - case 0x9048: // control - switch (bs) { - case press: ls = mbh.control_press (button); break; - case release: ls = mbh.control_release (button); break; - case neither: break; - } + case 0x04: /* LCP: Confirmation Denied */ + _active = false; break; + default: + error << "MCP: unknown sysex: " << bytes << endmsg; + } +} - case 0x9049: // cmd_alt - switch (bs) { - case press: ls = mbh.cmd_alt_press (button); break; - case release: ls = mbh.cmd_alt_release (button); break; - case neither: break; - } - break; +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; +} - case 0x904a: // on - switch (bs) { - case press: ls = mbh.on_press (button); break; - case release: ls = mbh.on_release (button); break; - case neither: break; - } - break; +// not used right now +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; + } - case 0x904b: // rec_ready - switch (bs) { - case press: ls = mbh.rec_ready_press (button); break; - case release: ls = mbh.rec_ready_release (button); break; - case neither: break; - } - break; + // 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; + } - case 0x904c: // undo - switch (bs) { - case press: ls = mbh.undo_press (button); break; - case release: ls = mbh.undo_release (button); break; - case neither: break; - } - break; + // build and send host connection reply + response << 0x02; + copy (bytes.begin() + 6, bytes.begin() + 6 + 7, back_inserter (response)); + response << calculate_challenge_response (bytes.begin() + 6 + 7, bytes.begin() + 6 + 7 + 4); + return response; +} - case 0x904d: // snapshot - switch (bs) { - case press: ls = mbh.snapshot_press (button); break; - case release: ls = mbh.snapshot_release (button); break; - case neither: break; - } - break; +// not used right now +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); +} - case 0x904e: // touch - switch (bs) { - case press: ls = mbh.touch_press (button); break; - case release: ls = mbh.touch_release (button); break; - case neither: break; - } - break; +void +Surface::turn_it_on () +{ + if (_active) { + return; + } - case 0x904f: // redo - switch (bs) { - case press: ls = mbh.redo_press (button); break; - case release: ls = mbh.redo_release (button); break; - case neither: break; - } - break; + _active = true; - case 0x9050: // marker - switch (bs) { - case press: ls = mbh.marker_press (button); break; - case release: ls = mbh.marker_release (button); break; - case neither: break; - } - break; + for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) { + (*s)->notify_all (); + } - case 0x9051: // enter - switch (bs) { - case press: ls = mbh.enter_press (button); break; - case release: ls = mbh.enter_release (button); break; - case neither: break; - } - break; + update_view_mode_display (); - case 0x9052: // cancel - switch (bs) { - case press: ls = mbh.cancel_press (button); break; - case release: ls = mbh.cancel_release (button); break; - case neither: break; - } - break; + if (_mcp.device_info ().has_global_controls ()) { + _mcp.update_global_button (Button::Read, _mcp.metering_active ()); + } +} - case 0x9053: // mixer - switch (bs) { - case press: ls = mbh.mixer_press (button); break; - case release: ls = mbh.mixer_release (button); break; - case neither: break; - } - break; +void +Surface::write_sysex (const MidiByteArray & mba) +{ + if (mba.empty()) { + return; + } - case 0x9054: // frm_left - switch (bs) { - case press: ls = mbh.frm_left_press (button); break; - case release: ls = mbh.frm_left_release (button); break; - case neither: break; - } - break; + MidiByteArray buf; + buf << sysex_hdr() << mba << MIDI::eox; + _port->write (buf); +} - case 0x9055: // frm_right - switch (bs) { - case press: ls = mbh.frm_right_press (button); break; - case release: ls = mbh.frm_right_release (button); break; - case neither: break; - } - break; +void +Surface::write_sysex (MIDI::byte msg) +{ + MidiByteArray buf; + buf << sysex_hdr() << msg << MIDI::eox; + _port->write (buf); +} - case 0x9056: // loop - switch (bs) { - case press: ls = mbh.loop_press (button); break; - case release: ls = mbh.loop_release (button); break; - case neither: break; - } - break; +uint32_t +Surface::n_strips (bool with_locked_strips) const +{ + if (with_locked_strips) { + return strips.size(); + } - case 0x9057: // punch_in - switch (bs) { - case press: ls = mbh.punch_in_press (button); break; - case release: ls = mbh.punch_in_release (button); break; - case neither: break; - } - break; + uint32_t n = 0; - case 0x9058: // punch_out - switch (bs) { - case press: ls = mbh.punch_out_press (button); break; - case release: ls = mbh.punch_out_release (button); break; - case neither: break; + for (Strips::const_iterator it = strips.begin(); it != strips.end(); ++it) { + if (!(*it)->locked()) { + ++n; } - break; + } + return n; +} - case 0x9059: // home - switch (bs) { - case press: ls = mbh.home_press (button); break; - case release: ls = mbh.home_release (button); break; - case neither: break; - } - break; +Strip* +Surface::nth_strip (uint32_t n) const +{ + if (n > n_strips()) { + return 0; + } + return strips[n]; +} - case 0x905a: // end - switch (bs) { - case press: ls = mbh.end_press (button); break; - case release: ls = mbh.end_release (button); break; - case neither: break; - } - break; +void +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, ' ')); + } - case 0x905b: // rewind - switch (bs) { - case press: ls = mbh.rewind_press (button); break; - case release: ls = mbh.rewind_release (button); break; - case neither: break; - } - break; + if (_mcp.device_info().has_master_fader () && _master_fader) { + _port->write (_master_fader->zero ()); + } - case 0x905c: // ffwd - switch (bs) { - case press: ls = mbh.ffwd_press (button); break; - case release: ls = mbh.ffwd_release (button); break; - case neither: break; - } - break; + // zero all strips + for (Strips::iterator it = strips.begin(); it != strips.end(); ++it) { + (*it)->zero(); + } - case 0x905d: // stop - switch (bs) { - case press: ls = mbh.stop_press (button); break; - case release: ls = mbh.stop_release (button); break; - case neither: break; - } - break; + zero_controls (); +} - case 0x905e: // play - switch (bs) { - case press: ls = mbh.play_press (button); break; - case release: ls = mbh.play_release (button); break; - case neither: break; - } - break; +void +Surface::zero_controls () +{ + if (!_mcp.device_info().has_global_controls()) { + return; + } - case 0x905f: // record - switch (bs) { - case press: ls = mbh.record_press (button); break; - case release: ls = mbh.record_release (button); break; - case neither: break; - } - break; + // turn off global buttons and leds + // global buttons are only ever on mcu_port, so we don't have + // to figure out which port. - case 0x9060: // cursor_up - switch (bs) { - case press: ls = mbh.cursor_up_press (button); break; - case release: ls = mbh.cursor_up_release (button); break; - case neither: break; + for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) { + Control & control = **it; + if (!control.group().is_strip()) { + _port->write (control.zero()); } - break; + } - case 0x9061: // cursor_down - switch (bs) { - case press: ls = mbh.cursor_down_press (button); break; - case release: ls = mbh.cursor_down_release (button); break; - case neither: break; - } - break; + // and the led ring for the master strip + blank_jog_ring (); - case 0x9062: // cursor_left - switch (bs) { - case press: ls = mbh.cursor_left_press (button); break; - case release: ls = mbh.cursor_left_release (button); break; - case neither: break; - } - break; + _last_master_gain_written = 0.0f; +} - case 0x9063: // cursor_right - switch (bs) { - case press: ls = mbh.cursor_right_press (button); break; - case release: ls = mbh.cursor_right_release (button); break; - case neither: break; - } - break; +void +Surface::periodic (uint64_t now_usecs) +{ + master_gain_changed(); + for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) { + (*s)->periodic (now_usecs); + } +} + +void +Surface::write (const MidiByteArray& data) +{ + if (_active) { + _port->write (data); + } else { + DEBUG_TRACE (DEBUG::MackieControl, "surface not active, write ignored\n"); + } +} + +void +Surface::map_routes (const vector >& routes) +{ + vector >::const_iterator r; + Strips::iterator s = strips.begin(); + + for (r = routes.begin(); r != routes.end() && s != strips.end(); ++s) { + + /* don't try to assign routes to a locked strip. it won't + use it anyway, but if we do, then we get out of sync + with the proposed mapping. + */ - case 0x9064: // zoom - switch (bs) { - case press: ls = mbh.zoom_press (button); break; - case release: ls = mbh.zoom_release (button); break; - case neither: break; + if (!(*s)->locked()) { + (*s)->set_route (*r); + ++r; } + } + + for (; s != strips.end(); ++s) { + (*s)->set_route (boost::shared_ptr()); + } + + +} + +static char +translate_seven_segment (char achar) +{ + achar = toupper (achar); + + if (achar >= 0x40 && achar <= 0x60) { + return achar - 0x40; + } else if (achar >= 0x21 && achar <= 0x3f) { + return achar; + } else { + return 0x00; + } +} + +void +Surface::show_two_char_display (const std::string & msg, const std::string & dots) +{ + 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); +} + +void +Surface::show_two_char_display (unsigned int value, const std::string & /*dots*/) +{ + ostringstream os; + os << setfill('0') << setw(2) << value % 100; + show_two_char_display (os.str()); +} + +void +Surface::display_timecode (const std::string & timecode, const std::string & last_timecode) +{ + if (!_active || !_mcp.device_info().has_timecode_display()) { + return; + } + // if there's no change, send nothing, not even sysex header + if (timecode == last_timecode) return; + + // length sanity checking + string local_timecode = timecode; + + // truncate to 10 characters + if (local_timecode.length() > 10) { + local_timecode = local_timecode.substr (0, 10); + } + + // pad to 10 characters + while (local_timecode.length() < 10) { + local_timecode += " "; + } + + // translate characters. + // Only the characters that actually changed are sent. + int position = 0x3f; + int i; + for (i = local_timecode.length () - 1; i >= 0; i--) { + position++; + if (local_timecode[i] == last_timecode[i]) { + continue; + } + MidiByteArray retval (2, 0xb0, position); + retval << translate_seven_segment (local_timecode[i]); + _port->write (retval); + } +} + +void +Surface::update_flip_mode_display () +{ + for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) { + (*s)->flip_mode_changed (true); + } +} + +void +Surface::update_view_mode_display () +{ + string text; + int id = -1; + + if (!_active) { + return; + } + + 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; + break; + case MackieControlProtocol::Loop: + show_two_char_display ("LP"); + id = Button::Loop; + break; + case MackieControlProtocol::AudioTracks: + show_two_char_display ("AT"); + break; + case MackieControlProtocol::MidiTracks: + show_two_char_display ("MT"); break; + case MackieControlProtocol::Sends: + show_two_char_display ("Sn"); + id = Button::Sends; + 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 */ - case 0x9065: // scrub - switch (bs) { - case press: ls = mbh.scrub_press (button); break; - case release: ls = mbh.scrub_release (button); break; - case neither: break; + map::iterator x = controls_by_device_independent_id.find (id); + + if (x != controls_by_device_independent_id.end()) { + Button* button = dynamic_cast (x->second); + if (button) { + _port->write (button->set_state (on)); + } } - break; + } - case 0x9066: // user_a - switch (bs) { - case press: ls = mbh.user_a_press (button); break; - case release: ls = mbh.user_a_release (button); break; - case neither: break; + if (!text.empty()) { + for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) { + _port->write ((*s)->display (1, text)); } - break; + } +} + +void +Surface::gui_selection_changed (const ARDOUR::StrongRouteNotificationList& routes) +{ + for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) { + (*s)->gui_selection_changed (routes); + } +} + +void +Surface::say_hello () +{ + /* wakeup for Mackie Control */ + MidiByteArray wakeup (7, MIDI::sysex, 0x00, 0x00, 0x66, 0x14, 0x00, MIDI::eox); + _port->write (wakeup); + wakeup[4] = 0x15; /* wakup Mackie XT */ + _port->write (wakeup); + wakeup[4] = 0x10; /* wakupe Logic Control */ + _port->write (wakeup); + wakeup[4] = 0x11; /* wakeup Logic Control XT */ + _port->write (wakeup); +} + +void +Surface::next_jog_mode () +{ +} + +void +Surface::set_jog_mode (JogWheel::Mode) +{ +} - case 0x9067: // user_b - switch (bs) { - case press: ls = mbh.user_b_press (button); break; - case release: ls = mbh.user_b_release (button); break; - case neither: break; +bool +Surface::route_is_locked_to_strip (boost::shared_ptr r) const +{ + for (Strips::const_iterator s = strips.begin(); s != strips.end(); ++s) { + if ((*s)->route() == r && (*s)->locked()) { + return true; } - break; + } + return false; +} +void +Surface::notify_metering_state_changed() +{ + for (Strips::const_iterator s = strips.begin(); s != strips.end(); ++s) { + (*s)->notify_metering_state_changed (); } - mbh.update_led (button, ls); }