manually fix up various cases where Gtk:Frame foo_frame had been changed to foo_sample
[ardour.git] / gtk2_ardour / vca_master_strip.cc
index 590b7c8d2ece62b713de543c13f67905c53e6a13..eacc1a0ecd3844c63f7497e9a1d698cfbe9bada6 100644 (file)
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
-#include "pbd/convert.h"
+#include <gtkmm/stock.h>
+
+#include "pbd/string_convert.h"
 
 #include "ardour/rc_configuration.h"
 #include "ardour/session.h"
 #include "ardour/vca.h"
 #include "ardour/vca_manager.h"
 
+#include "gtkmm2ext/doi.h"
 #include "gtkmm2ext/keyboard.h"
+#include "widgets/tooltips.h"
 
-#include "gui_thread.h"
+#include "ardour_dialog.h"
 #include "floating_text_entry.h"
-#include "tooltips.h"
+#include "gui_thread.h"
+#include "mixer_ui.h"
+#include "ui_config.h"
+#include "utils.h"
 #include "vca_master_strip.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
-using namespace ARDOUR_UI_UTILS;
+using namespace ArdourWidgets;
 using namespace Gtkmm2ext;
 using namespace Gtk;
 using namespace PBD;
 using std::string;
 
+PBD::Signal1<void,VCAMasterStrip*> VCAMasterStrip::CatchDeletion;
+
 VCAMasterStrip::VCAMasterStrip (Session* s, boost::shared_ptr<VCA> v)
-       : AxisView (s)
+       : SessionHandlePtr (s)
        , _vca (v)
-       , gain_meter (s, 250)
+       , gain_meter (s, 254) /* magic number, don't adjust blindly */
        , context_menu (0)
+       , delete_dialog (0)
+       , control_slave_ui (s)
 {
+       /* set color for the VCA, if not already done. */
+
+       if (!_vca->presentation_info().color_set()) {
+               _vca->presentation_info().set_color (ARDOUR_UI_UTILS::gdk_color_to_rgba (unique_random_color()));
+       }
+
+       control_slave_ui.set_stripable (boost::dynamic_pointer_cast<Stripable> (v));
+
        gain_meter.set_controls (boost::shared_ptr<Route>(),
                                 boost::shared_ptr<PeakMeter>(),
                                 boost::shared_ptr<Amp>(),
@@ -62,42 +81,48 @@ VCAMasterStrip::VCAMasterStrip (Session* s, boost::shared_ptr<VCA> v)
        hide_button.set_icon (ArdourIcon::CloseCross);
        set_tooltip (&hide_button, _("Hide this VCA strip"));
 
-       assign_button.set_name (X_("vca assign"));
-       set_tooltip (assign_button, _("Click to assign a VCA Master to this VCA"));
-       assign_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::vca_button_release), false);
-
        hide_button.signal_clicked.connect (sigc::mem_fun(*this, &VCAMasterStrip::hide_clicked));
 
-       width_hide_box.pack_start (number_label, true, true);
-       width_hide_box.pack_end (hide_button, false, true);
-
        solo_mute_box.set_spacing (2);
        solo_mute_box.pack_start (mute_button, true, true);
        solo_mute_box.pack_start (solo_button, true, true);
 
-       number_label.set_text (to_string (v->number(), std::dec));
+       mute_button.set_controllable (_vca->mute_control());
+       solo_button.set_controllable (_vca->solo_control());
+
+       number_label.set_text (PBD::to_string (v->number()));
        number_label.set_elements((ArdourButton::Element)(ArdourButton::Edge|ArdourButton::Body|ArdourButton::Text|ArdourButton::Inactive));
        number_label.set_no_show_all ();
        number_label.set_name ("generic button");
        number_label.set_alignment (.5, .5);
        number_label.set_fallthrough_to_parent (true);
-
-       name_button.signal_button_press_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::name_button_press), false);
-
-       top_padding.set_size_request (-1, 16); /* must match height in GroupTabs::set_size_request() */
-       bottom_padding.set_size_request (-1, 50); /* this one is a hack. there's no trivial way to compute it */
-
-       global_vpacker.set_border_width (1);
+       number_label.set_inactive_color (_vca->presentation_info().color ());
+       number_label.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::number_button_press), false);
+
+       update_bottom_padding ();
+
+       //Glib::RefPtr<Pango::Layout> layout = vertical_button.get_layout ();
+       // layout->set_justify (JUSTIFY_CENTER);
+       /* horizontally centered, with a little space (5%) at the top */
+       vertical_button.set_angle (90);
+       vertical_button.set_layout_font (UIConfiguration::instance().get_NormalBoldFont());
+       vertical_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::vertical_button_press));
+       vertical_button.set_fallthrough_to_parent (true);
+       vertical_button.set_active_color (_vca->presentation_info().color ());
+       set_tooltip (vertical_button, _("Click to show slaves only")); /* tooltip updated dynamically */
+
+       global_vpacker.set_border_width (0);
        global_vpacker.set_spacing (0);
