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.
33 #include <boost/shared_array.hpp>
35 #include "midi++/types.h"
36 #include "midi++/port.h"
37 #include "midi++/ipmidi_port.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/automation_control.h"
44 #include "ardour/async_midi_port.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;
76 using namespace ArdourSurface;
77 using namespace Mackie;
81 #include "pbd/abstract_ui.cc" // instantiate template
83 const int MackieControlProtocol::MODIFIER_OPTION = 0x1;
84 const int MackieControlProtocol::MODIFIER_CONTROL = 0x2;
85 const int MackieControlProtocol::MODIFIER_SHIFT = 0x4;
86 const int MackieControlProtocol::MODIFIER_CMDALT = 0x8;
87 const int MackieControlProtocol::MODIFIER_ZOOM = 0x10;
88 const int MackieControlProtocol::MODIFIER_SCRUB = 0x20;
89 const int MackieControlProtocol::MAIN_MODIFIER_MASK = (MackieControlProtocol::MODIFIER_OPTION|
90 MackieControlProtocol::MODIFIER_CONTROL|
91 MackieControlProtocol::MODIFIER_SHIFT|
92 MackieControlProtocol::MODIFIER_CMDALT);
94 MackieControlProtocol* MackieControlProtocol::_instance = 0;
96 bool MackieControlProtocol::probe()
101 MackieControlProtocol::MackieControlProtocol (Session& session)
102 : ControlProtocol (session, X_("Mackie"))
103 , AbstractUI<MackieControlUIRequest> ("mackie")
104 , _current_initial_bank (0)
105 , _timecode_type (ARDOUR::AnyTime::BBT)
107 , _scrub_mode (false)
108 , _flip_mode (Normal)
111 , _current_selected_track (-1)
112 , _modifier_state (0)
113 , _ipmidi_base (MIDI::IPMIDIPort::lowest_ipmidi_port_default)
114 , needs_ipmidi_restart (false)
115 , _metering_active (true)
116 , _initialized (false)
117 , _surfaces_state (0)
118 , _surfaces_version (0)
119 , _session_load (true)
121 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
123 DeviceInfo::reload_device_info ();
124 DeviceProfile::reload_device_profiles ();
126 TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::gui_track_selection_changed, this, _1, true), this);
133 MackieControlProtocol::~MackieControlProtocol()
135 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol init\n");
137 for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
141 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol drop_connections ()\n");
144 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol tear_down_gui ()\n");
147 delete _surfaces_state;
149 /* stop event loop */
150 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol BaseUI::quit ()\n");
154 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol close()\n");
157 catch (exception & e) {
158 cout << "~MackieControlProtocol caught " << e.what() << endl;
161 cout << "~MackieControlProtocol caught unknown" << endl;
166 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol done\n");
170 MackieControlProtocol::thread_init ()
172 struct sched_param rtparam;
174 pthread_set_name (X_("MackieControl"));
176 PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("MackieControl"), 2048);
177 ARDOUR::SessionEvent::create_per_thread_pool (X_("MackieControl"), 128);
179 memset (&rtparam, 0, sizeof (rtparam));
180 rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
182 if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
183 // do we care? not particularly.
188 MackieControlProtocol::ping_devices ()
190 /* should not be called if surfaces are not connected, but will not
191 * malfunction if it is.
194 for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
199 // go to the previous track.
200 // Assume that get_sorted_routes().size() > route_table.size()
202 MackieControlProtocol::prev_track()
204 if (_current_initial_bank >= 1) {
205 switch_banks (_current_initial_bank - 1);
209 // go to the next track.
210 // Assume that get_sorted_routes().size() > route_table.size()
212 MackieControlProtocol::next_track()
214 Sorted sorted = get_sorted_routes();
215 if (_current_initial_bank + n_strips() < sorted.size()) {
216 switch_banks (_current_initial_bank + 1);
221 MackieControlProtocol::route_is_locked_to_strip (boost::shared_ptr<Route> r) const
223 for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
224 if ((*si)->route_is_locked_to_strip (r)) {
231 // predicate for sort call in get_sorted_routes
232 struct RouteByRemoteId
234 bool operator () (const boost::shared_ptr<Route> & a, const boost::shared_ptr<Route> & b) const
236 return a->remote_control_id() < b->remote_control_id();
239 bool operator () (const Route & a, const Route & b) const
241 return a.remote_control_id() < b.remote_control_id();
244 bool operator () (const Route * a, const Route * b) const
246 return a->remote_control_id() < b->remote_control_id();
250 MackieControlProtocol::Sorted
251 MackieControlProtocol::get_sorted_routes()
256 boost::shared_ptr<RouteList> routes = session->get_routes();
257 set<uint32_t> remote_ids;
259 // routes with remote_id 0 should never be added
260 // TODO verify this with ardour devs
261 // remote_ids.insert (0);
263 // sort in remote_id order, and exclude master, control and hidden routes
264 // and any routes that are already set.
266 for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it) {
268 boost::shared_ptr<Route> route = *it;
270 if (remote_ids.find (route->remote_control_id()) != remote_ids.end()) {
274 if (route->is_auditioner() || route->is_master() || route->is_monitor()) {
278 /* don't include locked routes */
280 if (route_is_locked_to_strip(route)) {
283 /* This next section which is not used yet, looks wrong to me
284 The first four belong here but the bottom five are not a selection
285 of routes and belong elsewhere as they are v-pot modes.
287 switch (_view_mode) {
300 sorted.push_back (*it);
301 remote_ids.insert (route->remote_control_id());
304 sort (sorted.begin(), sorted.end(), RouteByRemoteId());
309 MackieControlProtocol::refresh_current_bank()
311 switch_banks (_current_initial_bank, true);
315 MackieControlProtocol::n_strips (bool with_locked_strips) const
317 uint32_t strip_count = 0;
319 for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
320 strip_count += (*si)->n_strips (with_locked_strips);
327 MackieControlProtocol::switch_banks (uint32_t initial, bool force)
329 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch banking to start at %1 force ? %2 current = %3\n", initial, force, _current_initial_bank));
331 if (initial == _current_initial_bank && !force) {
335 Sorted sorted = get_sorted_routes();
336 uint32_t strip_cnt = n_strips (false); // do not include locked strips
339 if (sorted.size() <= strip_cnt && _current_initial_bank == 0 && !force) {
340 /* no banking - not enough routes to fill all strips and we're
341 * not at the first one.
345 set_flip_mode (Normal);
346 _current_initial_bank = initial;
347 _current_selected_track = -1;
349 // Map current bank of routes onto each surface(+strip)
351 if (_current_initial_bank <= sorted.size()) {
353 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch to %1, %2, available routes %3 on %4 surfaces\n",
354 _current_initial_bank, strip_cnt, sorted.size(),
357 // link routes to strips
359 Sorted::iterator r = sorted.begin() + _current_initial_bank;
361 for (Surfaces::iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
362 vector<boost::shared_ptr<Route> > routes;
365 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has %1 unlockedstrips\n", (*si)->n_strips (false)));
367 for (; r != sorted.end() && added < (*si)->n_strips (false); ++r, ++added) {
368 routes.push_back (*r);
371 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("give surface %1 routes\n", routes.size()));
373 (*si)->map_routes (routes);
377 /* reset this to get the right display of view mode after the switch */
378 set_view_mode (_view_mode);
380 /* make sure selection is correct */
382 _gui_track_selection_changed (&_last_selected_routes, false);
384 /* current bank has not been saved */
385 session->set_dirty();
389 MackieControlProtocol::set_active (bool yn)
391 DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active init with yn: '%1'\n", yn));
393 if (yn == active()) {
399 /* start event loop */
403 connect_session_signals ();
405 if (!_device_info.name().empty()) {
406 set_device (_device_info.name(), true);
409 /* set up periodic task for metering and automation
412 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
413 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
414 periodic_timeout->attach (main_loop()->get_context());
416 /* a faster periodic task used to display parameter updates */
418 Glib::RefPtr<Glib::TimeoutSource> redisplay_timeout = Glib::TimeoutSource::create (10); // milliseconds
419 redisplay_connection = redisplay_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::redisplay));
420 redisplay_timeout->attach (main_loop()->get_context());
429 ControlProtocol::set_active (yn);
431 DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active done with yn: '%1'\n", yn));
437 MackieControlProtocol::hui_heartbeat ()
439 Glib::Threads::Mutex::Lock lm (surfaces_lock);
441 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
442 (*s)->hui_heartbeat ();
449 MackieControlProtocol::periodic ()
455 if (needs_ipmidi_restart) {
464 ARDOUR::microseconds_t now_usecs = ARDOUR::get_microseconds ();
467 Glib::Threads::Mutex::Lock lm (surfaces_lock);
469 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
470 (*s)->periodic (now_usecs);
474 update_timecode_display ();
480 MackieControlProtocol::redisplay ()
486 if (needs_ipmidi_restart) {
495 ARDOUR::microseconds_t now = ARDOUR::get_microseconds ();
498 Glib::Threads::Mutex::Lock lm (surfaces_lock);
500 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
501 (*s)->redisplay (now);
509 MackieControlProtocol::update_timecode_beats_led()
511 if (!_device_info.has_timecode_display()) {
515 DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::update_timecode_beats_led(): %1\n", _timecode_type));
516 switch (_timecode_type) {
517 case ARDOUR::AnyTime::BBT:
518 update_global_led (Led::Beats, on);
519 update_global_led (Led::Timecode, off);
521 case ARDOUR::AnyTime::Timecode:
522 update_global_led (Led::Timecode, on);
523 update_global_led (Led::Beats, off);
527 os << "Unknown Anytime::Type " << _timecode_type;
528 throw runtime_error (os.str());
533 MackieControlProtocol::update_global_button (int id, LedState ls)
535 Glib::Threads::Mutex::Lock lm (surfaces_lock);
537 if (surfaces.empty()) {
541 if (!_device_info.has_global_controls()) {
544 // surface needs to be master surface
545 boost::shared_ptr<Surface> surface = _master_surface;
547 map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
548 if (x != surface->controls_by_device_independent_id.end()) {
549 Button * button = dynamic_cast<Button*> (x->second);
550 surface->write (button->set_state (ls));
552 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", id));
557 MackieControlProtocol::update_global_led (int id, LedState ls)
559 Glib::Threads::Mutex::Lock lm (surfaces_lock);
561 if (surfaces.empty()) {
565 if (!_device_info.has_global_controls()) {
568 boost::shared_ptr<Surface> surface = _master_surface;
570 map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
572 if (x != surface->controls_by_device_independent_id.end()) {
573 Led * led = dynamic_cast<Led*> (x->second);
574 DEBUG_TRACE (DEBUG::MackieControl, "Writing LedState\n");
575 surface->write (led->set_state (ls));
577 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", id));
582 MackieControlProtocol::device_ready ()
584 /* this is not required to be called, but for devices which do
585 * handshaking, it can be called once the device has verified the
589 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("device ready init (active=%1)\n", active()));
593 // send messages to surface to set controls to correct values
595 MackieControlProtocol::update_surfaces()
597 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::update_surfaces() init (active=%1)\n", active()));
602 // do the initial bank switch to connect signals
603 // _current_initial_bank is initialised by set_state
604 switch_banks (_current_initial_bank, true);
606 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::update_surfaces() finished\n");
610 MackieControlProtocol::initialize()
613 Glib::Threads::Mutex::Lock lm (surfaces_lock);
615 if (surfaces.empty()) {
619 if (!_master_surface->active ()) {
623 // sometimes the jog wheel is a pot
624 if (_device_info.has_jog_wheel()) {
625 _master_surface->blank_jog_ring ();
629 // update global buttons and displays
631 notify_record_state_changed();
632 notify_transport_state_changed();
633 update_timecode_beats_led();
639 MackieControlProtocol::connect_session_signals()
641 // receive routes added
642 session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_route_added, this, _1), this);
643 // receive record state toggled
644 session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_record_state_changed, this), this);
645 // receive transport state changed
646 session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
647 session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
648 // receive punch-in and punch-out
649 Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
650 session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
651 // receive rude solo changed
652 session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), this);
654 // make sure remote id changed signals reach here
655 // see also notify_route_added
656 Sorted sorted = get_sorted_routes();
658 for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
659 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
664 MackieControlProtocol::set_profile (const string& profile_name)
666 if (profile_name == "default") {
667 /* reset to default */
668 _device_profile = DeviceProfile (profile_name);
671 map<string,DeviceProfile>::iterator d = DeviceProfile::device_profiles.find (profile_name);
673 if (d == DeviceProfile::device_profiles.end()) {
677 _device_profile = d->second;
681 MackieControlProtocol::set_device_info (const string& device_name)
683 map<string,DeviceInfo>::iterator d = DeviceInfo::device_info.find (device_name);
685 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("new device chosen %1\n", device_name));
687 if (d == DeviceInfo::device_info.end()) {
691 _device_info = d->second;
697 MackieControlProtocol::set_device (const string& device_name, bool force)
699 if (device_name == device_info().name() && !force) {
700 /* already using that device, nothing to do */
704 /* get state from the current setup, and make sure it is stored in
705 the _surface_states node so that if we switch back to this device,
706 we will have its state available.
709 if (!_surfaces_state) {
710 _surfaces_state = new XMLNode (X_("Surfaces"));
714 Glib::Threads::Mutex::Lock lm (surfaces_lock);
716 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
717 update_surface_state (*s);
721 if (set_device_info (device_name)) {
726 port_connection.disconnect ();
727 hui_connection.disconnect ();
729 if (_device_info.device_type() == DeviceInfo::HUI) {
730 Glib::RefPtr<Glib::TimeoutSource> hui_timeout = Glib::TimeoutSource::create (1000); // milliseconds
731 hui_connection = hui_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::hui_heartbeat));
732 hui_timeout->attach (main_loop()->get_context());
735 if (!_device_info.uses_ipmidi()) {
736 /* notice that the handler for this will execute in our event
737 loop, not in the thread where the
738 PortConnectedOrDisconnected signal is emitted.
740 ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::connection_handler, this, _1, _2, _3, _4, _5), this);
743 if (create_surfaces ()) {
753 ArdourSurface::ipmidi_input_handler (GIOChannel*, GIOCondition condition, void *data)
755 ArdourSurface::MackieControlProtocol::ipMIDIHandler* ipm = static_cast<ArdourSurface::MackieControlProtocol::ipMIDIHandler*>(data);
756 return ipm->mcp->midi_input_handler (Glib::IOCondition (condition), ipm->port);
760 MackieControlProtocol::create_surfaces ()
763 surface_type_t stype = mcu; // type not yet determined
765 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Create %1 surfaces for %2\n", 1 + _device_info.extenders(), _device_info.name()));
767 if (!_device_info.uses_ipmidi()) {
768 _input_bundle.reset (new ARDOUR::Bundle (_("Mackie Control In"), true));
769 _output_bundle.reset (new ARDOUR::Bundle (_("Mackie Control Out"), false));
771 _input_bundle.reset ();
772 _output_bundle.reset ();
775 for (uint32_t n = 0; n < 1 + _device_info.extenders(); ++n) {
776 bool is_master = false;
778 if (n == _device_info.master_position()) {
780 if (_device_info.extenders() == 0) {
781 device_name = _device_info.name();
783 device_name = X_("mackie control");
789 device_name = string_compose (X_("mackie control ext %1"), n+1);
791 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Port Name for surface %1 is %2\n", n, device_name));
793 boost::shared_ptr<Surface> surface;
801 surface.reset (new Surface (*this, device_name, n, stype));
807 _master_surface = surface;
810 if (_surfaces_state) {
811 surface->set_state (*_surfaces_state, _surfaces_version);
815 Glib::Threads::Mutex::Lock lm (surfaces_lock);
816 surfaces.push_back (surface);
819 if (!_device_info.uses_ipmidi()) {
821 _input_bundle->add_channel (
822 surface->port().input_port().name(),
823 ARDOUR::DataType::MIDI,
824 session->engine().make_port_name_non_relative (surface->port().input_port().name())
827 _output_bundle->add_channel (
828 surface->port().output_port().name(),
829 ARDOUR::DataType::MIDI,
830 session->engine().make_port_name_non_relative (surface->port().output_port().name())
834 MIDI::Port& input_port (surface->port().input_port());
835 AsyncMIDIPort* asp = dynamic_cast<AsyncMIDIPort*> (&input_port);
839 /* async MIDI port */
841 asp->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &MackieControlProtocol::midi_input_handler), &input_port));
842 asp->xthread().attach (main_loop()->get_context());
846 /* ipMIDI port, no IOSource method at this time */
850 if ((fd = input_port.selectable ()) >= 0) {
852 GIOChannel* ioc = g_io_channel_unix_new (fd);
853 surface->input_source = g_io_create_watch (ioc, GIOCondition (G_IO_IN|G_IO_HUP|G_IO_ERR));
855 /* make surface's input source now hold the
856 * only reference on the IO channel
858 g_io_channel_unref (ioc);
860 /* hack up an object so that in the callback from the event loop
861 we have both the MackieControlProtocol and the input port.
863 If we were using C++ for this stuff we wouldn't need this
864 but a nasty, not-fixable bug in the binding between C
865 and C++ makes it necessary to avoid C++ for the IO
869 ipMIDIHandler* ipm = new ipMIDIHandler (); /* we will leak this sizeof(pointer)*2 sized object */
871 ipm->port = &input_port;
873 g_source_set_callback (surface->input_source, (GSourceFunc) ipmidi_input_handler, ipm, NULL);
874 g_source_attach (surface->input_source, main_loop()->get_context()->gobj());
879 if (!_device_info.uses_ipmidi()) {
880 Glib::Threads::Mutex::Lock lm (surfaces_lock);
881 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
882 (*s)->port().reconnect ();
886 session->BundleAddedOrRemoved ();
888 assert (_master_surface);
894 MackieControlProtocol::close()
896 port_connection.disconnect ();
897 session_connections.drop_connections ();
898 route_connections.drop_connections ();
899 periodic_connection.disconnect ();
904 /** Ensure that the _surfaces_state XML node contains an up-to-date
905 * copy of the state node for @param surface. If _surfaces_state already
906 * contains a state node for @param surface, it will deleted and replaced.
909 MackieControlProtocol::update_surface_state (boost::shared_ptr<Surface> surface)
911 assert (_surfaces_state);
912 _surfaces_state->remove_nodes_and_delete (X_("name"), surface->name());
913 _surfaces_state->add_child_nocopy (surface->get_state());
917 MackieControlProtocol::get_state()
919 XMLNode& node (ControlProtocol::get_state());
921 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state init\n");
925 snprintf (buf, sizeof (buf), "%d", _current_initial_bank);
926 node.add_property (X_("bank"), buf);
928 // ipMIDI base port (possibly not used)
929 snprintf (buf, sizeof (buf), "%d", _ipmidi_base);
930 node.add_property (X_("ipmidi-base"), buf);
932 node.add_property (X_("device-profile"), _device_profile.name());
933 node.add_property (X_("device-name"), _device_info.name());
935 if (!_surfaces_state) {
936 _surfaces_state = new XMLNode (X_("Surfaces"));
940 Glib::Threads::Mutex::Lock lm (surfaces_lock);
941 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
942 update_surface_state (*s);
946 /* force a copy of the _surfaces_state node, because we want to retain ownership */
947 node.add_child_copy (*_surfaces_state);
949 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state done\n");
955 MackieControlProtocol::set_state (const XMLNode & node, int version)
957 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", active()));
960 const XMLProperty* prop;
963 if (ControlProtocol::set_state (node, version)) {
967 if ((prop = node.property (X_("ipmidi-base"))) != 0) {
968 set_ipmidi_base (atoi (prop->value()));
971 // fetch current bank
972 if ((prop = node.property (X_("bank"))) != 0) {
973 bank = atoi (prop->value());
976 if ((prop = node.property (X_("device-name"))) != 0) {
977 set_device_info (prop->value());
980 if ((prop = node.property (X_("device-profile"))) != 0) {
981 set_profile (prop->value());
984 XMLNode* snode = node.child (X_("Surfaces"));
986 delete _surfaces_state;
990 _surfaces_state = new XMLNode (*snode);
991 _surfaces_version = version;
994 switch_banks (bank, true);
996 DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::set_state done\n");
1002 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
1004 Timecode::BBT_Time bbt_time;
1006 session->bbt_time (now_frame, bbt_time);
1008 // The Mackie protocol spec is built around a BBT time display of
1010 // digits: 888/88/88/888
1011 // semantics: BBB/bb/ss/ttt
1013 // The third field is "subdivisions" which is a concept found in Logic
1014 // but not present in Ardour. Instead Ardour displays a 4 digit tick
1015 // count, which we need to spread across the 5 digits of ss/ttt.
1019 os << setw(3) << setfill('0') << bbt_time.bars;
1020 os << setw(2) << setfill('0') << bbt_time.beats;
1022 os << setw(1) << setfill('0') << bbt_time.ticks / 1000;
1023 os << setw(3) << setfill('0') << bbt_time.ticks % 1000;
1029 MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
1031 Timecode::Time timecode;
1032 session->timecode_time (now_frame, timecode);
1034 // According to the Logic docs
1035 // digits: 888/88/88/888
1036 // Timecode mode: Hours/Minutes/Seconds/Frames
1038 os << setw(2) << setfill('0') << timecode.hours;
1040 os << setw(2) << setfill('0') << timecode.minutes;
1041 os << setw(2) << setfill('0') << timecode.seconds;
1043 os << setw(2) << setfill('0') << timecode.frames;
1049 MackieControlProtocol::update_timecode_display()
1051 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1053 if (surfaces.empty()) {
1057 boost::shared_ptr<Surface> surface = _master_surface;
1059 if (surface->type() != mcu || !_device_info.has_timecode_display() || !surface->active ()) {
1063 // do assignment here so current_frame is fixed
1064 framepos_t current_frame = session->transport_frame();
1067 switch (_timecode_type) {
1068 case ARDOUR::AnyTime::BBT:
1069 timecode = format_bbt_timecode (current_frame);
1071 case ARDOUR::AnyTime::Timecode:
1072 timecode = format_timecode_timecode (current_frame);
1078 // only write the timecode string to the MCU if it's changed
1079 // since last time. This is to reduce midi bandwidth used.
1080 if (timecode != _timecode_last) {
1081 surface->display_timecode (timecode, _timecode_last);
1082 _timecode_last = timecode;
1086 ///////////////////////////////////////////
1088 ///////////////////////////////////////////
1090 void MackieControlProtocol::notify_parameter_changed (std::string const & p)
1092 if (p == "punch-in") {
1093 // no such button right now
1094 // update_global_button (Button::PunchIn, session->config.get_punch_in());
1095 } else if (p == "punch-out") {
1096 // no such button right now
1097 // update_global_button (Button::PunchOut, session->config.get_punch_out());
1098 } else if (p == "clicking") {
1099 update_global_button (Button::Click, Config->get_clicking());
1101 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
1105 // RouteList is the set of routes that have just been added
1107 MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
1110 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1112 if (surfaces.empty()) {
1117 // currently assigned banks are less than the full set of
1118 // strips, so activate the new strip now.
1120 refresh_current_bank();
1122 // otherwise route added, but current bank needs no updating
1124 // make sure remote id changes in the new route are handled
1125 typedef ARDOUR::RouteList ARS;
1127 for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
1128 (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
1133 MackieControlProtocol::notify_solo_active_changed (bool active)
1135 boost::shared_ptr<Surface> surface;
1138 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1140 if (surfaces.empty()) {
1144 surface = _master_surface;
1147 map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Led::RudeSolo);
1148 if (x != surface->controls_by_device_independent_id.end()) {
1149 Led* rude_solo = dynamic_cast<Led*> (x->second);
1151 surface->write (rude_solo->set_state (active ? flashing : off));
1157 MackieControlProtocol::notify_remote_id_changed()
1160 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1162 if (surfaces.empty()) {
1167 Sorted sorted = get_sorted_routes();
1168 uint32_t sz = n_strips();
1170 // if a remote id has been moved off the end, we need to shift
1171 // the current bank backwards.
1173 if (sorted.size() - _current_initial_bank < sz) {
1174 // but don't shift backwards past the zeroth channel
1175 switch_banks (max((Sorted::size_type) 0, sorted.size() - sz));
1177 // Otherwise just refresh the current bank
1178 refresh_current_bank();
1182 ///////////////////////////////////////////
1183 // Transport signals
1184 ///////////////////////////////////////////
1187 MackieControlProtocol::notify_loop_state_changed()
1189 update_global_button (Button::Loop, session->get_play_loop());
1193 MackieControlProtocol::notify_transport_state_changed()
1195 if (!_device_info.has_global_controls()) {
1199 // switch various play and stop buttons on / off
1200 update_global_button (Button::Loop, session->get_play_loop());
1201 update_global_button (Button::Play, session->transport_speed() == 1.0);
1202 update_global_button (Button::Stop, session->transport_stopped ());
1203 update_global_button (Button::Rewind, session->transport_speed() < 0.0);
1204 update_global_button (Button::Ffwd, session->transport_speed() > 1.0);
1206 notify_metering_state_changed ();
1210 MackieControlProtocol::notify_metering_state_changed()
1212 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1214 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1215 (*s)->notify_metering_state_changed ();
1220 MackieControlProtocol::notify_record_state_changed ()
1222 if (!_device_info.has_global_controls()) {
1226 boost::shared_ptr<Surface> surface;
1229 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1230 if (surfaces.empty()) {
1233 surface = _master_surface;
1236 /* rec is a tristate */
1238 map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Button::Record);
1239 if (x != surface->controls_by_device_independent_id.end()) {
1240 Button * rec = dynamic_cast<Button*> (x->second);
1244 switch (session->record_status()) {
1245 case Session::Disabled:
1246 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to disabled, LED off\n");
1249 case Session::Recording:
1250 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to recording, LED on\n");
1253 case Session::Enabled:
1254 DEBUG_TRACE (DEBUG::MackieControl, "record state changed to enabled, LED flashing\n");
1259 surface->write (rec->set_state (ls));
1264 list<boost::shared_ptr<ARDOUR::Bundle> >
1265 MackieControlProtocol::bundles ()
1267 list<boost::shared_ptr<ARDOUR::Bundle> > b;
1269 if (_input_bundle) {
1270 b.push_back (_input_bundle);
1271 b.push_back (_output_bundle);
1278 MackieControlProtocol::do_request (MackieControlUIRequest* req)
1280 if (req->type == CallSlot) {
1282 call_slot (MISSING_INVALIDATOR, req->the_slot);
1284 } else if (req->type == Quit) {
1291 MackieControlProtocol::stop ()
1299 MackieControlProtocol::update_led (Surface& surface, Button& button, Mackie::LedState ls)
1302 surface.port().write (button.set_state (ls));
1307 MackieControlProtocol::build_button_map ()
1309 /* this maps our device-independent button codes to the methods that handle them.
1312 #define DEFINE_BUTTON_HANDLER(b,p,r) button_map.insert (pair<Button::ID,ButtonHandlers> ((b), ButtonHandlers ((p),(r))));
1314 DEFINE_BUTTON_HANDLER (Button::Track, &MackieControlProtocol::track_press, &MackieControlProtocol::track_release);
1315 DEFINE_BUTTON_HANDLER (Button::Send, &MackieControlProtocol::send_press, &MackieControlProtocol::send_release);
1316 DEFINE_BUTTON_HANDLER (Button::Pan, &MackieControlProtocol::pan_press, &MackieControlProtocol::pan_release);
1317 DEFINE_BUTTON_HANDLER (Button::Plugin, &MackieControlProtocol::plugin_press, &MackieControlProtocol::plugin_release);
1318 DEFINE_BUTTON_HANDLER (Button::Eq, &MackieControlProtocol::eq_press, &MackieControlProtocol::eq_release);
1319 DEFINE_BUTTON_HANDLER (Button::Dyn, &MackieControlProtocol::dyn_press, &MackieControlProtocol::dyn_release);
1320 DEFINE_BUTTON_HANDLER (Button::Left, &MackieControlProtocol::left_press, &MackieControlProtocol::left_release);
1321 DEFINE_BUTTON_HANDLER (Button::Right, &MackieControlProtocol::right_press, &MackieControlProtocol::right_release);
1322 DEFINE_BUTTON_HANDLER (Button::ChannelLeft, &MackieControlProtocol::channel_left_press, &MackieControlProtocol::channel_left_release);
1323 DEFINE_BUTTON_HANDLER (Button::ChannelRight, &MackieControlProtocol::channel_right_press, &MackieControlProtocol::channel_right_release);
1324 DEFINE_BUTTON_HANDLER (Button::Flip, &MackieControlProtocol::flip_press, &MackieControlProtocol::flip_release);
1325 DEFINE_BUTTON_HANDLER (Button::View, &MackieControlProtocol::view_press, &MackieControlProtocol::view_release);
1326 DEFINE_BUTTON_HANDLER (Button::NameValue, &MackieControlProtocol::name_value_press, &MackieControlProtocol::name_value_release);
1327 DEFINE_BUTTON_HANDLER (Button::TimecodeBeats, &MackieControlProtocol::timecode_beats_press, &MackieControlProtocol::timecode_beats_release);
1328 DEFINE_BUTTON_HANDLER (Button::F1, &MackieControlProtocol::F1_press, &MackieControlProtocol::F1_release);
1329 DEFINE_BUTTON_HANDLER (Button::F2, &MackieControlProtocol::F2_press, &MackieControlProtocol::F2_release);
1330 DEFINE_BUTTON_HANDLER (Button::F3, &MackieControlProtocol::F3_press, &MackieControlProtocol::F3_release);
1331 DEFINE_BUTTON_HANDLER (Button::F4, &MackieControlProtocol::F4_press, &MackieControlProtocol::F4_release);
1332 DEFINE_BUTTON_HANDLER (Button::F5, &MackieControlProtocol::F5_press, &MackieControlProtocol::F5_release);
1333 DEFINE_BUTTON_HANDLER (Button::F6, &MackieControlProtocol::F6_press, &MackieControlProtocol::F6_release);
1334 DEFINE_BUTTON_HANDLER (Button::F7, &MackieControlProtocol::F7_press, &MackieControlProtocol::F7_release);
1335 DEFINE_BUTTON_HANDLER (Button::F8, &MackieControlProtocol::F8_press, &MackieControlProtocol::F8_release);
1336 DEFINE_BUTTON_HANDLER (Button::MidiTracks, &MackieControlProtocol::miditracks_press, &MackieControlProtocol::miditracks_release);
1337 DEFINE_BUTTON_HANDLER (Button::Inputs, &MackieControlProtocol::inputs_press, &MackieControlProtocol::inputs_release);
1338 DEFINE_BUTTON_HANDLER (Button::AudioTracks, &MackieControlProtocol::audiotracks_press, &MackieControlProtocol::audiotracks_release);
1339 DEFINE_BUTTON_HANDLER (Button::AudioInstruments, &MackieControlProtocol::audioinstruments_press, &MackieControlProtocol::audioinstruments_release);
1340 DEFINE_BUTTON_HANDLER (Button::Aux, &MackieControlProtocol::aux_press, &MackieControlProtocol::aux_release);
1341 DEFINE_BUTTON_HANDLER (Button::Busses, &MackieControlProtocol::busses_press, &MackieControlProtocol::busses_release);
1342 DEFINE_BUTTON_HANDLER (Button::Outputs, &MackieControlProtocol::outputs_press, &MackieControlProtocol::outputs_release);
1343 DEFINE_BUTTON_HANDLER (Button::User, &MackieControlProtocol::user_press, &MackieControlProtocol::user_release);
1344 DEFINE_BUTTON_HANDLER (Button::Shift, &MackieControlProtocol::shift_press, &MackieControlProtocol::shift_release);
1345 DEFINE_BUTTON_HANDLER (Button::Option, &MackieControlProtocol::option_press, &MackieControlProtocol::option_release);
1346 DEFINE_BUTTON_HANDLER (Button::Ctrl, &MackieControlProtocol::control_press, &MackieControlProtocol::control_release);
1347 DEFINE_BUTTON_HANDLER (Button::CmdAlt, &MackieControlProtocol::cmd_alt_press, &MackieControlProtocol::cmd_alt_release);
1348 DEFINE_BUTTON_HANDLER (Button::Read, &MackieControlProtocol::read_press, &MackieControlProtocol::read_release);
1349 DEFINE_BUTTON_HANDLER (Button::Write, &MackieControlProtocol::write_press, &MackieControlProtocol::write_release);
1350 DEFINE_BUTTON_HANDLER (Button::Trim, &MackieControlProtocol::trim_press, &MackieControlProtocol::trim_release);
1351 DEFINE_BUTTON_HANDLER (Button::Touch, &MackieControlProtocol::touch_press, &MackieControlProtocol::touch_release);
1352 DEFINE_BUTTON_HANDLER (Button::Latch, &MackieControlProtocol::latch_press, &MackieControlProtocol::latch_release);
1353 DEFINE_BUTTON_HANDLER (Button::Grp, &MackieControlProtocol::grp_press, &MackieControlProtocol::grp_release);
1354 DEFINE_BUTTON_HANDLER (Button::Save, &MackieControlProtocol::save_press, &MackieControlProtocol::save_release);
1355 DEFINE_BUTTON_HANDLER (Button::Undo, &MackieControlProtocol::undo_press, &MackieControlProtocol::undo_release);
1356 DEFINE_BUTTON_HANDLER (Button::Cancel, &MackieControlProtocol::cancel_press, &MackieControlProtocol::cancel_release);
1357 DEFINE_BUTTON_HANDLER (Button::Enter, &MackieControlProtocol::enter_press, &MackieControlProtocol::enter_release);
1358 DEFINE_BUTTON_HANDLER (Button::Marker, &MackieControlProtocol::marker_press, &MackieControlProtocol::marker_release);
1359 DEFINE_BUTTON_HANDLER (Button::Nudge, &MackieControlProtocol::nudge_press, &MackieControlProtocol::nudge_release);
1360 DEFINE_BUTTON_HANDLER (Button::Loop, &MackieControlProtocol::loop_press, &MackieControlProtocol::loop_release);
1361 DEFINE_BUTTON_HANDLER (Button::Drop, &MackieControlProtocol::drop_press, &MackieControlProtocol::drop_release);
1362 DEFINE_BUTTON_HANDLER (Button::Replace, &MackieControlProtocol::replace_press, &MackieControlProtocol::replace_release);
1363 DEFINE_BUTTON_HANDLER (Button::Click, &MackieControlProtocol::click_press, &MackieControlProtocol::click_release);
1364 DEFINE_BUTTON_HANDLER (Button::ClearSolo, &MackieControlProtocol::clearsolo_press, &MackieControlProtocol::clearsolo_release);
1365 DEFINE_BUTTON_HANDLER (Button::Rewind, &MackieControlProtocol::rewind_press, &MackieControlProtocol::rewind_release);
1366 DEFINE_BUTTON_HANDLER (Button::Ffwd, &MackieControlProtocol::ffwd_press, &MackieControlProtocol::ffwd_release);
1367 DEFINE_BUTTON_HANDLER (Button::Stop, &MackieControlProtocol::stop_press, &MackieControlProtocol::stop_release);
1368 DEFINE_BUTTON_HANDLER (Button::Play, &MackieControlProtocol::play_press, &MackieControlProtocol::play_release);
1369 DEFINE_BUTTON_HANDLER (Button::Record, &MackieControlProtocol::record_press, &MackieControlProtocol::record_release);
1370 DEFINE_BUTTON_HANDLER (Button::CursorUp, &MackieControlProtocol::cursor_up_press, &MackieControlProtocol::cursor_up_release);
1371 DEFINE_BUTTON_HANDLER (Button::CursorDown, &MackieControlProtocol::cursor_down_press, &MackieControlProtocol::cursor_down_release);
1372 DEFINE_BUTTON_HANDLER (Button::CursorLeft, &MackieControlProtocol::cursor_left_press, &MackieControlProtocol::cursor_left_release);
1373 DEFINE_BUTTON_HANDLER (Button::CursorRight, &MackieControlProtocol::cursor_right_press, &MackieControlProtocol::cursor_right_release);
1374 DEFINE_BUTTON_HANDLER (Button::Zoom, &MackieControlProtocol::zoom_press, &MackieControlProtocol::zoom_release);
1375 DEFINE_BUTTON_HANDLER (Button::Scrub, &MackieControlProtocol::scrub_press, &MackieControlProtocol::scrub_release);
1376 DEFINE_BUTTON_HANDLER (Button::UserA, &MackieControlProtocol::user_a_press, &MackieControlProtocol::user_a_release);
1377 DEFINE_BUTTON_HANDLER (Button::UserB, &MackieControlProtocol::user_b_press, &MackieControlProtocol::user_b_release);
1378 DEFINE_BUTTON_HANDLER (Button::MasterFaderTouch, &MackieControlProtocol::master_fader_touch_press, &MackieControlProtocol::master_fader_touch_release);
1383 MackieControlProtocol::handle_button_event (Surface& surface, Button& button, ButtonState bs)
1385 Button::ID button_id = button.bid();
1387 if (bs != press && bs != release) {
1388 update_led (surface, button, none);
1392 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2 (%3)\n", (bs == press ? "press" : "release"), button.id(),
1393 Button::id_to_name (button.bid())));
1395 /* check profile first */
1397 string action = _device_profile.get_button_action (button.bid(), _modifier_state);
1399 if (!action.empty()) {
1401 if (action.find ('/') != string::npos) { /* good chance that this is really an action */
1403 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Looked up action for button %1 with modifier %2, got [%3]\n",
1404 button.bid(), _modifier_state, action));
1406 /* if there is a bound action for this button, and this is a press event,
1407 carry out the action. If its a release event, do nothing since we
1408 don't bind to them at all but don't want any other handling to
1412 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("executing action %1\n", action));
1413 access_action (action);
1420 /* "action" is more likely to be a button name. We use this to
1421 * allow remapping buttons to different (builtin) functionality
1422 * associated with an existing button. This is similar to the
1423 * way that (for example) Nuendo moves the "Shift" function to
1424 * the "Enter" key of the MCU Pro.
1427 int bid = Button::name_to_id (action);
1430 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("apparent button name %1 not found\n", action));
1434 button_id = (Button::ID) bid;
1435 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handling button %1 as if it was %2 (%3)\n", Button::id_to_name (button.bid()), button_id, Button::id_to_name (button_id)));
1439 /* lookup using the device-INDEPENDENT button ID */
1441 ButtonMap::iterator b = button_map.find (button_id);
1443 if (b != button_map.end()) {
1445 ButtonHandlers& bh (b->second);
1449 surface.write (button.set_state ((this->*(bh.press)) (button)));
1452 surface.write (button.set_state ((this->*(bh.release)) (button)));
1458 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1459 button.bid(), button.id()));
1460 error << string_compose ("no button handlers for button ID %1 (device ID %2)\n",
1461 button.bid(), button.id()) << endmsg;
1466 MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
1469 DEBUG_TRACE (DEBUG::MackieControl, "MIDI port closed\n");
1475 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("something happend on %1\n", port->name()));
1477 /* Devices using regular JACK MIDI ports will need to have
1478 the x-thread FIFO drained to avoid burning endless CPU.
1480 Devices using ipMIDI have port->selectable() as the same
1481 file descriptor that data arrives on, so doing this
1482 for them will simply throw all incoming data away.
1485 if (!_device_info.uses_ipmidi()) {
1486 AsyncMIDIPort* asp = dynamic_cast<AsyncMIDIPort*>(port);
1492 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("data available on %1\n", port->name()));
1493 framepos_t now = session->engine().sample_time();
1501 MackieControlProtocol::clear_ports ()
1503 if (_input_bundle) {
1504 _input_bundle->remove_channels ();
1505 _output_bundle->remove_channels ();
1510 MackieControlProtocol::set_view_mode (ViewMode m)
1512 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1516 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1517 (*s)->update_view_mode_display ();
1523 MackieControlProtocol::set_flip_mode (FlipMode fm)
1525 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1529 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1530 (*s)->update_flip_mode_display ();
1535 MackieControlProtocol::set_pot_mode (PotMode m)
1537 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1541 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1542 (*s)->update_potmode ();
1549 MackieControlProtocol::set_master_on_surface_strip (uint32_t surface, uint32_t strip_number)
1551 force_special_route_to_strip (session->master_out(), surface, strip_number);
1555 MackieControlProtocol::set_monitor_on_surface_strip (uint32_t surface, uint32_t strip_number)
1557 force_special_route_to_strip (session->monitor_out(), surface, strip_number);
1561 MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r, uint32_t surface, uint32_t strip_number)
1567 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1569 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1570 if ((*s)->number() == surface) {
1571 Strip* strip = (*s)->nth_strip (strip_number);
1573 strip->set_route (session->master_out());
1574 strip->lock_controls ();
1581 MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl, bool save_list)
1583 _gui_track_selection_changed (rl.get(), save_list);
1587 MackieControlProtocol::_gui_track_selection_changed (ARDOUR::RouteNotificationList* rl, bool save_list)
1589 /* We need to keep a list of the most recently selected routes around,
1590 but we are not allowed to keep shared_ptr<Route> unless we want to
1591 handle the complexities of route deletion. So instead, the GUI sends
1592 us a notification using weak_ptr<Route>, which we keep a copy
1593 of. For efficiency's sake, however, we convert the weak_ptr's into
1594 shared_ptr<Route> before passing them to however many surfaces (and
1595 thus strips) that we have.
1598 StrongRouteNotificationList srl;
1600 for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
1601 boost::shared_ptr<ARDOUR::Route> r = (*i).lock();
1608 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1610 for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1611 (*s)->gui_selection_changed (srl);
1616 _last_selected_routes = *rl;
1621 MackieControlProtocol::transport_frame() const
1623 return session->transport_frame();
1627 MackieControlProtocol::add_down_select_button (int surface, int strip)
1629 _down_select_buttons.insert ((surface<<8)|(strip&0xf));
1633 MackieControlProtocol::remove_down_select_button (int surface, int strip)
1635 DownButtonList::iterator x = find (_down_select_buttons.begin(), _down_select_buttons.end(), (uint32_t) (surface<<8)|(strip&0xf));
1636 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down select buttons\n", surface, strip));
1637 if (x != _down_select_buttons.end()) {
1638 _down_select_buttons.erase (x);
1640 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down select buttons\n",
1646 MackieControlProtocol::select_range ()
1650 pull_route_range (_down_select_buttons, routes);
1652 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("select range: found %1 routes\n", routes.size()));
1654 if (!routes.empty()) {
1655 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1657 if (main_modifier_state() == MODIFIER_CONTROL) {
1658 ToggleRouteSelection ((*r)->remote_control_id ());
1660 if (r == routes.begin()) {
1661 SetRouteSelection ((*r)->remote_control_id());
1663 AddRouteToSelection ((*r)->remote_control_id());
1671 MackieControlProtocol::add_down_button (AutomationType a, int surface, int strip)
1673 DownButtonMap::iterator m = _down_buttons.find (a);
1675 if (m == _down_buttons.end()) {
1676 _down_buttons[a] = DownButtonList();
1679 _down_buttons[a].insert ((surface<<8)|(strip&0xf));
1683 MackieControlProtocol::remove_down_button (AutomationType a, int surface, int strip)
1685 DownButtonMap::iterator m = _down_buttons.find (a);
1687 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down buttons for %3\n", surface, strip, (int) a));
1689 if (m == _down_buttons.end()) {
1693 DownButtonList& l (m->second);
1694 DownButtonList::iterator x = find (l.begin(), l.end(), (surface<<8)|(strip&0xf));
1699 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 not found in down buttons for %3\n",
1700 surface, strip, (int) a));
1704 MackieControlProtocol::ControlList
1705 MackieControlProtocol::down_controls (AutomationType p)
1707 ControlList controls;
1710 DownButtonMap::iterator m = _down_buttons.find (p);
1712 if (m == _down_buttons.end()) {
1716 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("looking for down buttons for %1, got %2\n",
1717 p, m->second.size()));
1719 pull_route_range (m->second, routes);
1722 case GainAutomation:
1723 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1724 controls.push_back ((*r)->gain_control());
1727 case SoloAutomation:
1728 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1729 controls.push_back ((*r)->solo_control());
1732 case MuteAutomation:
1733 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1734 controls.push_back ((*r)->mute_control());
1737 case RecEnableAutomation:
1738 for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
1739 boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (*r);
1741 controls.push_back (trk->rec_enable_control());
1753 struct ButtonRangeSorter {
1754 bool operator() (const uint32_t& a, const uint32_t& b) {
1755 return (a>>8) < (b>>8) // a.surface < b.surface
1757 ((a>>8) == (b>>8) && (a&0xf) < (b&0xf)); // a.surface == b.surface && a.strip < b.strip
1762 MackieControlProtocol::pull_route_range (DownButtonList& down, RouteList& selected)
1764 ButtonRangeSorter cmp;
1770 list<uint32_t> ldown;
1771 ldown.insert (ldown.end(), down.begin(), down.end());
1774 uint32_t first = ldown.front();
1775 uint32_t last = ldown.back ();
1777 uint32_t first_surface = first>>8;
1778 uint32_t first_strip = first&0xf;
1780 uint32_t last_surface = last>>8;
1781 uint32_t last_strip = last&0xf;
1783 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("PRR %5 in list %1.%2 - %3.%4\n", first_surface, first_strip, last_surface, last_strip,
1786 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1788 for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1790 if ((*s)->number() >= first_surface && (*s)->number() <= last_surface) {
1795 if ((*s)->number() == first_surface) {
1801 if ((*s)->number() == last_surface) {
1805 ls = (*s)->n_strips ();
1808 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("adding strips for surface %1 (%2 .. %3)\n",
1809 (*s)->number(), fs, ls));
1811 for (uint32_t n = fs; n < ls; ++n) {
1812 boost::shared_ptr<Route> r = (*s)->nth_strip (n)->route();
1814 selected.push_back (r);
1822 MackieControlProtocol::set_ipmidi_base (int16_t portnum)
1824 /* this will not be saved without a session save, so .. */
1826 session->set_dirty ();
1828 _ipmidi_base = portnum;
1830 /* if the current device uses ipMIDI we need
1834 if (active() && _device_info.uses_ipmidi()) {
1835 needs_ipmidi_restart = true;
1840 MackieControlProtocol::ipmidi_restart ()
1843 if (create_surfaces ()) {
1846 switch_banks (_current_initial_bank, true);
1847 needs_ipmidi_restart = false;
1852 MackieControlProtocol::clear_surfaces ()
1857 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1858 _master_surface.reset ();
1864 MackieControlProtocol::set_touch_sensitivity (int sensitivity)
1866 sensitivity = min (9, sensitivity);
1867 sensitivity = max (0, sensitivity);
1869 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1871 for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1872 (*s)->set_touch_sensitivity (sensitivity);
1877 MackieControlProtocol::recalibrate_faders ()
1879 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1881 for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1882 (*s)->recalibrate_faders ();
1887 MackieControlProtocol::toggle_backlight ()
1889 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1891 for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1892 (*s)->toggle_backlight ();
1896 boost::shared_ptr<Surface>
1897 MackieControlProtocol::get_surface_by_raw_pointer (void* ptr) const
1899 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1901 for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
1902 if ((*s).get() == (Surface*) ptr) {
1907 return boost::shared_ptr<Surface> ();
1910 boost::shared_ptr<Surface>
1911 MackieControlProtocol::nth_surface (uint32_t n) const
1913 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1915 for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s, --n) {
1921 return boost::shared_ptr<Surface> ();
1925 MackieControlProtocol::connection_handler (boost::weak_ptr<ARDOUR::Port> wp1, std::string name1, boost::weak_ptr<ARDOUR::Port> wp2, std::string name2, bool yn)
1929 Glib::Threads::Mutex::Lock lm (surfaces_lock);
1933 for (Surfaces::const_iterator s = scopy.begin(); s != scopy.end(); ++s) {
1934 if ((*s)->connection_handler (wp1, name1, wp2, name2, yn)) {
1935 ConnectionChange (*s);