MCP: ctrl-select toggle selections status, analogous to GUI op
[ardour.git] / libs / surfaces / mackie / mackie_control_protocol.cc
index d1416d6e9f0bfc278ee87f44d452037f3722a5a8..a5bcefcb1785a1c98ffc69017261935fbb455ac8 100644 (file)
@@ -1,5 +1,6 @@
 /*
        Copyright (C) 2006,2007 John Anderson
+       Copyright (C) 2012 Paul Davis
 
        This program is free software; you can redistribute it and/or modify
        it under the terms of the GNU General Public License as published by
@@ -34,6 +35,7 @@
 
 #include "midi++/types.h"
 #include "midi++/port.h"
+#include "midi++/ipmidi_port.h"
 #include "pbd/pthread_utils.h"
 #include "pbd/error.h"
 #include "pbd/memento_command.h"
@@ -77,8 +79,6 @@ using namespace Glib;
 
 #include "pbd/abstract_ui.cc" // instantiate template
 
-#define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
-
 const int MackieControlProtocol::MODIFIER_OPTION = 0x1;
 const int MackieControlProtocol::MODIFIER_CONTROL = 0x2;
 const int MackieControlProtocol::MODIFIER_SHIFT = 0x4;
@@ -92,7 +92,7 @@ bool MackieControlProtocol::probe()
 }
 
 MackieControlProtocol::MackieControlProtocol (Session& session)
-       : ControlProtocol (session, X_("Mackie"), this)
+       : ControlProtocol (session, X_("Mackie"))
        , AbstractUI<MackieControlUIRequest> ("mackie")
        , _current_initial_bank (0)
        , _timecode_type (ARDOUR::AnyTime::BBT)
@@ -105,21 +105,15 @@ MackieControlProtocol::MackieControlProtocol (Session& session)
        , _view_mode (Mixer)
        , _current_selected_track (-1)
        , _modifier_state (0)
+       , _ipmidi_base (MIDI::IPMIDIPort::lowest_ipmidi_port_default)
+       , needs_ipmidi_restart (false)
 {
        DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
 
        DeviceInfo::reload_device_info ();
        DeviceProfile::reload_device_profiles ();
 
-       set_device (Config->get_mackie_device_name());
-       set_profile (Config->get_mackie_device_profile());
-
-       AudioEngine::instance()->PortConnectedOrDisconnected.connect (
-               audio_engine_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::port_connected_or_disconnected, this, _2, _4, _5),
-               this
-               );
-
-       TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::gui_track_selection_changed, this, _1), this);
+       TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::gui_track_selection_changed, this, _1), this);
 
        _instance = this;
 
@@ -132,6 +126,10 @@ MackieControlProtocol::~MackieControlProtocol()
 
        _active = false;
 
+       /* stop event loop */
+
+       BaseUI::quit ();
+
        try {
                close();
        }
@@ -165,6 +163,14 @@ MackieControlProtocol::thread_init ()
        }
 }
 
+void
+MackieControlProtocol::midi_connectivity_established ()
+{
+       for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
+               (*si)->say_hello ();
+       }
+}
+
 // go to the previous track.
 // Assume that get_sorted_routes().size() > route_table.size()
 void 
@@ -186,6 +192,17 @@ MackieControlProtocol::next_track()
        }
 }
 
+bool
+MackieControlProtocol::route_is_locked_to_strip (boost::shared_ptr<Route> r) const
+{
+       for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
+               if ((*si)->route_is_locked_to_strip (r)) {
+                       return true;
+               }
+       }
+       return false;
+}
+
 // predicate for sort call in get_sorted_routes
 struct RouteByRemoteId
 {
@@ -223,13 +240,19 @@ MackieControlProtocol::get_sorted_routes()
 
        for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it) {
 
-               Route & route = **it;
+               boost::shared_ptr<Route> route = *it;
+
+               if (remote_ids.find (route->remote_control_id()) != remote_ids.end()) {
+                       continue;
+               }
 
-               if (remote_ids.find (route.remote_control_id()) != remote_ids.end()) {
+               if (route->is_hidden() || route->is_master() || route->is_monitor()) {
                        continue;
                }
 
-               if (route.is_hidden() || route.is_master() || route.is_monitor()) {
+               /* don't include locked routes */
+
+               if (route_is_locked_to_strip(route)) {
                        continue;
                }
 
@@ -255,7 +278,7 @@ MackieControlProtocol::get_sorted_routes()
                }
 
                sorted.push_back (*it);
-               remote_ids.insert (route.remote_control_id());
+               remote_ids.insert (route->remote_control_id());
        }
 
        sort (sorted.begin(), sorted.end(), RouteByRemoteId());
@@ -269,12 +292,12 @@ MackieControlProtocol::refresh_current_bank()
 }
 
 uint32_t