+       gain_meter.set_spacing(4);
 
-       global_vpacker.pack_start (top_padding, false, false);
-       global_vpacker.pack_start (width_hide_box, false, false);
-       global_vpacker.pack_start (name_button, false, false);
-       global_vpacker.pack_start (vertical_padding, true, true);
-       global_vpacker.pack_start (solo_mute_box, false, false);
-       global_vpacker.pack_start (gain_meter, false, false);
-       global_vpacker.pack_start (assign_button, false, false);
-       global_vpacker.pack_start (bottom_padding, false, false);
+       global_vpacker.pack_start (number_label, false, false, 1);
+       global_vpacker.pack_start (hide_button, false, false, 1);
+       global_vpacker.pack_start (vertical_button, true, true, 1);
+       global_vpacker.pack_start (solo_mute_box, false, false, 1);
+       global_vpacker.pack_start (gain_meter, false, false, 1);
+       global_vpacker.pack_start (control_slave_ui, false, false, 1);
+       global_vpacker.pack_start (gain_meter.gain_automation_state_button, false, false, 1);
+       global_vpacker.pack_start (bottom_padding, false, false, 0);
 
        global_frame.add (global_vpacker);
        global_frame.set_shadow_type (Gtk::SHADOW_IN);
@@ -108,60 +133,135 @@ VCAMasterStrip::VCAMasterStrip (Session* s, boost::shared_ptr<VCA> v)
        global_vpacker.show ();
        global_frame.show ();
        top_padding.show ();
-       bottom_padding.show ();
-       vertical_padding.show ();
+       vertical_button.show ();
        hide_button.show ();
        number_label.show ();
-       width_hide_box.show ();
-       name_button.show ();
        gain_meter.show ();
        solo_mute_box.show_all ();
-       assign_button.show ();
+       control_slave_ui.show ();
+       gain_meter.gain_automation_state_button.show ();
 
        /* force setting of visible selected status */
 
        _selected = true;
        set_selected (false);
        set_solo_text ();
-       update_vca_display ();
        update_vca_name ();
+       solo_changed ();
+       mute_changed ();
+       spill_change (boost::shared_ptr<VCA>());
+
+       Mixer_UI::instance()->show_spill_change.connect (sigc::mem_fun (*this, &VCAMasterStrip::spill_change));
 
        _vca->PropertyChanged.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::vca_property_changed, this, _1), gui_context());
+       _vca->presentation_info().PropertyChanged.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::vca_property_changed, this, _1), gui_context());
+       _vca->DropReferences.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::self_delete, this), gui_context());
 
        _vca->solo_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::solo_changed, this), gui_context());
        _vca->mute_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::mute_changed, this), gui_context());
 
-       /* only need to connect to one of these to update VCA status */
 
-       _vca->gain_control()->MasterStatusChange.connect (vca_connections,
-                                                 invalidator (*this),
-                                                 boost::bind (&VCAMasterStrip::update_vca_display, this),
-                                                 gui_context());
+       s->config.ParameterChanged.connect (*this, invalidator (*this), boost::bind (&VCAMasterStrip::parameter_changed, this, _1), gui_context());
+       Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&VCAMasterStrip::parameter_changed, this, _1), gui_context());
+       UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun (*this, &VCAMasterStrip::parameter_changed));
+}
+
+VCAMasterStrip::~VCAMasterStrip ()
+{
+       if ((_session && !_session->deletion_in_progress()) && Mixer_UI::instance()->showing_spill_for (_vca)) {
+               /* cancel spill for this VCA */
+               Mixer_UI::instance()->show_spill (boost::shared_ptr<Stripable>());
+       }
+
+       delete delete_dialog;
+       delete context_menu;
+
+       CatchDeletion (this); /* EMIT SIGNAL */
 }
 
 void
