2 Copyright (C) 2006,2007 John Anderson
3 Copyright (C) 2012 Paul Davis
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
34 #include <boost/shared_array.hpp>
36 #include "midi++/types.h"
37 #include "midi++/port.h"
38 #include "midi++/ipmidi_port.h"
39 #include "pbd/pthread_utils.h"
40 #include "pbd/error.h"
41 #include "pbd/memento_command.h"
42 #include "pbd/convert.h"
44 #include "ardour/automation_control.h"
45 #include "ardour/dB.h"
46 #include "ardour/debug.h"
47 #include "ardour/location.h"
48 #include "ardour/meter.h"
49 #include "ardour/panner.h"
50 #include "ardour/panner_shell.h"
51 #include "ardour/route.h"
52 #include "ardour/session.h"
53 #include "ardour/tempo.h"
54 #include "ardour/track.h"
55 #include "ardour/types.h"
56 #include "ardour/audioengine.h"
58 #include "mackie_control_protocol.h"
60 #include "midi_byte_array.h"
61 #include "mackie_control_exception.h"
62 #include "device_profile.h"
63 #include "surface_port.h"
66 #include "control_group.h"
72 using namespace ARDOUR;
74 using namespace Mackie;
80 #include "pbd/abstract_ui.cc" // instantiate template
82 const int MackieControlProtocol::MODIFIER_OPTION = 0x1;
83 const int MackieControlProtocol::MODIFIER_CONTROL = 0x2;
84 const int MackieControlProtocol::MODIFIER_SHIFT = 0x4;
85 const int MackieControlProtocol::MODIFIER_CMDALT = 0x8;
87 MackieControlProtocol* MackieControlProtocol::_instance = 0;
89 bool MackieControlProtocol::probe()
94 MackieControlProtocol::MackieControlProtocol (Session& session)
95 : ControlProtocol (session, X_("Mackie"))
96 , AbstractUI<MackieControlUIRequest> ("mackie")
97 , _current_initial_bank (0)
98 , _timecode_type (ARDOUR::AnyTime::BBT)
99 , _input_bundle (new ARDOUR::Bundle (_("Mackie Control In"), true))
100 , _output_bundle (new ARDOUR::Bundle (_("Mackie Control Out"), false))
103 , _scrub_mode (false)
106 , _current_selected_track (-1)
107 , _modifier_state (0)
108 , _ipmidi_base (MIDI::IPMIDIPort::lowest_ipmidi_port_default)
109 , needs_ipmidi_restart (false)
111 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
113 DeviceInfo::reload_device_info ();
114 DeviceProfile::reload_device_profiles ();
116 TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::gui_track_selection_changed, this, _1, true), this);
123 MackieControlProtocol::~MackieControlProtocol()
125 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol\n");
132 /* stop event loop */
139 catch (exception & e) {
140 cout << "~MackieControlProtocol caught " << e.what() << endl;
143 cout << "~MackieControlProtocol caught unknown" << endl;
146 DEBUG_TRACE (DEBUG::MackieControl, "finished ~MackieControlProtocol::MackieControlProtocol\n");
152 MackieControlProtocol::thread_init ()
154 struct sched_param rtparam;
156 pthread_set_name (X_("MackieControl"));
158 PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("MackieControl"), 2048);
159 ARDOUR::SessionEvent::create_per_thread_pool (X_("MackieControl"), 128);
161 memset (&rtparam, 0, sizeof (rtparam));
162 rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
164 if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
165 // do we care? not particularly.
170 MackieControlProtocol::midi_connectivity_established ()
172 for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
177 // go to the previous track.
178 // Assume that get_sorted_routes().size() > route_table.size()
180 MackieControlProtocol::prev_track()
182 if (_current_initial_bank >= 1) {
183 switch_banks (_current_initial_bank - 1);
187 // go to the next track.
188 // Assume that get_sorted_routes().size() > route_table.size()
190 MackieControlProtocol::next_track()
192 Sorted sorted = get_sorted_routes();
193 if (_current_initial_bank + n_strips() < sorted.size()) {
194 switch_banks (_current_initial_bank + 1);
199 MackieControlProtocol::route_is_locked_to_strip (boost::shared_ptr<Route> r) const
201 for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
202 if ((*si)->route_is_locked_to_strip (r)) {
209 // predicate for sort call in get_sorted_routes
210 struct RouteByRemoteId
212 bool operator () (const boost::shared_ptr<Route> & a, const boost::shared_ptr<Route> & b) const
214 return a->remote_control_id() < b->remote_control_id();
217 bool operator () (const Route & a, const Route & b) const
219 return a.remote_control_id() < b.remote_control_id();
222 bool operator () (const Route * a, const Route * b) const
224 return a->remote_control_id() < b->remote_control_id();
228 MackieControlProtocol::Sorted
229 MackieControlProtocol::get_sorted_routes()
234 boost::shared_ptr<RouteList> routes = session->get_routes();
235 set<uint32_t> remote_ids;
237 // routes with remote_id 0 should never be added
238 // TODO verify this with ardour devs
239 // remote_ids.insert (0);
241 // sort in remote_id order, and exclude master, control and hidden routes
242 // and any routes that are already set.
244 for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it) {
246 boost::shared_ptr<Route> route = *it;
248 if (remote_ids.find (route->remote_control_id()) != remote_ids.end()) {
252 if (route->is_hidden() || route->is_master() || route->is_monitor()) {
256 /* don't include locked routes */
258 if (route_is_locked_to_strip(route)) {
262 switch (_view_mode) {
283 sorted.push_back (*it);
284 remote_ids.insert (route->remote_control_id());
287 sort (sorted.begin(), sorted.end(), RouteByRemoteId());
292 MackieControlProtocol::refresh_current_bank()
294 switch_banks (_current_initial_bank, true);
298 MackieControlProtocol::n_strips (bool with_locked_strips) const
300 uint32_t strip_count = 0;
302 for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
303 strip_count += (*si)->n_strips (with_locked_strips);
310 MackieControlProtocol::switch_banks (uint32_t initial, bool force)
312 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch banking to start at %1 force ? %2 current = %3\n", initial, force, _current_initial_bank));
314 if (initial == _current_initial_bank && !force) {
318 Sorted sorted = get_sorted_routes();
319 uint32_t strip_cnt = n_strips (false); // do not include locked strips
322 if (sorted.size() <= strip_cnt && _current_initial_bank == 0 && !force) {
323 /* no banking - not enough routes to fill all strips and we're
324 * not at the first one.
329 _current_initial_bank = initial;
330 _current_selected_track = -1;
332 // Map current bank of routes onto each surface(+strip)
334 if (_current_initial_bank <= sorted.size()) {
336 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch to %1, %2, available routes %3\n", _current_initial_bank, strip_cnt, sorted.size()));
338 // link routes to strips
340 Sorted::iterator r = sorted.begin() + _current_initial_bank;
342 for (Surfaces::iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
343 vector<boost::shared_ptr<Route> > routes;
346 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has %1 unlockedstrips\n", (*si)->n_strips (false)));
348 for (; r != sorted.end() && added < (*si)->n_strips (false); ++r, ++added) {
349 routes.push_back (*r);
352 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("give surface %1 routes\n", routes.size()));
354 (*si)->map_routes (routes);
358 /* reset this to get the right display of view mode after the switch */
359 set_view_mode (_view_mode);
361 /* make sure selection is correct */
363 _gui_track_selection_changed (&_last_selected_routes, false);
365 /* current bank has not been saved */
366 session->set_dirty();
370 MackieControlProtocol::set_active (bool yn)
378 /* start event loop */
383 connect_session_signals ();
387 /* set up periodic task for metering and automation
390 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
391 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
392 periodic_timeout->attach (main_loop()->get_context());
406 MackieControlProtocol::periodic ()
412 if (needs_ipmidi_restart) {
419 gettimeofday (&now, 0);
421 now_usecs = (now.tv_sec * 1000000) + now.tv_usec;
423 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
424 (*s)->periodic (now_usecs);
427 update_timecode_display ();
434 MackieControlProtocol::update_timecode_beats_led()
436 switch (_timecode_type) {
437 case ARDOUR::AnyTime::BBT:
438 update_global_led (Led::Beats, on);
439 update_global_led (Led::Timecode, off);
441 case ARDOUR::AnyTime::Timecode:
442 update_global_led (Led::Timecode, on);
443 update_global_led (Led::Beats, off);
447 os << "Unknown Anytime::Type " << _timecode_type;
448 throw runtime_error (os.str());
453 MackieControlProtocol::update_global_button (int id, LedState ls)
455 boost::shared_ptr<Surface> surface = surfaces.front();
457 if (!surface->type() == mcu) {
461 map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
462 if (x != surface->controls_by_device_independent_id.end()) {
463 Button * button = dynamic_cast<Button*> (x->second);
464 surface->write (button->set_state (ls));
466 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", id));
471 MackieControlProtocol::update_global_led (int id, LedState ls)
473 boost::shared_ptr<Surface> surface = surfaces.front();
475 if (!surface->type() == mcu) {
479 map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
480 if (x != surface->controls_by_device_independent_id.end()) {
481 Led * led = dynamic_cast<Led*> (x->second);
482 surface->write (led->set_state (ls));
484 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", id));
488 // send messages to surface to set controls to correct values
490 MackieControlProtocol::update_surfaces()
496 // do the initial bank switch to connect signals
497 // _current_initial_bank is initialised by set_state
498 switch_banks (_current_initial_bank, true);
500 // sometimes the jog wheel is a pot
501 surfaces.front()->blank_jog_ring ();
503 // update global buttons and displays
505 notify_record_state_changed();
506 notify_transport_state_changed();
507 update_timecode_beats_led();
511 MackieControlProtocol::connect_session_signals()
513 // receive routes added
514 session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_route_added, this, _1), this);
515 // receive record state toggled
516 session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_record_state_changed, this), this);
517 // receive transport state changed
518 session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
519 session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
520 // receive punch-in and punch-out
521 Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
522 session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
523 // receive rude solo changed
524 session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), this);
526 // make sure remote id changed signals reach here
527 // see also notify_route_added
528 Sorted sorted = get_sorted_routes();
530 for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
531 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
536 MackieControlProtocol::set_profile (const string& profile_name)
538 if (profile_name == "default") {
539 /* reset to default */
540 _device_profile = DeviceProfile (profile_name);
543 map<string,DeviceProfile>::iterator d = DeviceProfile::device_profiles.find (profile_name);
545 if (d == DeviceProfile::device_profiles.end()) {
549 _device_profile = d->second;
553 MackieControlProtocol::set_device (const string& device_name, bool allow_activation)
555 map<string,DeviceInfo>::iterator d = DeviceInfo::device_info.find (device_name);
557 if (d == DeviceInfo::device_info.end()) {
566 _device_info = d->second;
568 if (allow_activation) {
573 switch_banks (0, true);
579 MackieControlProtocol::create_surfaces ()
582 surface_type_t stype = mcu;
585 if (_device_info.extenders() == 0) {
586 device_name = X_("mackie control");
588 device_name = X_("mackie control #1");
591 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Create %1 surfaces\n", 1 + _device_info.extenders()));
593 for (uint32_t n = 0; n < 1 + _device_info.extenders(); ++n) {
595 boost::shared_ptr<Surface> surface (new Surface (*this, device_name, n, stype));
596 surfaces.push_back (surface);
598 /* next device will be an extender */
600 if (_device_info.extenders() < 2) {
601 device_name = X_("mackie control #2");
603 snprintf (buf, sizeof (buf), X_("mackie control #%d"), n+2);
608 if (!_device_info.uses_ipmidi()) {
609 _input_bundle->add_channel (
610 surface->port().input_port().name(),
611 ARDOUR::DataType::MIDI,
612 session->engine().make_port_name_non_relative (surface->port().input_port().name())
615 _output_bundle->add_channel (
616 surface->port().output_port().name(),
617 ARDOUR::DataType::MIDI,
618 session->engine().make_port_name_non_relative (surface->port().output_port().name())
623 MIDI::Port& input_port (surface->port().input_port());
625 if ((fd = input_port.selectable ()) >= 0) {
626 Glib::RefPtr<IOSource> psrc = IOSource::create (fd, IO_IN|IO_HUP|IO_ERR);
628 psrc->connect (sigc::bind (sigc::mem_fun (this, &MackieControlProtocol::midi_input_handler), &input_port));
629 psrc->attach (main_loop()->get_context());
631 // glibmm hack: for now, store only the GSource*
633 port_sources.push_back (psrc->gobj());
634 g_source_ref (psrc->gobj());
640 MackieControlProtocol::close()
644 port_connections.drop_connections ();
645 session_connections.drop_connections ();
646 route_connections.drop_connections ();
647 periodic_connection.disconnect ();
653 MackieControlProtocol::get_state()
655 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state\n");
658 // add name of protocol
659 XMLNode* node = new XMLNode (X_("Protocol"));
660 node->add_property (X_("name"), ARDOUR::ControlProtocol::_name);
663 snprintf (buf, sizeof (buf), "%d", _current_initial_bank);
664 node->add_property (X_("bank"), buf);
666 // ipMIDI base port (possibly not used)
667 snprintf (buf, sizeof (buf), "%d", _ipmidi_base);
668 node->add_property (X_("ipmidi-base"), buf);
670 node->add_property (X_("device-profile"), _device_profile.name());
671 node->add_property (X_("device-name"), _device_info.name());
677 MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
679 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", _active));
682 const XMLProperty* prop;
684 bool active = _active;
686 if ((prop = node.property (X_("ipmidi-base"))) != 0) {
687 set_ipmidi_base (atoi (prop->value()));
690 // fetch current bank
691 if ((prop = node.property (X_("bank"))) != 0) {
692 bank = atoi (prop->value());
695 if ((prop = node.property (X_("active"))) != 0) {
696 active = string_is_affirmative (prop->value());
699 if ((prop = node.property (X_("device-name"))) != 0) {
700 set_device (prop->value(), false);
703 if ((prop = node.property (X_("device-profile"))) != 0) {
704 set_profile (prop->value());
710 switch_banks (bank, true);
717 /////////////////////////////////////////////////
718 // handlers for Route signals
719 // TODO should these be part of RouteSignal?
720 // They started off as signal/slot handlers for signals
721 // from Route, but they're also used in polling for automation
722 /////////////////////////////////////////////////
724 // TODO handle plugin automation polling
726 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
728 Timecode::BBT_Time bbt_time;
730 session->bbt_time (now_frame, bbt_time);
732 // The Mackie protocol spec is built around a BBT time display of
734 // digits: 888/88/88/888
735 // semantics: BBB/bb/ss/ttt
737 // The third field is "subdivisions" which is a concept found in Logic
738 // but not present in Ardour. Instead Ardour displays a 4 digit tick
739 // count, which we need to spread across the 5 digits of ss/ttt.
743 os << setw(3) << setfill('0') << bbt_time.bars;
744 os << setw(2) << setfill('0') << bbt_time.beats;
745 os << setw(2) << setfill('0') << bbt_time.ticks / 1000;
746 os << setw(3) << setfill('0') << bbt_time.ticks % 1000;
752 MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
754 Timecode::Time timecode;
755 session->timecode_time (now_frame, timecode);
757 // According to the Logic docs
758 // digits: 888/88/88/888
759 // Timecode mode: Hours/Minutes/Seconds/Frames
761 os << setw(3) << setfill('0') << timecode.hours;
762 os << setw(2) << setfill('0') << timecode.minutes;
763 os << setw(2) << setfill('0') << timecode.seconds;
764 os << setw(3) << setfill('0') << timecode.frames;
770 MackieControlProtocol::update_timecode_display()
772 if (surfaces.empty()) {
776 boost::shared_ptr<Surface> surface = surfaces.front();
778 if (surface->type() != mcu || !_device_info.has_timecode_display()) {
782 // do assignment here so current_frame is fixed
783 framepos_t current_frame = session->transport_frame();
786 switch (_timecode_type) {
787 case ARDOUR::AnyTime::BBT:
788 timecode = format_bbt_timecode (current_frame);
790 case ARDOUR::AnyTime::Timecode:
791 timecode = format_timecode_timecode (current_frame);
797 // only write the timecode string to the MCU if it's changed
798 // since last time. This is to reduce midi bandwidth used.
799 if (timecode != _timecode_last) {
800 surface->display_timecode (timecode, _timecode_last);
801 _timecode_last = timecode;
805 ///////////////////////////////////////////
807 ///////////////////////////////////////////
809 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
811 if (p == "punch-in") {
812 update_global_button (Button::PunchIn, session->config.get_punch_in());
813 } else if (p == "punch-out") {
814 update_global_button (Button::PunchOut, session->config.get_punch_out());
815 } else if (p == "clicking") {
816 // update_global_button (Button::RelayClick, Config->get_clicking());
818 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
822 // RouteList is the set of routes that have just been added
824 MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
826 // currently assigned banks are less than the full set of
827 // strips, so activate the new strip now.
829 refresh_current_bank();
831 // otherwise route added, but current bank needs no updating
833 // make sure remote id changes in the new route are handled
834 typedef ARDOUR::RouteList ARS;
836 for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
837 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
842 MackieControlProtocol::notify_solo_active_changed (bool active)
844 boost::shared_ptr<Surface> surface = surfaces.front();
846 map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Led::RudeSolo);
847 if (x != surface->controls_by_device_independent_id.end()) {
848 Led* rude_solo = dynamic_cast<Led*> (x->second);
850 surface->write (rude_solo->set_state (active ? flashing : off));
856 MackieControlProtocol::notify_remote_id_changed()
858 Sorted sorted = get_sorted_routes();
859 uint32_t sz = n_strips();
861 // if a remote id has been moved off the end, we need to shift
862 // the current bank backwards.
864 if (sorted.size() - _current_initial_bank < sz) {
865 // but don't shift backwards past the zeroth channel
866 switch_banks (max((Sorted::size_type) 0, sorted.size() - sz));
868 // Otherwise just refresh the current bank
869 refresh_current_bank();
873 ///////////////////////////////////////////
875 ///////////////////////////////////////////
878 MackieControlProtocol::notify_loop_state_changed()
880 update_global_button (Button::Loop, session->get_play_loop());
884 MackieControlProtocol::notify_transport_state_changed()
886 // switch various play and stop buttons on / off
887 update_global_button (Button::Loop, session->get_play_loop());
888 update_global_button (Button::Play, session->transport_speed() == 1.0);
889 update_global_button (Button::Stop, !session->transport_rolling());
890 update_global_button (Button::Rewind, session->transport_speed() < 0.0);
891 update_global_button (Button::Ffwd, session->transport_speed() > 1.0);
893 _transport_previously_rolling = session->transport_rolling();
897 MackieControlProtocol::notify_record_state_changed ()
899 boost::shared_ptr<Surface> surface = surfaces.front();
901 /* rec is a tristate */
903 map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Button::Record);
904 if (x != surface->controls_by_device_independent_id.end()) {
905 Button * rec = dynamic_cast<Button*> (x->second);
909 switch (session->record_status()) {
910 case Session::Disabled:
911 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to disabled, LED off\n");
914 case Session::Recording:
915 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to recording, LED on\n");
918 case Session::Enabled:
919 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to enabled, LED flashing\n");
924 surface->write (rec->set_state (ls));
929 list<boost::shared_ptr<ARDOUR::Bundle> >
930 MackieControlProtocol::bundles ()
932 list<boost::shared_ptr<ARDOUR::Bundle> > b;
933 b.push_back (_input_bundle);
934 b.push_back (_output_bundle);
939 MackieControlProtocol::do_request (MackieControlUIRequest* req)
941 if (req->type == CallSlot) {
943 call_slot (MISSING_INVALIDATOR, req->the_slot);
945 } else if (req->type == Quit) {
952 MackieControlProtocol::stop ()
960 MackieControlProtocol::update_led (Surface& surface, Button& button, Mackie::LedState ls)
963 surface.port().write (button.set_state (ls));
968 MackieControlProtocol::build_button_map ()
970 /* this maps our device-independent button codes to the methods that handle them.
973 #define DEFINE_BUTTON_HANDLER(b,p,r) button_map.insert (pair<Button::ID,ButtonHandlers> ((b), ButtonHandlers ((p),(r))));
975 DEFINE_BUTTON_HANDLER (Button::IO, &MackieControlProtocol::io_press, &MackieControlProtocol::io_release);
976 DEFINE_BUTTON_HANDLER (Button::Sends, &MackieControlProtocol::sends_press, &MackieControlProtocol::sends_release);
977 DEFINE_BUTTON_HANDLER (Button::Pan, &MackieControlProtocol::pan_press, &MackieControlProtocol::pan_release);
978 DEFINE_BUTTON_HANDLER (Button::Plugin, &MackieControlProtocol::plugin_press, &MackieControlProtocol::plugin_release);
979 DEFINE_BUTTON_HANDLER (Button::Eq, &MackieControlProtocol::eq_press, &MackieControlProtocol::eq_release);
980 DEFINE_BUTTON_HANDLER (Button::Dyn, &MackieControlProtocol::dyn_press, &MackieControlProtocol::dyn_release);
981 DEFINE_BUTTON_HANDLER (Button::Left, &MackieControlProtocol::left_press, &MackieControlProtocol::left_release);
982 DEFINE_BUTTON_HANDLER (Button::Right, &MackieControlProtocol::right_press, &MackieControlProtocol::right_release);
983 DEFINE_BUTTON_HANDLER (Button::ChannelLeft, &MackieControlProtocol::channel_left_press, &MackieControlProtocol::channel_left_release);
984 DEFINE_BUTTON_HANDLER (Button::ChannelRight, &MackieControlProtocol::channel_right_press, &MackieControlProtocol::channel_right_release);
985 DEFINE_BUTTON_HANDLER (Button::Flip, &MackieControlProtocol::flip_press, &MackieControlProtocol::flip_release);
986 DEFINE_BUTTON_HANDLER (Button::Edit, &MackieControlProtocol::edit_press, &MackieControlProtocol::edit_release);
987 DEFINE_BUTTON_HANDLER (Button::NameValue, &MackieControlProtocol::name_value_press, &MackieControlProtocol::name_value_release);
988 DEFINE_BUTTON_HANDLER (Button::TimecodeBeats, &MackieControlProtocol::timecode_beats_press, &MackieControlProtocol::timecode_beats_release);
989 DEFINE_BUTTON_HANDLER (Button::F1, &MackieControlProtocol::F1_press, &MackieControlProtocol::F1_release);
990 DEFINE_BUTTON_HANDLER (Button::F2, &MackieControlProtocol::F2_press, &MackieControlProtocol::F2_release);
991 DEFINE_BUTTON_HANDLER (Button::F3, &MackieControlProtocol::F3_press, &MackieControlProtocol::F3_release);
992 DEFINE_BUTTON_HANDLER (Button::F4, &MackieControlProtocol::F4_press, &MackieControlProtocol::F4_release);
993 DEFINE_BUTTON_HANDLER (Button::F5, &MackieControlProtocol::F5_press, &MackieControlProtocol::F5_release);
994 DEFINE_BUTTON_HANDLER (Button::F6, &MackieControlProtocol::F6_press, &MackieControlProtocol::F6_release);
995 DEFINE_BUTTON_HANDLER (Button::F7, &MackieControlProtocol::F7_press, &MackieControlProtocol::F7_release);
996 DEFINE_BUTTON_HANDLER (Button::F8, &MackieControlProtocol::F8_press, &MackieControlProtocol::F8_release);
997 DEFINE_BUTTON_HANDLER (Button::F9, &MackieControlProtocol::F9_press, &MackieControlProtocol::F9_release);
998 DEFINE_BUTTON_HANDLER (Button::F10, &MackieControlProtocol::F10_press, &MackieControlProtocol::F10_release);
999 DEFINE_BUTTON_HANDLER (Button::F11, &MackieControlProtocol::F11_press, &MackieControlProtocol::F11_release);
1000 DEFINE_BUTTON_HANDLER (Button::F12, &MackieControlProtocol::F12_press, &MackieControlProtocol::F12_release);
1001 DEFINE_BUTTON_HANDLER (Button::F13, &MackieControlProtocol::F13_press, &MackieControlProtocol::F13_release);
1002 DEFINE_BUTTON_HANDLER (Button::F14, &MackieControlProtocol::F14_press, &MackieControlProtocol::F14_release);
1003 DEFINE_BUTTON_HANDLER (Button::F15, &MackieControlProtocol::F15_press, &MackieControlProtocol::F15_release);
1004 DEFINE_BUTTON_HANDLER (Button::F16, &MackieControlProtocol::F16_press, &MackieControlProtocol::F16_release);
1005 DEFINE_BUTTON_HANDLER (Button::Shift, &MackieControlProtocol::shift_press, &MackieControlProtocol::shift_release);
1006 DEFINE_BUTTON_HANDLER (Button::Option, &MackieControlProtocol::option_press, &MackieControlProtocol::option_release);
1007 DEFINE_BUTTON_HANDLER (Button::Ctrl, &MackieControlProtocol::control_press, &MackieControlProtocol::control_release);
1008 DEFINE_BUTTON_HANDLER (Button::CmdAlt, &MackieControlProtocol::cmd_alt_press, &MackieControlProtocol::cmd_alt_release);
1009 DEFINE_BUTTON_HANDLER (Button::On, &MackieControlProtocol::on_press, &MackieControlProtocol::on_release);
1010 DEFINE_BUTTON_HANDLER (Button::RecReady, &MackieControlProtocol::rec_ready_press, &MackieControlProtocol::rec_ready_release);
1011 DEFINE_BUTTON_HANDLER (Button::Undo, &MackieControlProtocol::undo_press, &MackieControlProtocol::undo_release);
1012 DEFINE_BUTTON_HANDLER (Button::Save, &MackieControlProtocol::save_press, &MackieControlProtocol::save_release);
1013 DEFINE_BUTTON_HANDLER (Button::Touch, &MackieControlProtocol::touch_press, &MackieControlProtocol::touch_release);
1014 DEFINE_BUTTON_HANDLER (Button::Redo, &MackieControlProtocol::redo_press, &MackieControlProtocol::redo_release);
1015 DEFINE_BUTTON_HANDLER (Button::Marker, &MackieControlProtocol::marker_press, &MackieControlProtocol::marker_release);
1016 DEFINE_BUTTON_HANDLER (Button::Enter, &MackieControlProtocol::enter_press, &MackieControlProtocol::enter_release);
1017 DEFINE_BUTTON_HANDLER (Button::Cancel, &MackieControlProtocol::cancel_press, &MackieControlProtocol::cancel_release);
1018 DEFINE_BUTTON_HANDLER (Button::Mixer, &MackieControlProtocol::mixer_press, &MackieControlProtocol::mixer_release);
1019 DEFINE_BUTTON_HANDLER (Button::FrmLeft, &MackieControlProtocol::frm_left_press, &MackieControlProtocol::frm_left_release);
1020 DEFINE_BUTTON_HANDLER (Button::FrmRight, &MackieControlProtocol::frm_right_press, &MackieControlProtocol::frm_right_release);
1021 DEFINE_BUTTON_HANDLER (Button::Loop, &MackieControlProtocol::loop_press, &MackieControlProtocol::loop_release);
1022 DEFINE_BUTTON_HANDLER (Button::PunchIn, &MackieControlProtocol::punch_in_press, &MackieControlProtocol::punch_in_release);
1023 DEFINE_BUTTON_HANDLER (Button::PunchOut, &MackieControlProtocol::punch_out_press, &MackieControlProtocol::punch_out_release);
1024 DEFINE_BUTTON_HANDLER (Button::Home, &MackieControlProtocol::home_press, &MackieControlProtocol::home_release);
1025 DEFINE_BUTTON_HANDLER (Button::End, &MackieControlProtocol::end_press, &MackieControlProtocol::end_release);
1026 DEFINE_BUTTON_HANDLER (Button::Rewind, &MackieControlProtocol::rewind_press, &MackieControlProtocol::rewind_release);
1027 DEFINE_BUTTON_HANDLER (Button::Ffwd, &MackieControlProtocol::ffwd_press, &MackieControlProtocol::ffwd_release);
1028 DEFINE_BUTTON_HANDLER (Button::Stop, &MackieControlProtocol::stop_press, &MackieControlProtocol::stop_release);
1029 DEFINE_BUTTON_HANDLER (Button::Play, &MackieControlProtocol::play_press, &MackieControlProtocol::play_release);
1030 DEFINE_BUTTON_HANDLER (Button::Record, &MackieControlProtocol::record_press, &MackieControlProtocol::record_release);
1031 DEFINE_BUTTON_HANDLER (Button::CursorUp, &MackieControlProtocol::cursor_up_press, &MackieControlProtocol::cursor_up_release);
1032 DEFINE_BUTTON_HANDLER (Button::CursorDown, &MackieControlProtocol::cursor_down_press, &MackieControlProtocol::cursor_down_release);
1033 DEFINE_BUTTON_HANDLER (Button::CursorLeft, &MackieControlProtocol::cursor_left_press, &MackieControlProtocol::cursor_left_release);
1034 DEFINE_BUTTON_HANDLER (Button::CursorRight, &MackieControlProtocol::cursor_right_press, &MackieControlProtocol::cursor_right_release);
1035 DEFINE_BUTTON_HANDLER (Button::Zoom, &MackieControlProtocol::zoom_press, &MackieControlProtocol::zoom_release);
1036 DEFINE_BUTTON_HANDLER (Button::Scrub, &MackieControlProtocol::scrub_press, &MackieControlProtocol::scrub_release);
1037 DEFINE_BUTTON_HANDLER (Button::UserA, &MackieControlProtocol::user_a_press, &MackieControlProtocol::user_a_release);
1038 DEFINE_BUTTON_HANDLER (Button::UserB, &MackieControlProtocol::user_b_press, &MackieControlProtocol::user_b_release);
1040 DEFINE_BUTTON_HANDLER (Button::Snapshot, &MackieControlProtocol::snapshot_press, &MackieControlProtocol::snapshot_release);
1041 DEFINE_BUTTON_HANDLER (Button::Read, &MackieControlProtocol::read_press, &MackieControlProtocol::read_release);
1042 DEFINE_BUTTON_HANDLER (Button::Write, &MackieControlProtocol::write_press, &MackieControlProtocol::write_release);
1043 DEFINE_BUTTON_HANDLER (Button::FdrGroup, &MackieControlProtocol::fdrgroup_press, &MackieControlProtocol::fdrgroup_release);
1044 DEFINE_BUTTON_HANDLER (Button::ClearSolo, &MackieControlProtocol::clearsolo_press, &MackieControlProtocol::clearsolo_release);
1045 DEFINE_BUTTON_HANDLER (Button::Track, &MackieControlProtocol::track_press, &MackieControlProtocol::track_release);
1046 DEFINE_BUTTON_HANDLER (Button::Send, &MackieControlProtocol::send_press, &MackieControlProtocol::send_release);
1047 DEFINE_BUTTON_HANDLER (Button::MidiTracks, &MackieControlProtocol::miditracks_press, &MackieControlProtocol::miditracks_release);
1048 DEFINE_BUTTON_HANDLER (Button::Inputs, &MackieControlProtocol::inputs_press, &MackieControlProtocol::inputs_release);
1049 DEFINE_BUTTON_HANDLER (Button::AudioTracks, &MackieControlProtocol::audiotracks_press, &MackieControlProtocol::audiotracks_release);
1050 DEFINE_BUTTON_HANDLER (Button::AudioInstruments, &MackieControlProtocol::audioinstruments_press, &MackieControlProtocol::audioinstruments_release);
1051 DEFINE_BUTTON_HANDLER (Button::Aux, &MackieControlProtocol::aux_press, &MackieControlProtocol::aux_release);
1052 DEFINE_BUTTON_HANDLER (Button::Busses, &MackieControlProtocol::busses_press, &MackieControlProtocol::busses_release);
1053 DEFINE_BUTTON_HANDLER (Button::Outputs, &MackieControlProtocol::outputs_press, &MackieControlProtocol::outputs_release);
1054 DEFINE_BUTTON_HANDLER (Button::User, &MackieControlProtocol::user_press, &MackieControlProtocol::user_release);
1055 DEFINE_BUTTON_HANDLER (Button::Trim, &MackieControlProtocol::trim_press, &MackieControlProtocol::trim_release);
1056 DEFINE_BUTTON_HANDLER (Button::Latch, &MackieControlProtocol::latch_press, &MackieControlProtocol::latch_release);
1057 DEFINE_BUTTON_HANDLER (Button::Grp, &MackieControlProtocol::grp_press, &MackieControlProtocol::grp_release);
1058 DEFINE_BUTTON_HANDLER (Button::Nudge, &MackieControlProtocol::nudge_press, &MackieControlProtocol::nudge_release);
1059 DEFINE_BUTTON_HANDLER (Button::Drop, &MackieControlProtocol::drop_press, &MackieControlProtocol::drop_release);
1060 DEFINE_BUTTON_HANDLER (Button::Replace, &MackieControlProtocol::replace_press, &MackieControlProtocol::replace_release);
1061 DEFINE_BUTTON_HANDLER (Button::Click, &MackieControlProtocol::click_press, &MackieControlProtocol::click_release);
1062 DEFINE_BUTTON_HANDLER (Button::View, &MackieControlProtocol::view_press, &MackieControlProtocol::view_release);
1066 MackieControlProtocol::handle_button_event (Surface& surface, Button& button, ButtonState bs)
1068 if (bs != press && bs != release) {
1069 update_led (surface, button, none);
1073 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2 (%3)\n", (bs == press ? "press" : "release"), button.id(),
1074 Button::id_to_name (button.bid())));
1076 /* check profile first */
1078 string action = _device_profile.get_button_action (button.bid(), _modifier_state);
1080 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Looked up action for button %1 with modifier %2, got [%3]\n",
1081 button.bid(), _modifier_state, action));
1083 if (!action.empty()) {
1084 /* if there is a bound action for this button, and this is a press event,
1085 carry out the action. If its a release event, do nothing since we
1086 don't bind to them at all but don't want any other handling to
1090 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("executing action %1\n", action));
1091 access_action (action);
1096 /* lookup using the device-INDEPENDENT button ID */
1098 ButtonMap::iterator b = button_map.find (button.bid());
1100 if (b != button_map.end()) {
1102 ButtonHandlers& bh (b->second);
1106 surface.write (button.set_state ((this->*(bh.press)) (button)));
1109 surface.write (button.set_state ((this->*(bh.release)) (button)));
1115 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1116 button.bid(), button.id()));
1117 error << string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1118 button.bid(), button.id()) << endmsg;
1123 MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
1125 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("something happend on %1\n", port->name()));
1133 /* Devices using regular JACK MIDI ports will need to have
1134 the x-thread FIFO drained to avoid burning endless CPU.
1136 Devices using ipMIDI have port->selectable() as the same
1137 file descriptor that data arrives on, so doing this
1138 for them will simply throw all incoming data away.
1141 if (!_device_info.uses_ipmidi()) {
1142 CrossThreadChannel::drain (port->selectable());
1145 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("data available on %1\n", port->name()));
1146 framepos_t now = session->engine().frame_time();
1154 MackieControlProtocol::clear_ports ()
1156 _input_bundle->remove_channels ();
1157 _output_bundle->remove_channels ();
1159 for (PortSources::iterator i = port_sources.begin(); i != port_sources.end(); ++i) {
1160 g_source_destroy (*i);
1161 g_source_unref (*i);
1164 port_sources.clear ();
1168 MackieControlProtocol::set_view_mode (ViewMode m)
1172 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1173 (*s)->update_view_mode_display ();
1179 MackieControlProtocol::set_flip_mode (bool yn)
1183 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1184 (*s)->update_flip_mode_display ();
1189 MackieControlProtocol::set_master_on_surface_strip (uint32_t surface, uint32_t strip_number)
1191 force_special_route_to_strip (session->master_out(), surface, strip_number);
1195 MackieControlProtocol::set_monitor_on_surface_strip (uint32_t surface, uint32_t strip_number)
1197 force_special_route_to_strip (session->monitor_out(), surface, strip_number);
1201 MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r, uint32_t surface, uint32_t strip_number)
1207 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1208 if ((*s)->number() == surface) {
1209 Strip* strip = (*s)->nth_strip (strip_number);
1211 strip->set_route (session->master_out());
1212 strip->lock_controls ();
1219 MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl, bool save_list)
1221 _gui_track_selection_changed (rl.get(), save_list);
1225 MackieControlProtocol::_gui_track_selection_changed (ARDOUR::RouteNotificationList* rl, bool save_list)
1228 /* We need to keep a list of the most recently selected routes around,
1229 but we are not allowed to keep shared_ptr<Route> unless we want to
1230 handle the complexities of route deletion. So instead, the GUI sends
1231 us a notification using weak_ptr<Route>, which we keep a copy
1232 of. For efficiency's sake, however, we convert the weak_ptr's into
1233 shared_ptr<Route> before passing them to however many surfaces (and
1234 thus strips) that we have.
1237 StrongRouteNotificationList srl;
1239 for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
1240 boost::shared_ptr<ARDOUR::Route> r = (*i).lock();
1246 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1247 (*s)->gui_selection_changed (srl);
1251 _last_selected_routes = *rl;
1256 MackieControlProtocol::transport_frame() const
1258 return session->transport_frame();
1262 MackieControlProtocol::add_down_select_button (int surface, int strip)
1264 _down_select_buttons.insert ((surface<<8)|(strip&0xf));
1268 MackieControlProtocol::remove_down_select_button (int surface, int strip)
1270 DownButtonList::iterator x = find (_down_select_buttons.begin(), _down_select_buttons.end(), (surface<<8)|(strip&0xf));
1271 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down select buttons\n", surface, strip));
1272 if (x != _down_select_buttons.end()) {
1273 _down_select_buttons.erase (x);
1275 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down select buttons\n",
1281 MackieControlProtocol::select_range ()
1285 pull_route_range (_down_select_buttons, routes);
1287 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("select range: found %1 routes\n", routes.size()));
1289 if (!routes.empty()) {
1290 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1292 if (_modifier_state == MODIFIER_CONTROL) {
1293 ToggleRouteSelection ((*r)->remote_control_id ());
1295 if (r == routes.begin()) {
1296 SetRouteSelection ((*r)->remote_control_id());
1298 AddRouteToSelection ((*r)->remote_control_id());
1306 MackieControlProtocol::add_down_button (AutomationType a, int surface, int strip)
1308 DownButtonMap::iterator m = _down_buttons.find (a);
1310 if (m == _down_buttons.end()) {
1311 _down_buttons[a] = DownButtonList();
1314 _down_buttons[a].insert ((surface<<8)|(strip&0xf));
1318 MackieControlProtocol::remove_down_button (AutomationType a, int surface, int strip)
1320 DownButtonMap::iterator m = _down_buttons.find (a);
1322 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down buttons for %3\n", surface, strip, (int) a));
1324 if (m == _down_buttons.end()) {
1328 DownButtonList& l (m->second);
1329 DownButtonList::iterator x = find (l.begin(), l.end(), (surface<<8)|(strip&0xf));
1334 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down buttons for %3\n",
1335 surface, strip, (int) a));
1339 MackieControlProtocol::ControlList
1340 MackieControlProtocol::down_controls (AutomationType p)
1342 ControlList controls;
1345 DownButtonMap::iterator m = _down_buttons.find (p);
1347 if (m == _down_buttons.end()) {
1351 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("looking for down buttons for %1, got %2\n",
1352 p, m->second.size()));
1354 pull_route_range (m->second, routes);
1357 case GainAutomation:
1358 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1359 controls.push_back ((*r)->gain_control());
1362 case SoloAutomation:
1363 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1364 controls.push_back ((*r)->solo_control());
1367 case MuteAutomation:
1368 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1369 controls.push_back ((*r)->mute_control());
1372 case RecEnableAutomation:
1373 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1374 boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (*r);
1376 controls.push_back (trk->rec_enable_control());
1388 struct ButtonRangeSorter {
1389 bool operator() (const uint32_t& a, const uint32_t& b) {
1390 return (a>>8) < (b>>8) // a.surface < b.surface
1392 ((a>>8) == (b>>8) && (a&0xf) < (b&0xf)); // a.surface == b.surface && a.strip < b.strip
1397 MackieControlProtocol::pull_route_range (DownButtonList& down, RouteList& selected)
1399 ButtonRangeSorter cmp;
1405 list<uint32_t> ldown;
1406 ldown.insert (ldown.end(), down.begin(), down.end());
1409 uint32_t first = ldown.front();
1410 uint32_t last = ldown.back ();
1412 uint32_t first_surface = first>>8;
1413 uint32_t first_strip = first&0xf;
1415 uint32_t last_surface = last>>8;
1416 uint32_t last_strip = last&0xf;
1418 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("PRR %5 in list %1.%2 - %3.%4\n", first_surface, first_strip, last_surface, last_strip,
1421 for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1423 if ((*s)->number() >= first_surface && (*s)->number() <= last_surface) {
1428 if ((*s)->number() == first_surface) {
1434 if ((*s)->number() == last_surface) {
1438 ls = (*s)->n_strips ();
1441 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("adding strips for surface %1 (%2 .. %3)\n",
1442 (*s)->number(), fs, ls));
1444 for (uint32_t n = fs; n < ls; ++n) {
1445 boost::shared_ptr<Route> r = (*s)->nth_strip (n)->route();
1447 selected.push_back (r);
1455 MackieControlProtocol::set_ipmidi_base (int16_t portnum)
1457 /* this will not be saved without a session save, so .. */
1459 session->set_dirty ();
1461 _ipmidi_base = portnum;
1463 /* if the current device uses ipMIDI we need
1467 if (_active && _device_info.uses_ipmidi()) {
1468 needs_ipmidi_restart = true;
1473 MackieControlProtocol::ipmidi_restart ()
1478 switch_banks (_current_initial_bank, true);
1479 needs_ipmidi_restart = false;