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(_("Input"),
 186          sigc::bind (sigc::mem_fun (*this,
 187          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterInput)));
 188         meter_point_menu.items().push_back (MenuElem(_("Pre Fader"),
 189          sigc::bind (sigc::mem_fun (*this,
 190          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterPreFader)));
 191         meter_point_menu.items().push_back (MenuElem(_("Post Fader"),
 192          sigc::bind (sigc::mem_fun (*this,
 193          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterPostFader)));
 194         meter_point_menu.items().push_back (MenuElem(_("Output"),
 195          sigc::bind (sigc::mem_fun (*this,
 196          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterOutput)));
 197         meter_point_menu.items().push_back (MenuElem(_("Custom"),
 198          sigc::bind (sigc::mem_fun (*this,
 199          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterCustom)));
 200         meter_point_button.signal_button_press_event().connect (sigc::mem_fun (*this, &GainMeter::meter_press), false);
 201
 202         gain_adjustment.signal_value_changed().connect (sigc::mem_fun(*this, &GainMeterBase::fader_moved));
 203         peak_display.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::peak_button_press), false);
 204         peak_display.signal_button_release_event().connect (sigc::mem_fun(*this, &GainMeterBase::peak_button_release), false);
 205         gain_display.signal_key_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_key_press), false);
 206
 207         ResetAllPeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_peak_display));
 208         ResetRoutePeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_route_peak_display));
 209         ResetGroupPeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_group_peak_display));
 210         RedrawMetrics.connect (sigc::mem_fun(*this, &GainMeterBase::redraw_metrics));
 211
 212         UI::instance()->theme_changed.connect (sigc::mem_fun(*this, &GainMeterBase::on_theme_changed));
 213         UIConfiguration::instance().ColorsChanged.connect (sigc::bind(sigc::mem_fun (*this, &GainMeterBase::color_handler), false));
 214         UIConfiguration::instance().DPIReset.connect (sigc::bind(sigc::mem_fun (*this, &GainMeterBase::color_handler), true));
 215 }
 216
 217 GainMeterBase::~GainMeterBase ()
 218 {
 219         delete meter_menu;
 220         delete level_meter;
 221 }
 222
 223 void
 224 GainMeterBase::set_controls (boost::shared_ptr<Route> r,
 225                              boost::shared_ptr<PeakMeter> pm,
 226                              boost::shared_ptr<Amp> amp,
 227                              boost::shared_ptr<GainControl> control)
 228 {
 229         connections.clear ();
 230         model_connections.drop_connections ();
 231
 232         /* no meter and no control? nothing to do ... */
 233
 234         if (!pm && !control) {
 235                 level_meter->set_meter (0);
 236                 gain_slider->set_controllable (boost::shared_ptr<PBD::Controllable>());
 237                 _meter.reset ();
 238                 _amp.reset ();
 239                 _route.reset ();
 240                 _control.reset ();
 241                 return;
 242         }
 243
 244         _meter = pm;
 245         _amp = amp;
 246         _route = r;
 247         _control = control;
 248
 249         level_meter->set_meter (pm.get());
 250         gain_slider->set_controllable (_control);
 251
 252         if (amp) {
 253                 amp->ConfigurationChanged.connect (
 254                         model_connections, invalidator (*this), boost::bind (&GainMeterBase::setup_gain_adjustment, this), gui_context ()
 255                         );
 256         }
 257
 258         setup_gain_adjustment ();
 259
 260         if (!_route || !_route->is_auditioner()) {
 261
 262                 using namespace Menu_Helpers;
 263
 264                 gain_astate_menu.items().clear ();
 265
 266                 gain_astate_menu.items().push_back (MenuElem (S_("Automation|Manual"),
 267                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Off)));
 268                 gain_astate_menu.items().push_back (MenuElem (_("Play"),
 269                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Play)));
 270                 gain_astate_menu.items().push_back (MenuElem (_("Write"),
 271                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Write)));
 272                 gain_astate_menu.items().push_back (MenuElem (_("Touch"),
 273                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Touch)));
 274                 gain_astate_menu.items().push_back (MenuElem (_("Latch"),
 275                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Latch)));
 276
 277                 connections.push_back (gain_automation_state_button.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_automation_state_button_event), false));
 278                 connections.push_back (ChangeGainAutomationState.connect (sigc::mem_fun(*this, &GainMeterBase::set_gain_astate)));
 279
 280                 _control->alist()->automation_state_changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeter::gain_automation_state_changed, this), gui_context());
 281
 282                 gain_automation_state_changed ();
 283         }
 284
 285         _control->Changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeterBase::gain_changed, this), gui_context());
 286
 287         gain_changed ();
 288         show_gain ();
 289         update_gain_sensitive ();
 290
 291         if (!_meter) {
 292                 peak_display.hide ();
 293         } else {
 294                 peak_display.show ();
 295         }
 296 }
 297
 298 void
 299 GainMeterBase::set_gain_astate (AutoState as)
 300 {
 301         if (gain_astate_propagate) {
 302                 gain_astate_propagate = false;
 303                 ChangeGainAutomationState (as);
 304                 return;
 305         }
 306         if (_amp) {
 307                 _amp->set_parameter_automation_state (Evoral::Parameter (GainAutomation), as);
 308         } else if (_control) {
 309                 _control->set_automation_state (as);
 310                 _session->set_dirty ();
 311         }
 312 }
 313
 314 void
 315 GainMeterBase::setup_gain_adjustment ()
 316 {
 317         if (!_amp) {
 318                 return;
 319         }
 320
 321         if (_previous_amp_output_streams == _amp->output_streams ()) {
 322                 return;
 323         }
 324
 325         ignore_toggle = true;
 326
 327         if (_amp->output_streams().n_midi() <=  _amp->output_streams().n_audio()) {
 328                 _data_type = DataType::AUDIO;
 329                 gain_adjustment.set_lower (GAIN_COEFF_ZERO);
 330                 gain_adjustment.set_upper (GAIN_COEFF_UNITY);
 331                 gain_adjustment.set_step_increment (dB_coeff_step(Config->get_max_gain()) / 10.0);
 332                 gain_adjustment.set_page_increment (dB_coeff_step(Config->get_max_gain()));
 333                 gain_slider->set_default_value (gain_to_slider_position_with_max (GAIN_COEFF_UNITY, Config->get_max_gain()));
 334         } else {
 335                 _data_type = DataType::MIDI;
 336                 gain_adjustment.set_lower (0.0);
 337                 gain_adjustment.set_upper (2.0);
 338                 gain_adjustment.set_step_increment (1.0/128.0);
 339                 gain_adjustment.set_page_increment (10.0/128.0);
 340                 gain_slider->set_default_value (1.0);
 341         }
 342
 343         ignore_toggle = false;
 344
 345         effective_gain_display ();
 346
 347         _previous_amp_output_streams = _amp->output_streams ();
 348 }
 349
 350 void
 351 GainMeterBase::hide_all_meters ()
 352 {
 353         level_meter->hide_meters();
 354 }
 355
 356 void
 357 GainMeter::hide_all_meters ()
 358 {
 359         GainMeterBase::hide_all_meters ();
 360 }
 361
 362 void
 363 GainMeterBase::setup_meters (int len)
 364 {
 365         int meter_width = 5;
 366         uint32_t meter_channels = 0;
 367         if (_meter) {
 368                 meter_channels = _meter->input_streams().n_total();
 369         } else if (_route) {
 370                 meter_channels = _route->shared_peak_meter()->input_streams().n_total();
 371         }
 372
 373         switch (_width) {
 374                 case Wide:
 375                         //meter_ticks1_area.show();
 376                         //meter_ticks2_area.show();
 377                         meter_metric_area.show();
 378                         if (meter_channels == 1) {
 379                                 meter_width = 10;
 380                         }
 381                         break;
 382                 case Narrow:
 383                         if (meter_channels > 1) {
 384                                 meter_width = 4;
 385                         }
 386                         //meter_ticks1_area.hide();
 387                         //meter_ticks2_area.hide();
 388                         meter_metric_area.hide();
 389                         break;
 390         }
 391         level_meter->setup_meters(len, meter_width);
 392 }
 393
 394 void
 395 GainMeter::setup_meters (int len)
 396 {
 397         switch (_width) {
 398                 case Wide:
 399                         {
 400                                 uint32_t meter_channels = 0;
 401                                 if (_meter) {
 402                                         meter_channels = _meter->input_streams().n_total();
 403                                 } else if (_route) {
 404                                         meter_channels = _route->shared_peak_meter()->input_streams().n_total();
 405                                 }
 406                                 hbox.set_homogeneous(meter_channels < 7 ? true : false);
 407                         }
 408                         break;
 409                 case Narrow:
 410                         hbox.set_homogeneous(false);
 411                         break;
 412         }
 413         GainMeterBase::setup_meters (len);
 414 }
 415
 416 bool
 417 GainMeterBase::gain_key_press (GdkEventKey* ev)
 418 {
 419         if (ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (ev->keyval)) {
 420                 /* drop through to normal handling */
 421                 return false;
 422         }
 423         /* illegal key for gain entry */
 424         return true;
 425 }
 426
 427 bool
 428 GainMeterBase::peak_button_press (GdkEventButton* ev)
 429 {
 430         return true;
 431 }
 432
 433 bool
 434 GainMeterBase::peak_button_release (GdkEventButton* ev)
 435 {
 436         /* reset peak label */
 437
 438         if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier|Keyboard::TertiaryModifier)) {
 439                 ResetAllPeakDisplays ();
 440         } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 441                 if (_route) {
 442                         ResetGroupPeakDisplays (_route->route_group());
 443                 }
 444         } else {
 445                 ResetRoutePeakDisplays (_route.get());
 446         }
 447
 448         return true;
 449 }
 450
 451 void
 452 GainMeterBase::reset_peak_display ()
 453 {
 454         if (!_route) {
 455                 // catch "reset all" for VCAs
 456                 return;
 457         }
 458         _meter->reset_max();
 459         level_meter->clear_meters();
 460         max_peak = minus_infinity ();
 461         peak_display.set_text (_("-inf"));
 462         peak_display.set_name ("MixerStripPeakDisplay");
 463 }
 464
 465 void
 466 GainMeterBase::reset_route_peak_display (Route* route)
 467 {
 468         if (_route && _route.get() == route) {
 469                 reset_peak_display ();
 470         }
 471 }
 472
 473 void
 474 GainMeterBase::reset_group_peak_display (RouteGroup* group)
 475 {
 476         if (_route && group == _route->route_group()) {
 477                 reset_peak_display ();
 478         }
 479 }
 480
 481 void
 482 GainMeterBase::popup_meter_menu (GdkEventButton *ev)
 483 {
 484         using namespace Menu_Helpers;
 485
 486         if (meter_menu == 0) {
 487                 meter_menu = new Gtk::Menu;
 488                 MenuList& items = meter_menu->items();
 489
 490                 items.push_back (MenuElem ("-inf .. +0dBFS"));
 491                 items.push_back (MenuElem ("-10dB .. +0dBFS"));
 492                 items.push_back (MenuElem ("-4 .. +0dBFS"));
 493                 items.push_back (SeparatorElem());
 494                 items.push_back (MenuElem ("-inf .. -2dBFS"));
 495                 items.push_back (MenuElem ("-10dB .. -2dBFS"));
 496                 items.push_back (MenuElem ("-4 .. -2dBFS"));
 497         }
 498
 499         meter_menu->popup (1, ev->time);
 500 }
 501
 502 bool
 503 GainMeterBase::gain_focused (GdkEventFocus* ev)
 504 {
 505         if (ev->in) {
 506                 gain_display.select_region (0, -1);
 507         } else {
 508                 gain_display.select_region (0, 0);
 509         }
 510         return false;
 511 }
 512
 513 void
 514 GainMeterBase::gain_activated ()
 515 {
 516         float f;
 517
 518         // Use the user's preferred locale/LC_NUMERIC setting
 519         if (sscanf (gain_display.get_text().c_str(), "%f", &f) != 1) {
 520                 return;
 521         }
 522
 523         /* clamp to displayable values */
 524         if (_data_type == DataType::AUDIO) {
 525                 f = min (f, 6.0f);
 526                 _control->set_value (dB_to_coefficient(f), Controllable::UseGroup);
 527         } else {
 528                 f = min (fabs (f), 2.0f);
 529                 _control->set_value (f, Controllable::UseGroup);
 530         }
 531
 532         if (gain_display.has_focus()) {
 533                 Gtk::Widget* w = gain_display.get_toplevel();
 534                 if (w) {
 535                         Gtk::Window* win = dynamic_cast<Gtk::Window*> (w);
 536
 537                         /* sigh. gtkmm doesn't wrap get_default_widget() */
 538
 539                         if (win) {
 540                                 GtkWidget* f = gtk_window_get_default_widget (win->gobj());
 541                                 if (f) {
 542                                         gtk_widget_grab_focus (f);
 543                                         return;
 544                                 }
 545                         }
 546                 }
 547         }
 548 }
 549
 550 void
 551 GainMeterBase::show_gain ()
 552 {
 553         char buf[32];
 554
 555         float v = gain_adjustment.get_value();
 556
 557         switch (_data_type) {
 558         case DataType::AUDIO:
 559                 if (v == 0.0) {
 560                         strcpy (buf, _("-inf"));
 561                 } else {
 562                         snprintf (buf, sizeof (buf), "%.1f", accurate_coefficient_to_dB (slider_position_to_gain_with_max (v, Config->get_max_gain())));
 563                 }
 564                 break;
 565         case DataType::MIDI:
 566                 snprintf (buf, sizeof (buf), "%.1f", v);
 567                 break;
 568         }
 569
 570         gain_display.set_text (buf);
 571 }
 572
 573 void
 574 GainMeterBase::fader_moved ()
 575 {
 576         if (!ignore_toggle) {
 577
 578                 gain_t value;
 579
 580                 /* convert from adjustment range (0..1) to gain coefficient */
 581
 582                 if (_data_type == DataType::AUDIO) {
 583                         value = slider_position_to_gain_with_max (gain_adjustment.get_value(), Config->get_max_gain());
 584                 } else {
 585                         value = gain_adjustment.get_value();
 586                 }
 587
 588                 // XXX hack allow to override group
 589                 // (this breaks group'ed  shift+click reset)
 590                 if (Keyboard::the_keyboard().key_is_down (GDK_Shift_R)
 591                                 || Keyboard::the_keyboard().key_is_down (GDK_Shift_L)) {
 592                         _control->set_value (value, Controllable::InverseGroup);
 593                 } else {
 594                         _control->set_value (value, Controllable::UseGroup);
 595                 }
 596         }
 597
 598         show_gain ();
 599 }
 600
 601 void
 602 GainMeterBase::effective_gain_display ()
 603 {
 604         gain_t fader_position = 0;
 605
 606         switch (_data_type) {
 607         case DataType::AUDIO:
 608                 /* the position of the fader should reflect any master gain,
 609                  * not just the control's own inherent value
 610                  */
 611                 fader_position = gain_to_slider_position_with_max (_control->get_value(), Config->get_max_gain());
 612                 break;
 613         case DataType::MIDI:
 614                 fader_position = _control->get_value ();
 615                 break;
 616         }
 617
 618         if (gain_adjustment.get_value() != fader_position) {
 619                 ignore_toggle = true;
 620                 gain_adjustment.set_value (fader_position);
 621                 ignore_toggle = false;
 622         }
 623 }
 624
 625 void
 626 GainMeterBase::gain_changed ()
 627 {
 628         ENSURE_GUI_THREAD (*this, &GainMeterBase::gain_automation_state_changed);
 629         effective_gain_display ();
 630 }
 631
 632 void
 633 GainMeterBase::set_meter_strip_name (const char * name)
 634 {
 635         char tmp[256];
 636         meter_metric_area.set_name (name);
 637         sprintf(tmp, "Mark%sLeft", name);
 638         meter_ticks1_area.set_name (tmp);
 639         sprintf(tmp, "Mark%sRight", name);
 640         meter_ticks2_area.set_name (tmp);
 641 }
 642
 643 void
 644 GainMeterBase::set_fader_name (const char * name)
 645 {
 646         gain_slider->set_name (name);
 647 }
 648
 649 void
 650 GainMeterBase::update_gain_sensitive ()
 651 {
 652         bool x = !(_control->alist()->automation_state() & Play);
 653         static_cast<ArdourWidgets::SliderController*>(gain_slider)->set_sensitive (x);
 654 }
 655
 656 gint
 657 GainMeterBase::meter_press(GdkEventButton* ev)
 658 {
 659         if (!_route) {
 660                 return false;
 661         }
 662         if (!ignore_toggle) {
 663                 switch (ev->button) {
 664                         case 1:
 665                                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
 666
 667                                         /* Primary+Tertiary-click applies change to all routes */
 668
 669                                         meter_point_change_target = MeterPointChangeAll;
 670
 671                                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 672
 673                                         /* Primary-click: apply change to all routes in group */
 674
 675                                         meter_point_change_target = MeterPointChangeGroup;
 676
 677                                 } else {
 678
 679                                         /* click: change just this route */
 680
 681                                         meter_point_change_target = MeterPointChangeSingle;
 682                                 }
 683                                 Gtkmm2ext::anchored_menu_popup(&meter_point_menu,
 684                                                                &meter_point_button,
 685                                                                "", 1, ev->time);
 686                                 break;
 687                         default:
 688                                 break;
 689                 }
 690         }
 691         return true;
 692 }
 693
 694 void
 695 GainMeterBase::set_meter_point (Route& route, MeterPoint mp)
 696 {
 697         route.set_meter_point (mp);
 698 }
 699
 700 void
 701 GainMeterBase::set_route_group_meter_point (Route& route, MeterPoint mp)
 702 {
 703         RouteGroup* route_group;
 704
 705         if ((route_group = route.route_group ()) != 0) {
 706                 route_group->foreach_route (boost::bind (&Route::set_meter_point, _1, mp, false));
 707         } else {
 708                 route.set_meter_point (mp);
 709         }
 710 }
 711
 712 void
 713 GainMeterBase::meter_point_clicked (MeterPoint mp)
 714 {
 715         if (_route) {
 716                 switch (meter_point_change_target) {
 717                         case MeterPointChangeAll:
 718                                 _session->foreach_route (this, &GainMeterBase::set_meter_point, mp);
 719                                 break;
 720                         case MeterPointChangeGroup:
 721                                 set_route_group_meter_point (*_route, mp);
 722                                 break;
 723                         case MeterPointChangeSingle:
 724                                 _route->set_meter_point (mp);
 725                                 break;
 726                 }
 727         }
 728 }
 729
 730 void
 731 GainMeterBase::amp_start_touch ()
 732 {
 733         _control->start_touch (_control->session().transport_sample());
 734 }
 735
 736 void
 737 GainMeterBase::amp_stop_touch ()
 738 {
 739         _control->stop_touch (_control->session().transport_sample());
 740         effective_gain_display ();
 741 }
 742
 743 gint
 744 GainMeterBase::gain_automation_state_button_event (GdkEventButton *ev)
 745 {
 746         if (ev->type == GDK_BUTTON_RELEASE) {
 747                 return TRUE;
 748         }
 749
 750         switch (ev->button) {
 751                 case 1:
 752                         gain_astate_propagate = Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier | Keyboard::TertiaryModifier));
 753                         Gtkmm2ext::anchored_menu_popup(&gain_astate_menu,
 754                                                        &gain_automation_state_button,
 755                                                        "", 1, ev->time);
 756                         break;
 757                 default:
 758                         break;
 759         }
 760
 761         return TRUE;
 762 }
 763
 764
 765 string
 766 GainMeterBase::astate_string (AutoState state)
 767 {
 768         return _astate_string (state, false);
 769 }
 770
 771 string
 772 GainMeterBase::short_astate_string (AutoState state)
 773 {
 774         return _astate_string (state, true);
 775 }
 776
 777 string
 778 GainMeterBase::_astate_string (AutoState state, bool shrt)
 779 {
 780         string sstr;
 781
 782         switch (state) {
 783         case ARDOUR::Off:
 784                 sstr = (shrt ? "M" : S_("Manual|M"));
 785                 break;
 786         case Play:
 787                 sstr = (shrt ? "P" : S_("Play|P"));
 788                 break;
 789         case Touch:
 790                 sstr = (shrt ? "T" : S_("Trim|T"));
 791                 break;
 792         case Latch:
 793                 sstr = (shrt ? "L" : S_("Latch|L"));
 794                 break;
 795         case Write:
 796                 sstr = (shrt ? "W" : S_("Write|W"));
 797                 break;
 798         }
 799
 800         return sstr;
 801 }
 802
 803 void
 804 GainMeterBase::gain_automation_state_changed ()
 805 {
 806         ENSURE_GUI_THREAD (*this, &GainMeterBase::gain_automation_state_changed);
 807
 808         switch (_width) {
 809         case Wide:
 810                 gain_automation_state_button.set_text (astate_string(_control->alist()->automation_state()));
 811                 break;
 812         case Narrow:
 813                 gain_automation_state_button.set_text (short_astate_string(_control->alist()->automation_state()));
 814                 break;
 815         }
 816
 817         const bool automation_watch_required = (_control->alist()->automation_state() != ARDOUR::Off);
 818
 819         if (gain_automation_state_button.get_active() != automation_watch_required) {
 820                 ignore_toggle = true;
 821                 gain_automation_state_button.set_active (automation_watch_required);
 822                 ignore_toggle = false;
 823         }
 824
 825         update_gain_sensitive ();
 826
 827         gain_watching.disconnect();
 828 }
 829
 830 const ChanCount
 831 GainMeterBase::meter_channels() const
 832 {
 833                 if (_meter) { return _meter->input_streams(); }
 834                 else { return ChanCount(); }
 835 }
 836 void
 837 GainMeterBase::update_meters()
 838 {
 839         char buf[32];
 840         float mpeak = level_meter->update_meters();
 841
 842         if (mpeak > max_peak) {
 843                 max_peak = mpeak;
 844                 if (mpeak <= -200.0f) {
 845                         peak_display.set_text (_("-inf"));
 846                 } else {
 847                         snprintf (buf, sizeof(buf), "%.1f", mpeak);
 848                         peak_display.set_text (buf);
 849                 }
 850         }
 851         if (mpeak >= UIConfiguration::instance().get_meter_peak()) {
 852                 peak_display.set_name ("MixerStripPeakDisplayPeak");
 853         }
 854 }
 855
 856 void GainMeterBase::color_handler(bool /*dpi*/)
 857 {
 858         setup_meters();
 859 }
 860
 861 void
 862 GainMeterBase::set_width (Width w, int len)
 863 {
 864         _width = w;
 865         int meter_width = 5;
 866         if (_width == Wide && _route && _route->shared_peak_meter()->input_streams().n_total() == 1) {
 867                 meter_width = 10;
 868         }
 869         level_meter->setup_meters(len, meter_width);
 870 }
 871
 872
 873 void
 874 GainMeterBase::on_theme_changed()
 875 {
 876 }
 877
 878 void
 879 GainMeterBase::redraw_metrics()
 880 {
 881         meter_metric_area.queue_draw ();
 882         meter_ticks1_area.queue_draw ();
 883         meter_ticks2_area.queue_draw ();
 884 }
 885
 886 #define PX_SCALE(pxmin, dflt) rint(std::max((double)pxmin, (double)dflt * UIConfiguration::instance().get_ui_scale()))
 887
 888 GainMeter::GainMeter (Session* s, int fader_length)
 889         : GainMeterBase (s, false, fader_length, 24)
 890         , gain_display_box(true, 0)
 891         , hbox(true, 2)
 892 {
 893         if (gain_display.get_parent()) {
 894                 gain_display.get_parent()->remove (gain_display);
 895         }
 896         gain_display_box.pack_start (gain_display, true, true);
 897
 898         if (peak_display.get_parent()) {
 899                 peak_display.get_parent()->remove (gain_display);
 900         }
 901         gain_display_box.pack_start (peak_display, true, true);
 902
 903         meter_metric_area.set_name ("AudioTrackMetrics");
 904         meter_metric_area.set_size_request(PX_SCALE(24, 24), -1);
 905
 906         gain_automation_state_button.set_name ("mixer strip button");
 907
 908         set_tooltip (gain_automation_state_button, _("Fader automation mode"));
 909
 910         gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
 911
 912         gain_automation_state_button.set_size_request (PX_SCALE(12, 15), PX_SCALE(12, 15));
 913
 914         fader_vbox.set_spacing (0);
 915         fader_vbox.pack_start (*gain_slider, true, true);
 916
 917         fader_alignment.set (0.5, 0.5, 0.0, 1.0);
 918         fader_alignment.add (fader_vbox);
 919
 920         hbox.pack_start (fader_alignment, true, true);
 921
 922         set_spacing (PX_SCALE(2, 2));
 923
 924         pack_start (gain_display_box, Gtk::PACK_SHRINK);
 925         pack_start (hbox, true, true);
 926
 927         meter_alignment.set (0.5, 0.5, 0.0, 1.0);
 928         meter_alignment.add (*level_meter);
 929
 930         meter_metric_area.signal_expose_event().connect (
 931                 sigc::mem_fun(*this, &GainMeter::meter_metrics_expose));
 932
 933         meter_ticks1_area.set_size_request (PX_SCALE(3, 3), -1);
 934         meter_ticks2_area.set_size_request (PX_SCALE(3, 3), -1);
 935
 936         meter_ticks1_area.signal_expose_event().connect (
 937                         sigc::mem_fun(*this, &GainMeter::meter_ticks1_expose));
 938         meter_ticks2_area.signal_expose_event().connect (
 939                         sigc::mem_fun(*this, &GainMeter::meter_ticks2_expose));
 940
 941         meter_hbox.pack_start (meter_ticks1_area, false, false);
 942         meter_hbox.pack_start (meter_alignment, false, false);
 943         meter_hbox.pack_start (meter_ticks2_area, false, false);
 944         meter_hbox.pack_start (meter_metric_area, false, false);
 945
 946         meter_metric_area.set_no_show_all ();
 947 }
 948 #undef PX_SCALE
 949
 950 GainMeter::~GainMeter () { }
 951
 952 void
 953 GainMeter::set_controls (boost::shared_ptr<Route> r,
 954                          boost::shared_ptr<PeakMeter> meter,
 955                          boost::shared_ptr<Amp> amp,
 956                          boost::shared_ptr<GainControl> control)
 957 {
 958         if (meter_hbox.get_parent()) {
 959                 hbox.remove (meter_hbox);
 960         }
 961
 962 //      if (gain_automation_state_button.get_parent()) {
 963 //              fader_vbox->remove (gain_automation_state_button);
 964 //      }
 965
 966         GainMeterBase::set_controls (r, meter, amp, control);
 967
 968         if (_meter) {
 969                 _meter->ConfigurationChanged.connect (
 970                         model_connections, invalidator (*this), boost::bind (&GainMeter::meter_configuration_changed, this, _1), gui_context()
 971                         );
 972                 _meter->MeterTypeChanged.connect (
 973                         model_connections, invalidator (*this), boost::bind (&GainMeter::redraw_metrics, this), gui_context()
 974                         );
 975
 976                 meter_configuration_changed (_meter->input_streams ());
 977         }
 978
 979
 980         if (_route) {
 981                 _route->active_changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeter::route_active_changed, this), gui_context ());
 982                 hbox.pack_start (meter_hbox, true, true);
 983                 meter_hbox.show ();
 984         }
 985
 986 //      if (r && !r->is_auditioner()) {
 987 //              fader_vbox->pack_start (gain_automation_state_button, false, false, 0);
 988 //      }
 989
 990         gain_display_box.show ();
 991         gain_display.show ();
 992         gain_slider->show ();
 993         fader_vbox.show ();
 994         fader_alignment.show ();
 995         hbox.show ();
 996         setup_meters ();
 997 }
 998
 999 int