-VCAMasterStrip::update_vca_display ()
+VCAMasterStrip::self_delete ()
 {
-       VCAList vcas (_session->vca_manager().vcas());
-       string label;
+       if ((_session && !_session->deletion_in_progress()) && Mixer_UI::instance()->showing_spill_for (_vca)) {
+               /* cancel spill for this VCA */
+               Mixer_UI::instance()->show_spill (boost::shared_ptr<Stripable>());
+       }
+       /* Drop reference immediately, delete self when idle */
+       _vca.reset ();
+       gain_meter.set_controls (boost::shared_ptr<Route>(),
+                                boost::shared_ptr<PeakMeter>(),
+                                boost::shared_ptr<Amp>(),
+                                boost::shared_ptr<GainControl>());
+       delete_when_idle (this);
+}
 
-       for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
-               if (_vca->gain_control()->slaved_to ((*v)->gain_control())) {
-                       if (!label.empty()) {
-                               label += ' ';
-                       }
-                       label += to_string ((*v)->number(), std::dec);
+void
+VCAMasterStrip::parameter_changed (std::string const & p)
+{
+       if (p == "use-monitor-bus" || p == "solo-control-is-listen-control" || p == "listen-position") {
+               set_button_names ();
+       } else if (p == "mixer-element-visibility") {
+               update_bottom_padding ();
+       }
+}
+
+void
+VCAMasterStrip::set_button_names ()
+{
+       if (Config->get_solo_control_is_listen_control()) {
+               switch (Config->get_listen_position()) {
+               case AfterFaderListen:
+                       solo_button.set_text (S_("AfterFader|A"));
+                       set_tooltip (solo_button, _("After-fade listen (AFL)"));
+                       break;
+               case PreFaderListen:
+                       solo_button.set_text (S_("PreFader|P"));
+                       set_tooltip (solo_button, _("Pre-fade listen (PFL)"));
+                       break;
                }
+       } else {
+               solo_button.set_text (S_("Solo|S"));
+               set_tooltip (solo_button, _("Solo"));
        }
+}
 
-       if (label.empty()) {
-               label = _("-vca-");
-               assign_button.set_active_state (Gtkmm2ext::Off);
+void
+VCAMasterStrip::update_bottom_padding ()
+{
+       std::string viz = UIConfiguration::instance().get_mixer_strip_visibility ();
+
+       ArdourButton output_button (_("Output"));
+       ArdourButton comment_button (_("Comments"));
+
+       output_button.set_name ("mixer strip button");
+       comment_button.set_name ("generic button");
+
+       if (viz.find ("VCA") == std::string::npos) {
+               control_slave_ui.hide ();
        } else {
-               assign_button.set_active_state (Gtkmm2ext::ExplicitActive);
+               control_slave_ui.show ();
        }
 
-       assign_button.set_text (label);
+       int h = 0;
+       if (viz.find ("Output") != std::string::npos) {
+               Gtk::Window window (WINDOW_TOPLEVEL);
+               window.add (output_button);
+               Gtk::Requisition requisition(output_button.size_request ());
+               h += requisition.height + 2;
+       }
+       if (viz.find ("Comments") != std::string::npos) {
+               Gtk::Window window (WINDOW_TOPLEVEL);
+               window.add (comment_button);
+               Gtk::Requisition requisition(comment_button.size_request ());
+               h += requisition.height + 2;
+       }
+       if (h <= 0) {
+               bottom_padding.set_size_request (-1, 1);
+               bottom_padding.hide ();
+       } else {
+               bottom_padding.set_size_request (-1, h);
+               bottom_padding.show ();
+       }
 }
 
 string
@@ -173,6 +273,24 @@ VCAMasterStrip::name() const
 void
 VCAMasterStrip::hide_clicked ()
 {
+       _vca->presentation_info().set_hidden (true);
+}
+
+void
+VCAMasterStrip::hide_confirmation (int response)
+{
+       delete_dialog->hide ();
+
+       switch (response) {
+       case RESPONSE_YES:
+               /* get everything to deassign. This will also delete ourselves (when
+                * idle) and that in turn will remove us from the Mixer GUI
+                */
+               _session->vca_manager().remove_vca (_vca);
+               break;
+       default:
+               break;
+       }
 }
 
 bool
@@ -258,95 +376,32 @@ VCAMasterStrip::solo_changed ()
        }
 }
 
