mackie: more debug tracing for remapped buttons
[ardour.git] / libs / surfaces / mackie / mcp_buttons.cc
index 5bf52ce4c4cf771c140a13ba771dade1db764328..dcbaa5c34bc94b00613d024ca28009fb82aa6836 100644 (file)
@@ -22,6 +22,7 @@
 #include "pbd/memento_command.h"
 
 #include "ardour/debug.h"
+#include "ardour/profile.h"
 #include "ardour/session.h"
 #include "ardour/route.h"
 #include "ardour/location.h"
@@ -31,7 +32,7 @@
 #include "surface.h"
 #include "fader.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 /* handlers for all buttons, broken into a separate file to avoid clutter in
  * mackie_control_protocol.cc
@@ -97,15 +98,19 @@ MackieControlProtocol::cmd_alt_release (Button &)
 LedState
 MackieControlProtocol::left_press (Button &)
 {
-       Sorted sorted = get_sorted_routes();
+       if (_subview_mode != None) {
+               return none;
+       }
+
+       Sorted sorted = get_sorted_stripables();
        uint32_t strip_cnt = n_strips ();
 
        DEBUG_TRACE (DEBUG::MackieControl, string_compose ("bank left with current initial = %1 nstrips = %2 tracks/busses = %3\n",
                                                           _current_initial_bank, strip_cnt, sorted.size()));
        if (_current_initial_bank > 0) {
-               switch_banks ((_current_initial_bank - 1) / strip_cnt * strip_cnt);
+               (void) switch_banks ((_current_initial_bank - 1) / strip_cnt * strip_cnt);
        } else {
-               switch_banks (0);
+               (void) switch_banks (0);
        }
 
 
@@ -115,13 +120,17 @@ MackieControlProtocol::left_press (Button &)
 LedState
 MackieControlProtocol::left_release (Button &)
 {
-       return off;
+       return none;
 }
 
 LedState
 MackieControlProtocol::right_press (Button &)
 {
-       Sorted sorted = get_sorted_routes();
+       if (_subview_mode != None) {
+               return none;
+       }
+
+       Sorted sorted = get_sorted_stripables();
        uint32_t strip_cnt = n_strips();
        uint32_t route_cnt = sorted.size();
        uint32_t max_bank = route_cnt / strip_cnt * strip_cnt;
@@ -132,23 +141,16 @@ MackieControlProtocol::right_press (Button &)
 
        if (_current_initial_bank < max_bank) {
                uint32_t new_initial = (_current_initial_bank / strip_cnt * strip_cnt) + strip_cnt;
-
-               switch_banks (new_initial);
-       } else {
-               switch_banks (max_bank);
+               (void) switch_banks (new_initial);
        }
 
-       return on;
+       return none;
 }
 
 LedState
 MackieControlProtocol::right_release (Button &)
 {
-       if (zoom_mode()) {
-
-       }
-
-       return off;
+       return none;
 }
 
 LedState
@@ -230,7 +232,7 @@ MackieControlProtocol::cursor_up_press (Button&)
                        VerticalZoomInAll (); /* EMIT SIGNAL */
                }
        } else {
-               StepTracksUp (); /* EMIT SIGNAL */
+               access_action ("Editor/select-prev-route");
        }
        return off;
 }
@@ -251,7 +253,7 @@ MackieControlProtocol::cursor_down_press (Button&)
                        VerticalZoomOutAll (); /* EMIT SIGNAL */
                }
        } else {
-               StepTracksDown (); /* EMIT SIGNAL */
+               access_action ("Editor/select-next-route");
        }
        return off;
 }
