Merge branch 'master' into windows
[ardour.git] / libs / surfaces / mackie / mackie_control_protocol.cc
index 1efe904976d01a65f6accc9f29a024b043a03861..5b772d9af5f4900de89ee8e8541831b29edf067a 100644 (file)
@@ -29,7 +29,6 @@
 #include <float.h>
 #include <sys/time.h>
 #include <errno.h>
-#include <poll.h>
 
 #include <boost/shared_array.hpp>
 
@@ -101,12 +100,14 @@ MackieControlProtocol::MackieControlProtocol (Session& session)
        , _gui (0)
        , _zoom_mode (false)
        , _scrub_mode (false)
-       , _flip_mode (false)
+       , _flip_mode (Normal)
        , _view_mode (Mixer)
        , _current_selected_track (-1)
        , _modifier_state (0)
        , _ipmidi_base (MIDI::IPMIDIPort::lowest_ipmidi_port_default)
        , needs_ipmidi_restart (false)
+       , _metering_active (true)
+       , _initialized (false)
 {
        DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
 
@@ -122,18 +123,22 @@ MackieControlProtocol::MackieControlProtocol (Session& session)
 
 MackieControlProtocol::~MackieControlProtocol()
 {
-       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol\n");
-
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol init\n");
+       
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol drop_connections ()\n");
        drop_connections ();
+
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol tear_down_gui ()\n");
        tear_down_gui ();
 
        _active = false;
 
        /* stop event loop */
-
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol BaseUI::quit ()\n");
        BaseUI::quit ();
 
        try {
+               DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol close()\n");
                close();
        }
        catch (exception & e) {
@@ -143,9 +148,9 @@ MackieControlProtocol::~MackieControlProtocol()
                cout << "~MackieControlProtocol caught unknown" << endl;
        }
 
-       DEBUG_TRACE (DEBUG::MackieControl, "finished ~MackieControlProtocol::MackieControlProtocol\n");
-
        _instance = 0;
+
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol done\n");
 }
 
 void
@@ -172,6 +177,12 @@ MackieControlProtocol::midi_connectivity_established ()
        for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
                (*si)->say_hello ();
        }
+
+       if (_device_info.no_handshake()) {
+               for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
+                       (*si)->turn_it_on ();
+               }
+       }
 }
 
 // go to the previous track.
@@ -249,7 +260,7 @@ MackieControlProtocol::get_sorted_routes()
                        continue;
                }
 
-               if (route->is_hidden() || route->is_master() || route->is_monitor()) {
+               if (route->is_auditioner() || route->is_master() || route->is_monitor()) {
                        continue;
                }
 
@@ -369,6 +380,8 @@ MackieControlProtocol::switch_banks (uint32_t initial, bool force)
 int 
 MackieControlProtocol::set_active (bool yn)
 {
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active init with yn: '%1'\n", yn));
+
        if (yn == _active) {
                return 0;
        }
@@ -379,7 +392,9 @@ MackieControlProtocol::set_active (bool yn)
                
                BaseUI::run ();
                
-               create_surfaces ();
+               if (create_surfaces ()) {
+                       return -1;
+               }
                connect_session_signals ();
                _active = true;
                update_surfaces ();
@@ -399,6 +414,8 @@ MackieControlProtocol::set_active (bool yn)
 
        }
 
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active done with yn: '%1'\n", yn));
+
        return 0;
 }
 
@@ -413,6 +430,10 @@ MackieControlProtocol::periodic ()
                ipmidi_restart ();
                return true;
        }
+       
+       if (!_initialized) {
+               initialize();
+       }
 
        struct timeval now;
        uint64_t now_usecs;
@@ -420,8 +441,12 @@ MackieControlProtocol::periodic ()
 
        now_usecs = (now.tv_sec * 1000000) + now.tv_usec;
 
-       for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
-               (*s)->periodic (now_usecs);
+       {
+               Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
+               for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
+                       (*s)->periodic (now_usecs);
+               }
        }
 
        update_timecode_display ();
@@ -429,10 +454,14 @@ MackieControlProtocol::periodic ()
        return true;
 }
 
