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