gtk2_ardour/vca_time_axis.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
  20 #include <gtkmm/menu.h>
  21
  22 #include "pbd/string_convert.h"
  23
  24 #include "ardour/mute_control.h"
  25 #include "ardour/profile.h"
  26 #include "ardour/session.h"
  27 #include "ardour/solo_control.h"
  28 #include "ardour/vca.h"
  29
  30 #include "gtkmm2ext/doi.h"
  31 #include <gtkmm2ext/utils.h>
  32
  33 #include "gui_thread.h"
  34 #include "public_editor.h"
  35 #include "tooltips.h"
  36 #include "ui_config.h"
  37 #include "vca_time_axis.h"
  38
  39 #include "pbd/i18n.h"
  40
  41 using namespace ARDOUR;
  42 using namespace ARDOUR_UI_UTILS;
  43 using namespace Gtk;
  44 using namespace Gtkmm2ext;
  45 using namespace PBD;
  46
  47 VCATimeAxisView::VCATimeAxisView (PublicEditor& ed, Session* s, ArdourCanvas::Canvas& canvas)
  48         : SessionHandlePtr (s)
  49         , StripableTimeAxisView (ed, s, canvas)
  50         , gain_meter (s, true, 75, 14) // XXX stupid magic numbers, match sizes in RouteTimeAxisView
  51         , automation_action_menu (0)
  52 {
  53         solo_button.set_name ("solo button");
  54         set_tooltip (solo_button, _("Solo slaves"));
  55         solo_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCATimeAxisView::solo_release), false);
  56         solo_button.unset_flags (Gtk::CAN_FOCUS);
  57
  58         mute_button.set_name ("mute button");
  59         mute_button.set_text (S_("Mute|M"));
  60         set_tooltip (mute_button, _("Mute slaves"));
  61         mute_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCATimeAxisView::mute_release), false);
  62         mute_button.unset_flags (Gtk::CAN_FOCUS);
  63
  64         drop_button.set_name ("mute button");
  65         drop_button.set_text (S_("VCA|D"));
  66         set_tooltip (drop_button, _("Unassign all slaves"));
  67         drop_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCATimeAxisView::drop_release), false);
  68         drop_button.unset_flags (Gtk::CAN_FOCUS);
  69
  70         automation_button.set_name ("route button");
  71         automation_button.set_text (S_("RTAV|A"));
  72         set_tooltip (automation_button, _("Automation"));
  73         automation_button.signal_button_press_event().connect (sigc::mem_fun (*this, &VCATimeAxisView::automation_click), false);
  74         automation_button.unset_flags (Gtk::CAN_FOCUS);
  75
  76         mute_button.set_tweaks(ArdourButton::TrackHeader);
  77         solo_button.set_tweaks(ArdourButton::TrackHeader);
  78         drop_button.set_tweaks(ArdourButton::TrackHeader);
  79         automation_button.set_tweaks(ArdourButton::TrackHeader);
  80
  81         if (ARDOUR::Profile->get_mixbus()) {
  82                 controls_button_size_group->add_widget(mute_button);
  83
  84                 Gtk::Fixed *blank = manage(new Gtk::Fixed());
  85                 controls_button_size_group->add_widget(*blank);
  86                 controls_table.attach (*blank, 0, 1, 0, 1, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
  87                 blank->show();
  88
  89                 controls_table.attach (mute_button, 1, 2, 0, 1, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
  90                 controls_table.attach (solo_button, 2, 3, 0, 1, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
  91                 controls_table.attach (automation_button, 1, 2, 2, 3, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
  92                 controls_table.attach (drop_button, 2, 3, 2, 3, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
  93                 controls_table.attach (gain_meter.get_gain_slider(), 3, 5, 2, 3, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 1, 0);
  94         } else {
  95                 controls_table.attach (mute_button, 2, 3, 0, 1, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
  96                 controls_table.attach (solo_button, 3, 4, 0, 1, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
  97                 controls_table.attach (automation_button, 2, 3, 1, 2, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
  98                 controls_table.attach (drop_button, 3, 4, 1, 2, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
  99                 controls_table.attach (gain_meter.get_gain_slider(), 0, 2, 1, 2, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 1, 0);
 100         }
 101
 102         mute_button.show ();
 103         solo_button.show ();
 104         drop_button.show ();
 105         automation_button.show ();
 106         gain_meter.get_gain_slider().show ();
 107
 108         controls_ebox.set_name ("ControlMasterBaseUnselected");
 109         time_axis_frame.set_name ("ControlMasterBaseUnselected");
 110
 111         s->config.ParameterChanged.connect (*this, invalidator (*this), boost::bind (&VCATimeAxisView::parameter_changed, this, _1), gui_context());
 112         Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&VCATimeAxisView::parameter_changed, this, _1), gui_context());
 113         UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun (*this, &VCATimeAxisView::parameter_changed));
 114 }
 115
 116 VCATimeAxisView::~VCATimeAxisView ()
 117 {
 118 }
 119
 120 void
 121 VCATimeAxisView::self_delete ()
 122 {
 123         /* reset reference immediately rather than deferring to idle */
 124         _vca.reset ();
 125         delete_when_idle (this);
 126 }
 127
 128 void
 129 VCATimeAxisView::parameter_changed (std::string const & p)
 130 {
 131         if (p == "track-name-number") {
 132                 update_track_number_visibility();
 133         } else if (p == "use-monitor-bus" || p == "solo-control-is-listen-control" || p == "listen-position") {
 134                 set_button_names ();
 135         }
 136 }
 137
 138 bool
 139 VCATimeAxisView::solo_release (GdkEventButton*)
 140 {
 141         /* We use NoGroup because VCA controls are never part of a group. This
 142            is redundant, but clear.
 143         */
 144         _vca->solo_control()->set_value (_vca->solo_control()->self_soloed() ? 0.0 : 1.0, Controllable::NoGroup);
 145         return true;
 146 }
 147
 148 bool
 149 VCATimeAxisView::mute_release (GdkEventButton*)
 150 {
 151         /* We use NoGroup because VCA controls are never part of a group. This
 152            is redundant, but clear.
 153         */
 154         _vca->mute_control()->set_value (_vca->mute_control()->muted_by_self() ? 0.0 : 1.0, Controllable::NoGroup);
 155         return true;
 156 }
 157
 158 void
 159 VCATimeAxisView::set_vca (boost::shared_ptr<VCA> v)
 160 {
 161         StripableTimeAxisView::set_stripable (v);
 162         _vca = v;
 163
 164         gain_meter.set_controls (boost::shared_ptr<Route>(),
 165                                  boost::shared_ptr<PeakMeter>(),
 166                                  boost::shared_ptr<Amp>(),
 167                                  _vca->gain_control());
 168
 169         // Mixer_UI::instance()->show_vca_change.connect (sigc::mem_fun (*this, &VCAMasterStrip::spill_change));
 170
 171         _vca->PropertyChanged.connect (vca_connections, invalidator (*this), boost::bind (&VCATimeAxisView::vca_property_changed, this, _1), gui_context());
 172
 173         _vca->solo_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCATimeAxisView::update_solo_display, this), gui_context());
 174         _vca->mute_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCATimeAxisView::update_mute_display, this), gui_context());
 175         _vca->DropReferences.connect (vca_connections, invalidator (*this), boost::bind (&VCATimeAxisView::self_delete, this), gui_context());
 176
 177         solo_button.set_controllable (_vca->solo_control());
 178         mute_button.set_controllable (_vca->mute_control());
 179
 180         /* VCA number never changes */
 181         number_label.set_text (PBD::to_string (_vca->number()));
 182
 183         set_height (preset_height (HeightNormal));
 184
 185         if (automation_child (GainAutomation) == 0) {
 186                 create_automation_child (GainAutomation, false);
 187         }
 188         if (automation_child (MuteAutomation) == 0) {
 189                 create_automation_child (MuteAutomation, false);
 190         }
 191
 192         update_vca_name ();
 193         set_button_names ();
 194         update_solo_display ();
 195         update_mute_display ();
 196         update_track_number_visibility ();
 197 }
 198
 199 void
 200 VCATimeAxisView::vca_property_changed (PropertyChange const & what_changed)
 201 {
 202         if (what_changed.contains (ARDOUR::Properties::name)) {
 203                 update_vca_name ();
 204         }
 205 }
 206
 207 void
 208 VCATimeAxisView::update_vca_name ()
 209 {
 210         name_label.set_text (_vca->full_name());
 211 }
 212
 213 void
 214 VCATimeAxisView::update_mute_display ()
 215 {
 216         if (_vca->mute_control()->muted_by_self()) {
 217                 mute_button.set_active_state (ExplicitActive);
 218         } else if (_vca->mute_control()->muted_by_masters ()) {
 219                 mute_button.set_active_state (ImplicitActive);
 220         } else {
 221                 mute_button.set_active_state (Gtkmm2ext::Off);
 222         }
 223 }
 224
 225 void
 226 VCATimeAxisView::update_solo_display ()
 227 {
 228         if (_vca->solo_control()->self_soloed()) {
 229                 solo_button.set_active_state (ExplicitActive);
 230         } else if (_vca->solo_control()->soloed_by_masters ()) {
 231                 solo_button.set_active_state (ImplicitActive);
 232         } else {
 233                 solo_button.set_active_state (Gtkmm2ext::Off);
 234         }
 235
 236         update_mute_display ();
 237 }
 238
 239 std::string
 240 VCATimeAxisView::name() const
 241 {
 242         return _vca->name();
 243 }
 244
 245 std::string
 246 VCATimeAxisView::state_id() const
 247 {
 248         return string_compose ("vtv %1", _vca->id().to_s());
 249 }
 250
 251 void
 252 VCATimeAxisView::set_button_names ()
 253 {
 254         if (Config->get_solo_control_is_listen_control()) {
 255                 switch (Config->get_listen_position()) {
 256                 case AfterFaderListen:
 257                         solo_button.set_text (S_("AfterFader|A"));
 258                         set_tooltip (solo_button, _("After-fade listen (AFL)"));
 259                         break;
 260                 case PreFaderListen:
 261                         solo_button.set_text (S_("PreFader|P"));
 262                         set_tooltip (solo_button, _("Pre-fade listen (PFL)"));
 263                         break;
 264                 }
 265         } else {
 266                 solo_button.set_text (S_("Solo|S"));
 267                 set_tooltip (solo_button, _("Solo"));
 268         }
 269 }
 270
 271 void
 272 VCATimeAxisView::update_track_number_visibility ()
 273 {
 274         DisplaySuspender ds;
 275         bool show_label = _session->config.get_track_name_number();
 276
 277         if (number_label.get_parent()) {
 278                 controls_table.remove (number_label);
 279         }
 280
 281         if (show_label) {
 282                 if (ARDOUR::Profile->get_mixbus()) {
 283                         controls_table.attach (number_label, 3, 4, 0, 1, Gtk::SHRINK, Gtk::EXPAND|Gtk::FILL, 1, 0);
 284                 } else {
 285                         controls_table.attach (number_label, 0, 1, 0, 1, Gtk::SHRINK, Gtk::EXPAND|Gtk::FILL, 1, 0);
 286                 }
 287
 288                 // see ArdourButton::on_size_request(), we should probably use a global size-group here instead.
 289                 // except the width of the number label is subtracted from the name-hbox, so we
 290                 // need to explictly calculate it anyway until the name-label & entry become ArdourWidgets.
 291
 292                 int tnw = (2 + std::max(2u, _session->track_number_decimals())) * number_label.char_pixel_width();
 293                 if (tnw & 1) --tnw;
 294                 number_label.set_size_request(tnw, -1);
 295                 number_label.show ();
 296         } else {
 297                 number_label.hide ();
 298         }
 299 }
 300
 301 bool
 302 VCATimeAxisView::automation_click (GdkEventButton* ev)
 303 {
 304         if (ev->button != 1) {
 305                 return true;
 306         }
 307
 308         conditionally_add_to_selection ();
 309         build_automation_action_menu (false);
 310         Gtkmm2ext::anchored_menu_popup (automation_action_menu, &automation_button, "", 1, ev->time);
 311         return true;
 312 }
 313
 314 bool
 315 VCATimeAxisView::drop_release (GdkEventButton*)
 316 {
 317         _vca->Drop (); /* EMIT SIGNAL */
 318
 319         return true;
 320 }
 321
 322 PresentationInfo const &
 323 VCATimeAxisView::presentation_info () const
 324 {
 325         return _vca->presentation_info();
 326 }
 327
 328 boost::shared_ptr<Stripable>
 329 VCATimeAxisView::stripable () const
 330 {
 331         return _vca;
 332 }
 333
 334 Gdk::Color
 335 VCATimeAxisView::color () const
 336 {
 337         return gdk_color_from_rgb (_vca->presentation_info().color ());
 338 }
 339
 340 void
 341 VCATimeAxisView::set_height (uint32_t h, TrackHeightMode m)
 342 {
 343         TimeAxisView::set_height (h, m);
 344         set_gui_property ("height", h);
 345         _vca->gui_changed ("track_height", (void*) 0); /* EMIT SIGNAL */
 346 }
 347
 348 bool
 349 VCATimeAxisView::marked_for_display () const
 350 {
 351         return _vca && !_vca->presentation_info().hidden();
 352 }
 353
 354 bool
 355 VCATimeAxisView::set_marked_for_display (bool yn)
 356 {
 357         if (_vca && (yn == _vca->presentation_info().hidden())) {
 358                 _vca->presentation_info().set_hidden (!yn);
 359                 return true; // things changed
 360         }
 361         return false;
 362 }
 363
 364 void
 365 VCATimeAxisView::create_gain_automation_child (const Evoral::Parameter& param, bool show)
 366 {
 367         boost::shared_ptr<AutomationControl> c = _vca->gain_control();
 368         if (!c) {
 369                 error << "VCA has no gain automation, unable to add automation track view." << endmsg;
 370                 return;
 371         }
 372
 373         gain_track.reset (new AutomationTimeAxisView (_session,
 374                                                       _vca, boost::shared_ptr<Automatable> (), c, param,
 375                                                       _editor,
 376                                                       *this,
 377                                                       false,
 378                                                       parent_canvas,
 379                                                       /*_route->amp()->describe_parameter(param)*/"Fader"));
 380
 381         add_automation_child (Evoral::Parameter(GainAutomation), gain_track, show);
 382 }
 383
 384 void
 385 VCATimeAxisView::create_mute_automation_child (const Evoral::Parameter& param, bool show)
 386 {
 387         boost::shared_ptr<AutomationControl> c = _vca->mute_control();
 388         if (!c) {
 389                 error << "VCA has no mute automation, unable to add automation track view." << endmsg;
 390                 return;
 391         }
 392
 393         mute_track.reset (new AutomationTimeAxisView (_session,
 394                                                       _vca, boost::shared_ptr<Automatable> (), c, param,
 395                                                       _editor,
 396                                                       *this,
 397                                                       false,
 398                                                       parent_canvas,
 399                                                       /*_route->describe_parameter(param)*/ "Mute"));
 400
 401         add_automation_child (Evoral::Parameter(MuteAutomation), mute_track, show);
 402 }
 403
 404 void
 405 VCATimeAxisView::create_automation_child (const Evoral::Parameter& param, bool show)
 406 {
 407         switch (param.type()) {
 408                 case GainAutomation:
 409                         create_gain_automation_child (param, show);
 410                         break;
 411                 case MuteAutomation:
 412                         create_mute_automation_child (param, show);
 413                         break;
 414                 default:
 415                         break;
 416         }
 417 }
 418
 419 void
 420 VCATimeAxisView::build_automation_action_menu (bool for_selection)
 421 {
 422         using namespace Menu_Helpers;
 423         _main_automation_menu_map.clear ();
 424         delete automation_action_menu;
 425         automation_action_menu = new Menu;
 426
 427         MenuList& items = automation_action_menu->items();
 428
 429         automation_action_menu->set_name ("ArdourContextMenu");
 430
 431         items.push_back (MenuElem (_("Show All Automation"),
 432                                    sigc::bind (sigc::mem_fun (*this, &VCATimeAxisView::show_all_automation), for_selection)));
 433
 434         items.push_back (MenuElem (_("Show Existing Automation"),
 435                                    sigc::bind (sigc::mem_fun (*this, &VCATimeAxisView::show_existing_automation), for_selection)));
 436
 437         items.push_back (MenuElem (_("Hide All Automation"),
 438                                    sigc::bind (sigc::mem_fun (*this, &VCATimeAxisView::hide_all_automation), for_selection)));
 439
 440         if (gain_track) {
 441                 items.push_back (CheckMenuElem (_("Fader"), sigc::mem_fun (*this, &VCATimeAxisView::update_gain_track_visibility)));
 442                 gain_automation_item = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
 443                 gain_automation_item->set_active (string_to<bool>(gain_track->gui_property ("visible")));
 444
 445                 _main_automation_menu_map[Evoral::Parameter(GainAutomation)] = gain_automation_item;
 446         }
 447
 448         if (trim_track) {
 449                 items.push_back (CheckMenuElem (_("Trim"), sigc::mem_fun (*this, &VCATimeAxisView::update_trim_track_visibility)));
 450                 trim_automation_item = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
 451                 trim_automation_item->set_active (string_to<bool>(trim_track->gui_property ("visible")));
 452
 453                 _main_automation_menu_map[Evoral::Parameter(TrimAutomation)] = trim_automation_item;
 454         }
 455
 456         if (mute_track) {
 457                 items.push_back (CheckMenuElem (_("Mute"), sigc::mem_fun (*this, &VCATimeAxisView::update_mute_track_visibility)));
 458                 mute_automation_item = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
 459                 mute_automation_item->set_active (string_to<bool>(mute_track->gui_property ("visible")));
 460
 461                 _main_automation_menu_map[Evoral::Parameter(MuteAutomation)] = mute_automation_item;
 462         }
 463 }
 464
 465 void
 466 VCATimeAxisView::show_all_automation (bool apply_to_selection)
 467 {
 468         assert (!apply_to_selection); // VCAs can't yet be selected
 469         no_redraw = true;
 470
 471         StripableTimeAxisView::show_all_automation ();
 472
 473         no_redraw = false;
 474         request_redraw ();
 475 }
 476
 477 void
 478 VCATimeAxisView::show_existing_automation (bool apply_to_selection)
 479 {
 480         assert (!apply_to_selection); // VCAs can't yet be selected
 481         no_redraw = true;
 482
 483         StripableTimeAxisView::show_existing_automation ();
 484
 485         no_redraw = false;
 486         request_redraw ();
 487 }
 488
 489 void
 490 VCATimeAxisView::hide_all_automation (bool apply_to_selection)
 491 {
 492         assert (!apply_to_selection); // VCAs can't yet be selected
 493         no_redraw = true;
 494
 495         StripableTimeAxisView::hide_all_automation ();
 496
 497         no_redraw = false;
 498         request_redraw ();
 499 }