Fix insane formatting (how did this even happen? copy paste from an email diff or...
[ardour.git] / gtk2_ardour / route_ui.cc
index 44032a4ea5cbf11eaa7afa299aea02297c0cce37..cefe2ac517e4c84b72c860ef8021de5e735f4a47 100644 (file)
@@ -23,6 +23,7 @@
 #include <gtkmm2ext/doi.h>
 #include <gtkmm2ext/bindable_button.h>
 #include <gtkmm2ext/barcontroller.h>
+#include <gtkmm2ext/gtk_ui.h>
 
 #include <ardour/route_group.h>
 #include <pbd/memento_command.h>
@@ -46,6 +47,7 @@
 #include <ardour/audio_diskstream.h>
 #include <ardour/midi_track.h>
 #include <ardour/midi_diskstream.h>
+#include <ardour/profile.h>
 
 #include "i18n.h"
 using namespace sigc;
@@ -54,13 +56,33 @@ using namespace Gtkmm2ext;
 using namespace ARDOUR;
 using namespace PBD;
 
-RouteUI::RouteUI (boost::shared_ptr<ARDOUR::Route> rt, ARDOUR::Session& sess, const char* m_name,
-                 const char* s_name, const char* r_name)
-       : AxisView(sess),
-         _route(rt),
-         mute_button(0),
-         solo_button(0),
-         rec_enable_button(0)
+RouteUI::RouteUI (ARDOUR::Session& sess, const char* mute_name, const char* solo_name, const char* rec_name)
+       : AxisView(sess)
+{
+       init ();
+       set_button_names (mute_name, solo_name, rec_name);
+}
+
+RouteUI::RouteUI (boost::shared_ptr<ARDOUR::Route> rt, 
+                 ARDOUR::Session& sess, const char* mute_name, const char* solo_name, const char* rec_name)
+       : AxisView(sess)
+{
+       init ();
+       set_button_names (mute_name, solo_name, rec_name);
+       set_route (rt);
+}
+
+RouteUI::~RouteUI()
+{
+       GoingAway (); /* EMIT SIGNAL */
+
+       delete solo_menu;
+       delete mute_menu;
+       delete remote_control_menu;
+}
+
+void
+RouteUI::init ()
 {
        xml_node = 0;
        mute_menu = 0;
@@ -72,28 +94,84 @@ RouteUI::RouteUI (boost::shared_ptr<ARDOUR::Route> rt, ARDOUR::Session& sess, co
        was_solo_safe = false;
        polarity_menu_item = 0;
        denormal_menu_item = 0;
+       multiple_mute_change = false;
+       multiple_solo_change = false;
 
-       if (set_color_from_route()) {
-               set_color (unique_random_color());
+       mute_button = manage (new BindableToggleButton (""));
+       mute_button->set_self_managed (true);
+       mute_button->set_name ("MuteButton");
+       UI::instance()->set_tip (mute_button, _("Mute this track"), "");
+
+       solo_button = manage (new BindableToggleButton (""));
+       solo_button->set_self_managed (true);
+       solo_button->set_name ("SoloButton");
+       UI::instance()->set_tip (solo_button, _("Mute other (non-soloed) tracks"), "");
+
+       rec_enable_button = manage (new BindableToggleButton (""));
+       rec_enable_button->set_name ("RecordEnableButton");
+       rec_enable_button->set_self_managed (true);
+       UI::instance()->set_tip (rec_enable_button, _("Enable recording on this track"), "");
+
+       _session.SoloChanged.connect (mem_fun(*this, &RouteUI::solo_changed_so_update_mute));
+}
+
+void
+RouteUI::reset ()
+{
+       connections.clear ();
+
+       delete solo_menu;
+       solo_menu = 0;
+
+       delete mute_menu;
+       mute_menu = 0;
+       
+       if (xml_node) {
+               /* do not delete the node - its owned by the route */
+               xml_node = 0;
        }
 
-       new PairedShiva<Route,RouteUI> (*_route, *this);
+       route_active_menu_item = 0;
+       polarity_menu_item = 0;
+       denormal_menu_item = 0;
+}
 
-       _route->active_changed.connect (mem_fun (*this, &RouteUI::route_active_changed));
+void
+RouteUI::set_button_names (const char* mute, const char* solo, const char* rec)
+{
+       m_name = mute;
+       s_name = solo;
+       r_name = rec;
+}
 
-       mute_button = manage (new BindableToggleButton (_route->mute_control(), m_name ));
-       mute_button->set_self_managed (true);
+void
+RouteUI::set_route (boost::shared_ptr<Route> rp)
+{
+       reset ();
 
-       solo_button = manage (new BindableToggleButton (_route->solo_control(), s_name ));
-       solo_button->set_self_managed (true);
+       _route = rp;
 
-       mute_button->set_name ("MuteButton");
-       solo_button->set_name ("SoloButton");
+       if (set_color_from_route()) {
+               set_color (unique_random_color());
+       }
 
-       _route->mute_changed.connect (mem_fun(*this, &RouteUI::mute_changed));
-       _route->solo_changed.connect (mem_fun(*this, &RouteUI::solo_changed));
-       _route->solo_safe_changed.connect (mem_fun(*this, &RouteUI::solo_changed));
+       /* no, there is no memory leak here. This object cleans itself (and other stuff)
+          up when the route is destroyed.
+       */
 
+       new PairedShiva<Route,RouteUI> (*_route, *this);
+  
+       mute_button->set_controllable (_route->mute_control());
+       mute_button->set_label (m_name);
+       
+       solo_button->set_controllable (_route->solo_control());
+       solo_button->set_label (s_name);
+  
+       connections.push_back (_route->active_changed.connect (mem_fun (*this, &RouteUI::route_active_changed)));
+       connections.push_back (_route->mute_changed.connect (mem_fun(*this, &RouteUI::mute_changed)));
+       connections.push_back (_route->solo_changed.connect (mem_fun(*this, &RouteUI::solo_changed)));
+       connections.push_back (_route->solo_safe_changed.connect (mem_fun(*this, &RouteUI::solo_changed)));
+  
        /* when solo changes, update mute state too, in case the user wants us to display it */
 
        _session.SoloChanged.connect (mem_fun(*this, &RouteUI::solo_changed_so_update_mute));
@@ -101,15 +179,13 @@ RouteUI::RouteUI (boost::shared_ptr<ARDOUR::Route> rt, ARDOUR::Session& sess, co
        if (is_track()) {
                boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(_route);
 
-               t->diskstream()->RecordEnableChanged.connect (mem_fun (*this, &RouteUI::route_rec_enable_changed));
-
-               _session.RecordStateChanged.connect (mem_fun (*this, &RouteUI::session_rec_enable_changed));
+               connections.push_back (t->diskstream()->RecordEnableChanged.connect (mem_fun (*this, &RouteUI::route_rec_enable_changed)));
+               connections.push_back (_session.RecordStateChanged.connect (mem_fun (*this, &RouteUI::session_rec_enable_changed)));
 
-               rec_enable_button = manage (new BindableToggleButton (t->rec_enable_control(), r_name ));
-               rec_enable_button->set_name ("RecordEnableButton");
-               rec_enable_button->set_self_managed (true);
-               
                rec_enable_button->show();
+               rec_enable_button->set_controllable (t->rec_enable_control());
+               rec_enable_button->set_label (r_name);
+
                update_rec_display ();
        } 
 
@@ -119,26 +195,20 @@ RouteUI::RouteUI (boost::shared_ptr<ARDOUR::Route> rt, ARDOUR::Session& sess, co
        mute_button->show();
        solo_button->show();
 
-       _route->RemoteControlIDChanged.connect (mem_fun(*this, &RouteUI::refresh_remote_control_menu));
+       connections.push_back (_route->RemoteControlIDChanged.connect (mem_fun(*this, &RouteUI::refresh_remote_control_menu)));
 
        /* map the current state */
 
        map_frozen ();
 }
 
-RouteUI::~RouteUI()
-{
-       GoingAway (); /* EMIT SIGNAL */
-       delete mute_menu;
-}
-
 bool
 RouteUI::mute_press(GdkEventButton* ev)
 {
-       if (ev->type == GDK_2BUTTON_PRESS) {
+       if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
                return true;
        }
-
+       multiple_mute_change = false;
        if (!ignore_toggle) {
 
                if (Keyboard::is_context_menu_event (ev)) {
@@ -151,7 +221,7 @@ RouteUI::mute_press(GdkEventButton* ev)
 
                } else {
 
-                       if (ev->button == 2) {
+                       if (Keyboard::is_button2_event (ev)) {
                                // Primary-button2 click is the midi binding click
                                // button2-click is "momentary"
                                
@@ -162,7 +232,7 @@ RouteUI::mute_press(GdkEventButton* ev)
                                }
                        }
 
-                       if (ev->button == 1 || ev->button == 2) {
+                       if (ev->button == 1 || Keyboard::is_button2_event (ev)) {
 
                                if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
 
@@ -174,6 +244,7 @@ RouteUI::mute_press(GdkEventButton* ev)
                                         cmd->mark();
                                        _session.add_command(cmd);
                                        _session.commit_reversible_command ();
+                                       multiple_mute_change = true;
 
                                } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 
@@ -188,8 +259,11 @@ RouteUI::mute_press(GdkEventButton* ev)
                                } else {
 
                                        /* plain click applies change to this route */
-
-                                       reversibly_apply_route_boolean ("mute change", &Route::set_mute, !_route->muted(), this);
+                                       if (wait_for_release) {
+                                               _route->set_mute (!_route->muted(), this);
+                                       } else {
+                                               reversibly_apply_route_boolean ("mute change", &Route::set_mute, !_route->muted(), this);
+                                       }
                                }
                        }
                }
@@ -205,9 +279,14 @@ RouteUI::mute_release(GdkEventButton* ev)
        if (!ignore_toggle) {
                if (wait_for_release){
                        wait_for_release = false;
-                       // undo the last op
-                       // because the press was the last undoable thing we did
-                       _session.undo (1U);
+                       if (multiple_mute_change) {
+                               multiple_mute_change = false;
+                               // undo the last op
+                               // because the press was the last undoable thing we did
+                               _session.undo (1U);
+                       } else {
+                               _route->set_mute (!_route->muted(), this);
+                       }
                }
        }
        return true;
@@ -216,16 +295,16 @@ RouteUI::mute_release(GdkEventButton* ev)
 bool
 RouteUI::solo_press(GdkEventButton* ev)
 {
-       /* ignore double clicks */
+       /* ignore double/triple clicks */
 
-       if (ev->type == GDK_2BUTTON_PRESS) {
+       if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
                return true;
        }
-
+       multiple_solo_change = false;
        if (!ignore_toggle) {
 
                if (Keyboard::is_context_menu_event (ev)) {
-                       
+
                        if (solo_menu == 0) {
                                build_solo_menu ();
                        }
@@ -234,7 +313,7 @@ RouteUI::solo_press(GdkEventButton* ev)
 
                } else {
 
-                       if (ev->button == 2) {
+                       if (Keyboard::is_button2_event (ev)) {
 
                                // Primary-button2 click is the midi binding click
                                // button2-click is "momentary"
@@ -246,18 +325,31 @@ RouteUI::solo_press(GdkEventButton* ev)
                                }
                        }
 
-                       if (ev->button == 1 || ev->button == 2) {
+                       if (ev->button == 1 || Keyboard::is_button2_event (ev)) {
 
                                if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
 
                                        /* Primary-Tertiary-click applies change to all routes */
-
+                                       bool was_not_latched = false;
+                                       if (!Config->get_solo_latched ()) {
+                                               was_not_latched = true;
+                                               /*
+                                                 XXX it makes no sense to solo all tracks if we're 
+                                                 not in latched mode, but doing nothing feels like a bug, 
+                                                 so do it anyway 
+                                               */
+                                               Config->set_solo_latched (true);
+                                       }
                                        _session.begin_reversible_command (_("solo change"));
                                         Session::GlobalSoloStateCommand *cmd = new Session::GlobalSoloStateCommand(_session, this);
                                        _session.set_all_solo (!_route->soloed());
                                         cmd->mark();
                                        _session.add_command (cmd);
                                        _session.commit_reversible_command ();
+                                       multiple_solo_change = true;
+                                       if (was_not_latched) {
+                                               Config->set_solo_latched (false);
+                                       }
                                        
                                } else if (Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::SecondaryModifier))) {
 
@@ -275,8 +367,17 @@ RouteUI::solo_press(GdkEventButton* ev)
 
                                        // shift-click: set this route to solo safe
 
-                                       _route->set_solo_safe (!_route->solo_safe(), this);
-                                       wait_for_release = false;
+                                       if (Profile->get_sae() && ev->button == 1) {
+                                               // button 1 and shift-click: disables solo_latched for this click
+                                               if (!Config->get_solo_latched ()) {
+                                                       Config->set_solo_latched (true);
+                                                       reversibly_apply_route_boolean ("solo change", &Route::set_solo, !_route->soloed(), this);
+                                                       Config->set_solo_latched (false);
+                                               }
+                                       } else {
+                                               _route->set_solo_safe (!_route->solo_safe(), this);
+                                               wait_for_release = false;
+                                       }
 
                                } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 
@@ -291,7 +392,11 @@ RouteUI::solo_press(GdkEventButton* ev)
                                } else {
 
                                        /* click: solo this route */
-                                       reversibly_apply_route_boolean ("solo change", &Route::set_solo, !_route->soloed(), this);
+                                       if (wait_for_release) {
+                                               _route->set_solo (!_route->soloed(), this);
+                                       } else {
+                                               reversibly_apply_route_boolean ("solo change", &Route::set_solo, !_route->soloed(), this);
+                                       }
                                }
                        }
                }
@@ -306,10 +411,16 @@ RouteUI::solo_release(GdkEventButton* ev)
        if (!ignore_toggle) {
                if (wait_for_release) {
                        wait_for_release = false;
-                       // undo the last op
-                       // because the press was the last undoable thing we did
-
-                       _session.undo (1U);
+                       if (multiple_solo_change) {
+                               multiple_solo_change = false;
+                               // undo the last op
+                               // because the press was the last undoable thing we did
+                               _session.undo (1U);
+                       } else {
+                               // we don't use "undo the last op"
+                               // here because its expensive for the GUI
+                               _route->set_solo (!_route->soloed(), this);
+                       }
                }
        }
 
@@ -319,7 +430,7 @@ RouteUI::solo_release(GdkEventButton* ev)
 bool
 RouteUI::rec_enable_press(GdkEventButton* ev)
 {
-       if (ev->type == GDK_2BUTTON_PRESS) {
+       if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
                return true;
        }
 
@@ -331,7 +442,7 @@ RouteUI::rec_enable_press(GdkEventButton* ev)
 
        if (!ignore_toggle && is_track() && rec_enable_button) {
 
-               if (ev->button == 2 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
+               if (Keyboard::is_button2_event (ev) && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 
                        // do nothing on midi bind event
                        return false;
@@ -377,6 +488,7 @@ RouteUI::rec_enable_release (GdkEventButton* ev)
 void
 RouteUI::solo_changed(void* src)
 {
+
        Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &RouteUI::update_solo_display));
 }
 
@@ -503,7 +615,7 @@ RouteUI::update_rec_display ()
 void
 RouteUI::build_remote_control_menu ()
 {
-       remote_control_menu = manage (new Menu);
+       remote_control_menu = new Menu;
        refresh_remote_control_menu ();
 }
 
@@ -835,7 +947,7 @@ gint
 RouteUI::idle_remove_this_route (RouteUI *rui)
 {
        rui->_session.remove_route (rui->_route);
-       return FALSE;
+       return false;
 }
 
 void