-MackieControlProtocol::n_strips() const
+MackieControlProtocol::n_strips (bool with_locked_strips) const
 {
        uint32_t strip_count = 0;
 
        for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
-               strip_count += (*si)->n_strips ();
+               strip_count += (*si)->n_strips (with_locked_strips);
        }
 
        return strip_count;
@@ -290,27 +313,17 @@ MackieControlProtocol::switch_banks (uint32_t initial, bool force)
        }
 
        Sorted sorted = get_sorted_routes();
-       uint32_t strip_cnt = n_strips();
+       uint32_t strip_cnt = n_strips (false); // do not include locked strips
+                                              // in this count
 
        if (sorted.size() <= strip_cnt && !force) {
                /* no banking - not enough routes to fill all strips */
                return;
        }
 
-       uint32_t delta = sorted.size() - strip_cnt;
-
-       if (delta > 0 && initial > delta) {
-               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("not switching to %1\n", initial));
-               return;
-       }
-
        _current_initial_bank = initial;
        _current_selected_track = -1;
 
-       for (Surfaces::iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
-               (*si)->drop_routes ();
-       }
-
        // Map current bank of routes onto each surface(+strip)
 
        if (_current_initial_bank <= sorted.size()) {
@@ -325,9 +338,9 @@ MackieControlProtocol::switch_banks (uint32_t initial, bool force)
                        vector<boost::shared_ptr<Route> > routes;
                        uint32_t added = 0;
 
-                       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has %1 strips\n", (*si)->n_strips()));
+                       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has %1 unlockedstrips\n", (*si)->n_strips (false)));
 
-                       for (; r != sorted.end() && added < (*si)->n_strips(); ++r, ++added) {
+                       for (; r != sorted.end() && added < (*si)->n_strips (false); ++r, ++added) {
                                routes.push_back (*r);
                        }
 
@@ -339,6 +352,10 @@ MackieControlProtocol::switch_banks (uint32_t initial, bool force)
 
        /* reset this to get the right display of view mode after the switch */
        set_view_mode (_view_mode);
+
+       /* make sure selection is correct */
+       
+       // gui_track_selection_changed (_last_selected_routes);
        
        /* current bank has not been saved */
        session->set_dirty();
@@ -351,37 +368,30 @@ MackieControlProtocol::set_active (bool yn)
                return 0;
        }
 
-       try
-       {
-               if (yn) {
-
-                       /* start event loop */
-
-                       BaseUI::run ();
-
-                       create_surfaces ();
-                       connect_session_signals ();
-                       _active = true;
-                       update_surfaces ();
-
-                       /* set up periodic task for metering and automation
-                        */
-
-                       Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
-                       periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
-                       periodic_timeout->attach (main_loop()->get_context());
+       if (yn) {
+               
+               /* start event loop */
+               
+               BaseUI::run ();
+               
+               create_surfaces ();
+               connect_session_signals ();
+               _active = true;
+               update_surfaces ();
+               
+               /* set up periodic task for metering and automation
+                */
+               
+               Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
+               periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
+               periodic_timeout->attach (main_loop()->get_context());
+               
+       } else {
 
-               } else {
-                       BaseUI::quit ();
-                       close();
-                       _active = false;
-               }
-       }
-       
-       catch (exception & e) {
-               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("set_active to false because exception caught: %1\n", e.what()));
+               BaseUI::quit ();
+               close ();
                _active = false;
-               throw;
+
        }
 
        return 0;
@@ -394,6 +404,11 @@ MackieControlProtocol::periodic ()
                return false;
        }
 
+       if (needs_ipmidi_restart) {
+               ipmidi_restart ();
+               return true;
+       }
+
        struct timeval now;
        uint64_t now_usecs;
        gettimeofday (&now, 0);
@@ -403,6 +418,8 @@ MackieControlProtocol::periodic ()
        for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
                (*s)->periodic (now_usecs);
        }
+
+       update_timecode_display ();
        
        return true;
 }
@@ -489,24 +506,24 @@ void
 MackieControlProtocol::connect_session_signals()
 {
        // receive routes added
-       session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_route_added, this, _1), this);
+       session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_route_added, this, _1), this);
        // receive record state toggled
-       session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_record_state_changed, this), this);
+       session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_record_state_changed, this), this);
        // receive transport state changed
-       session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
-       session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
+       session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
+       session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
        // receive punch-in and punch-out
-       Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
-       session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
+       Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
+       session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
        // receive rude solo changed
-       session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), this);
+       session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), this);
 
        // make sure remote id changed signals reach here
        // see also notify_route_added
        Sorted sorted = get_sorted_routes();
 
        for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
-               (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind(&MackieControlProtocol::notify_remote_id_changed, this), this);
+               (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
        }
 }
 
