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