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