@@ -528,7 +545,7 @@ MackieControlProtocol::set_profile (const string& profile_name)
 }      
 
 void
-MackieControlProtocol::set_device (const string& device_name)
+MackieControlProtocol::set_device (const string& device_name, bool allow_activation)
 {
        map<string,DeviceInfo>::iterator d = DeviceInfo::device_info.find (device_name);
 
@@ -536,17 +553,20 @@ MackieControlProtocol::set_device (const string& device_name)
                return;
        }
        
-       _device_info = d->second;
-
-       /* store it away in a global location */
-       
-       Config->set_mackie_device_name (device_name);
-
        if (_active) {
                clear_ports ();
-               surfaces.clear ();
-               create_surfaces ();
-               switch_banks (0, true);
+               surfaces.clear ();      
+       }
+
+       _device_info = d->second;
+
+       if (allow_activation) {
+               set_active (true);
+       } else {
+               if (_active) {
+                       create_surfaces ();
+                       switch_banks (0, true);
+               }
        }
 }
 
@@ -580,21 +600,23 @@ MackieControlProtocol::create_surfaces ()
                }
                stype = ext;
 
-               _input_bundle->add_channel (
-                       surface->port().input_port().name(),
-                       ARDOUR::DataType::MIDI,
-                       session->engine().make_port_name_non_relative (surface->port().input_port().name())
-                       );
-               
-               _output_bundle->add_channel (
-                       surface->port().output_port().name(),
-                       ARDOUR::DataType::MIDI,
-                       session->engine().make_port_name_non_relative (surface->port().output_port().name())
-                       );
+               if (!_device_info.uses_ipmidi()) {
+                       _input_bundle->add_channel (
+                               surface->port().input_port().name(),
+                               ARDOUR::DataType::MIDI,
+                               session->engine().make_port_name_non_relative (surface->port().input_port().name())
+                               );
+                       
+                       _output_bundle->add_channel (
+                               surface->port().output_port().name(),
+                               ARDOUR::DataType::MIDI,
+                               session->engine().make_port_name_non_relative (surface->port().output_port().name())
+                               );
+               }
 
                int fd;
                MIDI::Port& input_port (surface->port().input_port());
