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 "pbd/convert.h"
  20
  21 #include "ardour/rc_configuration.h"
  22 #include "ardour/session.h"
  23 #include "ardour/vca.h"
  24 #include "ardour/vca_manager.h"
  25
  26 #include "gtkmm2ext/keyboard.h"
  27
  28 #include "gui_thread.h"
  29 #include "floating_text_entry.h"
  30 #include "tooltips.h"
  31 #include "vca_master_strip.h"
  32
  33 #include "i18n.h"
  34
  35 using namespace ARDOUR;
  36 using namespace ARDOUR_UI_UTILS;
  37 using namespace Gtkmm2ext;
  38 using namespace Gtk;
  39 using namespace PBD;
  40 using std::string;
  41
  42 VCAMasterStrip::VCAMasterStrip (Session* s, boost::shared_ptr<VCA> v)
  43         : AxisView (s)
  44         , _vca (v)
  45         , gain_meter (s, 250)
  46         , context_menu (0)
  47 {
  48         gain_meter.set_controls (boost::shared_ptr<Route>(),
  49                                  boost::shared_ptr<PeakMeter>(),
  50                                  boost::shared_ptr<Amp>(),
  51                                  _vca->gain_control());
  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, &VCAMasterStrip::solo_release), false);
  56
  57         mute_button.set_name ("mute button");
  58         mute_button.set_text (_("M"));
  59         set_tooltip (mute_button, _("Mute slaves"));
  60         mute_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::mute_release), false);
  61
  62         hide_button.set_icon (ArdourIcon::CloseCross);
  63         set_tooltip (&hide_button, _("Hide this VCA strip"));
  64
  65         assign_button.set_name (X_("vca assign"));
  66         set_tooltip (assign_button, _("Click to assign a VCA Master to this VCA"));
  67         assign_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::vca_button_release), false);
  68
  69         hide_button.signal_clicked.connect (sigc::mem_fun(*this, &VCAMasterStrip::hide_clicked));
  70
  71         width_hide_box.pack_start (number_label, true, true);
  72         width_hide_box.pack_end (hide_button, false, true);
  73
  74         solo_mute_box.set_spacing (2);
  75         solo_mute_box.pack_start (mute_button, true, true);
  76         solo_mute_box.pack_start (solo_button, true, true);
  77
  78         number_label.set_text (to_string (v->number(), std::dec));
  79         number_label.set_elements((ArdourButton::Element)(ArdourButton::Edge|ArdourButton::Body|ArdourButton::Text|ArdourButton::Inactive));
  80         number_label.set_no_show_all ();
  81         number_label.set_name ("generic button");
  82         number_label.set_alignment (.5, .5);
  83         number_label.set_fallthrough_to_parent (true);
  84
  85         name_button.signal_button_press_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::name_button_press), false);
  86
  87         top_padding.set_size_request (-1, 16); /* must match height in GroupTabs::set_size_request() */
  88         bottom_padding.set_size_request (-1, 50); /* this one is a hack. there's no trivial way to compute it */
  89
  90         global_vpacker.set_border_width (1);
  91         global_vpacker.set_spacing (0);
  92
  93         global_vpacker.pack_start (top_padding, false, false);
  94         global_vpacker.pack_start (width_hide_box, false, false);
  95         global_vpacker.pack_start (name_button, false, false);
  96         global_vpacker.pack_start (vertical_padding, true, true);
  97         global_vpacker.pack_start (solo_mute_box, false, false);
  98         global_vpacker.pack_start (gain_meter, false, false);
  99         global_vpacker.pack_start (assign_button, false, false);
 100         global_vpacker.pack_start (bottom_padding, false, false);
 101
 102         global_frame.add (global_vpacker);
 103         global_frame.set_shadow_type (Gtk::SHADOW_IN);
 104         global_frame.set_name ("BaseFrame");
 105
 106         add (global_frame);
 107
 108         global_vpacker.show ();
 109         global_frame.show ();
 110         top_padding.show ();
 111         bottom_padding.show ();
 112         vertical_padding.show ();
 113         hide_button.show ();
 114         number_label.show ();
 115         width_hide_box.show ();
 116         name_button.show ();
 117         gain_meter.show ();
 118         solo_mute_box.show_all ();
 119         assign_button.show ();
 120
 121         /* force setting of visible selected status */
 122
 123         _selected = true;
 124         set_selected (false);
 125         set_solo_text ();
 126         update_vca_display ();
 127         update_vca_name ();
 128
 129         _vca->PropertyChanged.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::vca_property_changed, this, _1), gui_context());
 130
 131         _vca->solo_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::solo_changed, this), gui_context());
 132         _vca->mute_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::mute_changed, this), gui_context());
 133
 134         /* only need to connect to one of these to update VCA status */
 135
 136         _vca->gain_control()->MasterStatusChange.connect (vca_connections,
 137                                                   invalidator (*this),
 138                                                   boost::bind (&VCAMasterStrip::update_vca_display, this),
 139                                                   gui_context());
 140 }
 141
 142 void
 143 VCAMasterStrip::update_vca_display ()
 144 {
 145         VCAList vcas (_session->vca_manager().vcas());
 146         string label;
 147
 148         for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
 149                 if (_vca->gain_control()->slaved_to ((*v)->gain_control())) {
 150                         if (!label.empty()) {
 151                                 label += ' ';
 152                         }
 153                         label += to_string ((*v)->number(), std::dec);
 154                 }
 155         }
 156
 157         if (label.empty()) {
 158                 label = _("-vca-");
 159                 assign_button.set_active_state (Gtkmm2ext::Off);
 160         } else {
 161                 assign_button.set_active_state (Gtkmm2ext::ExplicitActive);
 162         }
 163
 164         assign_button.set_text (label);
 165 }
 166
 167 string
 168 VCAMasterStrip::name() const
 169 {
 170         return _vca->name();
 171 }
 172
 173 void
 174 VCAMasterStrip::hide_clicked ()
 175 {
 176 }
 177
 178 bool
 179 VCAMasterStrip::width_button_pressed (GdkEventButton* ev)
 180 {
 181         return false;
 182 }
 183
 184 void
 185 VCAMasterStrip::set_selected (bool yn)
 186 {
 187         AxisView::set_selected (yn);
 188
 189         if (_selected) {
 190                 global_frame.set_shadow_type (Gtk::SHADOW_ETCHED_OUT);
 191                 global_frame.set_name ("MixerStripSelectedFrame");
 192         } else {
 193                 global_frame.set_shadow_type (Gtk::SHADOW_IN);
 194                 global_frame.set_name ("MixerStripFrame");
 195         }
 196
 197         global_frame.queue_draw ();
 198 }
 199
 200 bool
 201 VCAMasterStrip::solo_release (GdkEventButton*)
 202 {
 203         /* We use NoGroup because VCA controls are never part of a group. This
 204            is redundant, but clear.
 205         */
 206         _vca->solo_control()->set_value (_vca->solo_control()->self_soloed() ? 0.0 : 1.0, Controllable::NoGroup);
 207         return true;
 208 }
 209
 210 bool
 211 VCAMasterStrip::mute_release (GdkEventButton*)
 212 {
 213         /* We use NoGroup because VCA controls are never part of a group. This
 214            is redundant, but clear.
 215         */
 216         _vca->mute_control()->set_value (_vca->mute_control()->muted_by_self() ? 0.0 : 1.0, Controllable::NoGroup);
 217         return true;
 218 }
 219
 220 void
 221 VCAMasterStrip::set_solo_text ()
 222 {
 223         if (Config->get_solo_control_is_listen_control ()) {
 224                 switch (Config->get_listen_position()) {
 225                 case AfterFaderListen:
 226                         solo_button.set_text (_("A"));
 227                         break;
 228                 case PreFaderListen:
 229                         solo_button.set_text (_("P"));
 230                         break;
 231                         }
 232         } else {
 233                 solo_button.set_text (_("S"));
 234         }
 235 }
 236
 237 void
 238 VCAMasterStrip::mute_changed ()
 239 {
 240         if (_vca->mute_control()->muted_by_self()) {
 241                 mute_button.set_active_state (ExplicitActive);
 242         } else if (_vca->mute_control()->muted_by_masters ()) {
 243                 mute_button.set_active_state (ImplicitActive);
 244         } else {
 245                 mute_button.set_active_state (Gtkmm2ext::Off);
 246         }
 247 }
 248
 249 void
 250 VCAMasterStrip::solo_changed ()
 251 {
 252         if (_vca->solo_control()->soloed() || _vca->solo_control()->get_masters_value()) {
 253                 solo_button.set_active_state (ExplicitActive);
 254         } else {
 255                 solo_button.set_active_state (Gtkmm2ext::Off);
 256         }
 257 }
 258
 259 void
 260 VCAMasterStrip::vca_menu_toggle (CheckMenuItem* menuitem, uint32_t n)
 261 {
 262         boost::shared_ptr<VCA> vca = _session->vca_manager().vca_by_number (n);
 263
 264         if (!menuitem->get_active()) {
 265                 if (!vca) {
 266                         /* null VCA means drop all VCA assignments */
 267                         vca_unassign ();
 268                 } else {
 269                         _vca->gain_control()->remove_master (vca->gain_control());
 270                         _vca->solo_control()->remove_master (vca->solo_control());
 271                         _vca->mute_control()->remove_master (vca->mute_control());
 272                 }
 273         } else {
 274                 if (vca) {
 275                         _vca->gain_control()->add_master (vca->gain_control());
 276                         _vca->mute_control()->add_master (vca->mute_control());
 277                         _vca->solo_control()->add_master (vca->solo_control());
 278                 }
 279         }
 280 }
 281
 282 void
 283 VCAMasterStrip::vca_unassign ()
 284 {
 285         _vca->gain_control()->clear_masters ();
 286         _vca->solo_control()->clear_masters ();
 287         _vca->mute_control()->clear_masters ();
 288 }
 289
 290 bool
 291 VCAMasterStrip::vca_button_release (GdkEventButton* ev)
 292 {
 293         using namespace Gtk::Menu_Helpers;
 294
 295         if (!_session) {
 296                 return false;
 297         }
 298
 299         /* primary click only */
 300
 301         if (ev->button != 1) {
 302                 return false;
 303         }
 304
 305         VCAList vcas (_session->vca_manager().vcas());
 306
 307         if (vcas.empty()) {
 308                 /* XXX should probably show a message saying "No VCA masters" */
 309                 return true;
 310         }
 311
 312         Menu* menu = new Menu;
 313         MenuList& items = menu->items();
 314
 315         items.push_back (MenuElem (_("Unassign"), sigc::mem_fun (*this, &VCAMasterStrip::vca_unassign)));
 316
 317         for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
 318
 319                 if (*v == _vca) {
 320                         /* no self-mastering */
 321                         continue;
 322                 }
 323
 324                 items.push_back (CheckMenuElem ((*v)->name()));
 325                 CheckMenuItem* item = dynamic_cast<CheckMenuItem*> (&items.back());
 326                 if (_vca->gain_control()->slaved_to ((*v)->gain_control())) {
 327                         item->set_active (true);
 328                 }
 329                 item->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &VCAMasterStrip::vca_menu_toggle), item, (*v)->number()));
 330         }
 331
 332         menu->popup (1, ev->time);
 333
 334         return true;
 335 }
 336
 337 bool
 338 VCAMasterStrip::name_button_press (GdkEventButton* ev)
 339 {
 340         if (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
 341                 Gtk::Window* win = dynamic_cast<Gtk::Window*>(get_toplevel());
 342                 FloatingTextEntry* fte = new FloatingTextEntry (win, _vca->name());
 343                 fte->use_text.connect (sigc::mem_fun (*this, &VCAMasterStrip::finish_name_edit));
 344                 fte->present ();
 345                 return true;
 346         }
 347
 348         if (Keyboard::is_context_menu_event (ev)) {
 349                 if (!context_menu) {
 350                         build_context_menu ();
 351                 }
 352                 context_menu->popup (1, ev->time);
 353                 return true;
 354         }
 355
 356         return false;
 357 }
 358
 359 void
 360 VCAMasterStrip::finish_name_edit (std::string str)
 361 {
 362         _vca->set_name (str);
 363 }
 364
 365 void
 366 VCAMasterStrip::vca_property_changed (PropertyChange const & what_changed)
 367 {
 368         if (what_changed.contains (ARDOUR::Properties::name)) {
 369                 update_vca_name ();
 370         }
 371 }
 372
 373 void
 374 VCAMasterStrip::update_vca_name ()
 375 {
 376         name_button.set_text (short_version (_vca->name(), 8));
 377 }
 378
 379 void
 380 VCAMasterStrip::build_context_menu ()
 381 {
 382         using namespace Gtk::Menu_Helpers;
 383         context_menu = new Menu;
 384         MenuList& items = context_menu->items();
 385         items.push_back (MenuElem (_("Remove")));
 386 }