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::NoGroup);
 483         } else {
 484                 f = min (fabs (f), 2.0f);
 485                 _control->set_value (f, Controllable::NoGroup);
 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                 if (_route && _control == _route->gain_control()) {
 545                         _route->set_gain (value, Controllable::UseGroup);
 546                 } else {
 547                         _control->set_value (value, Controllable::NoGroup);
 548                 }
 549         }
 550
 551         show_gain ();
 552 }
 553
 554 void
 555 GainMeterBase::effective_gain_display ()
 556 {
 557         gain_t fader_position = 0;
 558
 559         switch (_data_type) {
 560         case DataType::AUDIO:
 561                 /* the position of the fader should reflect any master gain,
 562                  * not just the control's own inherent value
 563                  */
 564                 fader_position = gain_to_slider_position_with_max (_control->get_value(), Config->get_max_gain());
 565                 break;
 566         case DataType::MIDI:
 567                 fader_position = _control->get_value ();
 568                 break;
 569         }
 570
 571         if (gain_adjustment.get_value() != fader_position) {
 572                 ignore_toggle = true;
 573                 gain_adjustment.set_value (fader_position);
 574                 ignore_toggle = false;
 575         }
 576 }
 577
 578 void
 579 GainMeterBase::gain_changed ()
 580 {
 581         Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&GainMeterBase::effective_gain_display, this));
 582 }
 583
 584 void
 585 GainMeterBase::set_meter_strip_name (const char * name)
 586 {
 587         char tmp[256];
 588         meter_metric_area.set_name (name);
 589         sprintf(tmp, "Mark%sLeft", name);
 590         meter_ticks1_area.set_name (tmp);
 591         sprintf(tmp, "Mark%sRight", name);
 592         meter_ticks2_area.set_name (tmp);
 593 }
 594
 595 void
 596 GainMeterBase::set_fader_name (const char * name)
 597 {
 598         gain_slider->set_name (name);
 599 }
 600
 601 void
 602 GainMeterBase::update_gain_sensitive ()
 603 {
 604         bool x = !(_control->alist()->automation_state() & Play);
 605         static_cast<Gtkmm2ext::SliderController*>(gain_slider)->set_sensitive (x);
 606 }
 607
 608 static MeterPoint
 609 next_meter_point (MeterPoint mp)
 610 {
 611         switch (mp) {
 612         case MeterInput:
 613                 return MeterPreFader;
 614                 break;
 615
 616         case MeterPreFader:
 617                 return MeterPostFader;
 618                 break;
 619
 620         case MeterPostFader:
 621                 return MeterOutput;
 622                 break;
 623
 624         case MeterOutput:
 625                 return MeterCustom;
 626                 break;
 627
 628         case MeterCustom:
 629                 return MeterInput;
 630                 break;
 631         }
 632
 633         abort(); /*NOTREACHED*/
 634         return MeterInput;
 635 }
 636
 637 gint
 638 GainMeterBase::meter_press(GdkEventButton* ev)
 639 {
 640         wait_for_release = false;
 641
 642         if (!_route) {
 643                 return FALSE;
 644         }
 645
 646         if (!ignore_toggle) {
 647
 648                 if (Keyboard::is_context_menu_event (ev)) {
 649
 650                         // no menu at this time.
 651
 652                 } else {
 653
 654                         if (Keyboard::is_button2_event(ev)) {
 655
 656                                 // Primary-button2 click is the midi binding click
 657                                 // button2-click is "momentary"
 658
 659                                 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier))) {
 660                                         wait_for_release = true;
 661                                         old_meter_point = _route->meter_point ();
 662                                 }
 663                         }
 664
 665                         if (_route && (ev->button == 1 || Keyboard::is_button2_event (ev))) {
 666
 667                                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
 668
 669                                         /* Primary+Tertiary-click applies change to all routes */
 670
 671                                         _session->foreach_route (this, &GainMeterBase::set_meter_point, next_meter_point (_route->meter_point()));
 672
 673
 674                                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 675
 676                                         /* Primary-click: solo mix group.
 677                                            NOTE: Primary-button2 is MIDI learn.
 678                                         */
 679
 680                                         if (ev->button == 1) {
 681                                                 set_route_group_meter_point (*_route, next_meter_point (_route->meter_point()));
 682                                         }
 683
 684                                 } else {
 685
 686                                         /* click: change just this route */
 687
 688                                         // XXX no undo yet
 689
 690                                         _route->set_meter_point (next_meter_point (_route->meter_point()));
 691                                 }
 692                         }
 693                 }
 694         }
 695
 696         return true;
 697
 698 }
 699
 700 gint
 701 GainMeterBase::meter_release(GdkEventButton*)
 702 {
 703         if (!ignore_toggle) {
 704                 if (wait_for_release) {
 705                         wait_for_release = false;
 706
 707                         if (_route) {
 708                                 set_meter_point (*_route, old_meter_point);
 709                         }
 710                 }
 711         }
 712
 713         return true;
 714 }
 715
 716 void
 717 GainMeterBase::set_meter_point (Route& route, MeterPoint mp)
 718 {
 719         route.set_meter_point (mp);
 720 }
 721
 722 void
 723 GainMeterBase::set_route_group_meter_point (Route& route, MeterPoint mp)
 724 {
 725         RouteGroup* route_group;
 726
 727         if ((route_group = route.route_group ()) != 0) {
 728                 route_group->foreach_route (boost::bind (&Route::set_meter_point, _1, mp, false));
 729         } else {
 730                 route.set_meter_point (mp);
 731         }
 732 }
 733
 734 void
 735 GainMeterBase::meter_point_clicked ()
 736 {
 737         if (_route) {
 738                 /* WHAT? */
 739         }
 740 }
 741
 742 void
 743 GainMeterBase::amp_start_touch ()
 744 {
 745         _control->start_touch (_control->session().transport_frame());
 746 }
 747
 748 void
 749 GainMeterBase::amp_stop_touch ()
 750 {
 751         _control->stop_touch (false, _control->session().transport_frame());
 752 }
 753
 754 gint
 755 GainMeterBase::gain_automation_state_button_event (GdkEventButton *ev)
 756 {
 757         if (ev->type == GDK_BUTTON_RELEASE) {
 758                 return TRUE;
 759         }
 760
 761         switch (ev->button) {
 762                 case 1:
 763                         gain_astate_menu.popup (1, ev->time);
 764                         break;
 765                 default:
 766                         break;
 767         }
 768
 769         return TRUE;
 770 }
 771
 772 gint
 773 GainMeterBase::gain_automation_style_button_event (GdkEventButton *ev)
 774 {
 775         if (ev->type == GDK_BUTTON_RELEASE) {
 776                 return TRUE;
 777         }
 778
 779         switch (ev->button) {
 780         case 1:
 781                 gain_astyle_menu.popup (1, ev->time);
 782                 break;
 783         default:
 784                 break;
 785         }
 786         return TRUE;
 787 }
 788
 789 string
 790 GainMeterBase::astate_string (AutoState state)
 791 {
 792         return _astate_string (state, false);
 793 }
 794
 795 string
 796 GainMeterBase::short_astate_string (AutoState state)
 797 {
 798         return _astate_string (state, true);
 799 }
 800
 801 string
 802 GainMeterBase::_astate_string (AutoState state, bool shrt)
 803 {
 804         string sstr;
 805
 806         switch (state) {
 807         case ARDOUR::Off:
 808                 sstr = (shrt ? "M" : _("M"));
 809                 break;
 810         case Play:
 811                 sstr = (shrt ? "P" : _("P"));
 812                 break;
 813         case Touch:
 814                 sstr = (shrt ? "T" : _("T"));
 815                 break;
 816         case Write:
 817                 sstr = (shrt ? "W" : _("W"));
 818                 break;
 819         }
 820
 821         return sstr;
 822 }
 823
 824 string
 825 GainMeterBase::astyle_string (AutoStyle style)
 826 {
 827         return _astyle_string (style, false);
 828 }
 829
 830 string
 831 GainMeterBase::short_astyle_string (AutoStyle style)
 832 {
 833         return _astyle_string (style, true);
 834 }
 835
 836 string
 837 GainMeterBase::_astyle_string (AutoStyle style, bool shrt)
 838 {
 839         if (style & Trim) {
 840                 return _("Trim");
 841         } else {
 842                 /* XXX it might different in different languages */
 843
 844                 return (shrt ? _("Abs") : _("Abs"));
 845         }
 846 }
 847
 848 void
 849 GainMeterBase::gain_automation_style_changed ()
 850 {
 851         switch (_width) {
 852         case Wide:
 853                 gain_automation_style_button.set_text (astyle_string(_control->alist()->automation_style()));
 854                 break;
 855         case Narrow:
 856                 gain_automation_style_button.set_text  (short_astyle_string(_control->alist()->automation_style()));
 857                 break;
 858         }
 859 }
 860
 861 void
 862 GainMeterBase::gain_automation_state_changed ()
 863 {
 864         ENSURE_GUI_THREAD (*this, &GainMeterBase::gain_automation_state_changed);
 865
 866         switch (_width) {
 867         case Wide:
 868                 gain_automation_state_button.set_text (astate_string(_control->alist()->automation_state()));
 869                 break;
 870         case Narrow:
 871                 gain_automation_state_button.set_text (short_astate_string(_control->alist()->automation_state()));
 872                 break;
 873         }
 874
 875         const bool automation_watch_required = (_control->alist()->automation_state() != ARDOUR::Off);
 876
 877         if (gain_automation_state_button.get_active() != automation_watch_required) {
 878                 ignore_toggle = true;
 879                 gain_automation_state_button.set_active (automation_watch_required);
 880                 ignore_toggle = false;
 881         }
 882
 883         update_gain_sensitive ();
 884
 885         gain_watching.disconnect();
 886
 887         if (automation_watch_required) {
 888                 /* start watching automation so that things move */
 889                 gain_watching = Timers::rapid_connect (sigc::mem_fun (*this, &GainMeterBase::effective_gain_display));
 890         } else {
 891                 /* update once to get the correct value shown as we re-enter off/manual mode */
 892                 effective_gain_display();
 893         }
 894 }
 895
 896 const ChanCount
 897 GainMeterBase::meter_channels() const
 898 {
 899                 if (_meter) { return _meter->input_streams(); }
 900                 else { return ChanCount(); }
 901 }
 902 void
 903 GainMeterBase::update_meters()
 904 {
 905         char buf[32];
 906         float mpeak = level_meter->update_meters();
 907
 908         if (mpeak > max_peak) {
 909                 max_peak = mpeak;
 910                 if (mpeak <= -200.0f) {
 911                         peak_display.set_text (_("-inf"));
 912                 } else {
 913                         snprintf (buf, sizeof(buf), "%.1f", mpeak);
 914                         peak_display.set_text (buf);
 915                 }
 916         }
 917         if (mpeak >= UIConfiguration::instance().get_meter_peak()) {
 918                 peak_display.set_name ("MixerStripPeakDisplayPeak");
 919         }
 920 }
 921
 922 void GainMeterBase::color_handler(bool /*dpi*/)
 923 {
 924         setup_meters();
 925 }
 926
 927 void
 928 GainMeterBase::set_width (Width w, int len)
 929 {
 930         _width = w;
 931         int meter_width = 5;
 932         if (_width == Wide && _route && _route->shared_peak_meter()->input_streams().n_total() == 1) {
 933                 meter_width = 10;
 934         }
 935         level_meter->setup_meters(len, meter_width);
 936 }
 937
 938
 939 void
 940 GainMeterBase::on_theme_changed()
 941 {
 942 }
 943
 944 void
 945 GainMeterBase::redraw_metrics()
 946 {
 947         meter_metric_area.queue_draw ();
 948         meter_ticks1_area.queue_draw ();
 949         meter_ticks2_area.queue_draw ();
 950 }
 951
 952 #define PX_SCALE(pxmin, dflt) rint(std::max((double)pxmin, (double)dflt * UIConfiguration::instance().get_ui_scale()))
 953
 954 GainMeter::GainMeter (Session* s, int fader_length)
 955         : GainMeterBase (s, false, fader_length, 24)
 956         , gain_display_box(true, 0)
 957         , hbox(true, 2)
 958 {
 959         if (gain_display.get_parent()) {
 960                 gain_display.get_parent()->remove (gain_display);
 961         }
 962         gain_display_box.pack_start (gain_display, true, true);
 963
 964         if (peak_display.get_parent()) {
 965                 peak_display.get_parent()->remove (gain_display);
 966         }
 967         gain_display_box.pack_start (peak_display, true, true);
 968
 969         meter_metric_area.set_name ("AudioTrackMetrics");
 970         meter_metric_area.set_size_request(PX_SCALE(24, 24), -1);
 971
 972         gain_automation_style_button.set_name ("mixer strip button");
 973         gain_automation_state_button.set_name ("mixer strip button");
 974
 975         set_tooltip (gain_automation_state_button, _("Fader automation mode"));
 976         set_tooltip (gain_automation_style_button, _("Fader automation type"));
 977
 978         gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
 979         gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
 980
 981         gain_automation_state_button.set_size_request (PX_SCALE(12, 15), PX_SCALE(12, 15));
 982         gain_automation_style_button.set_size_request (PX_SCALE(12, 15), PX_SCALE(12, 15));
 983
 984         fader_vbox.set_spacing (0);
 985         fader_vbox.pack_start (*gain_slider, true, true);
 986
 987         fader_alignment.set (0.5, 0.5, 0.0, 1.0);
 988         fader_alignment.add (fader_vbox);
 989
 990         hbox.pack_start (fader_alignment, true, true);
 991
 992         set_spacing (PX_SCALE(2, 2));
 993
 994         pack_start (gain_display_box, Gtk::PACK_SHRINK);
 995         pack_start (hbox, true, true);
 996
 997         meter_alignment.set (0.5, 0.5, 0.0, 1.0);
 998         meter_alignment.add (*level_meter);
 999
1000         meter_metric_area.signal_expose_event().connect (
1001                 sigc::mem_fun(*this, &GainMeter::meter_metrics_expose));
1002
1003         meter_ticks1_area.set_size_request (PX_SCALE(3, 3), -1);
1004         meter_ticks2_area.set_size_request (PX_SCALE(3, 3), -1);
1005
1006         meter_ticks1_area.signal_expose_event().connect (
1007                         sigc::mem_fun(*this, &GainMeter::meter_ticks1_expose));
1008         meter_ticks2_area.signal_expose_event().connect (
1009                         sigc::mem_fun(*this, &GainMeter::meter_ticks2_expose));
1010
1011         meter_hbox.pack_start (meter_ticks1_area, false, false);
1012         meter_hbox.pack_start (meter_alignment, false, false);
1013         meter_hbox.pack_start (meter_ticks2_area, false, false);
1014         meter_hbox.pack_start (meter_metric_area, false, false);
1015 }
1016 #undef PX_SCALE
1017
1018 GainMeter::~GainMeter () { }
1019
1020 void
1021 GainMeter::set_controls (boost::shared_ptr<Route> r,
1022                          boost::shared_ptr<PeakMeter> meter,
1023                          boost::shared_ptr<Amp> amp,
1024                          boost::shared_ptr<GainControl> control)
1025 {
1026         if (meter_hbox.get_parent()) {
1027                 hbox.remove (meter_hbox);
1028         }
1029
1030 //      if (gain_automation_state_button.get_parent()) {
1031 //              fader_vbox->remove (gain_automation_state_button);
1032 //      }
1033
1034         GainMeterBase::set_controls (r, meter, amp, control);
1035
1036         if (_meter) {
1037                 _meter->ConfigurationChanged.connect (
1038                         model_connections, invalidator (*this), boost::bind (&GainMeter::meter_configuration_changed, this, _1), gui_context()
1039                         );
1040                 _meter->TypeChanged.connect (
1041                         model_connections, invalidator (*this), boost::bind (&GainMeter::meter_type_changed, this, _1), gui_context()
1042                         );
1043
1044                 meter_configuration_changed (_meter->input_streams ());
1045         }
1046
1047
1048         if (_route) {
1049                 _route->active_changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeter::route_active_changed, this), gui_context ());
1050                 hbox.pack_start (meter_hbox, true, true);
1051                 meter_hbox.show ();
1052         }
1053
1054 //      if (r && !r->is_auditioner()) {
1055 //              fader_vbox->pack_start (gain_automation_state_button, false, false, 0);
1056 //      }
1057
1058         gain_display_box.show ();
1059         gain_display.show ();
1060         gain_slider->show ();
1061         fader_vbox.show ();
1062         fader_alignment.show ();
1063         hbox.show ();
1064         setup_meters ();
1065 }
1066
1067 int
1068 GainMeter::get_gm_width ()
1069 {
1070         Gtk::Requisition sz;
1071         int min_w = 0;
1072         sz.width = 0;
1073         meter_metric_area.size_request (sz);
1074         min_w += sz.width;
1075         level_meter->size_request (sz);
1076         min_w += sz.width;
1077
1078         fader_alignment.size_request (sz);
1079         if (_width == Wide)
1080                 return max(sz.width * 2, min_w * 2) + 6;
1081         else
1082                 return sz.width + min_w + 6;
1083
1084 }
1085
1086 gint
1087 GainMeter::meter_metrics_expose (GdkEventExpose *ev)
1088 {
1089         if (!_route) {
1090                 if (_types.empty()) { _types.push_back(DataType::AUDIO); }
1091                 return meter_expose_metrics(ev, MeterPeak, _types, &meter_metric_area);
1092         }
1093         return meter_expose_metrics(ev, _route->meter_type(), _types, &meter_metric_area);
1094 }
1095
1096 gint
1097 GainMeter::meter_ticks1_expose (GdkEventExpose *ev)
1098 {
1099         if (!_route) {
1100                 if (_types.empty()) { _types.push_back(DataType::AUDIO); }
1101                 return meter_expose_ticks(ev, MeterPeak, _types, &meter_ticks1_area);
1102         }
1103         return meter_expose_ticks(ev, _route->meter_type(), _types, &meter_ticks1_area);
1104 }
1105
1106 gint
1107 GainMeter::meter_ticks2_expose (GdkEventExpose *ev)
1108 {
1109         if (!_route) {
1110                 if (_types.empty()) { _types.push_back(DataType::AUDIO); }
1111                 return meter_expose_ticks(ev, MeterPeak, _types, &meter_ticks2_area);
1112         }
1113         return meter_expose_ticks(ev, _route->meter_type(), _types, &meter_ticks2_area);
1114 }
1115
1116 void
1117 GainMeter::on_style_changed (const Glib::RefPtr<Gtk::Style>&)
1118 {
1119         gain_display.queue_draw();
1120         peak_display.queue_draw();
1121 }
1122
1123 boost::shared_ptr<PBD::Controllable>
1124 GainMeterBase::get_controllable()
1125 {
1126         if (_amp) {
1127                 return _control;
1128         } else {
1129                 return boost::shared_ptr<PBD::Controllable>();
1130         }
1131 }
1132
1133 bool
1134 GainMeterBase::level_meter_button_press (GdkEventButton* ev)
1135 {
1136         return static_cast<bool>(LevelMeterButtonPress (ev)); /* EMIT SIGNAL */
1137 }
1138
1139 void
1140 GainMeter::meter_configuration_changed (ChanCount c)
1141 {
1142         int type = 0;
1143         _types.clear ();
1144
1145         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
1146                 if (c.get (*i) > 0) {
1147                         _types.push_back (*i);
1148                         type |= 1 << (*i);
1149                 }
1150         }
1151
1152         if (_route
1153                         && boost::dynamic_pointer_cast<AudioTrack>(_route) == 0
1154                         && boost::dynamic_pointer_cast<MidiTrack>(_route) == 0
1155                         ) {
1156                 if (_route->active()) {
1157                         set_meter_strip_name ("AudioBusMetrics");
1158                 } else {
1159                         set_meter_strip_name ("AudioBusMetricsInactive");
1160                 }
1161         }
1162         else if (
1163                            (type == (1 << DataType::MIDI))
1164                         || (_route && boost::dynamic_pointer_cast<MidiTrack>(_route))
1165                         ) {
1166                 if (!_route || _route->active()) {
1167                         set_meter_strip_name ("MidiTrackMetrics");
1168                 } else {
1169                         set_meter_strip_name ("MidiTrackMetricsInactive");
1170                 }
1171         }
1172         else if (type == (1 << DataType::AUDIO)) {
1173                 if (!_route || _route->active()) {
1174                         set_meter_strip_name ("AudioTrackMetrics");
1175                 } else {
1176                         set_meter_strip_name ("AudioTrackMetricsInactive");
1177                 }
1178         } else {
1179                 if (!_route || _route->active()) {
1180                         set_meter_strip_name ("AudioMidiTrackMetrics");
1181                 } else {
1182                         set_meter_strip_name ("AudioMidiTrackMetricsInactive");
1183                 }
1184         }
1185
1186         setup_meters();
1187         meter_clear_pattern_cache(4);
1188         on_style_changed(Glib::RefPtr<Gtk::Style>());
1189 }
1190
1191 void
1192 GainMeter::route_active_changed ()
1193 {
1194         if (_meter) {
1195                 meter_configuration_changed (_meter->input_streams ());
1196         }
1197 }
1198
1199 void
1200 GainMeter::meter_type_changed (MeterType t)
1201 {
1202         _route->set_meter_type(t);
1203         RedrawMetrics();
1204 }