-               
+
                if ((fd = input_port.selectable ()) >= 0) {
                        Glib::RefPtr<IOSource> psrc = IOSource::create (fd, IO_IN|IO_HUP|IO_ERR);
 
@@ -626,15 +648,22 @@ XMLNode&
 MackieControlProtocol::get_state()
 {
        DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state\n");
+       char buf[16];
 
        // add name of protocol
        XMLNode* node = new XMLNode (X_("Protocol"));
        node->add_property (X_("name"), ARDOUR::ControlProtocol::_name);
 
        // add current bank
-       ostringstream os;
-       os << _current_initial_bank;
-       node->add_property (X_("bank"), os.str());
+       snprintf (buf, sizeof (buf), "%d", _current_initial_bank);
+       node->add_property (X_("bank"), buf);
+
+       // ipMIDI base port (possibly not used)
+       snprintf (buf, sizeof (buf), "%d", _ipmidi_base);
+       node->add_property (X_("ipmidi-base"), buf);
+
+       node->add_property (X_("device-profile"), _device_profile.name());
+       node->add_property (X_("device-name"), _device_info.name());
 
        return *node;
 }
@@ -646,15 +675,34 @@ MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
 
        int retval = 0;
        const XMLProperty* prop;
+       uint32_t bank;
+       bool active = _active;
+
+       if ((prop = node.property (X_("ipmidi-base"))) != 0) {
+               set_ipmidi_base (atoi (prop->value()));
+       }
 
        // fetch current bank
        if ((prop = node.property (X_("bank"))) != 0) {
-               string bank = prop->value();
-               set_active (true);
-               uint32_t new_bank = atoi (bank.c_str());
-               if (_current_initial_bank != new_bank) {
-                       switch_banks (new_bank);
-               }
+               bank = atoi (prop->value());
+       }
+       
+       if ((prop = node.property (X_("active"))) != 0) {
+               active = string_is_affirmative (prop->value());
+       }
+
+       if ((prop = node.property (X_("device-name"))) != 0) {
+               set_device (prop->value(), false);
+       }
+
+       if ((prop = node.property (X_("device-profile"))) != 0) {
+               set_profile (prop->value());
+       }
+
+       set_active (active);
+
+       if (_active) {
+               switch_banks (bank, true);
        }
 
        return retval;
@@ -719,9 +767,13 @@ MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
 void 
 MackieControlProtocol::update_timecode_display()
 {
+       if (surfaces.empty()) {
+               return;
+       }
+
        boost::shared_ptr<Surface> surface = surfaces.front();
 
-       if (surface->type() != mcu || !surface->has_timecode_display()) {
+       if (surface->type() != mcu || !_device_info.has_timecode_display()) {
                return;
        }
 
@@ -780,7 +832,7 @@ MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
        typedef ARDOUR::RouteList ARS;
 
        for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
-               (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
+               (*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
        }
 }
 
@@ -830,6 +882,7 @@ void
 MackieControlProtocol::notify_transport_state_changed()
 {
        // switch various play and stop buttons on / off
+       update_global_button (Button::Loop, session->get_play_loop());
        update_global_button (Button::Play, session->transport_speed() == 1.0);
        update_global_button (Button::Stop, !session->transport_rolling());
        update_global_button (Button::Rewind, session->transport_speed() < 0.0);
@@ -880,26 +933,6 @@ MackieControlProtocol::bundles ()
        return b;
 }
 
-void
-MackieControlProtocol::port_connected_or_disconnected (string a, string b, bool connected)
-{
-       /* If something is connected to one of our output ports, send MIDI to update the surface
-          to whatever state it should have.
-       */
-
-       if (!connected) {
-               return;
-       }
-
-       for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
-               string const n = AudioEngine::instance()->make_port_name_non_relative ((*s)->port().output_port().name ());
-               if (a == n || b == n) {
-                       update_surfaces ();
-                       return;
-               }
-       }
-}
-
 void
 MackieControlProtocol::do_request (MackieControlUIRequest* req)
 {
@@ -1035,7 +1068,8 @@ MackieControlProtocol::handle_button_event (Surface& surface, Button& button, Bu
                return;
        }
        
-       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2\n", (bs == press ? "press" : "release"), button.id()));
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2 (%3)\n", (bs == press ? "press" : "release"), button.id(),
+                                                          Button::id_to_name (button.bid())));
 
        /* check profile first */
        
@@ -1068,6 +1102,7 @@ MackieControlProtocol::handle_button_event (Surface& surface, Button& button, Bu
                switch  (bs) {
                case press: 
                        surface.write (button.set_state ((this->*(bh.press)) (button)));
+                       break;
                case release: 
                        surface.write (button.set_state ((this->*(bh.release)) (button)));
                        break;
@@ -1085,7 +1120,7 @@ MackieControlProtocol::handle_button_event (Surface& surface, Button& button, Bu
 bool
 MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
 {
-       DEBUG_TRACE (DEBUG::MidiIO, string_compose ("something happend on  %1\n", port->name()));
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("something happend on  %1\n", port->name()));
 
        if (ioc & ~IO_IN) {
                return false;
@@ -1093,9 +1128,7 @@ MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
 
        if (ioc & IO_IN) {
 
-               CrossThreadChannel::drain (port->selectable());
-
-               DEBUG_TRACE (DEBUG::MidiIO, string_compose ("data available on %1\n", port->name()));
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("data available on %1\n", port->name()));
                framepos_t now = session->engine().frame_time();
                port->parse (now);
        }
@@ -1174,6 +1207,8 @@ MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationLis
        for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
                (*s)->gui_selection_changed (rl);
        }
+       
+       // _last_selected_routes = *rl;
 }
 
 framepos_t
@@ -1212,10 +1247,15 @@ MackieControlProtocol::select_range ()
 
        if (!routes.empty()) {
                for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
-                       if (r == routes.begin()) {
-                               SetRouteSelection ((*r)->remote_control_id());
+
+                       if (_modifier_state == MODIFIER_CONTROL) {
+                               ToggleRouteSelection ((*r)->remote_control_id ());
                        } else {
-                               AddRouteToSelection ((*r)->remote_control_id());
+                               if (r == routes.begin()) {
+                                       SetRouteSelection ((*r)->remote_control_id());
+                               } else {
+                                       AddRouteToSelection ((*r)->remote_control_id());
+                               }
                        }
                }
        }
@@ -1369,3 +1409,31 @@ MackieControlProtocol::pull_route_range (DownButtonList& down, RouteList& select
                }
        }
 }
+
+void
+MackieControlProtocol::set_ipmidi_base (int16_t portnum)
+{
+       /* this will not be saved without a session save, so .. */
+
+       session->set_dirty ();
+
+       _ipmidi_base = portnum;
+
+       /* if the current device uses ipMIDI we need
+          to restart.
+       */
+
+       if (_active && _device_info.uses_ipmidi()) {
+               needs_ipmidi_restart = true;
+       }
+}
+
+void
+MackieControlProtocol::ipmidi_restart ()
+{
+       clear_ports ();
+       surfaces.clear ();      
+       create_surfaces ();
+       switch_banks (_current_initial_bank, true);
+       needs_ipmidi_restart = false;
+}