gtk2_ardour/vca_master_strip.cc

   1 /*
   2     Copyright (C) 2016 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #include <gtkmm/stock.h>
  20
  21 #include "pbd/string_convert.h"
  22
  23 #include "ardour/rc_configuration.h"
  24 #include "ardour/session.h"
  25 #include "ardour/vca.h"
  26 #include "ardour/vca_manager.h"
  27
  28 #include "gtkmm2ext/doi.h"
  29 #include "gtkmm2ext/keyboard.h"
  30 #include "widgets/tooltips.h"
  31
  32 #include "ardour_dialog.h"
  33 #include "floating_text_entry.h"
  34 #include "gui_thread.h"
  35 #include "mixer_ui.h"
  36 #include "ui_config.h"
  37 #include "utils.h"
  38 #include "vca_master_strip.h"
  39
  40 #include "pbd/i18n.h"
  41
  42 using namespace ARDOUR;
  43 using namespace ArdourWidgets;
  44 using namespace Gtkmm2ext;
  45 using namespace Gtk;
  46 using namespace PBD;
  47 using std::string;
  48
  49 PBD::Signal1<void,VCAMasterStrip*> VCAMasterStrip::CatchDeletion;
  50
  51 VCAMasterStrip::VCAMasterStrip (Session* s, boost::shared_ptr<VCA> v)
  52         : SessionHandlePtr (s)
  53         , _vca (v)
  54         , gain_meter (s, 254) /* magic number, don't adjust blindly */
  55         , context_menu (0)
  56         , delete_dialog (0)
  57         , control_slave_ui (s)
  58 {
  59         /* set color for the VCA, if not already done. */
  60
  61         if (!_vca->presentation_info().color_set()) {
  62                 _vca->presentation_info().set_color (ARDOUR_UI_UTILS::gdk_color_to_rgba (unique_random_color()));
  63         }
  64
  65         control_slave_ui.set_stripable (boost::dynamic_pointer_cast<Stripable> (v));
  66
  67         gain_meter.set_controls (boost::shared_ptr<Route>(),
  68                                  boost::shared_ptr<PeakMeter>(),
  69                                  boost::shared_ptr<Amp>(),
  70                                  _vca->gain_control());
  71
  72         solo_button.set_name ("solo button");
  73         set_tooltip (solo_button, _("Solo slaves"));
  74         solo_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::solo_release), false);
  75
  76         mute_button.set_name ("mute button");
  77         mute_button.set_text (_("M"));
  78         set_tooltip (mute_button, _("Mute slaves"));
  79         mute_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::mute_release), false);
  80
  81         hide_button.set_icon (ArdourIcon::CloseCross);
  82         set_tooltip (&hide_button, _("Hide this VCA strip"));
  83
  84         hide_button.signal_clicked.connect (sigc::mem_fun(*this, &VCAMasterStrip::hide_clicked));
  85
  86         solo_mute_box.set_spacing (2);
  87         solo_mute_box.pack_start (mute_button, true, true);
  88         solo_mute_box.pack_start (solo_button, true, true);
  89
  90         mute_button.set_controllable (_vca->mute_control());
  91         solo_button.set_controllable (_vca->solo_control());
  92
  93         number_label.set_text (PBD::to_string (v->number()));
  94         number_label.set_elements((ArdourButton::Element)(ArdourButton::Edge|ArdourButton::Body|ArdourButton::Text|ArdourButton::Inactive));
  95         number_label.set_no_show_all ();
  96         number_label.set_name ("generic button");
  97         number_label.set_alignment (.5, .5);
  98         number_label.set_fallthrough_to_parent (true);
  99         number_label.set_inactive_color (_vca->presentation_info().color ());
 100         number_label.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::number_button_press));
 101
 102         update_bottom_padding ();
 103
 104         //Glib::RefPtr<Pango::Layout> layout = vertical_button.get_layout ();
 105         // layout->set_justify (JUSTIFY_CENTER);
 106         /* horizontally centered, with a little space (5%) at the top */
 107         vertical_button.set_angle (90);
 108         vertical_button.set_layout_font (UIConfiguration::instance().get_NormalBoldFont());
 109         vertical_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::vertical_button_press));
 110         vertical_button.set_fallthrough_to_parent (true);
 111         vertical_button.set_active_color (_vca->presentation_info().color ());
 112         set_tooltip (vertical_button, _("Click to show slaves only")); /* tooltip updated dynamically */
 113
 114         global_vpacker.set_border_width (0);
 115         global_vpacker.set_spacing (0);
 116         gain_meter.set_spacing(4);
 117
 118         global_vpacker.pack_start (number_label, false, false, 1);
 119         global_vpacker.pack_start (hide_button, false, false, 1);
 120         global_vpacker.pack_start (vertical_button, true, true, 1);
 121         global_vpacker.pack_start (solo_mute_box, false, false, 1);
 122         global_vpacker.pack_start (gain_meter, false, false, 1);
 123         global_vpacker.pack_start (control_slave_ui, false, false, 1);
 124         global_vpacker.pack_start (gain_meter.gain_automation_state_button, false, false, 1);
 125         global_vpacker.pack_start (bottom_padding, false, false, 0);
 126
 127         global_frame.add (global_vpacker);
 128         global_frame.set_shadow_type (Gtk::SHADOW_IN);
 129         global_frame.set_name ("BaseFrame");
 130
 131         add (global_frame);
 132
 133         global_vpacker.show ();
 134         global_frame.show ();
 135         top_padding.show ();
 136         vertical_button.show ();
 137         hide_button.show ();
 138         number_label.show ();
 139         gain_meter.show ();
 140         solo_mute_box.show_all ();
 141         control_slave_ui.show ();
 142         gain_meter.gain_automation_state_button.show ();
 143
 144         /* force setting of visible selected status */
 145
 146         _selected = true;
 147         set_selected (false);
 148         set_solo_text ();
 149         update_vca_name ();
 150         solo_changed ();
 151         mute_changed ();
 152         spill_change (boost::shared_ptr<VCA>());
 153
 154         Mixer_UI::instance()->show_spill_change.connect (sigc::mem_fun (*this, &VCAMasterStrip::spill_change));
 155
 156         _vca->PropertyChanged.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::vca_property_changed, this, _1), gui_context());
 157         _vca->presentation_info().PropertyChanged.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::vca_property_changed, this, _1), gui_context());
 158         _vca->DropReferences.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::self_delete, this), gui_context());
 159
 160         _vca->solo_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::solo_changed, this), gui_context());
 161         _vca->mute_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::mute_changed, this), gui_context());
 162
 163
 164         s->config.ParameterChanged.connect (*this, invalidator (*this), boost::bind (&VCAMasterStrip::parameter_changed, this, _1), gui_context());
 165         Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&VCAMasterStrip::parameter_changed, this, _1), gui_context());
 166         UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun (*this, &VCAMasterStrip::parameter_changed));
 167 }
 168
 169 VCAMasterStrip::~VCAMasterStrip ()
 170 {
 171         if ((_session && !_session->deletion_in_progress()) && Mixer_UI::instance()->showing_spill_for (_vca)) {
 172                 /* cancel spill for this VCA */
 173                 Mixer_UI::instance()->show_spill (boost::shared_ptr<Stripable>());
 174         }
 175
 176         delete delete_dialog;
 177         delete context_menu;
 178
 179         CatchDeletion (this); /* EMIT SIGNAL */
 180 }
 181
 182 void
 183 VCAMasterStrip::self_delete ()
 184 {
 185         if ((_session && !_session->deletion_in_progress()) && Mixer_UI::instance()->showing_spill_for (_vca)) {
 186                 /* cancel spill for this VCA */
 187                 Mixer_UI::instance()->show_spill (boost::shared_ptr<Stripable>());
 188         }
 189         /* Drop reference immediately, delete self when idle */
 190         _vca.reset ();
 191         delete_when_idle (this);
 192 }
 193
 194 void
 195 VCAMasterStrip::parameter_changed (std::string const & p)
 196 {
 197         if (p == "use-monitor-bus" || p == "solo-control-is-listen-control" || p == "listen-position") {
 198                 set_button_names ();
 199         } else if (p == "mixer-element-visibility") {
 200                 update_bottom_padding ();
 201         }
 202 }
 203
 204 void
 205 VCAMasterStrip::set_button_names ()
 206 {
 207         if (Config->get_solo_control_is_listen_control()) {
 208                 switch (Config->get_listen_position()) {
 209                 case AfterFaderListen:
 210                         solo_button.set_text (S_("AfterFader|A"));
 211                         set_tooltip (solo_button, _("After-fade listen (AFL)"));
 212                         break;
 213                 case PreFaderListen:
 214                         solo_button.set_text (S_("PreFader|P"));
 215                         set_tooltip (solo_button, _("Pre-fade listen (PFL)"));
 216                         break;
 217                 }
 218         } else {
 219                 solo_button.set_text (S_("Solo|S"));
 220                 set_tooltip (solo_button, _("Solo"));
 221         }
 222 }
 223
 224 void
 225 VCAMasterStrip::update_bottom_padding ()
 226 {
 227         std::string viz = UIConfiguration::instance().get_mixer_strip_visibility ();
 228
 229         ArdourButton output_button (_("Output"));
 230         ArdourButton comment_button (_("Comments"));
 231
 232         output_button.set_name ("mixer strip button");
 233         comment_button.set_name ("generic button");
 234
 235         if (viz.find ("VCA") == std::string::npos) {
 236                 control_slave_ui.hide ();
 237         } else {
 238                 control_slave_ui.show ();
 239         }
 240
 241         int h = 0;
 242         if (viz.find ("Output") != std::string::npos) {
 243                 Gtk::Window window (WINDOW_TOPLEVEL);
 244                 window.add (output_button);
 245                 Gtk::Requisition requisition(output_button.size_request ());
 246                 h += requisition.height + 2;
 247         }
 248         if (viz.find ("Comments") != std::string::npos) {
 249                 Gtk::Window window (WINDOW_TOPLEVEL);
 250                 window.add (comment_button);
 251                 Gtk::Requisition requisition(comment_button.size_request ());
 252                 h += requisition.height + 2;
 253         }
 254         if (h <= 0) {
 255                 bottom_padding.set_size_request (-1, 1);
 256                 bottom_padding.hide ();
 257         } else {
 258                 bottom_padding.set_size_request (-1, h);
 259                 bottom_padding.show ();
 260         }
 261 }
 262
 263 string
 264 VCAMasterStrip::name() const
 265 {
 266         return _vca->name();
 267 }
 268
 269 void
 270 VCAMasterStrip::hide_clicked ()
 271 {
 272         _vca->presentation_info().set_hidden (true);
 273 }
 274
 275 void
 276 VCAMasterStrip::hide_confirmation (int response)
 277 {
 278         delete_dialog->hide ();
 279
 280         switch (response) {
 281         case RESPONSE_YES:
 282                 /* get everything to deassign. This will also delete ourselves (when
 283                  * idle) and that in turn will remove us from the Mixer GUI
 284                  */
 285                 _session->vca_manager().remove_vca (_vca);
 286                 break;
 287         default:
 288                 break;
 289         }
 290 }
 291
 292 bool
 293 VCAMasterStrip::width_button_pressed (GdkEventButton* ev)
 294 {
 295         return false;
 296 }
 297
 298 void
 299 VCAMasterStrip::set_selected (bool yn)
 300 {
 301         AxisView::set_selected (yn);
 302
 303         if (_selected) {
 304                 global_frame.set_shadow_type (Gtk::SHADOW_ETCHED_OUT);
 305                 global_frame.set_name ("MixerStripSelectedFrame");
 306         } else {
 307                 global_frame.set_shadow_type (Gtk::SHADOW_IN);
 308                 global_frame.set_name ("MixerStripFrame");
 309         }
 310
 311         global_frame.queue_draw ();
 312 }
 313
 314 bool
 315 VCAMasterStrip::solo_release (GdkEventButton*)
 316 {
 317         /* We use NoGroup because VCA controls are never part of a group. This
 318            is redundant, but clear.
 319         */
 320         _vca->solo_control()->set_value (_vca->solo_control()->self_soloed() ? 0.0 : 1.0, Controllable::NoGroup);
 321         return true;
 322 }
 323
 324 bool
 325 VCAMasterStrip::mute_release (GdkEventButton*)
 326 {
 327         /* We use NoGroup because VCA controls are never part of a group. This
 328            is redundant, but clear.
 329         */
 330         _vca->mute_control()->set_value (_vca->mute_control()->muted_by_self() ? 0.0 : 1.0, Controllable::NoGroup);
 331         return true;
 332 }
 333
 334 void
 335 VCAMasterStrip::set_solo_text ()
 336 {
 337         if (Config->get_solo_control_is_listen_control ()) {
 338                 switch (Config->get_listen_position()) {
 339                 case AfterFaderListen:
 340                         solo_button.set_text (_("A"));
 341                         break;
 342                 case PreFaderListen:
 343                         solo_button.set_text (_("P"));
 344                         break;
 345                         }
 346         } else {
 347                 solo_button.set_text (_("S"));
 348         }
 349 }
 350
 351 void
 352 VCAMasterStrip::mute_changed ()
 353 {
 354         if (_vca->mute_control()->muted_by_self()) {
 355                 mute_button.set_active_state (ExplicitActive);
 356         } else if (_vca->mute_control()->muted_by_masters ()) {
 357                 mute_button.set_active_state (ImplicitActive);
 358         } else {
 359                 mute_button.set_active_state (Gtkmm2ext::Off);
 360         }
 361 }
 362
 363 void
 364 VCAMasterStrip::solo_changed ()
 365 {
 366         if (_vca->solo_control()->self_soloed()) {
 367                 solo_button.set_active_state (ExplicitActive);
 368         } else if (_vca->solo_control()->soloed_by_masters ()) {
 369                 solo_button.set_active_state (ImplicitActive);
 370         } else {
 371                 solo_button.set_active_state (Gtkmm2ext::Off);
 372         }
 373 }
 374
 375 bool
 376 VCAMasterStrip::vertical_button_press (GdkEventButton* ev)
 377 {
 378         if (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
 379                 start_name_edit ();
 380                 return true;
 381         }
 382
 383         if (Keyboard::is_context_menu_event (ev)) {
 384                 if (!context_menu) {
 385                         build_context_menu ();
 386                 }
 387                 context_menu->popup (1, ev->time);
 388                 return true;
 389         }
 390
 391         if (ev->button == 1) {
 392                 spill ();
 393         }
 394
 395         return true;
 396 }
 397
 398 bool
 399 VCAMasterStrip::number_button_press (GdkEventButton* ev)
 400 {
 401         if (Keyboard::is_context_menu_event (ev)) {
 402                 if (!context_menu) {
 403                         build_context_menu ();
 404                 }
 405                 context_menu->popup (1, ev->time);
 406         }
 407         return true;
 408 }
 409
 410 void
 411 VCAMasterStrip::start_name_edit ()
 412 {
 413         Gtk::Window* win = dynamic_cast<Gtk::Window*>(get_toplevel());
 414         FloatingTextEntry* fte = new FloatingTextEntry (win, _vca->name());
 415         fte->use_text.connect (sigc::mem_fun (*this, &VCAMasterStrip::finish_name_edit));
 416         fte->present ();
 417 }
 418
 419 void
 420 VCAMasterStrip::finish_name_edit (std::string str, int)
 421 {
 422         _vca->set_name (str);
 423 }
 424
 425 void
 426 VCAMasterStrip::vca_property_changed (PropertyChange const & what_changed)
 427 {
 428         if (what_changed.contains (ARDOUR::Properties::name)) {
 429                 update_vca_name ();
 430         }
 431
 432         if (what_changed.contains (ARDOUR::Properties::color)) {
 433                 vertical_button.set_active_color (_vca->presentation_info().color ());
 434                 number_label.set_inactive_color (_vca->presentation_info().color ());
 435         }
 436
 437         if (what_changed.contains (ARDOUR::Properties::hidden)) {
 438
 439         }
 440 }
 441
 442 void
 443 VCAMasterStrip::update_vca_name ()
 444 {
 445         /* 20 is a rough guess at the number of letters we can fit. */
 446         vertical_button.set_text (short_version (_vca->full_name(), 20));
 447 }
 448
 449 void
 450 VCAMasterStrip::build_context_menu ()
 451 {
 452         using namespace Gtk::Menu_Helpers;
 453         context_menu = new Menu;
 454         MenuList& items = context_menu->items();
 455         items.push_back (MenuElem (_("Rename"), sigc::mem_fun (*this, &VCAMasterStrip::start_name_edit)));
 456         items.push_back (MenuElem (_("Color..."), sigc::mem_fun (*this, &VCAMasterStrip::start_color_edit)));
 457         items.push_back (SeparatorElem());
 458         items.push_back (MenuElem (_("Assign Selected Channels"), sigc::mem_fun (*this, &VCAMasterStrip::assign_all_selected)));
 459         items.push_back (MenuElem (_("Drop Selected Channels"), sigc::mem_fun (*this, &VCAMasterStrip::unassign_all_selected)));
 460         items.push_back (SeparatorElem());
 461         items.push_back (MenuElem (_("Drop All Slaves"), sigc::mem_fun (*this, &VCAMasterStrip::drop_all_slaves)));
 462         items.push_back (SeparatorElem());
 463         items.push_back (MenuElem (_("Remove"), sigc::mem_fun (*this, &VCAMasterStrip::remove)));
 464 }
 465
 466 void
 467 VCAMasterStrip::spill ()
 468 {
 469         if (Mixer_UI::instance()->showing_spill_for (_vca)) {
 470                 Mixer_UI::instance()->show_spill (boost::shared_ptr<Stripable>());
 471         } else {
 472                 Mixer_UI::instance()->show_spill (_vca);
 473         }
 474 }
 475
 476 void
 477 VCAMasterStrip::spill_change (boost::shared_ptr<Stripable> vca)
 478 {
 479         if (vca != _vca) {
 480                 vertical_button.set_active_state (Gtkmm2ext::Off);
 481                 set_tooltip (vertical_button, _("Click to show slaves only"));
 482         } else {
 483                 vertical_button.set_active_state (Gtkmm2ext::ExplicitActive);
 484                 set_tooltip (vertical_button, _("Click to show normal mixer"));
 485         }
 486 }
 487
 488 void
 489 VCAMasterStrip::remove ()
 490 {
 491         if (!_session) {
 492                 return;
 493         }
 494
 495         _session->vca_manager().remove_vca (_vca);
 496 }
 497
 498 void
 499 VCAMasterStrip::assign_all_selected ()
 500 {
 501         Mixer_UI::instance()->do_vca_assign (_vca);
 502 }
 503
 504 void
 505 VCAMasterStrip::unassign_all_selected ()
 506 {
 507         Mixer_UI::instance()->do_vca_unassign (_vca);
 508 }
 509
 510 void
 511 VCAMasterStrip::drop_all_slaves ()
 512 {
 513         _vca->Drop (); /* EMIT SIGNAL */
 514
 515         if (Mixer_UI::instance()->showing_spill_for (_vca)) {
 516                 Mixer_UI::instance()->show_spill (boost::shared_ptr<Stripable>());
 517         }
 518 }
 519
 520 Gdk::Color
 521 VCAMasterStrip::color () const
 522 {
 523         return ARDOUR_UI_UTILS::gdk_color_from_rgba (_vca->presentation_info().color ());
 524 }
 525
 526 string
 527 VCAMasterStrip::state_id () const
 528 {
 529         return string_compose (X_("vms-%1"), _vca->number());
 530 }
 531
 532 void
 533 VCAMasterStrip::start_color_edit ()
 534 {
 535         _color_picker.popup (_vca);
 536 }
 537
 538 bool
 539 VCAMasterStrip::marked_for_display () const
 540 {
 541         return !_vca->presentation_info().hidden();
 542 }
 543
 544 bool
 545 VCAMasterStrip::set_marked_for_display (bool yn)
 546 {
 547         if (yn == _vca->presentation_info().hidden()) {
 548                 _vca->presentation_info().set_hidden (!yn);
 549                 return true; // things changed
 550         }
 551         return false;
 552 }
 553
 554 PresentationInfo const &
 555 VCAMasterStrip::presentation_info () const
 556 {
 557         return _vca->presentation_info();
 558 }
 559
 560 boost::shared_ptr<Stripable>
 561 VCAMasterStrip::stripable () const
 562 {
 563         return _vca;
 564 }