new solo safe/lock button image from oofus (a tad ugly, dare might i say)
[ardour.git] / gtk2_ardour / mixer_strip.cc
index 5ce4caa3af1b74866a95e2073aa5fab38ccc17e8..6d5a2706202174a555d0249c36910854b7d42520 100644 (file)
@@ -24,6 +24,7 @@
 #include "pbd/convert.h"
 #include "pbd/enumwriter.h"
 #include "pbd/replace_all.h"
+#include "pbd/stacktrace.h"
 
 #include <gtkmm2ext/gtk_ui.h>
 #include <gtkmm2ext/utils.h>
@@ -56,7 +57,7 @@
 #include "mixer_strip.h"
 #include "mixer_ui.h"
 #include "keyboard.h"
-#include "led.h"
+#include "ardour_button.h"
 #include "public_editor.h"
 #include "send_ui.h"
 #include "io_selector.h"
@@ -86,12 +87,14 @@ MixerStrip::MixerStrip (Mixer_UI& mx, Session* sess, bool in_mixer)
        , gpm (sess, 250)
        , panners (sess)
        , button_table (3, 1)
-       , solo_led_table (2, 2)
+       , rec_solo_table (2, 2)
        , top_button_table (1, 2)
        , middle_button_table (1, 2)
        , bottom_button_table (1, 2)
        , meter_point_label (_("pre"))
        , midi_input_enable_button (0)