@@ -265,7 +267,10 @@ MackieControlProtocol::cursor_down_release (Button&)
 LedState
 MackieControlProtocol::channel_left_press (Button &)
 {
-       Sorted sorted = get_sorted_routes();
+       if (_subview_mode != None) {
+               return none;
+       }
+       Sorted sorted = get_sorted_stripables();
        if (sorted.size() > n_strips()) {
                prev_track();
                return on;
@@ -283,7 +288,10 @@ MackieControlProtocol::channel_left_release (Button &)
 LedState
 MackieControlProtocol::channel_right_press (Button &)
 {
-       Sorted sorted = get_sorted_routes();
+       if (_subview_mode != None) {
+               return none;
+       }
+       Sorted sorted = get_sorted_stripables();
        if (sorted.size() > n_strips()) {
                next_track();
                return on;
@@ -335,44 +343,54 @@ MackieControlProtocol::scrub_release (Mackie::Button &)
 LedState
 MackieControlProtocol::undo_press (Button&)
 {
-       if (main_modifier_state() & MODIFIER_SHIFT) {
-               Redo(); /* EMIT SIGNAL */
+       if (main_modifier_state() == MODIFIER_SHIFT) {
+               redo();
        } else {
-               Undo(); /* EMIT SIGNAL */
+               undo ();
        }
-       return off;
+       return none;
 }
 
 LedState
 MackieControlProtocol::undo_release (Button&)
 {
-       return off;
+       return none;
 }
 
 LedState
 MackieControlProtocol::drop_press (Button &)
 {
-       session->remove_last_capture();
-       return on;
+       if (main_modifier_state() == MODIFIER_SHIFT) {
+               toggle_punch_in();
+               return none;
+       } else {
+               access_action ("Common/start-range-from-playhead");
+       }
+       return none;
 }
 
 LedState
 MackieControlProtocol::drop_release (Button &)
 {
-       return off;
+       return none;
 }
 
 LedState
 MackieControlProtocol::save_press (Button &)
 {
-       session->save_state ("");
-       return on;
+       if (main_modifier_state() == MODIFIER_SHIFT) {
+               quick_snapshot_switch();
+       } else {
+               save_state ();
+       }
+
+       return none;
 }
 
 LedState
 MackieControlProtocol::save_release (Button &)
 {
-       return off;
+       return none;
 }
 
 LedState
@@ -406,17 +424,50 @@ MackieControlProtocol::timecode_beats_release (Button &)
 LedState
 MackieControlProtocol::marker_press (Button &)
 {
-       string markername;
-
-       session->locations()->next_available_name (markername,"mcu");
-       add_marker (markername);
+       DEBUG_TRACE (DEBUG::MackieControl, "marker press\n");
 
-       return on;
+       if (main_modifier_state() & MODIFIER_SHIFT) {
+               access_action ("Common/remove-location-from-playhead");
+               return off;
+       } else {
+               _modifier_state |= MODIFIER_MARKER;
+               marker_modifier_consumed_by_button = false;
+               return on;
+       }
 }
 
 LedState
 MackieControlProtocol::marker_release (Button &)
 {
+       DEBUG_TRACE (DEBUG::MackieControl, "marker release\n");
+
+       _modifier_state &= ~MODIFIER_MARKER;
+
+       if (main_modifier_state() & MODIFIER_SHIFT)
+               return off;   //if shift was held, we already did the action
+
+       if (marker_modifier_consumed_by_button) {
+               /* marker was used a modifier for some other button(s), so do
+                  nothing
+               */
+               return off;
+       }
+
+       string markername;
+
+       /* Don't add another mark if one exists within 1/100th of a second of
+        * the current position and we're not rolling.
+        */
+
+       framepos_t where = session->audible_frame();
+
+       if (session->transport_stopped() && session->locations()->mark_at (where, session->frame_rate() / 100.0)) {
+               return off;
+       }
+
+       session->locations()->next_available_name (markername,"marker");
+       add_marker (markername);
+
        return off;
 }
 
@@ -428,6 +479,11 @@ LedState
 MackieControlProtocol::stop_press (Button &)
 {
        transport_stop ();
+
+       if (main_modifier_state() == MODIFIER_SHIFT) {
+               session->midi_panic();
+       }
+
        return on;
 }
 
@@ -470,7 +526,11 @@ MackieControlProtocol::record_release (Button &)
 LedState
 MackieControlProtocol::rewind_press (Button &)
 {
-       if (main_modifier_state() == MODIFIER_CONTROL) {
+       if (modifier_state() & MODIFIER_MARKER) {
+               prev_marker ();
+       } else if (modifier_state() & MODIFIER_NUDGE) {
+               access_action ("Common/nudge-playhead-backward");
+       } else if (main_modifier_state() & MODIFIER_SHIFT) {
                goto_start ();
        } else {
                rewind ();
@@ -487,7 +547,11 @@ MackieControlProtocol::rewind_release (Button &)
 LedState
 MackieControlProtocol::ffwd_press (Button &)
 {
-       if (main_modifier_state() == MODIFIER_CONTROL) {
+       if (modifier_state() & MODIFIER_MARKER) {
+               next_marker ();
+       } else if (modifier_state() & MODIFIER_NUDGE) {
+               access_action ("Common/nudge-playhead-forward");
+       } else if (main_modifier_state() & MODIFIER_SHIFT) {
                goto_end();
        } else {
                ffwd ();
@@ -504,12 +568,13 @@ MackieControlProtocol::ffwd_release (Button &)
 LedState
 MackieControlProtocol::loop_press (Button &)
 {
-       if (main_modifier_state() & MODIFIER_CONTROL) {
-               set_view_mode (Loop);
-               return on;
+       if (main_modifier_state() & MODIFIER_SHIFT) {
+               access_action ("Common/set-loop-from-edit-range");
+               return off;
        } else {
-               session->request_play_loop (!session->get_play_loop());
-               return none;
+               bool was_on = session->get_play_loop();
+               loop_toggle ();
+               return was_on ? off : on;
        }
 }
 
@@ -520,53 +585,49 @@ MackieControlProtocol::loop_release (Button &)
 }
 
 LedState
-MackieControlProtocol::clicking_press (Button &)
+MackieControlProtocol::enter_press (Button &)
 {
-       bool state = !Config->get_clicking();
-       Config->set_clicking (state);
-       return state;
+       if (main_modifier_state() & MODIFIER_SHIFT) {
+               access_action ("Transport/ToggleFollowEdits");
+       } else {
+               access_action ("Editor/select-all-tracks");
+       }
+       return none;
 }
 
 LedState
-MackieControlProtocol::clicking_release (Button &)
+MackieControlProtocol::enter_release (Button &)
 {
-       return Config->get_clicking();
+       return none;
 }
 
-LedState MackieControlProtocol::global_solo_press (Button &)
+LedState
+MackieControlProtocol::bank_release (Button& b, uint32_t basic_bank_num)
 {
-       bool state = !session->soloing();
-       session->set_solo (session->get_routes(), state);
-       return state;
-}
+       if (_subview_mode != None) {
+               return none;
+       }
 
-LedState MackieControlProtocol::global_solo_release (Button &)
-{
-       return session->soloing();
-}
+       uint32_t bank_num = basic_bank_num;
 
-LedState
-MackieControlProtocol::enter_press (Button &)
-{
-       Enter(); /* EMIT SIGNAL */
-       return off;
-}
+       if (b.long_press_count() > 0) {
+               bank_num = 8 + basic_bank_num;
+       }
 
-LedState
-MackieControlProtocol::enter_release (Button &)
-{
-       return off;
+       (void) switch_banks (n_strips() * bank_num);
+
+       return on;
 }
 
 LedState
-MackieControlProtocol::F1_press (Button &)
+MackieControlProtocol::F1_press (Button &b)
 {
        return off;
 }
 LedState
-MackieControlProtocol::F1_release (Button &)
+MackieControlProtocol::F1_release (Button &b)
 {
-       return off;
+       return bank_release (b, 0);
 }
 LedState
 MackieControlProtocol::F2_press (Button &)
@@ -574,9 +635,9 @@ MackieControlProtocol::F2_press (Button &)
        return off;
 }
 LedState
-MackieControlProtocol::F2_release (Button &)
+MackieControlProtocol::F2_release (Button &b)
 {
-       return off;
+       return bank_release (b, 1);
 }
 LedState
 MackieControlProtocol::F3_press (Button &)
@@ -584,9 +645,9 @@ MackieControlProtocol::F3_press (Button &)
        return off;
 }
 LedState
-MackieControlProtocol::F3_release (Button &)
+MackieControlProtocol::F3_release (Button &b)
 {
-       return off;
+       return bank_release (b, 2);
 }
 LedState
 MackieControlProtocol::F4_press (Button &)
@@ -594,9 +655,9 @@ MackieControlProtocol::F4_press (Button &)
        return off;
 }
 LedState
-MackieControlProtocol::F4_release (Button &)
+MackieControlProtocol::F4_release (Button &b)
 {
-       return off;
+       return bank_release (b, 3);
 }
 LedState
 MackieControlProtocol::F5_press (Button &)
@@ -645,7 +706,9 @@ MackieControlProtocol::F8_release (Button &)
 LedState
 MackieControlProtocol::pan_press (Button &)
 {
-       return off;
+       /* XXX eventually pan may have its own subview mode */
+       set_subview_mode (MackieControlProtocol::None, boost::shared_ptr<Stripable>());
+       return none;
 }
 LedState
 MackieControlProtocol::pan_release (Button &)
@@ -660,14 +723,16 @@ MackieControlProtocol::plugin_press (Button &)
 LedState
 MackieControlProtocol::plugin_release (Button &)
 {
-       return none;
+       // Do not do this yet, since it does nothing
+       // set_view_mode (Plugins);
+       return none; /* LED state set by set_view_mode */
 }
 LedState
 MackieControlProtocol::eq_press (Button &)
 {
-       //set_view_mode (EQ);
-       // not implemented yet, turn off (see comments for send button)
-       return off;
+       set_subview_mode (EQ, first_selected_stripable ());
+       return none; /* led state handled by set_subview_mode() */
+
 }
 LedState
 MackieControlProtocol::eq_release (Button &)
@@ -677,10 +742,10 @@ MackieControlProtocol::eq_release (Button &)
 LedState
 MackieControlProtocol::dyn_press (Button &)
 {
-       //set_view_mode (Dynamics);
-       // same as send
-       return off;
+       set_subview_mode (Dynamics, first_selected_stripable ());
+       return none; /* led state handled by set_subview_mode() */
 }
+
 LedState
 MackieControlProtocol::dyn_release (Button &)
 {
@@ -689,13 +754,18 @@ MackieControlProtocol::dyn_release (Button &)
 LedState
 MackieControlProtocol::flip_press (Button &)
 {
-       if (_flip_mode != Normal) {
-               set_flip_mode (Normal);
-       } else {
-               set_flip_mode (Mirror);
+       if (subview_mode() == MackieControlProtocol::Sends) {
+               if (_flip_mode != Normal) {
+                       set_flip_mode (Normal);
+               } else {
+                       set_flip_mode (Mirror);
+               }
+               return ((_flip_mode != Normal) ? on : off);
        }
-       return ((_flip_mode != Normal) ? on : off);
+
+       return none;
 }
+
 LedState
 MackieControlProtocol::flip_release (Button &)
 {
@@ -714,22 +784,28 @@ MackieControlProtocol::name_value_release (Button &)
 LedState
 MackieControlProtocol::touch_press (Button &)
 {
-       return off;
+       return none;
 }
 LedState
 MackieControlProtocol::touch_release (Button &)
 {
-       return off;
+       set_automation_state (ARDOUR::Touch);
+       return none;
 }
 LedState
 MackieControlProtocol::cancel_press (Button &)
 {
-       return off;
+       if (main_modifier_state() & MODIFIER_SHIFT) {
+               access_action ("Transport/ToggleExternalSync");
+       } else {
+               access_action ("Main/Escape");
+       }
+       return none;
 }
 LedState
 MackieControlProtocol::cancel_release (Button &)
 {
-       return off;
+       return none;
 }
 LedState
 MackieControlProtocol::user_a_press (Button &)
@@ -784,14 +860,14 @@ MackieControlProtocol::master_fader_touch_release (Mackie::Button &)
 Mackie::LedState
 MackieControlProtocol::read_press (Mackie::Button&)
 {
-       _metering_active = !_metering_active;
-       notify_metering_state_changed ();
-       return _metering_active;
+       return none;
 }
+
 Mackie::LedState
 MackieControlProtocol::read_release (Mackie::Button&)
 {
-       return _metering_active;
+       set_automation_state (ARDOUR::Play);
+       return none;
 }
 Mackie::LedState
 MackieControlProtocol::write_press (Mackie::Button&)
@@ -801,23 +877,36 @@ MackieControlProtocol::write_press (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::write_release (Mackie::Button&)
 {
+       set_automation_state (ARDOUR::Write);
        return none;
 }
+
 Mackie::LedState
 MackieControlProtocol::clearsolo_press (Mackie::Button&)
 {
+       // clears all solos and listens (pfl/afl)
+
+       if (main_modifier_state() & MODIFIER_SHIFT) {
+               access_action ("Common/set-session-from-edit-range");
+               return none;
+       }
+
+       cancel_all_solo ();
        return none;
 }
+
 Mackie::LedState
 MackieControlProtocol::clearsolo_release (Mackie::Button&)
 {
+       //return session->soloing();
        return none;
 }
+
 Mackie::LedState
 MackieControlProtocol::track_press (Mackie::Button&)
 {
-
-       return off;
+       set_subview_mode (TrackView, first_selected_stripable());
+       return none;
 }
 Mackie::LedState
 MackieControlProtocol::track_release (Mackie::Button&)
@@ -827,13 +916,8 @@ MackieControlProtocol::track_release (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::send_press (Mackie::Button&)
 {
-// code moved here from "sends_press"
-       //set_view_mode (Sends);
-       // Led state for vpot assignment should be radio button-ish
-       // Pressing any one should turn the rest off.
-       // but this is not implemented yet so leave off
-       //return on;
-       return off;
+       set_subview_mode (Sends, first_selected_stripable());
+       return none; /* led state handled by set_subview_mode() */
 }
 Mackie::LedState
 MackieControlProtocol::send_release (Mackie::Button&)
@@ -848,11 +932,15 @@ MackieControlProtocol::miditracks_press (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::miditracks_release (Mackie::Button&)
 {
+       set_view_mode (MidiTracks);
        return none;
 }
 Mackie::LedState
 MackieControlProtocol::inputs_press (Mackie::Button&)
 {
+#ifdef MIXBUS
+       set_view_mode (Mixer);  //in Mixbus, this is the same as Global View (avoid dead buttons)
+#endif
        return none;
 }
 Mackie::LedState
@@ -868,17 +956,23 @@ MackieControlProtocol::audiotracks_press (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::audiotracks_release (Mackie::Button&)
 {
+       set_view_mode (AudioTracks);
        return none;
 }
 Mackie::LedState
-MackieControlProtocol::audioinstruments_press (Mackie::Button&)
+MackieControlProtocol::audioinstruments_press (Mackie::Button& b)
 {
+#ifdef MIXBUS
+       set_view_mode (MidiTracks);  //in Mixbus, we do the same thing as MIDI Tracks ( aviod dead buttons )
+#endif
        return none;
 }
+
 Mackie::LedState
-MackieControlProtocol::audioinstruments_release (Mackie::Button&)
+MackieControlProtocol::audioinstruments_release (Mackie::Button& b)
 {
        return none;
+
 }
 Mackie::LedState
 MackieControlProtocol::aux_press (Mackie::Button&)
@@ -888,6 +982,7 @@ MackieControlProtocol::aux_press (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::aux_release (Mackie::Button&)
 {
+       set_view_mode (Auxes);
        return none;
 }
 Mackie::LedState
@@ -898,6 +993,7 @@ MackieControlProtocol::busses_press (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::busses_release (Mackie::Button&)
 {
+       set_view_mode (Busses);
        return none;
 }
 Mackie::LedState
@@ -908,6 +1004,7 @@ MackieControlProtocol::outputs_press (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::outputs_release (Mackie::Button&)
 {
+       set_view_mode (Hidden);
        return none;
 }
 Mackie::LedState
@@ -918,6 +1015,7 @@ MackieControlProtocol::user_press (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::user_release (Mackie::Button&)
 {
+       set_view_mode (Selected);
        return none;
 }
 Mackie::LedState
@@ -948,21 +1046,45 @@ MackieControlProtocol::grp_press (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::grp_release (Mackie::Button&)
 {
+       /* There is no "Off" button for automation,
+          so we use Group for this purpose.
+       */
+       set_automation_state (Off);
        return none;
 }
 Mackie::LedState
 MackieControlProtocol::nudge_press (Mackie::Button&)
 {
-       return none;
+       _modifier_state |= MODIFIER_NUDGE;
+       nudge_modifier_consumed_by_button = false;
+       return on;
 }
 Mackie::LedState
 MackieControlProtocol::nudge_release (Mackie::Button&)
 {
-       return none;
+       _modifier_state &= ~MODIFIER_NUDGE;
+
+       /* XXX these action names are stupid, because the action can affect
+        * regions, markers or the playhead depending on selection state.
+        */
+
+       if (main_modifier_state() & MODIFIER_SHIFT) {
+               access_action ("Region/nudge-backward");
+       } else {
+               access_action ("Region/nudge-forward");
+       }
+
+       return off;
 }
 Mackie::LedState
 MackieControlProtocol::replace_press (Mackie::Button&)
 {
+       if (main_modifier_state() == MODIFIER_SHIFT) {
+               toggle_punch_out();
+               return none;
+       } else {
+               access_action ("Common/finish-range-from-playhead");
+       }
        return none;
 }
 Mackie::LedState
@@ -973,7 +1095,14 @@ MackieControlProtocol::replace_release (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::click_press (Mackie::Button&)
 {
-       return none;
+       if (main_modifier_state() & MODIFIER_SHIFT) {
+               access_action ("Common/set-punch-from-edit-range");
+               return off;
+       } else {
+               bool state = !Config->get_clicking();
+               Config->set_clicking (state);
+               return state;
+       }
 }
 Mackie::LedState
 MackieControlProtocol::click_release (Mackie::Button&)
@@ -983,6 +1112,7 @@ MackieControlProtocol::click_release (Mackie::Button&)
 Mackie::LedState
 MackieControlProtocol::view_press (Mackie::Button&)
 {
+       set_view_mode (Mixer);
        return none;
 }
 Mackie::LedState