-
 void 
 MackieControlProtocol::update_timecode_beats_led()
 {
+       if (!_device_info.has_timecode_display()) {
+               return;
+       }
+
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::update_timecode_beats_led(): %1\n", _timecode_type));
        switch (_timecode_type) {
                case ARDOUR::AnyTime::BBT:
                        update_global_led (Led::Beats, on);
@@ -452,12 +481,14 @@ MackieControlProtocol::update_timecode_beats_led()
 void 
 MackieControlProtocol::update_global_button (int id, LedState ls)
 {
-       boost::shared_ptr<Surface> surface = surfaces.front();
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
 
-       if (!surface->type() == mcu) {
+       if (!_device_info.has_global_controls()) {
                return;
        }
 
+       boost::shared_ptr<Surface> surface = surfaces.front();
+
        map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
        if (x != surface->controls_by_device_independent_id.end()) {
                Button * button = dynamic_cast<Button*> (x->second);
@@ -470,15 +501,19 @@ MackieControlProtocol::update_global_button (int id, LedState ls)
 void 
 MackieControlProtocol::update_global_led (int id, LedState ls)
 {
-       boost::shared_ptr<Surface> surface = surfaces.front();
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
 
-       if (!surface->type() == mcu) {
+       if (!_device_info.has_global_controls()) {
                return;
        }
 
+       boost::shared_ptr<Surface> surface = surfaces.front();
+
        map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (id);
+
        if (x != surface->controls_by_device_independent_id.end()) {
                Led * led = dynamic_cast<Led*> (x->second);
+               DEBUG_TRACE (DEBUG::MackieControl, "Writing LedState\n");
                surface->write (led->set_state (ls));
        } else {
                DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", id));
@@ -489,6 +524,7 @@ MackieControlProtocol::update_global_led (int id, LedState ls)
 void 
 MackieControlProtocol::update_surfaces()
 {
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::update_surfaces() init\n");
        if (!_active) {
                return;
        }
@@ -497,14 +533,36 @@ MackieControlProtocol::update_surfaces()
        // _current_initial_bank is initialised by set_state
        switch_banks (_current_initial_bank, true);
        
-       // sometimes the jog wheel is a pot
-       surfaces.front()->blank_jog_ring ();
-       
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::update_surfaces() finished\n");
+}
+
+void
+MackieControlProtocol::initialize()
+{
+       {
+               Glib::Threads::Mutex::Lock lm (surfaces_lock);
+               
+               if (surfaces.empty()) {
+                       return;
+               }
+               
+               if (!surfaces.front()->active ()) {
+                       return;
+               }
+               
+               // sometimes the jog wheel is a pot
+               if (_device_info.has_jog_wheel()) {
+                       surfaces.front()->blank_jog_ring ();
+               }
+       }
+
        // update global buttons and displays
 
        notify_record_state_changed();
        notify_transport_state_changed();
        update_timecode_beats_led();
+       
+       _initialized = true;
 }
 
 void 
@@ -549,18 +607,21 @@ MackieControlProtocol::set_profile (const string& profile_name)
        _device_profile = d->second;
 }      
 
-void
+int
 MackieControlProtocol::set_device (const string& device_name, bool allow_activation)
 {
        map<string,DeviceInfo>::iterator d = DeviceInfo::device_info.find (device_name);
 
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("new device chosen %1, activation allowed ? %2\n",
+                                                          device_name, allow_activation));
+
        if (d == DeviceInfo::device_info.end()) {
-               return;
+               return -1;
        }
        
        if (_active) {
                clear_ports ();
-               surfaces.clear ();      
+               clear_surfaces ();
        }
 
        _device_info = d->second;
@@ -569,13 +630,16 @@ MackieControlProtocol::set_device (const string& device_name, bool allow_activat
                set_active (true);
        } else {
                if (_active) {
-                       create_surfaces ();
+                       if (create_surfaces ()) {
+                               return -1;
+                       }
                        switch_banks (0, true);
                }
        }
+       return 0;
 }
 
-void 
+int
 MackieControlProtocol::create_surfaces ()
 {
        string device_name;
@@ -592,8 +656,18 @@ MackieControlProtocol::create_surfaces ()
 
        for (uint32_t n = 0; n < 1 + _device_info.extenders(); ++n) {
 
-               boost::shared_ptr<Surface> surface (new Surface (*this, device_name, n, stype));
-               surfaces.push_back (surface);
+               boost::shared_ptr<Surface> surface;
+
+               try {
+                       surface.reset (new Surface (*this, device_name, n, stype));
+               } catch (...) {
+                       return -1;
+               }
+
+               {
+                       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+                       surfaces.push_back (surface);
+               }
 
                /* next device will be an extender */
                
@@ -634,6 +708,8 @@ MackieControlProtocol::create_surfaces ()
                        g_source_ref (psrc->gobj());
                }
        }
+
+       return 0;
 }
 
 void 
@@ -646,13 +722,13 @@ MackieControlProtocol::close()
        route_connections.drop_connections ();
        periodic_connection.disconnect ();
 
-       surfaces.clear ();
+       clear_surfaces();
 }
 
 XMLNode& 
 MackieControlProtocol::get_state()
 {
-       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state\n");
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state init\n");
        char buf[16];
 
        // add name of protocol
@@ -670,6 +746,8 @@ MackieControlProtocol::get_state()
        node->add_property (X_("device-profile"), _device_profile.name());
        node->add_property (X_("device-name"), _device_info.name());
 
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state done\n");
+
        return *node;
 }
 
@@ -680,7 +758,7 @@ MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
 
        int retval = 0;
        const XMLProperty* prop;
-       uint32_t bank;
+       uint32_t bank = 0;
        bool active = _active;
 
        if ((prop = node.property (X_("ipmidi-base"))) != 0) {
@@ -710,6 +788,8 @@ MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
                switch_banks (bank, true);
        }
 
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::set_state done\n");
+
        return retval;
 }
 
@@ -733,7 +813,8 @@ MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
 
        os << setw(3) << setfill('0') << bbt_time.bars;
        os << setw(2) << setfill('0') << bbt_time.beats;
-       os << setw(2) << setfill('0') << bbt_time.ticks / 1000;
+       os << ' ';
+       os << setw(1) << setfill('0') << bbt_time.ticks / 1000;
        os << setw(3) << setfill('0') << bbt_time.ticks % 1000;
 
        return os.str();
@@ -749,10 +830,12 @@ MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
        // digits: 888/88/88/888
        // Timecode mode: Hours/Minutes/Seconds/Frames
        ostringstream os;
-       os << setw(3) << setfill('0') << timecode.hours;
+       os << setw(2) << setfill('0') << timecode.hours;
+       os << ' ';
        os << setw(2) << setfill('0') << timecode.minutes;
        os << setw(2) << setfill('0') << timecode.seconds;
-       os << setw(3) << setfill('0') << timecode.frames;
+       os << ' ';
+       os << setw(2) << setfill('0') << timecode.frames;
 
        return os.str();
 }
@@ -760,13 +843,15 @@ MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
 void 
 MackieControlProtocol::update_timecode_display()
 {
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
        if (surfaces.empty()) {
                return;
        }
 
        boost::shared_ptr<Surface> surface = surfaces.front();
 
-       if (surface->type() != mcu || !_device_info.has_timecode_display()) {
+       if (surface->type() != mcu || !_device_info.has_timecode_display() || !surface->active ()) {
                return;
        }
 
@@ -832,7 +917,12 @@ MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
 void 
 MackieControlProtocol::notify_solo_active_changed (bool active)
 {
-       boost::shared_ptr<Surface> surface = surfaces.front();
+       boost::shared_ptr<Surface> surface;
+
+       {
+               Glib::Threads::Mutex::Lock lm (surfaces_lock);
+               surface = surfaces.front ();
+       }
        
        map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Led::RudeSolo);
        if (x != surface->controls_by_device_independent_id.end()) {
@@ -874,25 +964,44 @@ MackieControlProtocol::notify_loop_state_changed()
 void 
 MackieControlProtocol::notify_transport_state_changed()
 {
+       if (!_device_info.has_global_controls()) {
+               return;
+       }
+
        // 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::Stop, session->transport_stopped ());
        update_global_button (Button::Rewind, session->transport_speed() < 0.0);
        update_global_button (Button::Ffwd, session->transport_speed() > 1.0);
-       
+
+       notify_metering_state_changed ();
+}
+
+void 
+MackieControlProtocol::notify_metering_state_changed()
+{
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
        for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
-               (*s)->notify_transport_state_changed ();
-       }
-       
-       _transport_previously_rolling = session->transport_rolling();
+               (*s)->notify_metering_state_changed ();
+       }       
 }
 
 void
 MackieControlProtocol::notify_record_state_changed ()
 {
-       boost::shared_ptr<Surface> surface = surfaces.front();
+       if (!_device_info.has_global_controls()) {
+               return;
+       }
+
+       boost::shared_ptr<Surface> surface;
 
+       {
+               Glib::Threads::Mutex::Lock lm (surfaces_lock);
+               surface = surfaces.front();
+       }
+               
        /* rec is a tristate */
 
        map<int,Control*>::iterator x = surface->controls_by_device_independent_id.find (Button::Record);
@@ -915,7 +1024,7 @@ MackieControlProtocol::notify_record_state_changed ()
                                ls = flashing;
                                break;
                        }
-                       
+
                        surface->write (rec->set_state (ls));
                }
        }
@@ -1031,6 +1140,7 @@ MackieControlProtocol::build_button_map ()
        DEFINE_BUTTON_HANDLER (Button::Scrub, &MackieControlProtocol::scrub_press, &MackieControlProtocol::scrub_release);
        DEFINE_BUTTON_HANDLER (Button::UserA, &MackieControlProtocol::user_a_press, &MackieControlProtocol::user_a_release);
        DEFINE_BUTTON_HANDLER (Button::UserB, &MackieControlProtocol::user_b_press, &MackieControlProtocol::user_b_release);
+       DEFINE_BUTTON_HANDLER (Button::MasterFaderTouch, &MackieControlProtocol::master_fader_touch_press, &MackieControlProtocol::master_fader_touch_release);
 
        DEFINE_BUTTON_HANDLER (Button::Snapshot, &MackieControlProtocol::snapshot_press, &MackieControlProtocol::snapshot_release);
        DEFINE_BUTTON_HANDLER (Button::Read, &MackieControlProtocol::read_press, &MackieControlProtocol::read_release);
@@ -1134,11 +1244,13 @@ MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
                */
 
                if (!_device_info.uses_ipmidi()) {
+#ifndef PLATFORM_WINDOWS
                        CrossThreadChannel::drain (port->selectable());
+#endif
                }
 
                DEBUG_TRACE (DEBUG::MackieControl, string_compose ("data available on %1\n", port->name()));
-               framepos_t now = session->engine().frame_time();
+               framepos_t now = session->engine().sample_time();
                port->parse (now);
        }
 
