gtk2_ardour/gain_meter.cc

   1 /*
   2  * Copyright (C) 2005-2006 Nick Mainsbridge <mainsbridge@gmail.com>
   3  * Copyright (C) 2005-2017 Paul Davis <paul@linuxaudiosystems.com>
   4  * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
   5  * Copyright (C) 2006-2007 Doug McLain <doug@nostar.net>
   6  * Copyright (C) 2006-2014 David Robillard <d@drobilla.net>
   7  * Copyright (C) 2007-2016 Tim Mayberry <mojofunk@gmail.com>
   8  * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
   9  * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
  10  * Copyright (C) 2014-2015 Ben Loftis <ben@harrisonconsoles.com>
  11  * Copyright (C) 2016 Julien "_FrnchFrgg_" RIVAUD <frnchfrgg@free.fr>
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  26  */
  27
  28 #include <limits.h>
  29
  30 #include <pangomm.h>
  31
  32 #include <gtkmm/alignment.h>
  33 #include <gdkmm/color.h>
  34 #include <gtkmm/style.h>
  35
  36 #include "ardour/amp.h"
  37 #include "ardour/logmeter.h"
  38 #include "ardour/route_group.h"
  39 #include "ardour/session_route.h"
  40 #include "ardour/dB.h"
  41 #include "ardour/utils.h"
  42
  43 #include "gtkmm2ext/utils.h"
  44 #include "gtkmm2ext/gtk_ui.h"
  45
  46 #include "widgets/tooltips.h"
  47
  48 #include "pbd/fastlog.h"
  49 #include "pbd/stacktrace.h"
  50
  51 #include "gain_meter.h"
  52 #include "gui_thread.h"
  53 #include "keyboard.h"
  54 #include "public_editor.h"
  55 #include "utils.h"
  56 #include "meter_patterns.h"
  57 #include "timers.h"
  58 #include "ui_config.h"
  59
  60 #include "ardour/session.h"
  61 #include "ardour/route.h"
  62 #include "ardour/meter.h"
  63 #include "ardour/audio_track.h"
  64 #include "ardour/midi_track.h"
  65 #include "ardour/dB.h"
  66
  67 #include "pbd/i18n.h"
  68
  69 using namespace ARDOUR;
  70 using namespace ArdourWidgets;
  71 using namespace PBD;
  72 using namespace Gtkmm2ext;
  73 using namespace Gtk;
  74 using namespace std;
  75 using Gtkmm2ext::Keyboard;
  76 using namespace ArdourMeter;
  77
  78 static void
  79 reset_cursor_to_default (Gtk::Entry* widget)
  80 {
  81         Glib::RefPtr<Gdk::Window> win = widget->get_text_window ();
  82         if (win) {
  83                 /* C++ doesn't provide a pointer argument version of this
  84                    (i.e. you cannot set to NULL to get the default/parent
  85                    cursor)
  86                 */
  87                 gdk_window_set_cursor (win->gobj(), 0);
  88         }
  89 }
  90
  91 static void
  92 reset_cursor_to_default_state (Gtk::StateType, Gtk::Entry* widget)
  93 {
  94         reset_cursor_to_default (widget);
  95 }
  96
  97 sigc::signal<void, ARDOUR::AutoState> GainMeterBase::ChangeGainAutomationState;
  98
  99 GainMeterBase::GainMeterBase (Session* s, bool horizontal, int fader_length, int fader_girth)
 100         : gain_adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()),  // value
 101                            0.0,  // lower
 102                            1.0,  // upper
 103                            dB_coeff_step(Config->get_max_gain()) / 10.0,  // step increment
 104                            dB_coeff_step(Config->get_max_gain()))  // page increment
 105         , gain_automation_state_button ("")
 106         , meter_point_button (_("pre"))
 107         , gain_astate_propagate (false)
 108         , _data_type (DataType::AUDIO)
 109 {
 110         using namespace Menu_Helpers;
 111
 112         set_session (s);
 113
 114         ignore_toggle = false;
 115         meter_menu = 0;
 116         next_release_selects = false;
 117         _width = Wide;
 118
 119         fader_length = rint (fader_length * UIConfiguration::instance().get_ui_scale());
 120         fader_girth = rint (fader_girth * UIConfiguration::instance().get_ui_scale());
 121
 122         if (horizontal) {
 123                 gain_slider = manage (new HSliderController (&gain_adjustment, boost::shared_ptr<PBD::Controllable>(), fader_length, fader_girth));
 124                 gain_slider->set_tweaks (ArdourFader::Tweaks(ArdourFader::NoButtonForward | ArdourFader::NoVerticalScroll));
 125         } else {
 126                 gain_slider = manage (new VSliderController (&gain_adjustment, boost::shared_ptr<PBD::Controllable>(), fader_length, fader_girth));
 127                 gain_slider->set_tweaks (ArdourFader::NoButtonForward);
 128         }
 129
 130         level_meter = new LevelMeterHBox(_session);
 131
 132         level_meter->ButtonPress.connect_same_thread (_level_meter_connection, boost::bind (&GainMeterBase::level_meter_button_press, this, _1));
 133         meter_metric_area.signal_button_press_event().connect (sigc::mem_fun (*this, &GainMeterBase::level_meter_button_press));
 134         meter_metric_area.add_events (Gdk::BUTTON_PRESS_MASK);
 135
 136         gain_slider->StartGesture.connect (sigc::mem_fun (*this, &GainMeter::amp_start_touch));
 137         gain_slider->StopGesture.connect (sigc::mem_fun (*this, &GainMeter::amp_stop_touch));
 138         gain_slider->set_name ("GainFader");
 139
 140         gain_display.set_name ("MixerStripGainDisplay");
 141         set_size_request_to_display_given_text (gain_display, "-80.g", 2, 6); /* note the descender */
 142         gain_display.signal_activate().connect (sigc::mem_fun (*this, &GainMeter::gain_activated));
 143         gain_display.signal_focus_in_event().connect (sigc::mem_fun (*this, &GainMeter::gain_focused), false);
 144         gain_display.signal_focus_out_event().connect (sigc::mem_fun (*this, &GainMeter::gain_focused), false);
 145         gain_display.set_alignment (0.5);
 146
 147         peak_display.set_name ("MixerStripPeakDisplay");
 148         set_size_request_to_display_given_text (peak_display, "-80.g", 2, 6); /* note the descender */
 149         max_peak = minus_infinity();
 150         peak_display.set_text (_("-inf"));
 151         peak_display.set_alignment (0.5);
 152
 153         /* stuff related to the fact that the peak display is not, in
 154            fact, supposed to be a text entry.
 155         */
 156         peak_display.set_events (peak_display.get_events() & ~(Gdk::EventMask (Gdk::LEAVE_NOTIFY_MASK|Gdk::ENTER_NOTIFY_MASK|Gdk::POINTER_MOTION_MASK)));
 157         peak_display.signal_map().connect (sigc::bind (sigc::ptr_fun (reset_cursor_to_default), &peak_display));
 158         peak_display.signal_state_changed().connect (sigc::bind (sigc::ptr_fun (reset_cursor_to_default_state), &peak_display));
 159         peak_display.unset_flags (Gtk::CAN_FOCUS);
 160         peak_display.set_editable (false);
 161
 162         gain_automation_state_button.set_name ("mixer strip button");
 163
 164         set_tooltip (gain_automation_state_button, _("Fader automation mode"));
 165
 166         gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
 167
 168         gain_automation_state_button.set_size_request(15, 15);
 169
 170         gain_astate_menu.set_name ("ArdourContextMenu");
 171         gain_astate_menu.set_reserve_toggle_size(false);
 172
 173         meter_point_button.set_name ("mixer strip button");
 174
 175         set_tooltip (&meter_point_button, _("Metering point"));
 176
 177         meter_point_button.unset_flags (Gtk::CAN_FOCUS);
 178
 179         meter_point_button.set_size_request(15, 15);
 180
 181         meter_point_menu.set_name ("ArdourContextMenu");
 182         meter_point_menu.set_reserve_toggle_size(false);
 183
 184         meter_point_menu.items().clear ();
 185         meter_point_menu.items().push_back (MenuElem(meterpt_string(MeterInput),
 186          sigc::bind (sigc::mem_fun (*this,
 187          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterInput)));
 188         meter_point_menu.items().push_back (MenuElem(meterpt_string(MeterPreFader),
 189          sigc::bind (sigc::mem_fun (*this,
 190          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterPreFader)));
 191         meter_point_menu.items().push_back (MenuElem(meterpt_string (MeterPostFader),
 192          sigc::bind (sigc::mem_fun (*this,
 193          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterPostFader)));
 194         meter_point_menu.items().push_back (MenuElem(meterpt_string (MeterOutput),
 195          sigc::bind (sigc::mem_fun (*this,
 196          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterOutput)));
 197         meter_point_menu.items().push_back (MenuElem(meterpt_string (MeterCustom),
 198          sigc::bind (sigc::mem_fun (*this,
 199          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterCustom)));
 200
 201         meter_point_button.signal_button_press_event().connect (sigc::mem_fun (*this, &GainMeter::meter_press), false);
 202
 203         gain_adjustment.signal_value_changed().connect (sigc::mem_fun(*this, &GainMeterBase::fader_moved));
 204         peak_display.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::peak_button_press), false);
 205         peak_display.signal_button_release_event().connect (sigc::mem_fun(*this, &GainMeterBase::peak_button_release), false);
 206         gain_display.signal_key_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_key_press), false);
 207
 208         ResetAllPeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_peak_display));
 209         ResetRoutePeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_route_peak_display));
 210         ResetGroupPeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_group_peak_display));
 211         RedrawMetrics.connect (sigc::mem_fun(*this, &GainMeterBase::redraw_metrics));
 212
 213         UI::instance()->theme_changed.connect (sigc::mem_fun(*this, &GainMeterBase::on_theme_changed));
 214         UIConfiguration::instance().ColorsChanged.connect (sigc::bind(sigc::mem_fun (*this, &GainMeterBase::color_handler), false));
 215         UIConfiguration::instance().DPIReset.connect (sigc::bind(sigc::mem_fun (*this, &GainMeterBase::color_handler), true));
 216 }
 217
 218 GainMeterBase::~GainMeterBase ()
 219 {
 220         delete meter_menu;
 221         delete level_meter;
 222 }
 223
 224 void
 225 GainMeterBase::set_controls (boost::shared_ptr<Route> r,
 226                              boost::shared_ptr<PeakMeter> pm,
 227                              boost::shared_ptr<Amp> amp,
 228                              boost::shared_ptr<GainControl> control)
 229 {
 230         connections.clear ();
 231         model_connections.drop_connections ();
 232
 233         /* no meter and no control? nothing to do ... */
 234
 235         if (!pm && !control) {
 236                 level_meter->set_meter (0);
 237                 gain_slider->set_controllable (boost::shared_ptr<PBD::Controllable>());
 238                 _meter.reset ();
 239                 _amp.reset ();
 240                 _route.reset ();
 241                 _control.reset ();
 242                 return;
 243         }
 244
 245         _meter = pm;
 246         _amp = amp;
 247         _route = r;
 248         _control = control;
 249
 250         level_meter->set_meter (pm.get());
 251         gain_slider->set_controllable (_control);
 252
 253         if (amp) {
 254                 amp->ConfigurationChanged.connect (
 255                         model_connections, invalidator (*this), boost::bind (&GainMeterBase::setup_gain_adjustment, this), gui_context ()
 256                         );
 257         }
 258
 259         setup_gain_adjustment ();
 260
 261         if (!_route || !_route->is_auditioner()) {
 262
 263                 using namespace Menu_Helpers;
 264
 265                 gain_astate_menu.items().clear ();
 266
 267                 gain_astate_menu.items().push_back (MenuElem (astate_string (ARDOUR::Off),
 268                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Off)));
 269                 gain_astate_menu.items().push_back (MenuElem (astate_string (ARDOUR::Play),
 270                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Play)));
 271                 gain_astate_menu.items().push_back (MenuElem (astate_string (ARDOUR::Write),
 272                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Write)));
 273                 gain_astate_menu.items().push_back (MenuElem (astate_string (ARDOUR::Touch),
 274                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Touch)));
 275                 gain_astate_menu.items().push_back (MenuElem (astate_string (ARDOUR::Latch),
 276                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Latch)));
 277
 278                 connections.push_back (gain_automation_state_button.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_automation_state_button_event), false));
 279                 connections.push_back (ChangeGainAutomationState.connect (sigc::mem_fun(*this, &GainMeterBase::set_gain_astate)));
 280
 281                 _control->alist()->automation_state_changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeter::gain_automation_state_changed, this), gui_context());
 282
 283                 gain_automation_state_changed ();
 284         }
 285
 286         _control->Changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeterBase::gain_changed, this), gui_context());
 287
 288         gain_changed ();
 289         show_gain ();
 290         update_gain_sensitive ();
 291
 292         if (!_meter) {
 293                 peak_display.hide ();
 294         } else {
 295                 peak_display.show ();
 296         }
 297 }
 298
 299 void
 300 GainMeterBase::set_gain_astate (AutoState as)
 301 {
 302         if (gain_astate_propagate) {
 303                 gain_astate_propagate = false;
 304                 ChangeGainAutomationState (as);
 305                 return;
 306         }
 307         if (_amp) {
 308                 _amp->set_parameter_automation_state (Evoral::Parameter (GainAutomation), as);
 309         } else if (_control) {
 310                 _control->set_automation_state (as);
 311                 _session->set_dirty ();
 312         }
 313 }
 314
 315 void
 316 GainMeterBase::setup_gain_adjustment ()
 317 {
 318         if (!_amp) {
 319                 return;
 320         }
 321
 322         if (_previous_amp_output_streams == _amp->output_streams ()) {
 323                 return;
 324         }
 325
 326         ignore_toggle = true;
 327
 328         if (_amp->output_streams().n_midi() <=  _amp->output_streams().n_audio()) {
 329                 _data_type = DataType::AUDIO;
 330                 gain_adjustment.set_lower (GAIN_COEFF_ZERO);
 331                 gain_adjustment.set_upper (GAIN_COEFF_UNITY);
 332                 gain_adjustment.set_step_increment (dB_coeff_step(Config->get_max_gain()) / 10.0);
 333                 gain_adjustment.set_page_increment (dB_coeff_step(Config->get_max_gain()));
 334                 gain_slider->set_default_value (gain_to_slider_position_with_max (GAIN_COEFF_UNITY, Config->get_max_gain()));
 335         } else {
 336                 _data_type = DataType::MIDI;
 337                 gain_adjustment.set_lower (0.0);
 338                 gain_adjustment.set_upper (2.0);
 339                 gain_adjustment.set_step_increment (1.0/128.0);
 340                 gain_adjustment.set_page_increment (10.0/128.0);
 341                 gain_slider->set_default_value (1.0);
 342         }
 343
 344         ignore_toggle = false;
 345
 346         effective_gain_display ();
 347
 348         _previous_amp_output_streams = _amp->output_streams ();
 349 }
 350
 351 void
 352 GainMeterBase::hide_all_meters ()
 353 {
 354         level_meter->hide_meters();
 355 }
 356
 357 void
 358 GainMeter::hide_all_meters ()
 359 {
 360         GainMeterBase::hide_all_meters ();
 361 }
 362
 363 void
 364 GainMeterBase::setup_meters (int len)
 365 {
 366         int meter_width = 5;
 367         uint32_t meter_channels = 0;
 368         if (_meter) {
 369                 meter_channels = _meter->input_streams().n_total();
 370         } else if (_route) {
 371                 meter_channels = _route->shared_peak_meter()->input_streams().n_total();
 372         }
 373
 374         switch (_width) {
 375                 case Wide:
 376                         //meter_ticks1_area.show();
 377                         //meter_ticks2_area.show();
 378                         meter_metric_area.show();
 379                         if (meter_channels == 1) {
 380                                 meter_width = 10;
 381                         }
 382                         break;
 383                 case Narrow:
 384                         if (meter_channels > 1) {
 385                                 meter_width = 4;
 386                         }
 387                         //meter_ticks1_area.hide();
 388                         //meter_ticks2_area.hide();
 389                         meter_metric_area.hide();
 390                         break;
 391         }
 392         level_meter->setup_meters(len, meter_width);
 393 }
 394
 395 void
 396 GainMeter::setup_meters (int len)
 397 {
 398         switch (_width) {
 399                 case Wide:
 400                         {
 401                                 uint32_t meter_channels = 0;
 402                                 if (_meter) {
 403                                         meter_channels = _meter->input_streams().n_total();
 404                                 } else if (_route) {
 405                                         meter_channels = _route->shared_peak_meter()->input_streams().n_total();
 406                                 }
 407                                 hbox.set_homogeneous(meter_channels < 7 ? true : false);
 408                         }
 409                         break;
 410                 case Narrow:
 411                         hbox.set_homogeneous(false);
 412                         break;
 413         }
 414         GainMeterBase::setup_meters (len);
 415 }
 416
 417 bool
 418 GainMeterBase::gain_key_press (GdkEventKey* ev)
 419 {
 420         if (ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (ev->keyval)) {
 421                 /* drop through to normal handling */
 422                 return false;
 423         }
 424         /* illegal key for gain entry */
 425         return true;
 426 }
 427
 428 bool
 429 GainMeterBase::peak_button_press (GdkEventButton* ev)
 430 {
 431         return true;
 432 }
 433
 434 bool
 435 GainMeterBase::peak_button_release (GdkEventButton* ev)
 436 {
 437         /* reset peak label */
 438
 439         if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier|Keyboard::TertiaryModifier)) {
 440                 ResetAllPeakDisplays ();
 441         } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 442                 if (_route) {
 443                         ResetGroupPeakDisplays (_route->route_group());
 444                 }
 445         } else {
 446                 ResetRoutePeakDisplays (_route.get());
 447         }
 448
 449         return true;
 450 }
 451
 452 void
 453 GainMeterBase::reset_peak_display ()
 454 {
 455         if (!_route) {
 456                 // catch "reset all" for VCAs
 457                 return;
 458         }
 459         _meter->reset_max();
 460         level_meter->clear_meters();
 461         max_peak = minus_infinity ();
 462         peak_display.set_text (_("-inf"));
 463         peak_display.set_name ("MixerStripPeakDisplay");
 464 }
 465
 466 void
 467 GainMeterBase::reset_route_peak_display (Route* route)
 468 {
 469         if (_route && _route.get() == route) {
 470                 reset_peak_display ();
 471         }
 472 }
 473
 474 void
 475 GainMeterBase::reset_group_peak_display (RouteGroup* group)
 476 {
 477         if (_route && group == _route->route_group()) {
 478                 reset_peak_display ();
 479         }
 480 }
 481
 482 void
 483 GainMeterBase::popup_meter_menu (GdkEventButton *ev)
 484 {
 485         using namespace Menu_Helpers;
 486
 487         if (meter_menu == 0) {
 488                 meter_menu = new Gtk::Menu;
 489                 MenuList& items = meter_menu->items();
 490
 491                 items.push_back (MenuElem ("-inf .. +0dBFS"));
 492                 items.push_back (MenuElem ("-10dB .. +0dBFS"));
 493                 items.push_back (MenuElem ("-4 .. +0dBFS"));
 494                 items.push_back (SeparatorElem());
 495                 items.push_back (MenuElem ("-inf .. -2dBFS"));
 496                 items.push_back (MenuElem ("-10dB .. -2dBFS"));
 497                 items.push_back (MenuElem ("-4 .. -2dBFS"));
 498         }
 499
 500         meter_menu->popup (1, ev->time);
 501 }
 502
 503 bool
 504 GainMeterBase::gain_focused (GdkEventFocus* ev)
 505 {
 506         if (ev->in) {
 507                 gain_display.select_region (0, -1);
 508         } else {
 509                 gain_display.select_region (0, 0);
 510         }
 511         return false;
 512 }
 513
 514 void
 515 GainMeterBase::gain_activated ()
 516 {
 517         float f;
 518
 519         // Use the user's preferred locale/LC_NUMERIC setting
 520         if (sscanf (gain_display.get_text().c_str(), "%f", &f) != 1) {
 521                 return;
 522         }
 523
 524         /* clamp to displayable values */
 525         if (_data_type == DataType::AUDIO) {
 526                 f = min (f, 6.0f);
 527                 _control->set_value (dB_to_coefficient(f), Controllable::UseGroup);
 528         } else {
 529                 f = min (fabs (f), 2.0f);
 530                 _control->set_value (f, Controllable::UseGroup);
 531         }
 532
 533         if (gain_display.has_focus()) {
 534                 Gtk::Widget* w = gain_display.get_toplevel();
 535                 if (w) {
 536                         Gtk::Window* win = dynamic_cast<Gtk::Window*> (w);
 537
 538                         /* sigh. gtkmm doesn't wrap get_default_widget() */
 539
 540                         if (win) {
 541                                 GtkWidget* f = gtk_window_get_default_widget (win->gobj());
 542                                 if (f) {
 543                                         gtk_widget_grab_focus (f);
 544                                         return;
 545                                 }
 546                         }
 547                 }
 548         }
 549 }
 550
 551 void
 552 GainMeterBase::show_gain ()
 553 {
 554         char buf[32];
 555
 556         float v = gain_adjustment.get_value();
 557
 558         switch (_data_type) {
 559         case DataType::AUDIO:
 560                 if (v == 0.0) {
 561                         strcpy (buf, _("-inf"));
 562                 } else {
 563                         snprintf (buf, sizeof (buf), "%.1f", accurate_coefficient_to_dB (slider_position_to_gain_with_max (v, Config->get_max_gain())));
 564                 }
 565                 break;
 566         case DataType::MIDI:
 567                 snprintf (buf, sizeof (buf), "%.1f", v);
 568                 break;
 569         }
 570
 571         gain_display.set_text (buf);
 572 }
 573
 574 void
 575 GainMeterBase::fader_moved ()
 576 {
 577         if (!ignore_toggle) {
 578
 579                 gain_t value;
 580
 581                 /* convert from adjustment range (0..1) to gain coefficient */
 582
 583                 if (_data_type == DataType::AUDIO) {
 584                         value = slider_position_to_gain_with_max (gain_adjustment.get_value(), Config->get_max_gain());
 585                 } else {
 586                         value = gain_adjustment.get_value();
 587                 }
 588
 589                 // XXX hack allow to override group
 590                 // (this breaks group'ed  shift+click reset)
 591                 if (Keyboard::the_keyboard().key_is_down (GDK_Shift_R)
 592                                 || Keyboard::the_keyboard().key_is_down (GDK_Shift_L)) {
 593                         _control->set_value (value, Controllable::InverseGroup);
 594                 } else {
 595                         _control->set_value (value, Controllable::UseGroup);
 596                 }
 597         }
 598
 599         show_gain ();
 600 }
 601
 602 void
 603 GainMeterBase::effective_gain_display ()
 604 {
 605         gain_t fader_position = 0;
 606
 607         switch (_data_type) {
 608         case DataType::AUDIO:
 609                 /* the position of the fader should reflect any master gain,
 610                  * not just the control's own inherent value
 611                  */
 612                 fader_position = gain_to_slider_position_with_max (_control->get_value(), Config->get_max_gain());
 613                 break;
 614         case DataType::MIDI:
 615                 fader_position = _control->get_value ();
 616                 break;
 617         }
 618
 619         if (gain_adjustment.get_value() != fader_position) {
 620                 ignore_toggle = true;
 621                 gain_adjustment.set_value (fader_position);
 622                 ignore_toggle = false;
 623         }
 624 }
 625
 626 void
 627 GainMeterBase::gain_changed ()
 628 {
 629         ENSURE_GUI_THREAD (*this, &GainMeterBase::gain_automation_state_changed);
 630         effective_gain_display ();
 631 }
 632
 633 void
 634 GainMeterBase::set_meter_strip_name (const char * name)
 635 {
 636         char tmp[256];
 637         meter_metric_area.set_name (name);
 638         sprintf(tmp, "Mark%sLeft", name);
 639         meter_ticks1_area.set_name (tmp);
 640         sprintf(tmp, "Mark%sRight", name);
 641         meter_ticks2_area.set_name (tmp);
 642 }
 643
 644 void
 645 GainMeterBase::set_fader_name (const char * name)
 646 {
 647         gain_slider->set_name (name);
 648 }
 649
 650 void
 651 GainMeterBase::update_gain_sensitive ()
 652 {
 653         bool x = !(_control->alist()->automation_state() & Play);
 654         static_cast<ArdourWidgets::SliderController*>(gain_slider)->set_sensitive (x);
 655 }
 656
 657 gint
 658 GainMeterBase::meter_press(GdkEventButton* ev)
 659 {
 660         if (!_route) {
 661                 return false;
 662         }
 663         if (!ignore_toggle) {
 664                 switch (ev->button) {
 665                         case 1:
 666                                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
 667
 668                                         /* Primary+Tertiary-click applies change to all routes */
 669
 670                                         meter_point_change_target = MeterPointChangeAll;
 671
 672                                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 673
 674                                         /* Primary-click: apply change to all routes in group */
 675
 676                                         meter_point_change_target = MeterPointChangeGroup;
 677
 678                                 } else {
 679
 680                                         /* click: change just this route */
 681
 682                                         meter_point_change_target = MeterPointChangeSingle;
 683                                 }
 684                                 Gtkmm2ext::anchored_menu_popup(&meter_point_menu,
 685                                                                &meter_point_button,
 686                                                                meterpt_string (_route->meter_point()),
 687                                                                1, ev->time);
 688                                 break;
 689                         default:
 690                                 break;
 691                 }
 692         }
 693         return true;
 694 }
 695
 696 void
 697 GainMeterBase::set_meter_point (Route& route, MeterPoint mp)
 698 {
 699         route.set_meter_point (mp);
 700 }
 701
 702 void
 703 GainMeterBase::set_route_group_meter_point (Route& route, MeterPoint mp)
 704 {
 705         RouteGroup* route_group;
 706
 707         if ((route_group = route.route_group ()) != 0) {
 708                 route_group->foreach_route (boost::bind (&Route::set_meter_point, _1, mp, false));
 709         } else {
 710                 route.set_meter_point (mp);
 711         }
 712 }
 713
 714 void
 715 GainMeterBase::meter_point_clicked (MeterPoint mp)
 716 {
 717         if (_route) {
 718                 switch (meter_point_change_target) {
 719                         case MeterPointChangeAll:
 720                                 _session->foreach_route (this, &GainMeterBase::set_meter_point, mp);
 721                                 break;
 722                         case MeterPointChangeGroup:
 723                                 set_route_group_meter_point (*_route, mp);
 724                                 break;
 725                         case MeterPointChangeSingle:
 726                                 _route->set_meter_point (mp);
 727                                 break;
 728                 }
 729         }
 730 }
 731
 732 void
 733 GainMeterBase::amp_start_touch ()
 734 {
 735         _control->start_touch (_control->session().transport_sample());
 736 }
 737
 738 void
 739 GainMeterBase::amp_stop_touch ()
 740 {
 741         _control->stop_touch (_control->session().transport_sample());
 742         effective_gain_display ();
 743 }
 744
 745 gint
 746 GainMeterBase::gain_automation_state_button_event (GdkEventButton *ev)
 747 {
 748         if (ev->type == GDK_BUTTON_RELEASE) {
 749                 return TRUE;
 750         }
 751
 752         switch (ev->button) {
 753                 case 1:
 754                         gain_astate_propagate = Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier | Keyboard::TertiaryModifier));
 755                         Gtkmm2ext::anchored_menu_popup(&gain_astate_menu,
 756                                                        &gain_automation_state_button,
 757                                                        astate_string(_control->alist()->automation_state()),
 758                                                        1, ev->time);
 759                         break;
 760                 default:
 761                         break;
 762         }
 763
 764         return TRUE;
 765 }
 766
 767
 768 string
 769 GainMeterBase::astate_string (AutoState state)
 770 {
 771         return _astate_string (state, false);
 772 }
 773
 774 string
 775 GainMeterBase::short_astate_string (AutoState state)
 776 {
 777         return _astate_string (state, true);
 778 }
 779
 780 string
 781 GainMeterBase::_astate_string (AutoState state, bool shrt)
 782 {
 783         string sstr;
 784
 785         switch (state) {
 786         case ARDOUR::Off:
 787                 sstr = shrt ? S_("Manual|M") : S_("Automation|Manual");
 788                 break;
 789         case Play:
 790                 sstr = shrt ? S_("Play|P") : _("Play");
 791                 break;
 792         case Touch:
 793                 sstr = shrt ? S_("Trim|T") : _("Write");
 794                 break;
 795         case Latch:
 796                 sstr = shrt ? S_("Latch|L") : _("Touch");
 797                 break;
 798         case Write:
 799                 sstr = shrt ? S_("Write|W"): _("Latch");
 800                 break;
 801         }
 802
 803         return sstr;
 804 }
 805
 806 string
 807 GainMeterBase::meterpt_string (MeterPoint mp)
 808 {
 809         switch (mp) {
 810                 case MeterInput:
 811                         return _("Input");
 812                 case MeterPreFader:
 813                         return _("Pre Fader");
 814                 case MeterPostFader:
 815                         return _("Post Fader");
 816                 case MeterOutput:
 817                         return _("Output");
 818                 case MeterCustom:
 819                         return _("Custom");
 820         }
 821         assert (0);
 822         return "???"; // make gcc and _FrnchFrgg_ happy
 823 }
 824
 825 void
 826 GainMeterBase::gain_automation_state_changed ()
 827 {
 828         ENSURE_GUI_THREAD (*this, &GainMeterBase::gain_automation_state_changed);
 829         gain_automation_state_button.set_text (short_astate_string(_control->alist()->automation_state()));
 830
 831         const bool automation_watch_required = (_control->alist()->automation_state() != ARDOUR::Off);
 832
 833         if (gain_automation_state_button.get_active() != automation_watch_required) {
 834                 ignore_toggle = true;
 835                 gain_automation_state_button.set_active (automation_watch_required);
 836                 ignore_toggle = false;
 837         }
 838
 839         update_gain_sensitive ();
 840
 841         gain_watching.disconnect();
 842 }
 843
 844 const ChanCount
 845 GainMeterBase::meter_channels() const
 846 {
 847                 if (_meter) { return _meter->input_streams(); }
 848                 else { return ChanCount(); }
 849 }
 850 void
 851 GainMeterBase::update_meters()
 852 {
 853         char buf[32];
 854         float mpeak = level_meter->update_meters();
 855
 856         if (mpeak > max_peak) {
 857                 max_peak = mpeak;
 858                 if (mpeak <= -200.0f) {
 859                         peak_display.set_text (_("-inf"));
 860                 } else {
 861                         snprintf (buf, sizeof(buf), "%.1f", mpeak);
 862                         peak_display.set_text (buf);
 863                 }
 864         }
 865         if (mpeak >= UIConfiguration::instance().get_meter_peak()) {
 866                 peak_display.set_name ("MixerStripPeakDisplayPeak");
 867         }
 868 }
 869
 870 void GainMeterBase::color_handler(bool /*dpi*/)
 871 {
 872         setup_meters();
 873 }
 874
 875 void
 876 GainMeterBase::set_width (Width w, int len)
 877 {
 878         _width = w;
 879         int meter_width = 5;
 880         if (_width == Wide && _route && _route->shared_peak_meter()->input_streams().n_total() == 1) {
 881                 meter_width = 10;
 882         }
 883         level_meter->setup_meters(len, meter_width);
 884 }
 885
 886
 887 void
 888 GainMeterBase::on_theme_changed()
 889 {
 890 }
 891
 892 void
 893 GainMeterBase::redraw_metrics()
 894 {
 895         meter_metric_area.queue_draw ();
 896         meter_ticks1_area.queue_draw ();
 897         meter_ticks2_area.queue_draw ();
 898 }
 899
 900 #define PX_SCALE(pxmin, dflt) rint(std::max((double)pxmin, (double)dflt * UIConfiguration::instance().get_ui_scale()))
 901
 902 GainMeter::GainMeter (Session* s, int fader_length)
 903         : GainMeterBase (s, false, fader_length, 24)
 904         , gain_display_box(true, 0)
 905         , hbox(true, 2)
 906 {
 907         if (gain_display.get_parent()) {
 908                 gain_display.get_parent()->remove (gain_display);
 909         }
 910         gain_display_box.pack_start (gain_display, true, true);
 911
 912         if (peak_display.get_parent()) {
 913                 peak_display.get_parent()->remove (gain_display);
 914         }
 915         gain_display_box.pack_start (peak_display, true, true);
 916
 917         meter_metric_area.set_name ("AudioTrackMetrics");
 918         meter_metric_area.set_size_request(PX_SCALE(24, 24), -1);
 919
 920         gain_automation_state_button.set_name ("mixer strip button");
 921
 922         set_tooltip (gain_automation_state_button, _("Fader automation mode"));
 923
 924         gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
 925
 926         gain_automation_state_button.set_size_request (PX_SCALE(12, 15), PX_SCALE(12, 15));
 927
 928         fader_vbox.set_spacing (0);
 929         fader_vbox.pack_start (*gain_slider, true, true);
 930
 931         fader_alignment.set (0.5, 0.5, 0.0, 1.0);
 932         fader_alignment.add (fader_vbox);
 933
 934         hbox.pack_start (fader_alignment, true, true);
 935
 936         set_spacing (PX_SCALE(2, 2));
 937
 938         pack_start (gain_display_box, Gtk::PACK_SHRINK);
 939         pack_start (hbox, true, true);
 940
 941         meter_alignment.set (0.5, 0.5, 0.0, 1.0);
 942         meter_alignment.add (*level_meter);
 943
 944         meter_metric_area.signal_expose_event().connect (
 945                 sigc::mem_fun(*this, &GainMeter::meter_metrics_expose));
 946
 947         meter_ticks1_area.set_size_request (PX_SCALE(3, 3), -1);
 948         meter_ticks2_area.set_size_request (PX_SCALE(3, 3), -1);
 949
 950         meter_ticks1_area.signal_expose_event().connect (
 951                         sigc::mem_fun(*this, &GainMeter::meter_ticks1_expose));
 952         meter_ticks2_area.signal_expose_event().connect (
 953                         sigc::mem_fun(*this, &GainMeter::meter_ticks2_expose));
 954
 955         meter_hbox.pack_start (meter_ticks1_area, false, false);
 956         meter_hbox.pack_start (meter_alignment, false, false);
 957         meter_hbox.pack_start (meter_ticks2_area, false, false);
 958         meter_hbox.pack_start (meter_metric_area, false, false);
 959
 960         meter_metric_area.set_no_show_all ();
 961 }
 962 #undef PX_SCALE
 963
 964 GainMeter::~GainMeter () { }
 965
 966 void
 967 GainMeter::set_controls (boost::shared_ptr<Route> r,
 968                          boost::shared_ptr<PeakMeter> meter,
 969                          boost::shared_ptr<Amp> amp,
 970                          boost::shared_ptr<GainControl> control)
 971 {
 972         if (meter_hbox.get_parent()) {
 973                 hbox.remove (meter_hbox);
 974         }
 975
 976 //      if (gain_automation_state_button.get_parent()) {
 977 //              fader_vbox->remove (gain_automation_state_button);
 978 //      }
 979
 980         GainMeterBase::set_controls (r, meter, amp, control);
 981
 982         if (_meter) {
 983                 _meter->ConfigurationChanged.connect (
 984                         model_connections, invalidator (*this), boost::bind (&GainMeter::meter_configuration_changed, this, _1), gui_context()
 985                         );
 986                 _meter->MeterTypeChanged.connect (
 987                         model_connections, invalidator (*this), boost::bind (&GainMeter::redraw_metrics, this), gui_context()
 988                         );
 989
 990                 meter_configuration_changed (_meter->input_streams ());
 991         }
 992
 993
 994         if (_route) {
 995                 _route->active_changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeter::route_active_changed, this), gui_context ());
 996                 hbox.pack_start (meter_hbox, true, true);
 997                 meter_hbox.show ();
 998         }
 999
