gtk2_ardour/gain_meter.cc

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