1000 GainMeter::get_gm_width ()
1001 {
1002         Gtk::Requisition sz;
1003         int min_w = 0;
1004         sz.width = 0;
1005         meter_metric_area.size_request (sz);
1006         min_w += sz.width;
1007         level_meter->size_request (sz);
1008         min_w += sz.width;
1009
1010         fader_alignment.size_request (sz);
1011         if (_width == Wide)
1012                 return max(sz.width * 2, min_w * 2) + 6;
1013         else
1014                 return sz.width + min_w + 6;
1015
1016 }
1017
1018 gint
1019 GainMeter::meter_metrics_expose (GdkEventExpose *ev)
1020 {
1021         if (!_route) {
1022                 if (_types.empty()) { _types.push_back(DataType::AUDIO); }
1023                 return meter_expose_metrics(ev, MeterPeak, _types, &meter_metric_area);
1024         }
1025         return meter_expose_metrics(ev, _route->meter_type(), _types, &meter_metric_area);
1026 }
1027
1028 gint
1029 GainMeter::meter_ticks1_expose (GdkEventExpose *ev)
1030 {
1031         if (!_route) {
1032                 if (_types.empty()) { _types.push_back(DataType::AUDIO); }
1033                 return meter_expose_ticks(ev, MeterPeak, _types, &meter_ticks1_area);
1034         }
1035         return meter_expose_ticks(ev, _route->meter_type(), _types, &meter_ticks1_area);
1036 }
1037
1038 gint
1039 GainMeter::meter_ticks2_expose (GdkEventExpose *ev)
1040 {
1041         if (!_route) {
1042                 if (_types.empty()) { _types.push_back(DataType::AUDIO); }
1043                 return meter_expose_ticks(ev, MeterPeak, _types, &meter_ticks2_area);
1044         }
1045         return meter_expose_ticks(ev, _route->meter_type(), _types, &meter_ticks2_area);
1046 }
1047
1048 void
1049 GainMeter::on_style_changed (const Glib::RefPtr<Gtk::Style>&)
1050 {
1051         gain_display.queue_draw();
1052         peak_display.queue_draw();
1053 }
1054
1055 boost::shared_ptr<PBD::Controllable>
1056 GainMeterBase::get_controllable()
1057 {
1058         if (_amp) {
1059                 return _control;
1060         } else {
1061                 return boost::shared_ptr<PBD::Controllable>();
1062         }
1063 }
1064
1065 bool
1066 GainMeterBase::level_meter_button_press (GdkEventButton* ev)
1067 {
1068         return static_cast<bool>(LevelMeterButtonPress (ev)); /* EMIT SIGNAL */
1069 }
1070
1071 void
1072 GainMeter::meter_configuration_changed (ChanCount c)
1073 {
1074         int type = 0;
1075         _types.clear ();
1076
1077         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1078                 if (c.get (*i) > 0) {
1079                         _types.push_back (*i);
1080                         type |= 1 << (*i);
1081                 }
1082         }
1083
1084         if (_route
1085                         && boost::dynamic_pointer_cast<AudioTrack>(_route) == 0
1086                         && boost::dynamic_pointer_cast<MidiTrack>(_route) == 0
1087                         ) {
1088                 if (_route->active()) {
1089                         set_meter_strip_name ("AudioBusMetrics");
1090                 } else {
1091                         set_meter_strip_name ("AudioBusMetricsInactive");
1092                 }
1093         }
1094         else if (
1095                            (type == (1 << DataType::MIDI))
1096                         || (_route && boost::dynamic_pointer_cast<MidiTrack>(_route))
1097                         ) {
1098                 if (!_route || _route->active()) {
1099                         set_meter_strip_name ("MidiTrackMetrics");
1100                 } else {
1101                         set_meter_strip_name ("MidiTrackMetricsInactive");
1102                 }
1103         }
1104         else if (type == (1 << DataType::AUDIO)) {
1105                 if (!_route || _route->active()) {
1106                         set_meter_strip_name ("AudioTrackMetrics");
1107                 } else {
1108                         set_meter_strip_name ("AudioTrackMetricsInactive");
1109                 }
1110         } else {
1111                 if (!_route || _route->active()) {
1112                         set_meter_strip_name ("AudioMidiTrackMetrics");
1113                 } else {
1114                         set_meter_strip_name ("AudioMidiTrackMetricsInactive");
1115                 }
1116         }
1117
1118         setup_meters();
1119         meter_clear_pattern_cache(4);
1120         on_style_changed(Glib::RefPtr<Gtk::Style>());
1121 }
1122
1123 void
1124 GainMeter::route_active_changed ()
1125 {
1126         if (_meter) {
1127                 meter_configuration_changed (_meter->input_streams ());
1128         }
1129 }
1130
1131 void
1132 GainMeter::redraw_metrics ()
1133 {
1134         GainMeterBase::redraw_metrics ();
1135 }