-void
-VCAMasterStrip::vca_menu_toggle (CheckMenuItem* menuitem, uint32_t n)
-{
-       boost::shared_ptr<VCA> vca = _session->vca_manager().vca_by_number (n);
-
-       if (!menuitem->get_active()) {
-               if (!vca) {
-                       /* null VCA means drop all VCA assignments */
-                       vca_unassign ();
-               } else {
-                       _vca->gain_control()->remove_master (vca->gain_control());
-                       _vca->solo_control()->remove_master (vca->solo_control());
-                       _vca->mute_control()->remove_master (vca->mute_control());
-               }
-       } else {
-               if (vca) {
-                       _vca->gain_control()->add_master (vca->gain_control());
-                       _vca->mute_control()->add_master (vca->mute_control());
-                       _vca->solo_control()->add_master (vca->solo_control());
-               }
-       }
-}
-
-void
-VCAMasterStrip::vca_unassign ()
-{
-       _vca->gain_control()->clear_masters ();
-       _vca->solo_control()->clear_masters ();
-       _vca->mute_control()->clear_masters ();
-}
-
 bool
-VCAMasterStrip::vca_button_release (GdkEventButton* ev)
+VCAMasterStrip::vertical_button_press (GdkEventButton* ev)
 {
-       using namespace Gtk::Menu_Helpers;
-
-       if (!_session) {
-               return false;
-       }
-
-       /* primary click only */
-
-       if (ev->button != 1) {
-               return false;
-       }
-
-       VCAList vcas (_session->vca_manager().vcas());
-
-       if (vcas.empty()) {
-               /* XXX should probably show a message saying "No VCA masters" */
+       if (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
+               start_name_edit ();
                return true;
        }
 
-       Menu* menu = new Menu;
-       MenuList& items = menu->items();
-
-       items.push_back (MenuElem (_("Unassign"), sigc::mem_fun (*this, &VCAMasterStrip::vca_unassign)));
-
-       for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
-
-               if (*v == _vca) {
-                       /* no self-mastering */
-                       continue;
-               }
-
-               items.push_back (CheckMenuElem ((*v)->name()));
-               CheckMenuItem* item = dynamic_cast<CheckMenuItem*> (&items.back());
-               if (_vca->gain_control()->slaved_to ((*v)->gain_control())) {
-                       item->set_active (true);
+       if (Keyboard::is_context_menu_event (ev)) {
+               if (!context_menu) {
+                       build_context_menu ();
                }
-               item->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &VCAMasterStrip::vca_menu_toggle), item, (*v)->number()));
+               context_menu->popup (1, ev->time);
+               return true;
        }
 
-       menu->popup (1, ev->time);
+       if (ev->button == 1) {
+               spill ();
+       }
 
        return true;
 }
 
 bool
-VCAMasterStrip::name_button_press (GdkEventButton* ev)
+VCAMasterStrip::number_button_press (GdkEventButton* ev)
 {
-       if (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
-               Gtk::Window* win = dynamic_cast<Gtk::Window*>(get_toplevel());
-               FloatingTextEntry* fte = new FloatingTextEntry (win, _vca->name());
-               fte->use_text.connect (sigc::mem_fun (*this, &VCAMasterStrip::finish_name_edit));
-               fte->present ();
-               return true;
-       }
-
        if (Keyboard::is_context_menu_event (ev)) {
                if (!context_menu) {
                        build_context_menu ();
@@ -354,12 +409,20 @@ VCAMasterStrip::name_button_press (GdkEventButton* ev)
                context_menu->popup (1, ev->time);
                return true;
        }
-
        return false;
 }
 
 void
-VCAMasterStrip::finish_name_edit (std::string str)
+VCAMasterStrip::start_name_edit ()
+{
+       Gtk::Window* win = dynamic_cast<Gtk::Window*>(get_toplevel());
+       FloatingTextEntry* fte = new FloatingTextEntry (win, _vca->name());
+       fte->use_text.connect (sigc::mem_fun (*this, &VCAMasterStrip::finish_name_edit));
+       fte->present ();
+}
+
+void
+VCAMasterStrip::finish_name_edit (std::string str, int)
 {
        _vca->set_name (str);
 }
@@ -370,12 +433,22 @@ VCAMasterStrip::vca_property_changed (PropertyChange const & what_changed)
        if (what_changed.contains (ARDOUR::Properties::name)) {
                update_vca_name ();
        }
+
+       if (what_changed.contains (ARDOUR::Properties::color)) {
+               vertical_button.set_active_color (_vca->presentation_info().color ());
+               number_label.set_inactive_color (_vca->presentation_info().color ());
+       }
+
+       if (what_changed.contains (ARDOUR::Properties::hidden)) {
+
+       }
 }
 
 void
 VCAMasterStrip::update_vca_name ()
 {
-       name_button.set_text (short_version (_vca->name(), 8));
+       /* 20 is a rough guess at the number of letters we can fit. */
+       vertical_button.set_text (short_version (_vca->full_name(), 20));
 }
 
 void
