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 MackieMidiBuilder builder;
75 #define midi_ui_context() MidiControlUI::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
76 #define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
78 MackieControlProtocol::MackieControlProtocol (Session& session)
79 : ControlProtocol (session, X_("Mackie"), MidiControlUI::instance())
80 , _current_initial_bank (0)
83 , _timecode_type (ARDOUR::AnyTime::BBT)
84 , _input_bundle (new ARDOUR::Bundle (_("Mackie Control In"), true))
85 , _output_bundle (new ARDOUR::Bundle (_("Mackie Control Out"), false))
88 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
91 MackieControlProtocol::~MackieControlProtocol()
93 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol\n");
98 catch (exception & e) {
99 cout << "~MackieControlProtocol caught " << e.what() << endl;
102 cout << "~MackieControlProtocol caught unknown" << endl;
105 DEBUG_TRACE (DEBUG::MackieControl, "finished ~MackieControlProtocol::MackieControlProtocol\n");
109 MackieControlProtocol::surface()
112 throw MackieControlException ("_surface is 0 in MackieControlProtocol::surface");
117 const Mackie::SurfacePort&
118 MackieControlProtocol::mcu_port() const
120 if (_ports.size() < 1) {
123 return dynamic_cast<const MackiePort &> (*_ports[0]);
128 MackieControlProtocol::mcu_port()
130 if (_ports.size() < 1) {
133 return dynamic_cast<MackiePort &> (*_ports[0]);
137 // go to the previous track.
138 // Assume that get_sorted_routes().size() > route_table.size()
140 MackieControlProtocol::prev_track()
142 if (_current_initial_bank >= 1) {
143 session->set_dirty();
144 switch_banks (_current_initial_bank - 1);
148 // go to the next track.
149 // Assume that get_sorted_routes().size() > route_table.size()
151 MackieControlProtocol::next_track()
153 Sorted sorted = get_sorted_routes();
154 if (_current_initial_bank + route_table.size() < sorted.size())
156 session->set_dirty();
157 switch_banks (_current_initial_bank + 1);
162 MackieControlProtocol::clear_route_signals()
164 for (RouteSignals::iterator it = route_signals.begin(); it != route_signals.end(); ++it) {
167 route_signals.clear();
170 // return the port for a given id - 0 based
171 // throws an exception if no port found
173 MackieControlProtocol::port_for_id (uint32_t index)
175 uint32_t current_max = 0;
176 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
177 current_max += (*it)->strips();
178 if (index < current_max) return **it;
181 // oops - no matching port
183 os << "No port for index " << index;
184 throw MackieControlException (os.str());
187 // predicate for sort call in get_sorted_routes
188 struct RouteByRemoteId
190 bool operator () (const boost::shared_ptr<Route> & a, const boost::shared_ptr<Route> & b) const
192 return a->remote_control_id() < b->remote_control_id();
195 bool operator () (const Route & a, const Route & b) const
197 return a.remote_control_id() < b.remote_control_id();
200 bool operator () (const Route * a, const Route * b) const
202 return a->remote_control_id() < b->remote_control_id();
206 MackieControlProtocol::Sorted
207 MackieControlProtocol::get_sorted_routes()
212 boost::shared_ptr<RouteList> routes = session->get_routes();
213 set<uint32_t> remote_ids;
215 // routes with remote_id 0 should never be added
216 // TODO verify this with ardour devs
217 // remote_ids.insert (0);
219 // sort in remote_id order, and exclude master, control and hidden routes
220 // and any routes that are already set.
221 for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it)
223 Route & route = **it;
226 && !route.is_master()
227 && !route.is_hidden()
228 && !route.is_monitor()
229 && remote_ids.find (route.remote_control_id()) == remote_ids.end()
232 sorted.push_back (*it);
233 remote_ids.insert (route.remote_control_id());
236 sort (sorted.begin(), sorted.end(), RouteByRemoteId());
241 MackieControlProtocol::refresh_current_bank()
243 switch_banks (_current_initial_bank);
247 MackieControlProtocol::switch_banks (int initial)
249 // DON'T prevent bank switch if initial == _current_initial_bank
250 // because then this method can't be used as a refresh
253 Sorted sorted = get_sorted_routes();
254 int delta = sorted.size() - route_table.size();
255 if (initial < 0 || (delta > 0 && initial > delta))
257 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("not switching to %1\n", initial));
260 _current_initial_bank = initial;
262 // first clear the signals from old routes
263 // taken care of by the RouteSignal destructors
264 clear_route_signals();
266 // now set the signals for new routes
267 if (_current_initial_bank <= sorted.size())
269 // fetch the bank start and end to switch to
270 uint32_t end_pos = min (route_table.size(), sorted.size());
271 Sorted::iterator it = sorted.begin() + _current_initial_bank;
272 Sorted::iterator end = sorted.begin() + _current_initial_bank + end_pos;
274 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch to %1, %2\n", _current_initial_bank, end_pos));
276 // clear out routes from our table in case any have been deleted
277 for (vector<boost::shared_ptr<Route> >::iterator i = route_table.begin(); i != route_table.end(); ++i) {
281 // link routes to strips
283 for (; it != end && it != sorted.end(); ++it, ++i)
285 boost::shared_ptr<Route> route = *it;
287 assert (surface().strips[i]);
288 Strip & strip = *surface().strips[i];
290 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("remote id %1 connecting %2 to %3 with port %4\n",
291 route->remote_control_id(), route->name(), strip.name(), port_for_id(i)));
292 route_table[i] = route;
293 RouteSignal * rs = new RouteSignal (route, *this, strip, port_for_id(i));
294 route_signals.push_back (rs);
295 // update strip from route
299 // create dead strips if there aren't enough routes to
301 for (; i < route_table.size(); ++i)
303 Strip & strip = *surface().strips[i];
304 // send zero for this strip
305 MackiePort & port = port_for_id(i);
306 port.write (builder.zero_strip (port, strip));
310 // display the current start bank.
311 surface().display_bank_start (mcu_port(), builder, _current_initial_bank);
315 MackieControlProtocol::zero_all()
317 // TODO turn off Timecode displays
320 for (Surface::Strips::iterator it = surface().strips.begin(); it != surface().strips.end(); ++it)
322 MackiePort & port = port_for_id ((*it)->index());
323 port.write (builder.zero_strip (port, **it));
326 // and the master strip
327 mcu_port().write (builder.zero_strip (dynamic_cast<MackiePort&> (mcu_port()), master_strip()));
329 // turn off global buttons and leds
330 // global buttons are only ever on mcu_port, so we don't have
331 // to figure out which port.
332 for (Surface::Controls::iterator it = surface().controls.begin(); it != surface().controls.end(); ++it)
334 Control & control = **it;
335 if (!control.group().is_strip() && control.accepts_feedback())
337 mcu_port().write (builder.zero_control (control));
341 // any hardware-specific stuff
342 surface().zero_all (mcu_port(), builder);
346 MackieControlProtocol::set_active (bool yn)
352 // the reason for the locking and unlocking is that
353 // glibmm can't do a condition wait on a RecMutex
356 // TODO what happens if this fails half way?
358 // create MackiePorts
360 Glib::Mutex::Lock lock (update_mutex);
364 // now initialise MackiePorts - ie exchange sysex messages
365 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
369 // wait until all ports are active
370 // TODO a more sophisticated approach would
371 // allow things to start up with only an MCU, even if
372 // extenders were specified but not responding.
373 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
374 (*it)->wait_for_init();
377 // create surface object. This depends on the ports being
378 // correctly initialised
379 initialize_surface();
380 connect_session_signals();
385 // send current control positions to surface
386 // must come after _active = true otherwise it won't run
394 catch (exception & e) {
395 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("set_active to false because exception caught: %1\n", e.what()));
405 MackieControlProtocol::handle_strip_button (SurfacePort & port, Control & control, ButtonState bs, boost::shared_ptr<Route> route)
411 if (control.name() == "recenable")
413 state = !route->record_enabled();
414 route->set_record_enabled (state, this);
416 else if (control.name() == "mute")
418 state = !route->muted();
419 route->set_mute (state, this);
421 else if (control.name() == "solo")
423 state = !route->soloed();
424 route->set_solo (state, this);
426 else if (control.name() == "select")
428 // TODO make the track selected. Whatever that means.
429 //state = default_button_press (dynamic_cast<Button&> (control));
431 else if (control.name() == "vselect")
433 // TODO could be used to select different things to apply the pot to?
434 //state = default_button_press (dynamic_cast<Button&> (control));
438 if (control.name() == "fader_touch")
441 control.strip().gain().set_in_use (state);
443 if (ARDOUR::Config->get_mackie_emulation() == "bcf" && state) {
444 /* BCF faders don't support touch, so add a timeout to reset
445 their `in_use' state.
447 port.add_in_use_timeout (control.strip().gain(), &control.strip().fader_touch());
455 MackieControlProtocol::update_led (Mackie::Button & button, Mackie::LedState ls)
459 SurfacePort * port = 0;
460 if (button.group().is_strip())
462 if (button.group().is_master())
468 port = &port_for_id (dynamic_cast<const Strip&> (button.group()).index());
475 port->write (builder.build_led (button, ls));
480 MackieControlProtocol::update_timecode_beats_led()
482 switch (_timecode_type)
484 case ARDOUR::AnyTime::BBT:
485 update_global_led ("beats", on);
486 update_global_led ("timecode", off);
488 case ARDOUR::AnyTime::Timecode:
489 update_global_led ("timecode", on);
490 update_global_led ("beats", off);
494 os << "Unknown Anytime::Type " << _timecode_type;
495 throw runtime_error (os.str());
500 MackieControlProtocol::update_global_button (const string & name, LedState ls)
502 if (surface().controls_by_name.find (name) != surface().controls_by_name.end())
504 Button * button = dynamic_cast<Button*> (surface().controls_by_name[name]);
505 mcu_port().write (builder.build_led (button->led(), ls));
509 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", name));
514 MackieControlProtocol::update_global_led (const string & name, LedState ls)
516 if (surface().controls_by_name.find (name) != surface().controls_by_name.end())
518 Led * led = dynamic_cast<Led*> (surface().controls_by_name[name]);
519 mcu_port().write (builder.build_led (*led, ls));
523 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", name));
527 // send messages to surface to set controls to correct values
529 MackieControlProtocol::update_surface()
533 // do the initial bank switch to connect signals
534 // _current_initial_bank is initialised by set_state
535 switch_banks (_current_initial_bank);
537 // create a RouteSignal for the master route
539 boost::shared_ptr<Route> mr = master_route ();
541 master_route_signal = boost::shared_ptr<RouteSignal> (new RouteSignal (mr, *this, master_strip(), mcu_port()));
542 // update strip from route
543 master_route_signal->notify_all();
546 // sometimes the jog wheel is a pot
547 surface().blank_jog_ring (mcu_port(), builder);
549 // update global buttons and displays
550 notify_record_state_changed();
551 notify_transport_state_changed();
552 update_timecode_beats_led();
557 MackieControlProtocol::connect_session_signals()
559 // receive routes added
560 session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_route_added, this, _1), midi_ui_context());
561 // receive record state toggled
562 session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_record_state_changed, this), midi_ui_context());
563 // receive transport state changed
564 session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_transport_state_changed, this), midi_ui_context());
565 // receive punch-in and punch-out
566 Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), midi_ui_context());
567 session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), midi_ui_context());
568 // receive rude solo changed
569 session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), midi_ui_context());
571 // make sure remote id changed signals reach here
572 // see also notify_route_added
573 Sorted sorted = get_sorted_routes();
575 for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
576 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind(&MackieControlProtocol::notify_remote_id_changed, this), midi_ui_context());
581 MackieControlProtocol::add_port (MIDI::Port & midi_input_port, MIDI::Port & midi_output_port, int number)
583 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("add port %1 %2\n", midi_input_port.name(), midi_output_port.name()));
585 MackiePort * sport = new MackiePort (*this, midi_input_port, midi_output_port, number);
586 _ports.push_back (sport);
588 sport->init_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_port_init, this, sport));
589 sport->active_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_port_active, this, sport));
590 sport->inactive_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_port_inactive, this, sport));
592 _input_bundle->add_channel (
593 midi_input_port.name(),
594 ARDOUR::DataType::MIDI,
595 session->engine().make_port_name_non_relative (midi_input_port.name())
598 _output_bundle->add_channel (
599 midi_output_port.name(),
600 ARDOUR::DataType::MIDI,
601 session->engine().make_port_name_non_relative (midi_output_port.name())
606 MackieControlProtocol::create_ports()
608 MIDI::Manager * mm = MIDI::Manager::instance();
609 MIDI::Port * midi_input_port = mm->add_port (
610 new MIDI::Port (string_compose (_("%1 in"), default_port_name), MIDI::Port::IsInput, session->engine().jack())
612 MIDI::Port * midi_output_port = mm->add_port (
613 new MIDI::Port (string_compose (_("%1 out"), default_port_name), MIDI::Port::IsOutput, session->engine().jack())
616 /* Create main port */
618 if (!midi_input_port->ok() || !midi_output_port->ok()) {
620 os << _("Mackie control MIDI ports could not be created; Mackie control disabled");
621 error << os.str() << endmsg;
622 throw MackieControlException (os.str());
625 add_port (*midi_input_port, *midi_output_port, 0);
627 /* Create extender ports */
629 for (uint32_t index = 1; index <= Config->get_mackie_extenders(); ++index) {
630 MIDI::Port * midi_input_port = mm->add_port (
631 new MIDI::Port (string_compose (_("mcu_xt_%1 in"), index), MIDI::Port::IsInput, session->engine().jack())
633 MIDI::Port * midi_output_port = mm->add_port (
634 new MIDI::Port (string_compose (_("mcu_xt_%1 out"), index), MIDI::Port::IsOutput, session->engine().jack())
636 if (midi_input_port->ok() && midi_output_port->ok()) {
637 add_port (*midi_input_port, *midi_output_port, index);
642 boost::shared_ptr<Route>
643 MackieControlProtocol::master_route()
645 return session->master_out ();
649 MackieControlProtocol::master_strip()
651 return dynamic_cast<Strip&> (*surface().groups["master"]);
655 MackieControlProtocol::initialize_surface()
657 // set up the route table
659 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
660 strips += (*it)->strips();
663 set_route_table_size (strips);
665 // TODO same as code in mackie_port.cc
666 string emulation = ARDOUR::Config->get_mackie_emulation();
667 if (emulation == "bcf")
669 _surface = new BcfSurface (strips);
671 else if (emulation == "mcu")
673 _surface = new MackieSurface (strips);
678 os << "no Surface class found for emulation: " << emulation;
679 throw MackieControlException (os.str());
684 // Connect events. Must be after route table otherwise there will be trouble
686 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
687 (*it)->control_event.connect_same_thread (port_connections, boost::bind (&MackieControlProtocol::handle_control_event, this, _1, _2, _3));
692 MackieControlProtocol::close()
695 // must be before other shutdown otherwise polling loop
696 // calls methods on objects that are deleted
698 port_connections.drop_connections ();
699 session_connections.drop_connections ();
700 route_connections.drop_connections ();
703 // These will fail if the port has gone away.
704 // So catch the exception and do the rest of the
706 // because the bcf doesn't respond to the next 3 sysex messages
711 catch (exception & e) {
712 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::close caught exception: %1\n", e.what()));
715 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
717 MackiePort & port = **it;
719 port.write_sysex (0x61);
721 port.write_sysex (0x62);
722 // Reset (reboot into offline mode)
723 port.write_sysex (0x63);
725 catch (exception & e) {
726 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::close caught exception: %1\n", e.what()));
730 // disconnect routes from strips
731 clear_route_signals();
736 // shut down MackiePorts
737 for (MackiePorts::iterator it = _ports.begin(); it != _ports.end(); ++it) {
745 MackieControlProtocol::get_state()
747 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state\n");
749 // add name of protocol
750 XMLNode* node = new XMLNode (X_("Protocol"));
751 node->add_property (X_("name"), _name);
755 os << _current_initial_bank;
756 node->add_property (X_("bank"), os.str());
762 MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
764 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", _active));
768 // fetch current bank
770 if (node.property (X_("bank")) != 0) {
771 string bank = node.property (X_("bank"))->value();
774 uint32_t new_bank = atoi (bank.c_str());
775 if (_current_initial_bank != new_bank) {
776 switch_banks (new_bank);
779 catch (exception & e) {
780 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("exception in MackieControlProtocol::set_state: %1\n", e.what()));
789 MackieControlProtocol::handle_control_event (SurfacePort & port, Control & control, const ControlState & state)
791 // find the route for the control, if there is one
792 boost::shared_ptr<Route> route;
793 if (control.group().is_strip()) {
794 if (control.group().is_master()) {
795 route = master_route();
797 uint32_t index = control.ordinal() - 1 + (port.number() * port.strips());
798 if (index < route_table.size())
799 route = route_table[index];
801 cerr << "Warning: index is " << index << " which is not in the route table, size: " << route_table.size() << endl;
805 // This handles control element events from the surface
806 // the state of the controls on the surface is usually updated
808 switch (control.type()) {
809 case Control::type_fader:
810 // find the route in the route table for the id
811 // if the route isn't available, skip it
812 // at which point the fader should just reset itself
815 route->gain_control()->set_value (slider_position_to_gain (state.pos));
817 if (ARDOUR::Config->get_mackie_emulation() == "bcf") {
818 /* reset the timeout while we're still moving the fader */
819 port.add_in_use_timeout (control, control.in_use_touch_control);
822 // must echo bytes back to slider now, because
823 // the notifier only works if the fader is not being
824 // touched. Which it is if we're getting input.
825 port.write (builder.build_fader ((Fader&)control, state.pos));
829 case Control::type_button:
830 if (control.group().is_strip()) {
833 handle_strip_button (port, control, state.button_state, route);
835 // no route so always switch the light off
836 // because no signals will be emitted by a non-route
837 port.write (builder.build_led (control.led(), off));
839 } else if (control.group().is_master()) {
840 // master fader touch
842 handle_strip_button (port, control, state.button_state, route);
845 // handle all non-strip buttons
846 surface().handle_button (*this, state.button_state, dynamic_cast<Button&> (control));
850 // pot (jog wheel, external control)
851 case Control::type_pot:
852 if (control.group().is_strip()) {
854 boost::shared_ptr<Panner> panner = route->panner_shell()->panner();
855 // pan for mono input routes, or stereo linked panners
857 double p = panner->position ();
859 // calculate new value, and adjust
860 p += state.delta * state.sign;
863 panner->set_position (p);
868 // it's a pot for an umnapped route, so turn all the lights off
869 port.write (builder.build_led_ring (dynamic_cast<Pot &> (control), off));
874 if (control.is_jog())
876 _jog_wheel.jog_event (port, control, state);
880 cout << "external controller" << state.ticks * state.sign << endl;
886 cout << "Control::type not handled: " << control.type() << endl;
890 /////////////////////////////////////////////////
891 // handlers for Route signals
892 // TODO should these be part of RouteSignal?
893 // They started off as signal/slot handlers for signals
894 // from Route, but they're also used in polling for automation
895 /////////////////////////////////////////////////
898 MackieControlProtocol::notify_solo_changed (RouteSignal * route_signal)
902 Button & button = route_signal->strip().solo();
903 route_signal->port().write (builder.build_led (button, route_signal->route()->soloed()));
905 catch (exception & e)
907 cout << e.what() << endl;
912 MackieControlProtocol::notify_mute_changed (RouteSignal * route_signal)
916 Button & button = route_signal->strip().mute();
917 route_signal->port().write (builder.build_led (button, route_signal->route()->muted()));
919 catch (exception & e)
921 cout << e.what() << endl;
926 MackieControlProtocol::notify_record_enable_changed (RouteSignal * route_signal)
930 Button & button = route_signal->strip().recenable();
931 route_signal->port().write (builder.build_led (button, route_signal->route()->record_enabled()));
933 catch (exception & e)
935 cout << e.what() << endl;
939 void MackieControlProtocol::notify_active_changed (RouteSignal *)
943 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::notify_active_changed\n");
944 refresh_current_bank();
946 catch (exception & e)
948 cout << e.what() << endl;
953 MackieControlProtocol::notify_gain_changed (RouteSignal * route_signal, bool force_update)
957 Fader & fader = route_signal->strip().gain();
960 float gain_value = gain_to_slider_position (route_signal->route()->gain_control()->get_value());
961 // check that something has actually changed
962 if (force_update || gain_value != route_signal->last_gain_written())
964 route_signal->port().write (builder.build_fader (fader, gain_value));
965 route_signal->last_gain_written (gain_value);
969 catch (exception & e)
971 cout << e.what() << endl;
976 MackieControlProtocol::notify_property_changed (const PropertyChange& what_changed, RouteSignal * route_signal)
978 if (!what_changed.contains (Properties::name)) {
984 Strip & strip = route_signal->strip();
986 /* XXX: not sure about this check to only display stuff for strips of index < 8 */
987 if (!strip.is_master() && strip.index() < 8)
990 string fullname = route_signal->route()->name();
992 if (fullname.length() <= 6)
998 line1 = PBD::short_version (fullname, 6);
1001 SurfacePort & port = route_signal->port();
1002 port.write (builder.strip_display (port, strip, 0, line1));
1003 port.write (builder.strip_display_blank (port, strip, 1));
1006 catch (exception & e)
1008 cout << e.what() << endl;
1013 MackieControlProtocol::notify_panner_changed (RouteSignal * route_signal, bool force_update)
1017 Pot & pot = route_signal->strip().vpot();
1018 boost::shared_ptr<Panner> panner = route_signal->route()->panner();
1020 double pos = panner->position ();
1022 // cache the MidiByteArray here, because the mackie led control is much lower
1023 // resolution than the panner control. So we save lots of byte
1024 // sends in spite of more work on the comparison
1025 MidiByteArray bytes = builder.build_led_ring (pot, ControlState (on, pos), MackieMidiBuilder::midi_pot_mode_dot);
1026 // check that something has actually changed
1027 if (force_update || bytes != route_signal->last_pan_written())
1029 route_signal->port().write (bytes);
1030 route_signal->last_pan_written (bytes);
1035 route_signal->port().write (builder.zero_control (pot));
1038 catch (exception & e)
1040 cout << e.what() << endl;
1044 // TODO handle plugin automation polling
1046 MackieControlProtocol::update_automation (RouteSignal & rs)
1048 ARDOUR::AutoState gain_state = rs.route()->gain_control()->automation_state();
1050 if (gain_state == Touch || gain_state == Play)
1052 notify_gain_changed (&rs, false);
1055 if (rs.route()->panner()) {
1056 ARDOUR::AutoState panner_state = rs.route()->panner()->automation_state();
1057 if (panner_state == Touch || panner_state == Play)
1059 notify_panner_changed (&rs, false);
1065 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
1067 Timecode::BBT_Time bbt_time;
1068 session->bbt_time (now_frame, bbt_time);
1070 // According to the Logic docs
1071 // digits: 888/88/88/888
1072 // BBT mode: Bars/Beats/Subdivisions/Ticks
1074 os << setw(3) << setfill('0') << bbt_time.bars;
1075 os << setw(2) << setfill('0') << bbt_time.beats;
1077 // figure out subdivisions per beat
1078 const Meter & meter = session->tempo_map().meter_at (now_frame);
1080 if (meter.note_divisor() == 8 && (meter.beats_per_bar() == 12.0 || meter.beats_per_bar() == 9.0 || meter.beats_per_bar() == 6.0))
1085 uint32_t subdivisions = bbt_time.ticks / uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
1086 uint32_t ticks = bbt_time.ticks % uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
1088 os << setw(2) << setfill('0') << subdivisions + 1;
1089 os << setw(3) << setfill('0') << ticks;
1095 MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
1097 Timecode::Time timecode;
1098 session->timecode_time (now_frame, timecode);
1100 // According to the Logic docs
1101 // digits: 888/88/88/888
1102 // Timecode mode: Hours/Minutes/Seconds/Frames
1104 os << setw(3) << setfill('0') << timecode.hours;
1105 os << setw(2) << setfill('0') << timecode.minutes;
1106 os << setw(2) << setfill('0') << timecode.seconds;
1107 os << setw(3) << setfill('0') << timecode.frames;
1113 MackieControlProtocol::update_timecode_display()
1115 if (surface().has_timecode_display())
1117 // do assignment here so current_frame is fixed
1118 framepos_t current_frame = session->transport_frame();
1121 switch (_timecode_type)
1123 case ARDOUR::AnyTime::BBT:
1124 timecode = format_bbt_timecode (current_frame);
1126 case ARDOUR::AnyTime::Timecode:
1127 timecode = format_timecode_timecode (current_frame);
1131 os << "Unknown timecode: " << _timecode_type;
1132 throw runtime_error (os.str());
1135 // only write the timecode string to the MCU if it's changed
1136 // since last time. This is to reduce midi bandwidth used.
1137 if (timecode != _timecode_last)
1139 surface().display_timecode (mcu_port(), builder, timecode, _timecode_last);
1140 _timecode_last = timecode;
1146 MackieControlProtocol::poll_session_data()
1148 // XXX need to attach this to a timer in the MIDI UI event loop (20msec)
1151 // do all currently mapped routes
1152 for (RouteSignals::iterator it = route_signals.begin(); it != route_signals.end(); ++it) {
1153 update_automation (**it);
1156 // and the master strip
1157 if (master_route_signal != 0) {
1158 update_automation (*master_route_signal);
1161 update_timecode_display();
1165 /////////////////////////////////////
1166 // Transport Buttons
1167 /////////////////////////////////////
1170 MackieControlProtocol::frm_left_press (Button &)
1172 // can use first_mark_before/after as well
1173 unsigned long elapsed = _frm_left_last.restart();
1175 Location * loc = session->locations()->first_location_before (
1176 session->transport_frame()
1179 // allow a quick double to go past a previous mark
1180 if (session->transport_rolling() && elapsed < 500 && loc != 0)
1182 Location * loc_two_back = session->locations()->first_location_before (loc->start());
1183 if (loc_two_back != 0)
1189 // move to the location, if it's valid
1192 session->request_locate (loc->start(), session->transport_rolling());
1199 MackieControlProtocol::frm_left_release (Button &)
1205 MackieControlProtocol::frm_right_press (Button &)
1207 // can use first_mark_before/after as well
1208 Location * loc = session->locations()->first_location_after (
1209 session->transport_frame()
1211 if (loc != 0) session->request_locate (loc->start(), session->transport_rolling());
1216 MackieControlProtocol::frm_right_release (Button &)
1222 MackieControlProtocol::stop_press (Button &)
1224 session->request_stop();
1229 MackieControlProtocol::stop_release (Button &)
1231 return session->transport_stopped();
1235 MackieControlProtocol::play_press (Button &)
1237 session->request_transport_speed (1.0);
1242 MackieControlProtocol::play_release (Button &)
1244 return session->transport_rolling();
1248 MackieControlProtocol::record_press (Button &)
1250 if (session->get_record_enabled()) {
1251 session->disable_record (false);
1253 session->maybe_enable_record();
1259 MackieControlProtocol::record_release (Button &)
1261 if (session->get_record_enabled()) {
1262 if (session->transport_rolling()) {
1273 MackieControlProtocol::rewind_press (Button &)
1275 _jog_wheel.push (JogWheel::speed);
1276 _jog_wheel.transport_direction (-1);
1277 session->request_transport_speed (-_jog_wheel.transport_speed());
1282 MackieControlProtocol::rewind_release (Button &)
1285 _jog_wheel.transport_direction (0);
1286 if (_transport_previously_rolling)
1287 session->request_transport_speed (1.0);
1289 session->request_stop();
1294 MackieControlProtocol::ffwd_press (Button &)
1296 _jog_wheel.push (JogWheel::speed);
1297 _jog_wheel.transport_direction (1);
1298 session->request_transport_speed (_jog_wheel.transport_speed());
1303 MackieControlProtocol::ffwd_release (Button &)
1306 _jog_wheel.transport_direction (0);
1307 if (_transport_previously_rolling)
1308 session->request_transport_speed (1.0);
1310 session->request_stop();
1315 MackieControlProtocol::loop_press (Button &)
1317 session->request_play_loop (!session->get_play_loop());
1322 MackieControlProtocol::loop_release (Button &)
1324 return session->get_play_loop();
1328 MackieControlProtocol::punch_in_press (Button &)
1330 bool state = !session->config.get_punch_in();
1331 session->config.set_punch_in (state);
1336 MackieControlProtocol::punch_in_release (Button &)
1338 return session->config.get_punch_in();
1342 MackieControlProtocol::punch_out_press (Button &)
1344 bool state = !session->config.get_punch_out();
1345 session->config.set_punch_out (state);
1350 MackieControlProtocol::punch_out_release (Button &)
1352 return session->config.get_punch_out();
1356 MackieControlProtocol::home_press (Button &)
1358 session->goto_start();
1363 MackieControlProtocol::home_release (Button &)
1369 MackieControlProtocol::end_press (Button &)
1371 session->goto_end();
1376 MackieControlProtocol::end_release (Button &)
1382 MackieControlProtocol::clicking_press (Button &)
1384 bool state = !Config->get_clicking();
1385 Config->set_clicking (state);
1390 MackieControlProtocol::clicking_release (Button &)
1392 return Config->get_clicking();
1395 LedState MackieControlProtocol::global_solo_press (Button &)
1397 bool state = !session->soloing();
1398 session->set_solo (session->get_routes(), state);
1402 LedState MackieControlProtocol::global_solo_release (Button &)
1404 return session->soloing();
1407 ///////////////////////////////////////////
1409 ///////////////////////////////////////////
1411 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
1413 if (p == "punch-in")
1415 update_global_button ("punch_in", session->config.get_punch_in());
1417 else if (p == "punch-out")
1419 update_global_button ("punch_out", session->config.get_punch_out());
1421 else if (p == "clicking")
1423 update_global_button ("clicking", Config->get_clicking());
1427 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
1431 // RouteList is the set of routes that have just been added
1433 MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
1435 // currently assigned banks are less than the full set of
1436 // strips, so activate the new strip now.
1437 if (route_signals.size() < route_table.size())
1439 refresh_current_bank();
1441 // otherwise route added, but current bank needs no updating
1443 // make sure remote id changes in the new route are handled
1444 typedef ARDOUR::RouteList ARS;
1446 for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
1447 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_remote_id_changed, this), midi_ui_context());
1452 MackieControlProtocol::notify_solo_active_changed (bool active)
1454 Button * rude_solo = reinterpret_cast<Button*> (surface().controls_by_name["solo"]);
1455 mcu_port().write (builder.build_led (*rude_solo, active ? flashing : off));
1459 MackieControlProtocol::notify_remote_id_changed()
1461 Sorted sorted = get_sorted_routes();
1463 // if a remote id has been moved off the end, we need to shift
1464 // the current bank backwards.
1465 if (sorted.size() - _current_initial_bank < route_signals.size())
1467 // but don't shift backwards past the zeroth channel
1468 switch_banks (max((Sorted::size_type) 0, sorted.size() - route_signals.size()));
1470 // Otherwise just refresh the current bank
1473 refresh_current_bank();
1477 ///////////////////////////////////////////
1478 // Transport signals
1479 ///////////////////////////////////////////
1482 MackieControlProtocol::notify_record_state_changed()
1484 // switch rec button on / off / flashing
1485 Button * rec = reinterpret_cast<Button*> (surface().controls_by_name["record"]);
1486 mcu_port().write (builder.build_led (*rec, record_release (*rec)));
1490 MackieControlProtocol::notify_transport_state_changed()
1492 // switch various play and stop buttons on / off
1493 update_global_button ("play", session->transport_rolling());
1494 update_global_button ("stop", !session->transport_rolling());
1495 update_global_button ("loop", session->get_play_loop());
1497 _transport_previously_rolling = session->transport_rolling();
1499 // rec is special because it's tristate
1500 Button * rec = reinterpret_cast<Button*> (surface().controls_by_name["record"]);
1501 mcu_port().write (builder.build_led (*rec, record_release (*rec)));
1504 /////////////////////////////////////
1506 /////////////////////////////////////
1508 MackieControlProtocol::left_press (Button &)
1510 Sorted sorted = get_sorted_routes();
1511 if (sorted.size() > route_table.size())
1513 int new_initial = _current_initial_bank - route_table.size();
1514 if (new_initial < 0) {
1518 if (new_initial != int (_current_initial_bank)) {
1519 session->set_dirty();
1520 switch_banks (new_initial);
1532 MackieControlProtocol::left_release (Button &)
1538 MackieControlProtocol::right_press (Button &)
1540 Sorted sorted = get_sorted_routes();
1541 if (sorted.size() > route_table.size()) {
1542 uint32_t delta = sorted.size() - (route_table.size() + _current_initial_bank);
1544 if (delta > route_table.size()) {
1545 delta = route_table.size();
1549 session->set_dirty();
1550 switch_banks (_current_initial_bank + delta);
1560 MackieControlProtocol::right_release (Button &)
1566 MackieControlProtocol::channel_left_press (Button &)
1568 Sorted sorted = get_sorted_routes();
1569 if (sorted.size() > route_table.size())
1581 MackieControlProtocol::channel_left_release (Button &)
1587 MackieControlProtocol::channel_right_press (Button &)
1589 Sorted sorted = get_sorted_routes();
1590 if (sorted.size() > route_table.size())
1602 MackieControlProtocol::channel_right_release (Button &)
1607 /////////////////////////////////////
1609 /////////////////////////////////////
1611 MackieControlProtocol::marker_press (Button &)
1613 // cut'n'paste from LocationUI::add_new_location()
1615 framepos_t where = session->audible_frame();
1616 session->locations()->next_available_name(markername,"mcu");
1617 Location *location = new Location (*session, where, where, markername, Location::IsMark);
1618 session->begin_reversible_command (_("add marker"));
1619 XMLNode &before = session->locations()->get_state();
1620 session->locations()->add (location, true);
1621 XMLNode &after = session->locations()->get_state();
1622 session->add_command (new MementoCommand<Locations>(*(session->locations()), &before, &after));
1623 session->commit_reversible_command ();
1628 MackieControlProtocol::marker_release (Button &)
1634 jog_wheel_state_display (JogWheel::State state, SurfacePort & port)
1638 case JogWheel::zoom: port.write (builder.two_char_display ("Zm")); break;
1639 case JogWheel::scroll: port.write (builder.two_char_display ("Sc")); break;
1640 case JogWheel::scrub: port.write (builder.two_char_display ("Sb")); break;
1641 case JogWheel::shuttle: port.write (builder.two_char_display ("Sh")); break;
1642 case JogWheel::speed: port.write (builder.two_char_display ("Sp")); break;
1643 case JogWheel::select: port.write (builder.two_char_display ("Se")); break;
1648 MackieControlProtocol::zoom_press (Mackie::Button &)
1650 _jog_wheel.zoom_state_toggle();
1651 update_global_button ("scrub", _jog_wheel.jog_wheel_state() == JogWheel::scrub);
1652 jog_wheel_state_display (_jog_wheel.jog_wheel_state(), mcu_port());
1653 return _jog_wheel.jog_wheel_state() == JogWheel::zoom;
1657 MackieControlProtocol::zoom_release (Mackie::Button &)
1659 return _jog_wheel.jog_wheel_state() == JogWheel::zoom;
1663 MackieControlProtocol::scrub_press (Mackie::Button &)
1665 _jog_wheel.scrub_state_cycle();
1666 update_global_button ("zoom", _jog_wheel.jog_wheel_state() == JogWheel::zoom);
1667 jog_wheel_state_display (_jog_wheel.jog_wheel_state(), mcu_port());
1669 _jog_wheel.jog_wheel_state() == JogWheel::scrub
1671 _jog_wheel.jog_wheel_state() == JogWheel::shuttle
1676 MackieControlProtocol::scrub_release (Mackie::Button &)
1679 _jog_wheel.jog_wheel_state() == JogWheel::scrub
1681 _jog_wheel.jog_wheel_state() == JogWheel::shuttle
1686 MackieControlProtocol::drop_press (Button &)
1688 session->remove_last_capture();
1693 MackieControlProtocol::drop_release (Button &)
1699 MackieControlProtocol::save_press (Button &)
1701 session->save_state ("");
1706 MackieControlProtocol::save_release (Button &)
1712 MackieControlProtocol::timecode_beats_press (Button &)
1714 switch (_timecode_type)
1716 case ARDOUR::AnyTime::BBT:
1717 _timecode_type = ARDOUR::AnyTime::Timecode;
1719 case ARDOUR::AnyTime::Timecode:
1720 _timecode_type = ARDOUR::AnyTime::BBT;
1724 os << "Unknown Anytime::Type " << _timecode_type;
1725 throw runtime_error (os.str());
1727 update_timecode_beats_led();
1732 MackieControlProtocol::timecode_beats_release (Button &)
1737 list<boost::shared_ptr<ARDOUR::Bundle> >
1738 MackieControlProtocol::bundles ()
1740 list<boost::shared_ptr<ARDOUR::Bundle> > b;
1741 b.push_back (_input_bundle);
1742 b.push_back (_output_bundle);