+       , _comment_button (_("Comments"))
+       , _visibility (X_("mixer-strip-visibility"))
 {
        init ();
 
@@ -117,6 +120,8 @@ MixerStrip::MixerStrip (Mixer_UI& mx, Session* sess, boost::shared_ptr<Route> rt
        , bottom_button_table (1, 2)
        , meter_point_label (_("pre"))
        , midi_input_enable_button (0)
+       , _comment_button (_("Comments"))
+       , _visibility (X_("mixer-strip-visibility"))
 {
        init ();
        set_route (rt);
@@ -182,59 +187,47 @@ MixerStrip::init ()
 
        hide_button.set_events (hide_button.get_events() & ~(Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK));
 
-       mute_button->set_name ("MixerMuteButton");
+       // mute_button->set_name ("MixerMuteButton");
        solo_button->set_name ("MixerSoloButton");
 
-       monitor_input_button->set_name ("MixerMonitorInputButton");
-       monitor_disk_button->set_name ("MixerMonitorInputButton");
+       monitor_input_button->set_diameter (3);
+       monitor_disk_button->set_diameter (3);
 
-        solo_isolated_led = manage (new LED);
+        solo_isolated_led = manage (new ArdourButton (ArdourButton::led_default_elements));
         solo_isolated_led->show ();
-        solo_isolated_led->set_diameter (6);
+        solo_isolated_led->set_diameter (3);
         solo_isolated_led->set_no_show_all (true);
-        solo_isolated_led->set_name (X_("SoloIsolatedLED"));
+        solo_isolated_led->set_name (X_("solo isolate"));
         solo_isolated_led->add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
         solo_isolated_led->signal_button_release_event().connect (sigc::mem_fun (*this, &RouteUI::solo_isolate_button_release));
        UI::instance()->set_tip (solo_isolated_led, _("Isolate Solo"), "");
 
-        solo_safe_led = manage (new LED);
+        solo_safe_led = manage (new ArdourButton (ArdourButton::led_default_elements));
         solo_safe_led->show ();
-        solo_safe_led->set_diameter (6);
+        solo_safe_led->set_diameter (3);
         solo_safe_led->set_no_show_all (true);
-        solo_safe_led->set_name (X_("SoloSafeLED"));
+        solo_safe_led->set_name (X_("solo safe"));
         solo_safe_led->add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
         solo_safe_led->signal_button_release_event().connect (sigc::mem_fun (*this, &RouteUI::solo_safe_button_release));
        UI::instance()->set_tip (solo_safe_led, _("Lock Solo Status"), "");
 
-       _iso_label = manage (new Label (_("iso")));
-       _safe_label = manage (new Label (_("lock")));
-
-       _iso_label->set_name (X_("SoloLEDLabel"));
-       _safe_label->set_name (X_("SoloLEDLabel"));
-
-       _iso_label->show ();
-       _safe_label->show ();
-
-        solo_led_table.set_spacings (0);
-        solo_led_table.set_border_width (1);
-       solo_led_table.attach (*_iso_label, 0, 1, 0, 1, Gtk::FILL, Gtk::FILL);
-        solo_led_table.attach (*solo_isolated_led, 1, 2, 0, 1, Gtk::FILL, Gtk::FILL);
-       solo_led_table.attach (*_safe_label, 0, 1, 1, 2, Gtk::FILL, Gtk::FILL);
-        solo_led_table.attach (*solo_safe_led, 1, 2, 1, 2, Gtk::FILL, Gtk::FILL);
-        solo_led_table.show ();
+       solo_safe_led->set_text (_("lock"));
+       solo_isolated_led->set_text (_("iso"));
 
        top_button_table.set_homogeneous (true);
-       top_button_table.set_spacings (0);
+       top_button_table.set_spacings (2);
        top_button_table.attach (*monitor_input_button, 0, 1, 0, 1);
         top_button_table.attach (*monitor_disk_button, 1, 2, 0, 1);
        top_button_table.show ();
 
-       below_panner_box.set_border_width (2);
-       below_panner_box.set_spacing (2);
-        below_panner_box.pack_end (solo_led_table, false, false);
-        below_panner_box.show ();
+       rec_solo_table.set_homogeneous (false);
+       rec_solo_table.set_row_spacings (2);
+       rec_solo_table.set_col_spacings (2);
+        rec_solo_table.attach (*solo_isolated_led, 1, 2, 0, 1);
+        rec_solo_table.attach (*solo_safe_led, 1, 2, 1, 2);
+        rec_solo_table.show ();
 
-       button_table.set_homogeneous (true);
+       button_table.set_homogeneous (false);
        button_table.set_spacings (0);
 
        button_table.attach (name_button, 0, 1, 0, 1);
@@ -261,6 +254,9 @@ MixerStrip::init ()
        Gtkmm2ext::set_size_request_to_display_given_text (group_button, "Group", 2, 2);
        group_label.set_name ("MixerGroupButtonLabel");
 
+       _comment_button.set_name (X_("MixerCommentButton"));
+       _comment_button.signal_clicked().connect (sigc::mem_fun (*this, &MixerStrip::toggle_comment));
+
        global_vpacker.set_border_width (0);
        global_vpacker.set_spacing (0);
 
@@ -281,12 +277,13 @@ MixerStrip::init ()
        global_vpacker.pack_start (button_table, Gtk::PACK_SHRINK);
        global_vpacker.pack_start (processor_box, true, true);
        global_vpacker.pack_start (panners, Gtk::PACK_SHRINK);
-       global_vpacker.pack_start (top_button_table, Gtk::PACK_SHRINK);
-       global_vpacker.pack_start (below_panner_box, Gtk::PACK_SHRINK);
-       global_vpacker.pack_start (middle_button_table, Gtk::PACK_SHRINK);
+       global_vpacker.pack_start (top_button_table, Gtk::PACK_SHRINK, 2);
+       global_vpacker.pack_start (rec_solo_table, Gtk::PACK_SHRINK, 2);
+       global_vpacker.pack_start (middle_button_table, Gtk::PACK_SHRINK, 2);
        global_vpacker.pack_start (gpm, Gtk::PACK_SHRINK);
        global_vpacker.pack_start (bottom_button_table, Gtk::PACK_SHRINK);
        global_vpacker.pack_start (output_button, Gtk::PACK_SHRINK);
+       global_vpacker.pack_start (_comment_button, Gtk::PACK_SHRINK);
 
        global_frame.add (global_vpacker);
        global_frame.set_shadow_type (Gtk::SHADOW_IN);
@@ -329,10 +326,11 @@ MixerStrip::init ()
           in update_diskstream_display().
        */
 
-       if (is_midi_track())
+       if (is_midi_track()) {
                set_name ("MidiTrackStripBase");
-       else
+       } else {
                set_name ("AudioTrackStripBase");
+       }
 
        add_events (Gdk::BUTTON_RELEASE_MASK|
                    Gdk::ENTER_NOTIFY_MASK|
@@ -347,6 +345,21 @@ MixerStrip::init ()
        AudioEngine::instance()->PortConnectedOrDisconnected.connect (
                *this, invalidator (*this), boost::bind (&MixerStrip::port_connected_or_disconnected, this, _1, _3), gui_context ()
                );
+
+       /* Add the widgets under visibility control to the VisibilityGroup; the names used here
+          must be the same as those used in RCOptionEditor so that the configuration changes
+          are recognised when they occur.
+       */
+       _visibility.add (&_invert_button_box, X_("PhaseInvert"), _("Phase Invert"));
+       _visibility.add (solo_safe_led, X_("SoloSafe"), _("Solo Safe"));
+       _visibility.add (solo_isolated_led, X_("SoloIsolated"), _("Solo Isolated"));
+       _visibility.add (&_comment_button, X_("Comments"), _("Comments"));
+       _visibility.add (&group_button, X_("Group"), _("Group"));
+       _visibility.add (&meter_point_button, X_("MeterPoint"), _("Meter Point"));
+
+       parameter_changed (X_("mixer-strip-visibility"));
+
+       Config->ParameterChanged.connect (_config_connection, MISSING_INVALIDATOR, ui_bind (&MixerStrip::parameter_changed, this, _1), gui_context());
 }
 
 MixerStrip::~MixerStrip ()
@@ -362,11 +375,11 @@ void
 MixerStrip::set_route (boost::shared_ptr<Route> rt)
 {
        if (rec_enable_button->get_parent()) {
-               below_panner_box.remove (*rec_enable_button);
+               rec_solo_table.remove (*rec_enable_button);
        }
 
        if (show_sends_button->get_parent()) {
-               below_panner_box.remove (*show_sends_button);
+               rec_solo_table.remove (*show_sends_button);
        }
 
        processor_box.set_route (rt);
@@ -388,10 +401,10 @@ MixerStrip::set_route (boost::shared_ptr<Route> rt)
 
        if (route()->is_master()) {
                solo_button->hide ();
-               below_panner_box.hide ();
+               rec_solo_table.hide ();
        } else {
                solo_button->show ();
-               below_panner_box.show ();
+               rec_solo_table.show ();
        }
 
        if (_mixer_owned && (route()->is_master() || route()->is_monitor())) {
@@ -453,7 +466,7 @@ MixerStrip::set_route (boost::shared_ptr<Route> rt)
 
        if (is_track ()) {
 
-               below_panner_box.pack_start (*rec_enable_button);
+               rec_solo_table.attach (*rec_enable_button, 0, 1, 0, 2);
                rec_enable_button->set_sensitive (_session->writable());
                rec_enable_button->show();
 
@@ -462,7 +475,7 @@ MixerStrip::set_route (boost::shared_ptr<Route> rt)
                /* non-master bus */
 
                if (!_route->is_master()) {
-                       below_panner_box.pack_start (*show_sends_button);
+                       rec_solo_table.attach (*show_sends_button, 0, 1, 0, 2);
                        show_sends_button->show();
                }
        }
@@ -531,9 +544,12 @@ MixerStrip::set_route (boost::shared_ptr<Route> rt)
        output_label.show();
        name_label.show();
        name_button.show();
+       _comment_button.show();
        group_button.show();
        group_label.show();
 
+       parameter_changed ("mixer-strip-visibility");
+
        show ();
 }
 
@@ -571,7 +587,7 @@ MixerStrip::set_width_enum (Width w, void* owner)
        switch (w) {
        case Wide:
                if (show_sends_button)  {
-                       ((Gtk::Label*)show_sends_button->get_child())->set_text (_("Sends"));
+                       show_sends_button->set_text (_("Sends"));
                }
 
                ((Gtk::Label*)gpm.gain_automation_style_button.get_child())->set_text (
@@ -586,8 +602,8 @@ MixerStrip::set_width_enum (Width w, void* owner)
                                        panners.astate_string(_route->panner()->automation_state()));
                }
 
-               _iso_label->show ();
-               _safe_label->show ();
+               solo_isolated_led->set_text (_("iso"));
+               solo_safe_led->set_text (_("lock"));
 
                Gtkmm2ext::set_size_request_to_display_given_text (name_button, "long", 2, 2);
                set_size_request (-1, -1);
@@ -595,7 +611,7 @@ MixerStrip::set_width_enum (Width w, void* owner)
 
        case Narrow:
                if (show_sends_button) {
-                       ((Gtk::Label*)show_sends_button->get_child())->set_text (_("Snd"));
+                       show_sends_button->set_text (_("Snd"));
                }
 
                ((Gtk::Label*)gpm.gain_automation_style_button.get_child())->set_text (
@@ -609,9 +625,9 @@ MixerStrip::set_width_enum (Width w, void* owner)
                        ((Gtk::Label*)panners.pan_automation_state_button.get_child())->set_text (
                        panners.short_astate_string(_route->panner()->automation_state()));
                }
-
-               _iso_label->hide ();
-               _safe_label->hide ();
+               
+               solo_isolated_led->set_text ("");
+               solo_safe_led->set_text ("");
 
                Gtkmm2ext::set_size_request_to_display_given_text (name_button, longest_label.c_str(), 2, 2);
                set_size_request (max (50, gpm.get_gm_width()), -1);
@@ -622,6 +638,7 @@ MixerStrip::set_width_enum (Width w, void* owner)
 
        update_input_display ();
        update_output_display ();
+       setup_comment_button ();
        route_group_changed ();
        name_changed ();
        WidthChanged ();
@@ -1005,7 +1022,7 @@ MixerStrip::update_io_button (boost::shared_ptr<ARDOUR::Route> route, Width widt
 {
        uint32_t io_count;
        uint32_t io_index;
-       Port *port;
+       boost::shared_ptr<Port> port;
        vector<string> port_connections;
 
        uint32_t total_connection_count = 0;
@@ -1197,32 +1214,63 @@ MixerStrip::diskstream_changed ()
 }
 
 void
-MixerStrip::port_connected_or_disconnected (Port* a, Port* b)
+MixerStrip::port_connected_or_disconnected (boost::weak_ptr<Port> wa, boost::weak_ptr<Port> wb)
 {
-       if (_route->input()->has_port (a) || _route->input()->has_port (b)) {
+       boost::shared_ptr<Port> a = wa.lock ();
+       boost::shared_ptr<Port> b = wb.lock ();
+
+       if ((a && _route->input()->has_port (a)) || (b && _route->input()->has_port (b))) {
                update_input_display ();
                set_width_enum (_width, this);
        }
 
-       if (_route->output()->has_port (a) || _route->output()->has_port (b)) {
+       if ((a && _route->output()->has_port (a)) || (b && _route->output()->has_port (b))) {
                update_output_display ();
                set_width_enum (_width, this);
        }
 }
 
 void
-MixerStrip::comment_editor_done_editing ()
+MixerStrip::setup_comment_button ()
 {
-       ignore_toggle = true;
-       _comment_menu_item->set_active (false);
-       ignore_toggle = false;
+       switch (_width) {
 
+       case Wide:
+               if (_route->comment().empty ()) {
+                       _comment_button.unset_bg (STATE_NORMAL);
+                       ((Gtk::Label *) _comment_button.get_child ())->set_text (_("Comments"));
+               } else {
+                       _comment_button.modify_bg (STATE_NORMAL, color ());
+                       ((Gtk::Label *) _comment_button.get_child ())->set_text (_("*Comments*"));
+               }
+               break;
+
+       case Narrow:
+               if (_route->comment().empty ()) {
+                       _comment_button.unset_bg (STATE_NORMAL);
+                       ((Gtk::Label *) _comment_button.get_child ())->set_text (_("Cmt"));
+               } else {
+                       _comment_button.modify_bg (STATE_NORMAL, color ());
+                       ((Gtk::Label *) _comment_button.get_child ())->set_text (_("*Cmt*"));
+               }
+               break;
+       }
+
+       ARDOUR_UI::instance()->set_tip (
+               _comment_button, _route->comment().empty() ? _("Click to Add/Edit Comments") : _route->comment()
+               );
+}
+
+void
+MixerStrip::comment_editor_done_editing ()
+{
        string const str = comment_area->get_buffer()->get_text();
        if (str == _route->comment ()) {
                return;
        }
 
        _route->set_comment (str, this);
+       setup_comment_button ();
 }
 
 void
@@ -1355,13 +1403,15 @@ MixerStrip::build_route_ops_menu ()
        MenuList& items = route_ops_menu->items();
 
        items.push_back (CheckMenuElem (_("Comments..."), sigc::mem_fun (*this, &MixerStrip::toggle_comment)));
-       _comment_menu_item = dynamic_cast<CheckMenuItem*> (&items.back ());
+       CheckMenuItem* i = dynamic_cast<CheckMenuItem*> (&items.back ());
+       i->set_active (comment_window && comment_window->is_visible ());
        items.push_back (MenuElem (_("Save As Template..."), sigc::mem_fun(*this, &RouteUI::save_as_template)));
        items.push_back (MenuElem (_("Rename..."), sigc::mem_fun(*this, &RouteUI::route_rename)));
        rename_menu_item = &items.back();
+
        items.push_back (SeparatorElem());
        items.push_back (CheckMenuElem (_("Active")));
-       CheckMenuItem* i = dynamic_cast<CheckMenuItem *> (&items.back());
+       i = dynamic_cast<CheckMenuItem *> (&items.back());
        i->set_active (_route->active());
        i->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &RouteUI::set_route_active), !_route->active(), false));
 
@@ -1623,8 +1673,7 @@ MixerStrip::switch_io (boost::shared_ptr<Route> target)
                   since we're not the target.
                */
                send_blink_connection.disconnect ();
-               show_sends_button->set_active (false);
-               show_sends_button->set_state (STATE_NORMAL);
+               show_sends_button->unset_active_state ();
        }
 
        if (!target) {
@@ -1664,6 +1713,7 @@ MixerStrip::drop_send ()
        solo_safe_led->set_sensitive (true);
        monitor_input_button->set_sensitive (true);
        monitor_disk_button->set_sensitive (true);
+       _comment_button.set_sensitive (true);
 }
 
 void
@@ -1702,6 +1752,7 @@ MixerStrip::show_send (boost::shared_ptr<Send> send)
        solo_safe_led->set_sensitive (false);
        monitor_input_button->set_sensitive (false);
        monitor_disk_button->set_sensitive (false);
+       _comment_button.set_sensitive (false);
 
        if (boost::dynamic_pointer_cast<InternalSend>(send)) {
                output_button.set_sensitive (false);
@@ -1714,7 +1765,7 @@ void
 MixerStrip::revert_to_default_display ()
 {
        if (show_sends_button) {
-               show_sends_button->set_active (false);
+               show_sends_button->unset_active_state ();
        }
 
        drop_send ();
@@ -1736,12 +1787,21 @@ MixerStrip::set_button_names ()
        switch (_width) {
        case Wide:
                rec_enable_button_label.set_text (_("Rec"));
-               mute_button_label.set_text (_("Mute"));
-               monitor_input_button_label.set_text (_("In"));
-               monitor_disk_button_label.set_text (_("Disk"));
+               mute_button->set_text (_("Mute"));
+               monitor_input_button->set_text (_("In"));
+               monitor_disk_button->set_text (_("Disk"));
+
                if (_route && _route->solo_safe()) {
-                       solo_button_label.set_text (X_("!"));
+                       solo_button->remove ();
+                       if (solo_safe_image == 0) {
+                               solo_safe_image = new Gtk::Image (::get_icon("solo-safe-enabled"));
+                               solo_safe_image->show ();
+                       }
+                       solo_button->add (*solo_safe_image);
                } else {
+                       solo_button->remove ();
+                       solo_button->add (solo_button_label);
+                       solo_button_label.show ();
                        if (!Config->get_solo_control_is_listen_control()) {
                                solo_button_label.set_text (_("Solo"));
                        } else {
@@ -1759,11 +1819,20 @@ MixerStrip::set_button_names ()
 
        default:
                rec_enable_button_label.set_text (_("R"));
-               mute_button_label.set_text (_("M"));
-               monitor_input_button_label.set_text (_("I"));
-               monitor_disk_button_label.set_text (_("D"));
+               mute_button->set_text (_("M"));
+               monitor_input_button->set_text (_("I"));
+               monitor_disk_button->set_text (_("D"));
                if (_route && _route->solo_safe()) {
-                       solo_button_label.set_text (X_("!"));
+                       solo_button->remove ();
+                       if (solo_safe_image == 0) {
+                               solo_safe_image = new Gtk::Image (::get_icon("solo-safe-enabled"));
+                               solo_safe_image->show ();
+                       }
+                       solo_button->add (*solo_safe_image);
+               } else {
+                       solo_button->remove ();
+                       solo_button->add (solo_button_label);
+                       solo_button_label.show ();
                        if (!Config->get_solo_control_is_listen_control()) {
                                solo_button_label.set_text (_("S"));
                        } else {
@@ -1957,3 +2026,14 @@ MixerStrip::state_id () const
 {
        return string_compose ("strip %1", _route->id().to_s());
 }
+
+void
+MixerStrip::parameter_changed (string p)
+{
+       if (p == _visibility.get_state_name()) {
+               /* The user has made changes to the mixer strip visibility, so get
+                  our VisibilityGroup to reflect these changes in our widgets.
+               */
+               _visibility.set_state (Config->get_mixer_strip_visibility ());
+       }
+}