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