LTC Slave, add support for variable framerates
[ardour.git] / libs / surfaces / mackie / mackie_control_protocol.cc
index 85b92cbeabe72a8f6d676e8bbf59ea57f39e757e..3791252ade0bf651599db8e472e6e206ca26b168 100644 (file)
@@ -107,13 +107,15 @@ MackieControlProtocol::MackieControlProtocol (Session& session)
        , _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");
 
        DeviceInfo::reload_device_info ();
        DeviceProfile::reload_device_profiles ();
 
-       TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::gui_track_selection_changed, this, _1), this);
+       TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::gui_track_selection_changed, this, _1, true), this);
 
        _instance = this;
 
@@ -122,15 +124,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) {
@@ -140,9 +149,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
@@ -357,7 +366,7 @@ MackieControlProtocol::switch_banks (uint32_t initial, bool force)
 
        /* make sure selection is correct */
        
-       // gui_track_selection_changed (_last_selected_routes);
+       _gui_track_selection_changed (&_last_selected_routes, false);
        
        /* current bank has not been saved */
        session->set_dirty();
@@ -366,6 +375,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;
        }
@@ -396,6 +407,8 @@ MackieControlProtocol::set_active (bool yn)
 
        }
 
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose("MackieControlProtocol::set_active done with yn: '%1'\n", yn));
+
        return 0;
 }
 
@@ -410,6 +423,10 @@ MackieControlProtocol::periodic ()
                ipmidi_restart ();
                return true;
        }
+       
+       if (!_initialized) {
+               initialize();
+       }
 
        struct timeval now;
        uint64_t now_usecs;
@@ -426,10 +443,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);
@@ -449,12 +470,12 @@ MackieControlProtocol::update_timecode_beats_led()
 void 
 MackieControlProtocol::update_global_button (int id, LedState ls)
 {
-       boost::shared_ptr<Surface> surface = surfaces.front();
-
-       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);
@@ -467,15 +488,17 @@ MackieControlProtocol::update_global_button (int id, LedState ls)
 void 
 MackieControlProtocol::update_global_led (int id, LedState ls)
 {
-       boost::shared_ptr<Surface> surface = surfaces.front();
-
-       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));
@@ -486,6 +509,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;
        }
@@ -494,14 +518,28 @@ MackieControlProtocol::update_surfaces()
        // _current_initial_bank is initialised by set_state
        switch_banks (_current_initial_bank, true);
        
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::update_surfaces() finished\n");
+}
+
+void
+MackieControlProtocol::initialize()
+{
+       if (!surfaces.front()->active ()) {
+               return;
+       }
+
        // sometimes the jog wheel is a pot
-       surfaces.front()->blank_jog_ring ();
+       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 
@@ -649,7 +687,7 @@ MackieControlProtocol::close()
 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
@@ -667,6 +705,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;
 }
 
@@ -677,7 +717,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) {
@@ -707,43 +747,34 @@ MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
                switch_banks (bank, true);
        }
 
+       DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::set_state done\n");
+
        return retval;
 }
 
-
-/////////////////////////////////////////////////
-// handlers for Route signals
-// TODO should these be part of RouteSignal?
-// They started off as signal/slot handlers for signals
-// from Route, but they're also used in polling for automation
-/////////////////////////////////////////////////
-
-// TODO handle plugin automation polling
 string 
 MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
 {
        Timecode::BBT_Time bbt_time;
+
        session->bbt_time (now_frame, bbt_time);
 
-       // According to the Logic docs
-       // digits: 888/88/88/888
-       // BBT mode: Bars/Beats/Subdivisions/Ticks
+       // The Mackie protocol spec is built around a BBT time display of
+       //
+       // digits:     888/88/88/888
+       // semantics:  BBB/bb/ss/ttt
+       //
+       // The third field is "subdivisions" which is a concept found in Logic
+       // but not present in Ardour. Instead Ardour displays a 4 digit tick
+       // count, which we need to spread across the 5 digits of ss/ttt.
+
        ostringstream os;
+
        os << setw(3) << setfill('0') << bbt_time.bars;
        os << setw(2) << setfill('0') << bbt_time.beats;
-
-       // figure out subdivisions per beat
-       const ARDOUR::Meter & meter = session->tempo_map().meter_at (now_frame);
-       int subdiv = 2;
-       if (meter.note_divisor() == 8 && (meter.divisions_per_bar() == 12.0 || meter.divisions_per_bar() == 9.0 || meter.divisions_per_bar() == 6.0)) {
-               subdiv = 3;
-       }
-
-       uint32_t subdivisions = bbt_time.ticks / uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
-       uint32_t ticks = bbt_time.ticks % uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
-
-       os << setw(2) << setfill('0') << subdivisions + 1;
-       os << setw(3) << setfill('0') << ticks;
+       os << ' ';
+       os << setw(1) << setfill('0') << bbt_time.ticks / 1000;
+       os << setw(3) << setfill('0') << bbt_time.ticks % 1000;
 
        return os.str();
 }
@@ -758,10 +789,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();
 }
@@ -775,7 +808,7 @@ MackieControlProtocol::update_timecode_display()
 
        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;
        }
 
@@ -883,19 +916,34 @@ 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);
 
-       _transport_previously_rolling = session->transport_rolling();
+       notify_metering_state_changed ();
+}
+
+void 
+MackieControlProtocol::notify_metering_state_changed()
+{
+       for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
+               (*s)->notify_metering_state_changed ();
+       }       
 }
 
 void
 MackieControlProtocol::notify_record_state_changed ()
 {
+       if (!_device_info.has_global_controls()) {
+               return;
+       }
        boost::shared_ptr<Surface> surface = surfaces.front();
 
        /* rec is a tristate */
@@ -920,7 +968,7 @@ MackieControlProtocol::notify_record_state_changed ()
                                ls = flashing;
                                break;
                        }
-                       
+
                        surface->write (rec->set_state (ls));
                }
        }
@@ -1036,6 +1084,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);
@@ -1130,6 +1179,18 @@ MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
 
        if (ioc & IO_IN) {
 
+               /* Devices using regular JACK MIDI ports will need to have
+                  the x-thread FIFO drained to avoid burning endless CPU.
+
+                  Devices using ipMIDI have port->selectable() as the same
+                  file descriptor that data arrives on, so doing this
+                  for them will simply throw all incoming data away.
+               */
+
+               if (!_device_info.uses_ipmidi()) {
+                       CrossThreadChannel::drain (port->selectable());
+               }
+
                DEBUG_TRACE (DEBUG::MackieControl, string_compose ("data available on %1\n", port->name()));
                framepos_t now = session->engine().frame_time();
                port->parse (now);
@@ -1204,13 +1265,40 @@ MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r,
 }
 
 void
-MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl)
+MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl, bool save_list)
+{
+       _gui_track_selection_changed (rl.get(), save_list);
+}
+
+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
+          us a notification using weak_ptr<Route>, which we keep a copy
+          of. For efficiency's sake, however, we convert the weak_ptr's into
+          shared_ptr<Route> before passing them to however many surfaces (and
+          thus strips) that we have.
+       */
+
+       StrongRouteNotificationList srl;
+
+       for (ARDOUR::RouteNotificationList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
+               boost::shared_ptr<ARDOUR::Route> r = (*i).lock();
+               if (r) {
+                       srl.push_back (r);
+               }
+       }
+
        for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
-               (*s)->gui_selection_changed (rl);
+               (*s)->gui_selection_changed (srl);
        }
        
-       // _last_selected_routes = *rl;
+       if (save_list) {
+               _last_selected_routes = *rl;
+       }
 }
 
 framepos_t