2 Copyright (C) 2006,2007 John Anderson
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
33 #include <boost/shared_array.hpp>
35 #include "midi++/types.h"
36 #include "midi++/port.h"
37 #include "midi++/manager.h"
38 #include "pbd/pthread_utils.h"
39 #include "pbd/error.h"
40 #include "pbd/memento_command.h"
41 #include "pbd/convert.h"
43 #include "ardour/dB.h"
44 #include "ardour/debug.h"
45 #include "ardour/location.h"
46 #include "ardour/midi_ui.h"
47 #include "ardour/panner.h"
48 #include "ardour/panner_shell.h"
49 #include "ardour/route.h"
50 #include "ardour/session.h"
51 #include "ardour/tempo.h"
52 #include "ardour/types.h"
53 #include "ardour/audioengine.h"
55 #include "mackie_control_protocol.h"
57 #include "midi_byte_array.h"
58 #include "mackie_control_exception.h"
59 #include "route_signal.h"
60 #include "mackie_midi_builder.h"
61 #include "surface_port.h"
63 #include "bcf_surface.h"
64 #include "mackie_surface.h"
66 using namespace ARDOUR;
68 using namespace Mackie;
73 #include "pbd/abstract_ui.cc" // instantiate template
75 MackieMidiBuilder builder;
77 #define midi_ui_context() MidiControlUI::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
78 #define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
80 extern PBD::EventLoop::InvalidationRecord* __invalidator (sigc::trackable& trackable, const char*, int);
81 #define invalidator(x) __invalidator ((x), __FILE__, __LINE__)
83 MackieControlProtocol::MackieControlProtocol (Session& session)
84 : ControlProtocol (session, X_("Mackie"), MidiControlUI::instance())
85 , AbstractUI<MackieControlUIRequest> ("mackie")
86 , _current_initial_bank (0)
89 , _timecode_type (ARDOUR::AnyTime::BBT)
90 , _input_bundle (new ARDOUR::Bundle (_("Mackie Control In"), true))
91 , _output_bundle (new ARDOUR::Bundle (_("Mackie Control Out"), false))
94 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
96 AudioEngine::instance()->PortConnectedOrDisconnected.connect (
97 audio_engine_connections, invalidator (*this), ui_bind (&MackieControlProtocol::port_connected_or_disconnected, this, _2, _4, _5),
102 MackieControlProtocol::~MackieControlProtocol()
104 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol\n");
109 catch (exception & e) {
110 cout << "~MackieControlProtocol caught " << e.what() << endl;
113 cout << "~MackieControlProtocol caught unknown" << endl;
116 DEBUG_TRACE (DEBUG::MackieControl, "finished ~MackieControlProtocol::MackieControlProtocol\n");
120 MackieControlProtocol::surface()
123 throw MackieControlException ("_surface is 0 in MackieControlProtocol::surface");
128 const Mackie::SurfacePort&
129 MackieControlProtocol::mcu_port() const
131 if (_ports.size() < 1) {
134 return dynamic_cast<const MackiePort &> (*_ports[0]);
139 MackieControlProtocol::mcu_port()
141 if (_ports.size() < 1) {
144 return dynamic_cast<MackiePort &> (*_ports[0]);
148 // go to the previous track.
149 // Assume that get_sorted_routes().size() > route_table.size()
151 MackieControlProtocol::prev_track()
153 if (_current_initial_bank >= 1) {
154 session->set_dirty();
155 switch_banks (_current_initial_bank - 1);
159 // go to the next track.
160 // Assume that get_sorted_routes().size() > route_table.size()
162 MackieControlProtocol::next_track()
164 Sorted sorted = get_sorted_routes();
165 if (_current_initial_bank + route_table.size() < sorted.size()) {
166 session->set_dirty();
167 switch_banks (_current_initial_bank + 1);
172 MackieControlProtocol::clear_route_signals()
174 for (RouteSignals::iterator it = route_signals.begin(); it != route_signals.end(); ++it) {
177 route_signals.clear();
180 // return the port for a given id - 0 based
181 // throws an exception if no port found
183 MackieControlProtocol::port_for_id (uint32_t index)
185 uint32_t current_max = 0;
186 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
187 current_max += (*it)->strips();
188 if (index < current_max) return **it;
191 // oops - no matching port
193 os << "No port for index " << index;
194 throw MackieControlException (os.str());
197 // predicate for sort call in get_sorted_routes
198 struct RouteByRemoteId
200 bool operator () (const boost::shared_ptr<Route> & a, const boost::shared_ptr<Route> & b) const
202 return a->remote_control_id() < b->remote_control_id();
205 bool operator () (const Route & a, const Route & b) const
207 return a.remote_control_id() < b.remote_control_id();
210 bool operator () (const Route * a, const Route * b) const
212 return a->remote_control_id() < b->remote_control_id();
216 MackieControlProtocol::Sorted
217 MackieControlProtocol::get_sorted_routes()
222 boost::shared_ptr<RouteList> routes = session->get_routes();
223 set<uint32_t> remote_ids;
225 // routes with remote_id 0 should never be added
226 // TODO verify this with ardour devs
227 // remote_ids.insert (0);
229 // sort in remote_id order, and exclude master, control and hidden routes
230 // and any routes that are already set.
231 for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it) {
232 Route & route = **it;
235 && !route.is_master()
236 && !route.is_hidden()
237 && !route.is_monitor()
238 && remote_ids.find (route.remote_control_id()) == remote_ids.end()
240 sorted.push_back (*it);
241 remote_ids.insert (route.remote_control_id());
244 sort (sorted.begin(), sorted.end(), RouteByRemoteId());
249 MackieControlProtocol::refresh_current_bank()
251 switch_banks (_current_initial_bank);
255 MackieControlProtocol::switch_banks (int initial)
257 // DON'T prevent bank switch if initial == _current_initial_bank
258 // because then this method can't be used as a refresh
261 Sorted sorted = get_sorted_routes();
262 int delta = sorted.size() - route_table.size();
263 if (initial < 0 || (delta > 0 && initial > delta)) {
264 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("not switching to %1\n", initial));
267 _current_initial_bank = initial;
269 // first clear the signals from old routes
270 // taken care of by the RouteSignal destructors
271 clear_route_signals();
273 // now set the signals for new routes
274 if (_current_initial_bank <= sorted.size()) {
275 // fetch the bank start and end to switch to
276 uint32_t end_pos = min (route_table.size(), sorted.size());
277 Sorted::iterator it = sorted.begin() + _current_initial_bank;
278 Sorted::iterator end = sorted.begin() + _current_initial_bank + end_pos;
280 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch to %1, %2\n", _current_initial_bank, end_pos));
282 // clear out routes from our table in case any have been deleted
283 for (vector<boost::shared_ptr<Route> >::iterator i = route_table.begin(); i != route_table.end(); ++i) {
287 // link routes to strips
289 for (; it != end && it != sorted.end(); ++it, ++i) {
290 boost::shared_ptr<Route> route = *it;
292 assert (surface().strips[i]);
293 Strip & strip = *surface().strips[i];
295 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("remote id %1 connecting %2 to %3 with port %4\n",
296 route->remote_control_id(), route->name(), strip.name(), port_for_id(i)));
297 route_table[i] = route;
298 RouteSignal * rs = new RouteSignal (route, *this, strip, port_for_id(i));
299 route_signals.push_back (rs);
300 // update strip from route
304 // create dead strips if there aren't enough routes to
306 for (; i < route_table.size(); ++i) {
307 Strip & strip = *surface().strips[i];
308 // send zero for this strip
309 MackiePort & port = port_for_id(i);
310 port.write (builder.zero_strip (port, strip));
314 // display the current start bank.
315 surface().display_bank_start (mcu_port(), builder, _current_initial_bank);
319 MackieControlProtocol::zero_all()
321 // TODO turn off Timecode displays
324 for (Surface::Strips::iterator it = surface().strips.begin(); it != surface().strips.end(); ++it) {
325 MackiePort & port = port_for_id ((*it)->index());
326 port.write (builder.zero_strip (port, **it));
329 // and the master strip
330 mcu_port().write (builder.zero_strip (dynamic_cast<MackiePort&> (mcu_port()), master_strip()));
332 // turn off global buttons and leds
333 // global buttons are only ever on mcu_port, so we don't have
334 // to figure out which port.
335 for (Surface::Controls::iterator it = surface().controls.begin(); it != surface().controls.end(); ++it) {
336 Control & control = **it;
337 if (!control.group().is_strip() && control.accepts_feedback()) {
338 mcu_port().write (builder.zero_control (control));
342 // any hardware-specific stuff
343 surface().zero_all (mcu_port(), builder);
347 MackieControlProtocol::set_active (bool yn)
355 // the reason for the locking and unlocking is that
356 // glibmm can't do a condition wait on a RecMutex
358 // TODO what happens if this fails half way?
360 // create MackiePorts
362 Glib::Mutex::Lock lock (update_mutex);
366 // now initialise MackiePorts - ie exchange sysex messages
367 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
371 // wait until all ports are active
372 // TODO a more sophisticated approach would
373 // allow things to start up with only an MCU, even if
374 // extenders were specified but not responding.
375 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
376 (*it)->wait_for_init();
379 // create surface object. This depends on the ports being
380 // correctly initialised
381 initialize_surface();
382 connect_session_signals();
387 // send current control positions to surface
388 // must come after _active = true otherwise it won't run
396 catch (exception & e) {
397 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("set_active to false because exception caught: %1\n", e.what()));
406 MackieControlProtocol::handle_strip_button (SurfacePort & port, Control & control, ButtonState bs, boost::shared_ptr<Route> route)
411 if (control.name() == "recenable") {
412 state = !route->record_enabled();
413 route->set_record_enabled (state, this);
414 } else if (control.name() == "mute") {
415 state = !route->muted();
416 route->set_mute (state, this);
417 } else if (control.name() == "solo") {
418 state = !route->soloed();
419 route->set_solo (state, this);
420 } else if (control.name() == "select") {
421 // TODO make the track selected. Whatever that means.
422 //state = default_button_press (dynamic_cast<Button&> (control));
423 } else if (control.name() == "vselect") {
424 // TODO could be used to select different things to apply the pot to?
425 //state = default_button_press (dynamic_cast<Button&> (control));
429 if (control.name() == "fader_touch") {
431 control.strip().gain().set_in_use (state);
433 if (ARDOUR::Config->get_mackie_emulation() == "bcf" && state) {
434 /* BCF faders don't support touch, so add a timeout to reset
435 their `in_use' state.
437 port.add_in_use_timeout (control.strip().gain(), &control.strip().fader_touch());
445 MackieControlProtocol::update_led (Mackie::Button & button, Mackie::LedState ls)
448 SurfacePort * port = 0;
449 if (button.group().is_strip()) {
450 if (button.group().is_master()) {
453 port = &port_for_id (dynamic_cast<const Strip&> (button.group()).index());
458 port->write (builder.build_led (button, ls));
463 MackieControlProtocol::update_timecode_beats_led()
465 switch (_timecode_type) {
466 case ARDOUR::AnyTime::BBT:
467 update_global_led ("beats", on);
468 update_global_led ("timecode", off);
470 case ARDOUR::AnyTime::Timecode:
471 update_global_led ("timecode", on);
472 update_global_led ("beats", off);
476 os << "Unknown Anytime::Type " << _timecode_type;
477 throw runtime_error (os.str());
482 MackieControlProtocol::update_global_button (const string & name, LedState ls)
484 if (surface().controls_by_name.find (name) != surface().controls_by_name.end()) {
485 Button * button = dynamic_cast<Button*> (surface().controls_by_name[name]);
486 mcu_port().write (builder.build_led (button->led(), ls));
488 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", name));
493 MackieControlProtocol::update_global_led (const string & name, LedState ls)
495 if (surface().controls_by_name.find (name) != surface().controls_by_name.end()) {
496 Led * led = dynamic_cast<Led*> (surface().controls_by_name[name]);
497 mcu_port().write (builder.build_led (*led, ls));
499 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", name));
503 // send messages to surface to set controls to correct values
505 MackieControlProtocol::update_surface()
511 // do the initial bank switch to connect signals
512 // _current_initial_bank is initialised by set_state
513 switch_banks (_current_initial_bank);
515 /* Create a RouteSignal for the master route, if we don't already have one */
516 if (!master_route_signal) {
517 boost::shared_ptr<Route> mr = master_route ();
519 master_route_signal = boost::shared_ptr<RouteSignal> (new RouteSignal (mr, *this, master_strip(), mcu_port()));
520 // update strip from route
521 master_route_signal->notify_all();
525 // sometimes the jog wheel is a pot
526 surface().blank_jog_ring (mcu_port(), builder);
528 // update global buttons and displays
529 notify_record_state_changed();
530 notify_transport_state_changed();
531 update_timecode_beats_led();
535 MackieControlProtocol::connect_session_signals()
537 // receive routes added
538 session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_route_added, this, _1), midi_ui_context());
539 // receive record state toggled
540 session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_record_state_changed, this), midi_ui_context());
541 // receive transport state changed
542 session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_transport_state_changed, this), midi_ui_context());
543 // receive punch-in and punch-out
544 Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), midi_ui_context());
545 session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), midi_ui_context());
546 // receive rude solo changed
547 session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), midi_ui_context());
549 // make sure remote id changed signals reach here
550 // see also notify_route_added
551 Sorted sorted = get_sorted_routes();
553 for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
554 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind(&MackieControlProtocol::notify_remote_id_changed, this), midi_ui_context());
559 MackieControlProtocol::add_port (MIDI::Port & midi_input_port, MIDI::Port & midi_output_port, int number)
561 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("add port %1 %2\n", midi_input_port.name(), midi_output_port.name()));
563 MackiePort * sport = new MackiePort (*this, midi_input_port, midi_output_port, number);
564 _ports.push_back (sport);
566 sport->init_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_port_init, this, sport));
567 sport->active_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_port_active, this, sport));
568 sport->inactive_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_port_inactive, this, sport));
570 _input_bundle->add_channel (
571 midi_input_port.name(),
572 ARDOUR::DataType::MIDI,
573 session->engine().make_port_name_non_relative (midi_input_port.name())
576 _output_bundle->add_channel (
577 midi_output_port.name(),
578 ARDOUR::DataType::MIDI,
579 session->engine().make_port_name_non_relative (midi_output_port.name())
584 MackieControlProtocol::create_ports()
586 MIDI::Manager * mm = MIDI::Manager::instance();
587 MIDI::Port * midi_input_port = mm->add_port (
588 new MIDI::Port (string_compose (_("%1 in"), default_port_name), MIDI::Port::IsInput, session->engine().jack())
590 MIDI::Port * midi_output_port = mm->add_port (
591 new MIDI::Port (string_compose (_("%1 out"), default_port_name), MIDI::Port::IsOutput, session->engine().jack())
594 /* Create main port */
596 if (!midi_input_port->ok() || !midi_output_port->ok()) {
598 os << _("Mackie control MIDI ports could not be created; Mackie control disabled");
599 error << os.str() << endmsg;
600 throw MackieControlException (os.str());
603 add_port (*midi_input_port, *midi_output_port, 0);
605 /* Create extender ports */
607 for (uint32_t index = 1; index <= Config->get_mackie_extenders(); ++index) {
608 MIDI::Port * midi_input_port = mm->add_port (
609 new MIDI::Port (string_compose (_("mcu_xt_%1 in"), index), MIDI::Port::IsInput, session->engine().jack())
611 MIDI::Port * midi_output_port = mm->add_port (
612 new MIDI::Port (string_compose (_("mcu_xt_%1 out"), index), MIDI::Port::IsOutput, session->engine().jack())
614 if (midi_input_port->ok() && midi_output_port->ok()) {
615 add_port (*midi_input_port, *midi_output_port, index);
620 boost::shared_ptr<Route>
621 MackieControlProtocol::master_route()
623 return session->master_out ();
627 MackieControlProtocol::master_strip()
629 return dynamic_cast<Strip&> (*surface().groups["master"]);
633 MackieControlProtocol::initialize_surface()
635 // set up the route table
637 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
638 strips += (*it)->strips();
641 set_route_table_size (strips);
643 // TODO same as code in mackie_port.cc
644 string emulation = ARDOUR::Config->get_mackie_emulation();
645 if (emulation == "bcf") {
646 _surface = new BcfSurface (strips);
647 } else if (emulation == "mcu") {
648 _surface = new MackieSurface (strips);
651 os << "no Surface class found for emulation: " << emulation;
652 throw MackieControlException (os.str());
657 // Connect events. Must be after route table otherwise there will be trouble
659 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
660 (*it)->control_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_control_event, this, _1, _2, _3));
665 MackieControlProtocol::close()
668 // must be before other shutdown otherwise polling loop
669 // calls methods on objects that are deleted
671 port_connections.drop_connections ();
672 session_connections.drop_connections ();
673 route_connections.drop_connections ();
676 // These will fail if the port has gone away.
677 // So catch the exception and do the rest of the
679 // because the bcf doesn't respond to the next 3 sysex messages
684 catch (exception & e) {
685 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::close caught exception: %1\n", e.what()));
688 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
690 MackiePort & port = **it;
692 port.write_sysex (0x61);
694 port.write_sysex (0x62);
695 // Reset (reboot into offline mode)
696 port.write_sysex (0x63);
698 catch (exception & e) {
699 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::close caught exception: %1\n", e.what()));
703 // disconnect routes from strips
704 clear_route_signals();
709 // shut down MackiePorts
710 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
718 MackieControlProtocol::get_state()
720 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state\n");
722 // add name of protocol
723 XMLNode* node = new XMLNode (X_("Protocol"));
724 node->add_property (X_("name"), ARDOUR::ControlProtocol::_name);
728 os << _current_initial_bank;
729 node->add_property (X_("bank"), os.str());
735 MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
737 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", _active));
741 // fetch current bank
743 if (node.property (X_("bank")) != 0) {
744 string bank = node.property (X_("bank"))->value();
747 uint32_t new_bank = atoi (bank.c_str());
748 if (_current_initial_bank != new_bank) {
749 switch_banks (new_bank);
752 catch (exception & e) {
753 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("exception in MackieControlProtocol::set_state: %1\n", e.what()));
762 MackieControlProtocol::handle_control_event (SurfacePort & port, Control & control, const ControlState & state)
764 // find the route for the control, if there is one
765 boost::shared_ptr<Route> route;
766 if (control.group().is_strip()) {
767 if (control.group().is_master()) {
768 route = master_route();
770 uint32_t index = control.ordinal() - 1 + (port.number() * port.strips());
771 if (index < route_table.size())
772 route = route_table[index];
774 cerr << "Warning: index is " << index << " which is not in the route table, size: " << route_table.size() << endl;
778 // This handles control element events from the surface
779 // the state of the controls on the surface is usually updated
781 switch (control.type()) {
782 case Control::type_fader:
783 // find the route in the route table for the id
784 // if the route isn't available, skip it
785 // at which point the fader should just reset itself
788 route->gain_control()->set_value (slider_position_to_gain (state.pos));
790 if (ARDOUR::Config->get_mackie_emulation() == "bcf") {
791 /* reset the timeout while we're still moving the fader */
792 port.add_in_use_timeout (control, control.in_use_touch_control);
795 // must echo bytes back to slider now, because
796 // the notifier only works if the fader is not being
797 // touched. Which it is if we're getting input.
798 port.write (builder.build_fader ((Fader&)control, state.pos));
802 case Control::type_button:
803 if (control.group().is_strip()) {
806 handle_strip_button (port, control, state.button_state, route);
808 // no route so always switch the light off
809 // because no signals will be emitted by a non-route
810 port.write (builder.build_led (control.led(), off));
812 } else if (control.group().is_master()) {
813 // master fader touch
815 handle_strip_button (port, control, state.button_state, route);
818 // handle all non-strip buttons
819 surface().handle_button (*this, state.button_state, dynamic_cast<Button&> (control));
823 // pot (jog wheel, external control)
824 case Control::type_pot:
825 if (control.group().is_strip()) {
827 boost::shared_ptr<Panner> panner = route->panner_shell()->panner();
828 // pan for mono input routes, or stereo linked panners
830 double p = panner->position ();
832 // calculate new value, and adjust
833 p += state.delta * state.sign;
836 panner->set_position (p);
839 // it's a pot for an umnapped route, so turn all the lights off
840 port.write (builder.build_led_ring (dynamic_cast<Pot &> (control), off));
845 if (control.is_jog()) {
846 _jog_wheel.jog_event (port, control, state);
848 cout << "external controller" << state.ticks * state.sign << endl;
854 cout << "Control::type not handled: " << control.type() << endl;
858 /////////////////////////////////////////////////
859 // handlers for Route signals
860 // TODO should these be part of RouteSignal?
861 // They started off as signal/slot handlers for signals
862 // from Route, but they're also used in polling for automation
863 /////////////////////////////////////////////////
866 MackieControlProtocol::notify_solo_changed (RouteSignal * route_signal)
869 Button & button = route_signal->strip().solo();
870 route_signal->port().write (builder.build_led (button, route_signal->route()->soloed()));
872 catch (exception & e) {
873 cout << e.what() << endl;
878 MackieControlProtocol::notify_mute_changed (RouteSignal * route_signal)
881 Button & button = route_signal->strip().mute();
882 route_signal->port().write (builder.build_led (button, route_signal->route()->muted()));
884 catch (exception & e) {
885 cout << e.what() << endl;
890 MackieControlProtocol::notify_record_enable_changed (RouteSignal * route_signal)
893 Button & button = route_signal->strip().recenable();
894 route_signal->port().write (builder.build_led (button, route_signal->route()->record_enabled()));
896 catch (exception & e) {
897 cout << e.what() << endl;
901 void MackieControlProtocol::notify_active_changed (RouteSignal *)
904 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::notify_active_changed\n");
905 refresh_current_bank();
907 catch (exception & e) {
908 cout << e.what() << endl;
913 MackieControlProtocol::notify_gain_changed (RouteSignal * route_signal, bool force_update)
916 Fader & fader = route_signal->strip().gain();
917 if (!fader.in_use()) {
918 float gain_value = gain_to_slider_position (route_signal->route()->gain_control()->get_value());
919 // check that something has actually changed
920 if (force_update || gain_value != route_signal->last_gain_written()) {
921 route_signal->port().write (builder.build_fader (fader, gain_value));
922 route_signal->last_gain_written (gain_value);
926 catch (exception & e) {
927 cout << e.what() << endl;
932 MackieControlProtocol::notify_property_changed (const PropertyChange& what_changed, RouteSignal * route_signal)
934 if (!what_changed.contains (Properties::name)) {
939 Strip & strip = route_signal->strip();
941 /* XXX: not sure about this check to only display stuff for strips of index < 8 */
942 if (!strip.is_master() && strip.index() < 8) {
944 string fullname = route_signal->route()->name();
946 if (fullname.length() <= 6) {
949 line1 = PBD::short_version (fullname, 6);
952 SurfacePort & port = route_signal->port();
953 port.write (builder.strip_display (port, strip, 0, line1));
954 port.write (builder.strip_display_blank (port, strip, 1));
957 catch (exception & e) {
958 cout << e.what() << endl;
963 MackieControlProtocol::notify_panner_changed (RouteSignal * route_signal, bool force_update)
966 Pot & pot = route_signal->strip().vpot();
967 boost::shared_ptr<Panner> panner = route_signal->route()->panner();
969 double pos = panner->position ();
971 // cache the MidiByteArray here, because the mackie led control is much lower
972 // resolution than the panner control. So we save lots of byte
973 // sends in spite of more work on the comparison
974 MidiByteArray bytes = builder.build_led_ring (pot, ControlState (on, pos), MackieMidiBuilder::midi_pot_mode_dot);
975 // check that something has actually changed
976 if (force_update || bytes != route_signal->last_pan_written())
978 route_signal->port().write (bytes);
979 route_signal->last_pan_written (bytes);
982 route_signal->port().write (builder.zero_control (pot));
985 catch (exception & e) {
986 cout << e.what() << endl;
990 // TODO handle plugin automation polling
992 MackieControlProtocol::update_automation (RouteSignal & rs)
994 ARDOUR::AutoState gain_state = rs.route()->gain_control()->automation_state();
996 if (gain_state == Touch || gain_state == Play) {
997 notify_gain_changed (&rs, false);
1000 if (rs.route()->panner()) {
1001 ARDOUR::AutoState panner_state = rs.route()->panner()->automation_state();
1002 if (panner_state == Touch || panner_state == Play) {
1003 notify_panner_changed (&rs, false);
1009 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
1011 Timecode::BBT_Time bbt_time;
1012 session->bbt_time (now_frame, bbt_time);
1014 // According to the Logic docs
1015 // digits: 888/88/88/888
1016 // BBT mode: Bars/Beats/Subdivisions/Ticks
1018 os << setw(3) << setfill('0') << bbt_time.bars;
1019 os << setw(2) << setfill('0') << bbt_time.beats;
1021 // figure out subdivisions per beat
1022 const Meter & meter = session->tempo_map().meter_at (now_frame);
1024 if (meter.note_divisor() == 8 && (meter.divisions_per_bar() == 12.0 || meter.divisions_per_bar() == 9.0 || meter.divisions_per_bar() == 6.0)) {
1028 uint32_t subdivisions = bbt_time.ticks / uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
1029 uint32_t ticks = bbt_time.ticks % uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
1031 os << setw(2) << setfill('0') << subdivisions + 1;
1032 os << setw(3) << setfill('0') << ticks;
1038 MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
1040 Timecode::Time timecode;
1041 session->timecode_time (now_frame, timecode);
1043 // According to the Logic docs
1044 // digits: 888/88/88/888
1045 // Timecode mode: Hours/Minutes/Seconds/Frames
1047 os << setw(3) << setfill('0') << timecode.hours;
1048 os << setw(2) << setfill('0') << timecode.minutes;
1049 os << setw(2) << setfill('0') << timecode.seconds;
1050 os << setw(3) << setfill('0') << timecode.frames;
1056 MackieControlProtocol::update_timecode_display()
1058 if (surface().has_timecode_display()) {
1059 // do assignment here so current_frame is fixed
1060 framepos_t current_frame = session->transport_frame();
1063 switch (_timecode_type) {
1064 case ARDOUR::AnyTime::BBT:
1065 timecode = format_bbt_timecode (current_frame);
1067 case ARDOUR::AnyTime::Timecode:
1068 timecode = format_timecode_timecode (current_frame);
1072 os << "Unknown timecode: " << _timecode_type;
1073 throw runtime_error (os.str());
1076 // only write the timecode string to the MCU if it's changed
1077 // since last time. This is to reduce midi bandwidth used.
1078 if (timecode != _timecode_last) {
1079 surface().display_timecode (mcu_port(), builder, timecode, _timecode_last);
1080 _timecode_last = timecode;
1086 MackieControlProtocol::poll_session_data()
1088 // XXX need to attach this to a timer in the MIDI UI event loop (20msec)
1091 // do all currently mapped routes
1092 for (RouteSignals::iterator it = route_signals.begin(); it != route_signals.end(); ++it) {
1093 update_automation (**it);
1096 // and the master strip
1097 if (master_route_signal != 0) {
1098 update_automation (*master_route_signal);
1101 update_timecode_display();
1105 /////////////////////////////////////
1106 // Transport Buttons
1107 /////////////////////////////////////
1110 MackieControlProtocol::frm_left_press (Button &)
1112 // can use first_mark_before/after as well
1113 unsigned long elapsed = _frm_left_last.restart();
1115 Location * loc = session->locations()->first_location_before (
1116 session->transport_frame()
1119 // allow a quick double to go past a previous mark
1120 if (session->transport_rolling() && elapsed < 500 && loc != 0) {
1121 Location * loc_two_back = session->locations()->first_location_before (loc->start());
1122 if (loc_two_back != 0)
1128 // move to the location, if it's valid
1130 session->request_locate (loc->start(), session->transport_rolling());
1137 MackieControlProtocol::frm_left_release (Button &)
1143 MackieControlProtocol::frm_right_press (Button &)
1145 // can use first_mark_before/after as well
1146 Location * loc = session->locations()->first_location_after (session->transport_frame());
1149 session->request_locate (loc->start(), session->transport_rolling());
1156 MackieControlProtocol::frm_right_release (Button &)
1162 MackieControlProtocol::stop_press (Button &)
1164 session->request_stop();
1169 MackieControlProtocol::stop_release (Button &)
1171 return session->transport_stopped();
1175 MackieControlProtocol::play_press (Button &)
1177 session->request_transport_speed (1.0);
1182 MackieControlProtocol::play_release (Button &)
1184 return session->transport_rolling();
1188 MackieControlProtocol::record_press (Button &)
1190 if (session->get_record_enabled()) {
1191 session->disable_record (false);
1193 session->maybe_enable_record();
1199 MackieControlProtocol::record_release (Button &)
1201 if (session->get_record_enabled()) {
1202 if (session->transport_rolling()) {
1213 MackieControlProtocol::rewind_press (Button &)
1215 _jog_wheel.push (JogWheel::speed);
1216 _jog_wheel.transport_direction (-1);
1217 session->request_transport_speed (-_jog_wheel.transport_speed());
1222 MackieControlProtocol::rewind_release (Button &)
1225 _jog_wheel.transport_direction (0);
1226 if (_transport_previously_rolling) {
1227 session->request_transport_speed (1.0);
1229 session->request_stop();
1235 MackieControlProtocol::ffwd_press (Button &)
1237 _jog_wheel.push (JogWheel::speed);
1238 _jog_wheel.transport_direction (1);
1239 session->request_transport_speed (_jog_wheel.transport_speed());
1244 MackieControlProtocol::ffwd_release (Button &)
1247 _jog_wheel.transport_direction (0);
1248 if (_transport_previously_rolling) {
1249 session->request_transport_speed (1.0);
1251 session->request_stop();
1257 MackieControlProtocol::loop_press (Button &)
1259 session->request_play_loop (!session->get_play_loop());
1264 MackieControlProtocol::loop_release (Button &)
1266 return session->get_play_loop();
1270 MackieControlProtocol::punch_in_press (Button &)
1272 bool const state = !session->config.get_punch_in();
1273 session->config.set_punch_in (state);
1278 MackieControlProtocol::punch_in_release (Button &)
1280 return session->config.get_punch_in();
1284 MackieControlProtocol::punch_out_press (Button &)
1286 bool const state = !session->config.get_punch_out();
1287 session->config.set_punch_out (state);
1292 MackieControlProtocol::punch_out_release (Button &)
1294 return session->config.get_punch_out();
1298 MackieControlProtocol::home_press (Button &)
1300 session->goto_start();
1305 MackieControlProtocol::home_release (Button &)
1311 MackieControlProtocol::end_press (Button &)
1313 session->goto_end();
1318 MackieControlProtocol::end_release (Button &)
1324 MackieControlProtocol::clicking_press (Button &)
1326 bool state = !Config->get_clicking();
1327 Config->set_clicking (state);
1332 MackieControlProtocol::clicking_release (Button &)
1334 return Config->get_clicking();
1337 LedState MackieControlProtocol::global_solo_press (Button &)
1339 bool state = !session->soloing();
1340 session->set_solo (session->get_routes(), state);
1344 LedState MackieControlProtocol::global_solo_release (Button &)
1346 return session->soloing();
1349 ///////////////////////////////////////////
1351 ///////////////////////////////////////////
1353 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
1355 if (p == "punch-in") {
1356 update_global_button ("punch_in", session->config.get_punch_in());
1357 } else if (p == "punch-out") {
1358 update_global_button ("punch_out", session->config.get_punch_out());
1359 } else if (p == "clicking") {
1360 update_global_button ("clicking", Config->get_clicking());
1362 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
1366 // RouteList is the set of routes that have just been added
1368 MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
1370 // currently assigned banks are less than the full set of
1371 // strips, so activate the new strip now.
1372 if (route_signals.size() < route_table.size()) {
1373 refresh_current_bank();
1375 // otherwise route added, but current bank needs no updating
1377 // make sure remote id changes in the new route are handled
1378 typedef ARDOUR::RouteList ARS;
1380 for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
1381 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_remote_id_changed, this), midi_ui_context());
1386 MackieControlProtocol::notify_solo_active_changed (bool active)
1388 Button * rude_solo = reinterpret_cast<Button*> (surface().controls_by_name["solo"]);
1389 mcu_port().write (builder.build_led (*rude_solo, active ? flashing : off));
1393 MackieControlProtocol::notify_remote_id_changed()
1395 Sorted sorted = get_sorted_routes();
1397 // if a remote id has been moved off the end, we need to shift
1398 // the current bank backwards.
1399 if (sorted.size() - _current_initial_bank < route_signals.size()) {
1400 // but don't shift backwards past the zeroth channel
1401 switch_banks (max((Sorted::size_type) 0, sorted.size() - route_signals.size()));
1403 // Otherwise just refresh the current bank
1404 refresh_current_bank();
1408 ///////////////////////////////////////////
1409 // Transport signals
1410 ///////////////////////////////////////////
1413 MackieControlProtocol::notify_record_state_changed()
1415 // switch rec button on / off / flashing
1416 Button * rec = reinterpret_cast<Button*> (surface().controls_by_name["record"]);
1417 mcu_port().write (builder.build_led (*rec, record_release (*rec)));
1421 MackieControlProtocol::notify_transport_state_changed()
1423 // switch various play and stop buttons on / off
1424 update_global_button ("play", session->transport_rolling());
1425 update_global_button ("stop", !session->transport_rolling());
1426 update_global_button ("loop", session->get_play_loop());
1428 _transport_previously_rolling = session->transport_rolling();
1430 // rec is special because it's tristate
1431 Button * rec = reinterpret_cast<Button*> (surface().controls_by_name["record"]);
1432 mcu_port().write (builder.build_led (*rec, record_release (*rec)));
1435 /////////////////////////////////////
1437 /////////////////////////////////////
1439 MackieControlProtocol::left_press (Button &)
1441 Sorted sorted = get_sorted_routes();
1442 if (sorted.size() > route_table.size()) {
1443 int new_initial = _current_initial_bank - route_table.size();
1444 if (new_initial < 0) {
1448 if (new_initial != int (_current_initial_bank)) {
1449 session->set_dirty();
1450 switch_banks (new_initial);
1460 MackieControlProtocol::left_release (Button &)
1466 MackieControlProtocol::right_press (Button &)
1468 Sorted sorted = get_sorted_routes();
1469 if (sorted.size() > route_table.size()) {
1470 uint32_t delta = sorted.size() - (route_table.size() + _current_initial_bank);
1472 if (delta > route_table.size()) {
1473 delta = route_table.size();
1477 session->set_dirty();
1478 switch_banks (_current_initial_bank + delta);
1488 MackieControlProtocol::right_release (Button &)
1494 MackieControlProtocol::channel_left_press (Button &)
1496 Sorted sorted = get_sorted_routes();
1497 if (sorted.size() > route_table.size()) {
1506 MackieControlProtocol::channel_left_release (Button &)
1512 MackieControlProtocol::channel_right_press (Button &)
1514 Sorted sorted = get_sorted_routes();
1515 if (sorted.size() > route_table.size()) {
1524 MackieControlProtocol::channel_right_release (Button &)
1529 /////////////////////////////////////
1531 /////////////////////////////////////
1533 MackieControlProtocol::marker_press (Button &)
1535 // cut'n'paste from LocationUI::add_new_location()
1537 framepos_t where = session->audible_frame();
1538 session->locations()->next_available_name(markername,"mcu");
1539 Location *location = new Location (*session, where, where, markername, Location::IsMark);
1540 session->begin_reversible_command (_("add marker"));
1541 XMLNode &before = session->locations()->get_state();
1542 session->locations()->add (location, true);
1543 XMLNode &after = session->locations()->get_state();
1544 session->add_command (new MementoCommand<Locations>(*(session->locations()), &before, &after));
1545 session->commit_reversible_command ();
1550 MackieControlProtocol::marker_release (Button &)
1556 jog_wheel_state_display (JogWheel::State state, SurfacePort & port)
1559 case JogWheel::zoom:
1560 port.write (builder.two_char_display ("Zm"));
1562 case JogWheel::scroll:
1563 port.write (builder.two_char_display ("Sc"));
1565 case JogWheel::scrub:
1566 port.write (builder.two_char_display ("Sb"));
1568 case JogWheel::shuttle:
1569 port.write (builder.two_char_display ("Sh"));
1571 case JogWheel::speed:
1572 port.write (builder.two_char_display ("Sp"));
1574 case JogWheel::select:
1575 port.write (builder.two_char_display ("Se"));
1581 MackieControlProtocol::zoom_press (Mackie::Button &)
1583 _jog_wheel.zoom_state_toggle();
1584 update_global_button ("scrub", _jog_wheel.jog_wheel_state() == JogWheel::scrub);
1585 jog_wheel_state_display (_jog_wheel.jog_wheel_state(), mcu_port());
1586 return _jog_wheel.jog_wheel_state() == JogWheel::zoom;
1590 MackieControlProtocol::zoom_release (Mackie::Button &)
1592 return _jog_wheel.jog_wheel_state() == JogWheel::zoom;
1596 MackieControlProtocol::scrub_press (Mackie::Button &)
1598 _jog_wheel.scrub_state_cycle();
1599 update_global_button ("zoom", _jog_wheel.jog_wheel_state() == JogWheel::zoom);
1600 jog_wheel_state_display (_jog_wheel.jog_wheel_state(), mcu_port());
1602 _jog_wheel.jog_wheel_state() == JogWheel::scrub
1604 _jog_wheel.jog_wheel_state() == JogWheel::shuttle
1609 MackieControlProtocol::scrub_release (Mackie::Button &)
1612 _jog_wheel.jog_wheel_state() == JogWheel::scrub
1614 _jog_wheel.jog_wheel_state() == JogWheel::shuttle
1619 MackieControlProtocol::drop_press (Button &)
1621 session->remove_last_capture();
1626 MackieControlProtocol::drop_release (Button &)
1632 MackieControlProtocol::save_press (Button &)
1634 session->save_state ("");
1639 MackieControlProtocol::save_release (Button &)
1645 MackieControlProtocol::timecode_beats_press (Button &)
1647 switch (_timecode_type) {
1648 case ARDOUR::AnyTime::BBT:
1649 _timecode_type = ARDOUR::AnyTime::Timecode;
1651 case ARDOUR::AnyTime::Timecode:
1652 _timecode_type = ARDOUR::AnyTime::BBT;
1656 os << "Unknown Anytime::Type " << _timecode_type;
1657 throw runtime_error (os.str());
1659 update_timecode_beats_led();
1664 MackieControlProtocol::timecode_beats_release (Button &)
1669 list<boost::shared_ptr<ARDOUR::Bundle> >
1670 MackieControlProtocol::bundles ()
1672 list<boost::shared_ptr<ARDOUR::Bundle> > b;
1673 b.push_back (_input_bundle);
1674 b.push_back (_output_bundle);
1679 MackieControlProtocol::port_connected_or_disconnected (string a, string b, bool connected)
1681 /* If something is connected to one of our output ports, send MIDI to update the surface
1682 to whatever state it should have.
1689 MackiePorts::const_iterator i = _ports.begin();
1690 while (i != _ports.end()) {
1692 string const n = AudioEngine::instance()->make_port_name_non_relative ((*i)->output_port().name ());
1694 if (a == n || b == n) {
1701 if (i != _ports.end ()) {
1707 MackieControlProtocol::do_request (MackieControlUIRequest* req)
1709 if (req->type == CallSlot) {
1711 call_slot (MISSING_INVALIDATOR, req->the_slot);
1713 } else if (req->type == Quit) {
1720 MackieControlProtocol::stop ()