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