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