@@ -384,5 +457,113 @@ VCAMasterStrip::build_context_menu ()
        using namespace Gtk::Menu_Helpers;
        context_menu = new Menu;
        MenuList& items = context_menu->items();
-       items.push_back (MenuElem (_("Remove")));
+       items.push_back (MenuElem (_("Rename"), sigc::mem_fun (*this, &VCAMasterStrip::start_name_edit)));
+       items.push_back (MenuElem (_("Color..."), sigc::mem_fun (*this, &VCAMasterStrip::start_color_edit)));
+       items.push_back (SeparatorElem());
+       items.push_back (MenuElem (_("Assign Selected Channels"), sigc::mem_fun (*this, &VCAMasterStrip::assign_all_selected)));
+       items.push_back (MenuElem (_("Drop Selected Channels"), sigc::mem_fun (*this, &VCAMasterStrip::unassign_all_selected)));
+       items.push_back (SeparatorElem());
+       items.push_back (MenuElem (_("Drop All Slaves"), sigc::mem_fun (*this, &VCAMasterStrip::drop_all_slaves)));
+       items.push_back (SeparatorElem());
+       items.push_back (MenuElem (_("Remove"), sigc::mem_fun (*this, &VCAMasterStrip::remove)));
+}
+
+void
+VCAMasterStrip::spill ()
+{
+       if (Mixer_UI::instance()->showing_spill_for (_vca)) {
+               Mixer_UI::instance()->show_spill (boost::shared_ptr<Stripable>());
+       } else {
+               Mixer_UI::instance()->show_spill (_vca);
+       }
+}
+
+void
+VCAMasterStrip::spill_change (boost::shared_ptr<Stripable> vca)
+{
+       if (vca != _vca) {
+               vertical_button.set_active_state (Gtkmm2ext::Off);
+               set_tooltip (vertical_button, _("Click to show slaves only"));
+       } else {
+               vertical_button.set_active_state (Gtkmm2ext::ExplicitActive);
+               set_tooltip (vertical_button, _("Click to show normal mixer"));
+       }
+}
+
+void
+VCAMasterStrip::remove ()
+{
+       if (!_session) {
+               return;
+       }
+
+       _session->vca_manager().remove_vca (_vca);
+}
+
+void
+VCAMasterStrip::assign_all_selected ()
+{
+       Mixer_UI::instance()->do_vca_assign (_vca);
+}
+
+void
+VCAMasterStrip::unassign_all_selected ()
+{
+       Mixer_UI::instance()->do_vca_unassign (_vca);
+}
+
+void
+VCAMasterStrip::drop_all_slaves ()
+{
+       _vca->Drop (); /* EMIT SIGNAL */
+
+       if (Mixer_UI::instance()->showing_spill_for (_vca)) {
+               Mixer_UI::instance()->show_spill (boost::shared_ptr<Stripable>());
+       }
+}
+
+Gdk::Color
+VCAMasterStrip::color () const
+{
+       return ARDOUR_UI_UTILS::gdk_color_from_rgba (_vca->presentation_info().color ());
+}
+
+string
+VCAMasterStrip::state_id () const
+{
+       return string_compose (X_("vms-%1"), _vca->number());
+}
+
+void
+VCAMasterStrip::start_color_edit ()
+{
+       _color_picker.popup (_vca);
+}
+
+bool
+VCAMasterStrip::marked_for_display () const
+{
+       return !_vca->presentation_info().hidden();
+}
+
+bool
+VCAMasterStrip::set_marked_for_display (bool yn)
+{
+       if (yn == _vca->presentation_info().hidden()) {
+               _vca->presentation_info().set_hidden (!yn);
+               return true; // things changed
+       }
+       return false;
+}
+
+PresentationInfo const &
+VCAMasterStrip::presentation_info () const
+{
+       return _vca->presentation_info();
+}
+
+boost::shared_ptr<Stripable>
+VCAMasterStrip::stripable () const
+{
+       return _vca;
 }