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