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         update_bottom_padding ();
  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 (2);
 112         gain_meter.set_spacing(4);
 113
 114         global_vpacker.pack_start (number_label, false, false);
 115         global_vpacker.pack_start (hide_button, false, false);
 116         global_vpacker.pack_start (vertical_button, true, true);
 117         global_vpacker.pack_start (solo_mute_box, false, false);
 118         global_vpacker.pack_start (gain_meter, false, false);
 119         global_vpacker.pack_start (control_slave_ui, false, false);
 120         global_vpacker.pack_start (bottom_padding, false, false);
 121
 122         global_frame.add (global_vpacker);
 123         global_frame.set_shadow_type (Gtk::SHADOW_IN);
 124         global_frame.set_name ("BaseFrame");
 125
 126         add (global_frame);
 127
 128         global_vpacker.show ();
 129         global_frame.show ();
 130         top_padding.show ();
 131         bottom_padding.show ();
 132         vertical_button.show ();
 133         hide_button.show ();
 134         number_label.show ();
 135         gain_meter.show ();
 136         solo_mute_box.show_all ();
 137         control_slave_ui.show ();
 138
 139         /* force setting of visible selected status */
 140
 141         _selected = true;
 142         set_selected (false);
 143         set_solo_text ();
 144         update_vca_name ();
 145         solo_changed ();
 146         mute_changed ();
 147         spill_change (boost::shared_ptr<VCA>());
 148
 149         Mixer_UI::instance()->show_vca_change.connect (sigc::mem_fun (*this, &VCAMasterStrip::spill_change));
 150
 151         _vca->PropertyChanged.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::vca_property_changed, this, _1), gui_context());
 152         _vca->presentation_info().PropertyChanged.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::vca_property_changed, this, _1), gui_context());
 153         _vca->DropReferences.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::self_delete, this), gui_context());
 154
 155         _vca->solo_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::solo_changed, this), gui_context());
 156         _vca->mute_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::mute_changed, this), gui_context());
 157
 158
 159         s->config.ParameterChanged.connect (*this, invalidator (*this), boost::bind (&VCAMasterStrip::parameter_changed, this, _1), gui_context());
 160         Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&VCAMasterStrip::parameter_changed, this, _1), gui_context());
 161         UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun (*this, &VCAMasterStrip::parameter_changed));
 162 }
 163
 164 VCAMasterStrip::~VCAMasterStrip ()
 165 {
 166         if ((_session && !_session->deletion_in_progress()) && Mixer_UI::instance()->showing_vca_slaves_for (_vca)) {
 167                 /* cancel spill for this VCA */
 168                 Mixer_UI::instance()->show_vca_slaves (boost::shared_ptr<VCA>());
 169         }
 170
 171         delete delete_dialog;
 172         delete context_menu;
 173
 174         CatchDeletion (this); /* EMIT SIGNAL */
 175 }
 176
 177 void
 178 VCAMasterStrip::self_delete ()
 179 {
 180         if ((_session && !_session->deletion_in_progress()) && Mixer_UI::instance()->showing_vca_slaves_for (_vca)) {
 181                 /* cancel spill for this VCA */
 182                 Mixer_UI::instance()->show_vca_slaves (boost::shared_ptr<VCA>());
 183         }
 184         /* Drop reference immediately, delete self when idle */
 185         _vca.reset ();
 186         delete_when_idle (this);
 187 }
 188
 189 void
 190 VCAMasterStrip::parameter_changed (std::string const & p)
 191 {
 192         if (p == "use-monitor-bus" || p == "solo-control-is-listen-control" || p == "listen-position") {
 193                 set_button_names ();
 194         } else if (p == "mixer-element-visibility") {
 195                 update_bottom_padding ();
 196         }
 197 }
 198
 199 void
 200 VCAMasterStrip::set_button_names ()
 201 {
 202         if (Config->get_solo_control_is_listen_control()) {
 203                 switch (Config->get_listen_position()) {
 204                 case AfterFaderListen:
 205                         solo_button.set_text (S_("AfterFader|A"));
 206                         set_tooltip (solo_button, _("After-fade listen (AFL)"));
 207                         break;
 208                 case PreFaderListen:
 209                         solo_button.set_text (S_("PreFader|P"));
 210                         set_tooltip (solo_button, _("Pre-fade listen (PFL)"));
 211                         break;
 212                 }
 213         } else {
 214                 solo_button.set_text (S_("Solo|S"));
 215                 set_tooltip (solo_button, _("Solo"));
 216         }
 217 }
 218
 219 void
 220 VCAMasterStrip::update_bottom_padding ()
 221 {
 222         std::string viz = UIConfiguration::instance().get_mixer_strip_visibility ();
 223
 224         ArdourButton meter_point_button (_("pre"));
 225         ArdourButton output_button (_("Output"));
 226         ArdourButton comment_button (_("Comments"));
 227
 228         meter_point_button.set_name ("mixer strip button");
 229         output_button.set_name ("mixer strip button");
 230         comment_button.set_name ("generic button");
 231
 232
 233         int h = 0;
 234         if (1) {
 235                 Gtk::Window window (WINDOW_TOPLEVEL);
 236                 window.add (meter_point_button);
 237                 Gtk::Requisition requisition(meter_point_button.size_request ());
 238                 h += requisition.height;
 239         }
 240         if (viz.find ("Output") != std::string::npos) {
 241                 Gtk::Window window (WINDOW_TOPLEVEL);
 242                 window.add (output_button);
 243                 Gtk::Requisition requisition(output_button.size_request ());
 244                 h += requisition.height + 2;
 245         }
 246         if (viz.find ("Comments") != std::string::npos) {
 247                 Gtk::Window window (WINDOW_TOPLEVEL);
 248                 window.add (comment_button);
 249                 Gtk::Requisition requisition(comment_button.size_request ());
 250                 h += requisition.height + 2;
 251         }
 252         bottom_padding.set_size_request (-1, h);
 253 }
 254
 255 string
 256 VCAMasterStrip::name() const
 257 {
 258         return _vca->name();
 259 }
 260
 261 void
 262 VCAMasterStrip::hide_clicked ()
 263 {
 264         _vca->presentation_info().set_hidden (true);
 265 }
 266
 267 void
 268 VCAMasterStrip::hide_confirmation (int response)
 269 {
 270         delete_dialog->hide ();
 271
 272         switch (response) {
 273         case RESPONSE_YES:
 274                 /* get everything to deassign. This will also delete ourselves (when
 275                  * idle) and that in turn will remove us from the Mixer GUI
 276                  */
 277                 _session->vca_manager().remove_vca (_vca);
 278                 break;
 279         default:
 280                 break;
 281         }
 282 }
 283
 284 bool
 285 VCAMasterStrip::width_button_pressed (GdkEventButton* ev)
 286 {
 287         return false;
 288 }
 289
 290 void
 291 VCAMasterStrip::set_selected (bool yn)
 292 {
 293         AxisView::set_selected (yn);
 294
 295         if (_selected) {
 296                 global_frame.set_shadow_type (Gtk::SHADOW_ETCHED_OUT);
 297                 global_frame.set_name ("MixerStripSelectedFrame");
 298         } else {
 299                 global_frame.set_shadow_type (Gtk::SHADOW_IN);
 300                 global_frame.set_name ("MixerStripFrame");
 301         }
 302
 303         global_frame.queue_draw ();
 304 }
 305
 306 bool
 307 VCAMasterStrip::solo_release (GdkEventButton*)
 308 {
 309         /* We use NoGroup because VCA controls are never part of a group. This
 310            is redundant, but clear.
 311         */
 312         _vca->solo_control()->set_value (_vca->solo_control()->self_soloed() ? 0.0 : 1.0, Controllable::NoGroup);
 313         return true;
 314 }
 315
 316 bool
 317 VCAMasterStrip::mute_release (GdkEventButton*)
 318 {
 319         /* We use NoGroup because VCA controls are never part of a group. This
 320            is redundant, but clear.
 321         */
 322         _vca->mute_control()->set_value (_vca->mute_control()->muted_by_self() ? 0.0 : 1.0, Controllable::NoGroup);
 323         return true;
 324 }
 325
 326 void
 327 VCAMasterStrip::set_solo_text ()
 328 {
 329         if (Config->get_solo_control_is_listen_control ()) {
 330                 switch (Config->get_listen_position()) {
 331                 case AfterFaderListen:
 332                         solo_button.set_text (_("A"));
 333                         break;
 334                 case PreFaderListen:
 335                         solo_button.set_text (_("P"));
 336                         break;
 337                         }
 338         } else {
 339                 solo_button.set_text (_("S"));
 340         }
 341 }
 342
 343 void
 344 VCAMasterStrip::mute_changed ()
 345 {
 346         if (_vca->mute_control()->muted_by_self()) {
 347                 mute_button.set_active_state (ExplicitActive);
 348         } else if (_vca->mute_control()->muted_by_masters ()) {
 349                 mute_button.set_active_state (ImplicitActive);
 350         } else {
 351                 mute_button.set_active_state (Gtkmm2ext::Off);
 352         }
 353 }
 354
 355 void
 356 VCAMasterStrip::solo_changed ()
 357 {
 358         if (_vca->solo_control()->self_soloed()) {
 359                 solo_button.set_active_state (ExplicitActive);
 360         } else if (_vca->solo_control()->soloed_by_masters ()) {
 361                 solo_button.set_active_state (ImplicitActive);
 362         } else {
 363                 solo_button.set_active_state (Gtkmm2ext::Off);
 364         }
 365 }
 366
 367 bool
 368 VCAMasterStrip::vertical_button_press (GdkEventButton* ev)
 369 {
 370         if (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
 371                 start_name_edit ();
 372                 return true;
 373         }
 374
 375         if (Keyboard::is_context_menu_event (ev)) {
 376                 if (!context_menu) {
 377                         build_context_menu ();
 378                 }
 379                 context_menu->popup (1, ev->time);
 380                 return true;
 381         }
 382
 383         if (ev->button == 1) {
 384                 spill ();
 385         }
 386
 387         return true;
 388 }
 389
 390 void
 391 VCAMasterStrip::start_name_edit ()
 392 {
 393         Gtk::Window* win = dynamic_cast<Gtk::Window*>(get_toplevel());
 394         FloatingTextEntry* fte = new FloatingTextEntry (win, _vca->name());
 395         fte->use_text.connect (sigc::mem_fun (*this, &VCAMasterStrip::finish_name_edit));
 396         fte->present ();
 397 }
 398
 399 void
 400 VCAMasterStrip::finish_name_edit (std::string str, int)
 401 {
 402         _vca->set_name (str);
 403 }
 404
 405 void
 406 VCAMasterStrip::vca_property_changed (PropertyChange const & what_changed)
 407 {
 408         if (what_changed.contains (ARDOUR::Properties::name)) {
 409                 update_vca_name ();
 410         }
 411
 412         if (what_changed.contains (ARDOUR::Properties::color)) {
 413                 vertical_button.set_active_color (_vca->presentation_info().color ());
 414         }
 415
 416         if (what_changed.contains (ARDOUR::Properties::hidden)) {
 417
 418         }
 419 }
 420
 421 void
 422 VCAMasterStrip::update_vca_name ()
 423 {
 424         /* 20 is a rough guess at the number of letters we can fit. */
 425         vertical_button.set_text (short_version (_vca->name(), 20));
 426 }
 427
 428 void
 429 VCAMasterStrip::build_context_menu ()
 430 {
 431         using namespace Gtk::Menu_Helpers;
 432         context_menu = new Menu;
 433         MenuList& items = context_menu->items();
 434         items.push_back (MenuElem (_("Rename"), sigc::mem_fun (*this, &VCAMasterStrip::start_name_edit)));
 435         items.push_back (MenuElem (_("Color..."), sigc::mem_fun (*this, &VCAMasterStrip::start_color_edit)));
 436         items.push_back (SeparatorElem());
 437         items.push_back (MenuElem (_("Drop All Slaves"), sigc::mem_fun (*this, &VCAMasterStrip::drop_all_slaves)));
 438         items.push_back (SeparatorElem());
 439         items.push_back (MenuElem (_("Remove"), sigc::mem_fun (*this, &VCAMasterStrip::remove)));
 440 }
 441
 442 void
 443 VCAMasterStrip::spill ()
 444 {
 445         if (Mixer_UI::instance()->showing_vca_slaves_for (_vca)) {
 446                 Mixer_UI::instance()->show_vca_slaves (boost::shared_ptr<VCA>());
 447         } else {
 448                 Mixer_UI::instance()->show_vca_slaves (_vca);
 449         }
 450 }
 451
 452 void
 453 VCAMasterStrip::spill_change (boost::shared_ptr<VCA> vca)
 454 {
 455         if (vca != _vca) {
 456                 vertical_button.set_active_state (Gtkmm2ext::Off);
 457                 set_tooltip (vertical_button, _("Click to show slaves only"));
 458         } else {
 459                 vertical_button.set_active_state (Gtkmm2ext::ExplicitActive);
 460                 set_tooltip (vertical_button, _("Click to show normal mixer"));
 461         }
 462 }
 463
 464 void
 465 VCAMasterStrip::remove ()
 466 {
 467         if (!_session) {
 468                 return;
 469         }
 470
 471         _session->vca_manager().remove_vca (_vca);
 472 }
 473
 474 void
 475 VCAMasterStrip::drop_all_slaves ()
 476 {
 477         _vca->Drop (); /* EMIT SIGNAL */
 478
 479         if (Mixer_UI::instance()->showing_vca_slaves_for (_vca)) {
 480                 Mixer_UI::instance()->show_vca_slaves (boost::shared_ptr<VCA>());
 481         }
 482 }
 483
 484 Gdk::Color
 485 VCAMasterStrip::color () const
 486 {
 487         return gdk_color_from_rgba (_vca->presentation_info().color ());
 488 }
 489
 490 string
 491 VCAMasterStrip::state_id () const
 492 {
 493         return string_compose (X_("vms-%1"), _vca->number());
 494 }
 495
 496 void
 497 VCAMasterStrip::start_color_edit ()
 498 {
 499         Gtk::ColorSelectionDialog* color_dialog = new Gtk::ColorSelectionDialog;
 500
 501         color_dialog->get_colorsel()->set_has_opacity_control (false);
 502         color_dialog->get_colorsel()->set_has_palette (true);
 503
 504         Gdk::Color c = gdk_color_from_rgba (_vca->presentation_info().color ());
 505
 506         color_dialog->get_colorsel()->set_previous_color (c);
 507         color_dialog->get_colorsel()->set_current_color (c);
 508
 509         color_dialog->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &VCAMasterStrip::finish_color_edit), color_dialog));
 510         color_dialog->present ();
 511 }
 512
 513 void
 514 VCAMasterStrip::finish_color_edit (int response, Gtk::ColorSelectionDialog* dialog)
 515 {
 516         switch (response) {
 517         case RESPONSE_OK:
 518                 _vca->presentation_info().set_color (gdk_color_to_rgba (dialog->get_colorsel()->get_current_color()));
 519                 break;
 520         }
 521
 522         delete_when_idle (dialog);
 523 }
 524
 525 bool
 526 VCAMasterStrip::marked_for_display () const
 527 {
 528         return !_vca->presentation_info().hidden();
 529 }
 530
 531 bool
 532 VCAMasterStrip::set_marked_for_display (bool yn)
 533 {
 534         if (yn == _vca->presentation_info().hidden()) {
 535                 _vca->presentation_info().set_hidden (!yn);
 536                 return true; // things changed
 537         }
 538         return false;
 539 }
 540
 541 PresentationInfo const &
 542 VCAMasterStrip::presentation_info () const
 543 {
 544         return _vca->presentation_info();
 545 }
 546
 547 boost::shared_ptr<Stripable>
 548 VCAMasterStrip::stripable () const
 549 {
 550         return _vca;
 551 }