@@ -1162,6 +1274,8 @@ MackieControlProtocol::clear_ports ()
 void
 MackieControlProtocol::set_view_mode (ViewMode m)
 {
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
        _view_mode = m;
 
        for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
@@ -1171,9 +1285,11 @@ MackieControlProtocol::set_view_mode (ViewMode m)
 }
 
 void
-MackieControlProtocol::set_flip_mode (bool yn)
+MackieControlProtocol::set_flip_mode (FlipMode fm)
 {
-       _flip_mode = yn;
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
+       _flip_mode = fm;
        
        for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
                (*s)->update_flip_mode_display ();
@@ -1199,6 +1315,8 @@ MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r,
                return;
        }
 
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
        for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
                if ((*s)->number() == surface) {
                        Strip* strip = (*s)->nth_strip (strip_number);
@@ -1219,7 +1337,6 @@ MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationLis
 void
 MackieControlProtocol::_gui_track_selection_changed (ARDOUR::RouteNotificationList* rl, bool save_list)
 {
-
        /* We need to keep a list of the most recently selected routes around,
           but we are not allowed to keep shared_ptr<Route> unless we want to
           handle the complexities of route deletion. So instead, the GUI sends
@@ -1238,8 +1355,12 @@ MackieControlProtocol::_gui_track_selection_changed (ARDOUR::RouteNotificationLi
                }
        }
 
-       for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
-               (*s)->gui_selection_changed (srl);
+       {
+               Glib::Threads::Mutex::Lock lm (surfaces_lock);
+               
+               for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
+                       (*s)->gui_selection_changed (srl);
+               }
        }
        
        if (save_list) {
@@ -1262,7 +1383,7 @@ MackieControlProtocol::add_down_select_button (int surface, int strip)
 void
 MackieControlProtocol::remove_down_select_button (int surface, int strip)
 {
-       DownButtonList::iterator x = find (_down_select_buttons.begin(), _down_select_buttons.end(), (surface<<8)|(strip&0xf));
+       DownButtonList::iterator x = find (_down_select_buttons.begin(), _down_select_buttons.end(), (uint32_t) (surface<<8)|(strip&0xf));
        DEBUG_TRACE (DEBUG::MackieControl, string_compose ("removing surface %1 strip %2 from down select buttons\n", surface, strip));
        if (x != _down_select_buttons.end()) {
                _down_select_buttons.erase (x);
@@ -1413,6 +1534,8 @@ MackieControlProtocol::pull_route_range (DownButtonList& down, RouteList& select
        DEBUG_TRACE (DEBUG::MackieControl, string_compose ("PRR %5 in list %1.%2 - %3.%4\n", first_surface, first_strip, last_surface, last_strip,
                                                           down.size()));
        
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+
        for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
                
                if ((*s)->number() >= first_surface && (*s)->number() <= last_surface) {
@@ -1464,12 +1587,22 @@ MackieControlProtocol::set_ipmidi_base (int16_t portnum)
        }
 }
 
-void
+int
 MackieControlProtocol::ipmidi_restart ()
 {
        clear_ports ();
-       surfaces.clear ();      
-       create_surfaces ();
+       clear_surfaces ();
+       if (create_surfaces ()) {
+               return -1;
+       }
        switch_banks (_current_initial_bank, true);
        needs_ipmidi_restart = false;
+       return 0;
+}
+
+void
+MackieControlProtocol::clear_surfaces ()
+{
+       Glib::Threads::Mutex::Lock lm (surfaces_lock);
+       surfaces.clear ();      
 }