1000 //      if (r && !r->is_auditioner()) {
1001 //              fader_vbox->pack_start (gain_automation_state_button, false, false, 0);
1002 //      }
1003
1004         gain_display_box.show ();
1005         gain_display.show ();
1006         gain_slider->show ();
1007         fader_vbox.show ();
1008         fader_alignment.show ();
1009         hbox.show ();
1010         setup_meters ();
1011 }
1012
1013 int
1014 GainMeter::get_gm_width ()
1015 {
1016         Gtk::Requisition sz;
1017         int min_w = 0;
1018         sz.width = 0;
1019         meter_metric_area.size_request (sz);
1020         min_w += sz.width;
1021         level_meter->size_request (sz);
1022         min_w += sz.width;
1023
1024         fader_alignment.size_request (sz);
1025         if (_width == Wide)
1026                 return max(sz.width * 2, min_w * 2) + 6;
1027         else
1028                 return sz.width + min_w + 6;
1029
1030 }
1031
1032 gint
1033 GainMeter::meter_metrics_expose (GdkEventExpose *ev)
1034 {
1035         if (!_route) {
1036                 if (_types.empty()) { _types.push_back(DataType::AUDIO); }
1037                 return meter_expose_metrics(ev, MeterPeak, _types, &meter_metric_area);
1038         }
1039         return meter_expose_metrics(ev, _route->meter_type(), _types, &meter_metric_area);
1040 }
1041
1042 gint
1043 GainMeter::meter_ticks1_expose (GdkEventExpose *ev)
1044 {
1045         if (!_route) {
1046                 if (_types.empty()) { _types.push_back(DataType::AUDIO); }
1047                 return meter_expose_ticks(ev, MeterPeak, _types, &meter_ticks1_area);
1048         }
1049         return meter_expose_ticks(ev, _route->meter_type(), _types, &meter_ticks1_area);
1050 }
1051
1052 gint
1053 GainMeter::meter_ticks2_expose (GdkEventExpose *ev)
1054 {
1055         if (!_route) {
1056                 if (_types.empty()) { _types.push_back(DataType::AUDIO); }
1057                 return meter_expose_ticks(ev, MeterPeak, _types, &meter_ticks2_area);
1058         }
1059         return meter_expose_ticks(ev, _route->meter_type(), _types, &meter_ticks2_area);
1060 }
1061
1062 void
1063 GainMeter::on_style_changed (const Glib::RefPtr<Gtk::Style>&)
1064 {
1065         gain_display.queue_draw();
1066         peak_display.queue_draw();
1067 }
1068
1069 boost::shared_ptr<PBD::Controllable>
1070 GainMeterBase::get_controllable()
1071 {
1072         if (_amp) {
1073                 return _control;
1074         } else {
1075                 return boost::shared_ptr<PBD::Controllable>();
1076         }
1077 }
1078
1079 bool
1080 GainMeterBase::level_meter_button_press (GdkEventButton* ev)
1081 {
1082         return static_cast<bool>(LevelMeterButtonPress (ev)); /* EMIT SIGNAL */
1083 }
1084
1085 void
1086 GainMeter::meter_configuration_changed (ChanCount c)
1087 {
1088         int type = 0;
1089         _types.clear ();
1090
1091         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1092                 if (c.get (*i) > 0) {
1093                         _types.push_back (*i);
1094                         type |= 1 << (*i);
1095                 }
1096         }
1097
1098         if (_route
1099                         && boost::dynamic_pointer_cast<AudioTrack>(_route) == 0
1100                         && boost::dynamic_pointer_cast<MidiTrack>(_route) == 0
1101                         ) {
1102                 if (_route->active()) {
1103                         set_meter_strip_name ("AudioBusMetrics");
1104                 } else {
1105                         set_meter_strip_name ("AudioBusMetricsInactive");
1106                 }
1107         }
1108         else if (
1109                            (type == (1 << DataType::MIDI))
1110                         || (_route && boost::dynamic_pointer_cast<MidiTrack>(_route))
1111                         ) {
1112                 if (!_route || _route->active()) {
1113                         set_meter_strip_name ("MidiTrackMetrics");
1114                 } else {
1115                         set_meter_strip_name ("MidiTrackMetricsInactive");
1116                 }
1117         }
1118         else if (type == (1 << DataType::AUDIO)) {
1119                 if (!_route || _route->active()) {
1120                         set_meter_strip_name ("AudioTrackMetrics");
1121                 } else {
1122                         set_meter_strip_name ("AudioTrackMetricsInactive");
1123                 }
1124         } else {
1125                 if (!_route || _route->active()) {
1126                         set_meter_strip_name ("AudioMidiTrackMetrics");
1127                 } else {
1128                         set_meter_strip_name ("AudioMidiTrackMetricsInactive");
1129                 }
1130         }
1131
1132         setup_meters();
1133         meter_clear_pattern_cache(4);
1134         on_style_changed(Glib::RefPtr<Gtk::Style>());
1135 }
1136
1137 void
1138 GainMeter::route_active_changed ()
1139 {
1140         if (_meter) {
1141                 meter_configuration_changed (_meter->input_streams ());
1142         }
1143 }
1144
1145 void
1146 GainMeter::redraw_metrics ()
1147 {
1148         GainMeterBase::redraw_metrics ();
1149 }