gtk2_ardour/gain_meter.cc

   1 /*
   2   Copyright (C) 2002 Paul Davis
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8
   9   This program is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12   GNU General Public License for more details.
  13
  14   You should have received a copy of the GNU General Public License
  15   along with this program; if not, write to the Free Software
  16   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <limits.h>
  21
  22 #include "ardour/amp.h"
  23 #include "ardour/route_group.h"
  24 #include "ardour/session_route.h"
  25 #include "ardour/dB.h"
  26 #include "ardour/utils.h"
  27
  28 #include <pangomm.h>
  29 #include <gtkmm/style.h>
  30 #include <gdkmm/color.h>
  31 #include <gtkmm2ext/utils.h>
  32 #include <gtkmm2ext/fastmeter.h>
  33 #include <gtkmm2ext/gtk_ui.h>
  34 #include "pbd/fastlog.h"
  35 #include "pbd/stacktrace.h"
  36
  37 #include "gain_meter.h"
  38 #include "logmeter.h"
  39 #include "gui_thread.h"
  40 #include "keyboard.h"
  41 #include "public_editor.h"
  42 #include "utils.h"
  43 #include "meter_patterns.h"
  44 #include "timers.h"
  45 #include "tooltips.h"
  46 #include "ui_config.h"
  47
  48 #include "ardour/session.h"
  49 #include "ardour/route.h"
  50 #include "ardour/meter.h"
  51 #include "ardour/audio_track.h"
  52 #include "ardour/midi_track.h"
  53 #include "ardour/dB.h"
  54
  55 #include "i18n.h"
  56
  57 using namespace ARDOUR;
  58 using namespace ARDOUR_UI_UTILS;
  59 using namespace PBD;
  60 using namespace Gtkmm2ext;
  61 using namespace Gtk;
  62 using namespace std;
  63 using Gtkmm2ext::Keyboard;
  64 using namespace ArdourMeter;
  65
  66 static void
  67 reset_cursor_to_default (Gtk::Entry* widget)
  68 {
  69         Glib::RefPtr<Gdk::Window> win = widget->get_text_window ();
  70         if (win) {
  71                 /* C++ doesn't provide a pointer argument version of this
  72                    (i.e. you cannot set to NULL to get the default/parent
  73                    cursor)
  74                 */
  75                 gdk_window_set_cursor (win->gobj(), 0);
  76         }
  77 }
  78
  79 static void
  80 reset_cursor_to_default_state (Gtk::StateType, Gtk::Entry* widget)
  81 {
  82         reset_cursor_to_default (widget);
  83 }
  84
  85 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
 133         peak_display.set_name ("MixerStripPeakDisplay");
 134         set_size_request_to_display_given_text (peak_display, "-80.g", 2, 6); /* note the descender */
 135         max_peak = minus_infinity();
 136         peak_display.set_text (_("-inf"));
 137
 138         /* stuff related to the fact that the peak display is not, in
 139            fact, supposed to be a text entry.
 140         */
 141         peak_display.set_events (peak_display.get_events() & ~(Gdk::EventMask (Gdk::LEAVE_NOTIFY_MASK|Gdk::ENTER_NOTIFY_MASK|Gdk::POINTER_MOTION_MASK)));
 142         peak_display.signal_map().connect (sigc::bind (sigc::ptr_fun (reset_cursor_to_default), &peak_display));
 143         peak_display.signal_state_changed().connect (sigc::bind (sigc::ptr_fun (reset_cursor_to_default_state), &peak_display));
 144         peak_display.unset_flags (Gtk::CAN_FOCUS);
 145         peak_display.set_editable (false);
 146
 147         gain_automation_style_button.set_name ("mixer strip button");
 148         gain_automation_state_button.set_name ("mixer strip button");
 149
 150         set_tooltip (gain_automation_state_button, _("Fader automation mode"));
 151         set_tooltip (gain_automation_style_button, _("Fader automation type"));
 152
 153         gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
 154         gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
 155
 156         gain_automation_state_button.set_size_request(15, 15);
 157         gain_automation_style_button.set_size_request(15, 15);
 158
 159         gain_astyle_menu.items().push_back (MenuElem (_("Trim")));
 160         gain_astyle_menu.items().push_back (MenuElem (_("Abs")));
 161
 162         gain_astate_menu.set_name ("ArdourContextMenu");
 163         gain_astyle_menu.set_name ("ArdourContextMenu");
 164
 165         gain_adjustment.signal_value_changed().connect (sigc::mem_fun(*this, &GainMeterBase::fader_moved));
 166         peak_display.signal_button_release_event().connect (sigc::mem_fun(*this, &GainMeterBase::peak_button_release), false);
 167         gain_display.signal_key_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_key_press), false);
 168
 169         ResetAllPeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_peak_display));
 170         ResetRoutePeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_route_peak_display));
 171         ResetGroupPeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_group_peak_display));
 172         RedrawMetrics.connect (sigc::mem_fun(*this, &GainMeterBase::redraw_metrics));
 173
 174         UI::instance()->theme_changed.connect (sigc::mem_fun(*this, &GainMeterBase::on_theme_changed));
 175         UIConfiguration::instance().ColorsChanged.connect (sigc::bind(sigc::mem_fun (*this, &GainMeterBase::color_handler), false));
 176         UIConfiguration::instance().DPIReset.connect (sigc::bind(sigc::mem_fun (*this, &GainMeterBase::color_handler), true));
 177 }
 178
 179 GainMeterBase::~GainMeterBase ()
 180 {
 181         delete meter_menu;
 182         delete level_meter;
 183 }
 184
 185 void
 186 GainMeterBase::set_controls (boost::shared_ptr<Route> r,
 187                              boost::shared_ptr<PeakMeter> pm,
 188                              boost::shared_ptr<Amp> amp,
 189                              boost::shared_ptr<GainControl> control)
 190 {
 191         connections.clear ();
 192         model_connections.drop_connections ();
 193
 194         /* no meter and no control? nothing to do ... */
 195
 196         if (!pm && !control) {
 197                 level_meter->set_meter (0);
 198                 gain_slider->set_controllable (boost::shared_ptr<PBD::Controllable>());
 199                 _meter.reset ();
 200                 _amp.reset ();
 201                 _route.reset ();
 202                 _control.reset ();
 203                 return;
 204         }
 205
 206         _meter = pm;
 207         _amp = amp;
 208         _route = r;
 209         _control = control;
 210
 211         level_meter->set_meter (pm.get());
 212         gain_slider->set_controllable (_control);
 213
 214         if (amp) {
 215                 amp->ConfigurationChanged.connect (
 216                         model_connections, invalidator (*this), boost::bind (&GainMeterBase::setup_gain_adjustment, this), gui_context ()
 217                         );
 218         }
 219
 220         setup_gain_adjustment ();
 221
 222         if (!_route || !_route->is_auditioner()) {
 223
 224                 using namespace Menu_Helpers;
 225
 226                 gain_astate_menu.items().clear ();
 227
 228                 gain_astate_menu.items().push_back (MenuElem (S_("Automation|Manual"),
 229                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Off)));
 230                 gain_astate_menu.items().push_back (MenuElem (_("Play"),
 231                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Play)));
 232                 gain_astate_menu.items().push_back (MenuElem (_("Write"),
 233                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Write)));
 234                 gain_astate_menu.items().push_back (MenuElem (_("Touch"),
 235                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Touch)));
 236
 237                 connections.push_back (gain_automation_style_button.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_automation_style_button_event), false));
 238                 connections.push_back (gain_automation_state_button.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_automation_state_button_event), false));
 239                 connections.push_back (ChangeGainAutomationState.connect (sigc::mem_fun(*this, &GainMeterBase::set_gain_astate)));
 240
 241                 _control->alist()->automation_state_changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeter::gain_automation_state_changed, this), gui_context());
 242                 _control->alist()->automation_style_changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeter::gain_automation_style_changed, this), gui_context());
 243
 244                 gain_automation_state_changed ();
 245         }
 246
 247         _control->Changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeterBase::gain_changed, this), gui_context());
 248
 249         gain_changed ();
 250         show_gain ();
 251         update_gain_sensitive ();
 252
 253         if (!_meter) {
 254                 peak_display.hide ();
 255         } else {
 256                 peak_display.show ();
 257         }
 258 }
 259
 260 void
 261 GainMeterBase::set_gain_astate (AutoState as)
 262 {
 263         if (gain_astate_propagate) {
 264                 gain_astate_propagate = false;
 265                 ChangeGainAutomationState (as);
 266                 return;
 267         }
 268         _amp->set_parameter_automation_state (Evoral::Parameter (GainAutomation), as);
 269 }
 270
 271 void
 272 GainMeterBase::setup_gain_adjustment ()
 273 {
 274         if (!_amp) {
 275                 return;
 276         }
 277
 278         if (_previous_amp_output_streams == _amp->output_streams ()) {
 279                 return;
 280         }
 281
 282         ignore_toggle = true;
 283
 284         if (_amp->output_streams().n_midi() <=  _amp->output_streams().n_audio()) {
 285                 _data_type = DataType::AUDIO;
 286                 gain_adjustment.set_lower (GAIN_COEFF_ZERO);
 287                 gain_adjustment.set_upper (GAIN_COEFF_UNITY);
 288                 gain_adjustment.set_step_increment (dB_coeff_step(Config->get_max_gain()) / 10.0);
 289                 gain_adjustment.set_page_increment (dB_coeff_step(Config->get_max_gain()));
 290                 gain_slider->set_default_value (gain_to_slider_position (GAIN_COEFF_UNITY));
 291         } else {
 292                 _data_type = DataType::MIDI;
 293                 gain_adjustment.set_lower (0.0);
 294                 gain_adjustment.set_upper (2.0);
 295                 gain_adjustment.set_step_increment (1.0/128.0);
 296                 gain_adjustment.set_page_increment (10.0/128.0);
 297                 gain_slider->set_default_value (1.0);
 298         }
 299
 300         ignore_toggle = false;
 301
 302         effective_gain_display ();
 303
 304         _previous_amp_output_streams = _amp->output_streams ();
 305 }
 306
 307 void
 308 GainMeterBase::hide_all_meters ()
 309 {
 310         level_meter->hide_meters();
 311 }
 312
 313 void
 314 GainMeter::hide_all_meters ()
 315 {
 316         GainMeterBase::hide_all_meters ();
 317 }
 318
 319 void
 320 GainMeterBase::setup_meters (int len)
 321 {
 322         int meter_width = 5;
 323         uint32_t meter_channels = 0;
 324         if (_meter) {
 325                 meter_channels = _meter->input_streams().n_total();
 326         } else if (_route) {
 327                 meter_channels = _route->shared_peak_meter()->input_streams().n_total();
 328         }
 329
 330         switch (_width) {
 331                 case Wide:
 332                         //meter_ticks1_area.show();
 333                         //meter_ticks2_area.show();
 334                         meter_metric_area.show();
 335                         if (meter_channels == 1) {
 336                                 meter_width = 10;
 337                         }
 338                         break;
 339                 case Narrow:
 340                         if (meter_channels > 1) {
 341                                 meter_width = 4;
 342                         }
 343                         //meter_ticks1_area.hide();
 344                         //meter_ticks2_area.hide();
 345                         meter_metric_area.hide();
 346                         break;
 347         }
 348         level_meter->setup_meters(len, meter_width);
 349 }
 350
 351 void
 352 GainMeterBase::set_type (MeterType t)
 353 {
 354         level_meter->set_type(t);
 355 }
 356
 357 void
 358 GainMeter::setup_meters (int len)
 359 {
 360         switch (_width) {
 361                 case Wide:
 362                         {
 363                                 uint32_t meter_channels = 0;
 364                                 if (_meter) {
 365                                         meter_channels = _meter->input_streams().n_total();
 366                                 } else if (_route) {
 367                                         meter_channels = _route->shared_peak_meter()->input_streams().n_total();
 368                                 }
 369                                 hbox.set_homogeneous(meter_channels < 7 ? true : false);
 370                         }
 371                         break;
 372                 case Narrow:
 373                         hbox.set_homogeneous(false);
 374                         break;
 375         }
 376         GainMeterBase::setup_meters (len);
 377 }
 378
 379 void
 380 GainMeter::set_type (MeterType t)
 381 {
 382         GainMeterBase::set_type (t);
 383 }
 384
 385 bool
 386 GainMeterBase::gain_key_press (GdkEventKey* ev)
 387 {
 388         if (key_is_legal_for_numeric_entry (ev->keyval)) {
 389                 /* drop through to normal handling */
 390                 return false;
 391         }
 392         /* illegal key for gain entry */
 393         return true;
 394 }
 395
 396 bool
 397 GainMeterBase::peak_button_release (GdkEventButton* ev)
 398 {
 399         /* reset peak label */
 400
 401         if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier|Keyboard::TertiaryModifier)) {
 402                 ResetAllPeakDisplays ();
 403         } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 404                 if (_route) {
 405                         ResetGroupPeakDisplays (_route->route_group());
 406                 }
 407         } else {
 408                 ResetRoutePeakDisplays (_route.get());
 409         }
 410
 411         return true;
 412 }
 413
 414 void
 415 GainMeterBase::reset_peak_display ()
 416 {
 417         _meter->reset_max();
 418         level_meter->clear_meters();
 419         max_peak = minus_infinity ();
 420         peak_display.set_text (_("-inf"));
 421         peak_display.set_name ("MixerStripPeakDisplay");
 422 }
 423
 424 void
 425 GainMeterBase::reset_route_peak_display (Route* route)
 426 {
 427         if (_route && _route.get() == route) {
 428                 reset_peak_display ();
 429         }
 430 }
 431
 432 void
 433 GainMeterBase::reset_group_peak_display (RouteGroup* group)
 434 {
 435         if (_route && group == _route->route_group()) {
 436                 reset_peak_display ();
 437         }
 438 }
 439
 440 void
 441 GainMeterBase::popup_meter_menu (GdkEventButton *ev)
 442 {
 443         using namespace Menu_Helpers;
 444
 445         if (meter_menu == 0) {
 446                 meter_menu = new Gtk::Menu;
 447                 MenuList& items = meter_menu->items();
 448
 449                 items.push_back (MenuElem ("-inf .. +0dBFS"));
 450                 items.push_back (MenuElem ("-10dB .. +0dBFS"));
 451                 items.push_back (MenuElem ("-4 .. +0dBFS"));
 452                 items.push_back (SeparatorElem());
 453                 items.push_back (MenuElem ("-inf .. -2dBFS"));
 454                 items.push_back (MenuElem ("-10dB .. -2dBFS"));
 455                 items.push_back (MenuElem ("-4 .. -2dBFS"));
 456         }
 457
 458         meter_menu->popup (1, ev->time);
 459 }
 460
 461 bool
 462 GainMeterBase::gain_focused (GdkEventFocus* ev)
 463 {
 464         if (ev->in) {
 465                 gain_display.select_region (0, -1);
 466         } else {
 467                 gain_display.select_region (0, 0);
 468         }
 469         return false;
 470 }
 471
 472 void
 473 GainMeterBase::gain_activated ()
 474 {
 475         float f;
 476
 477         {
 478                 // Switch to user's preferred locale so that
 479                 // if they use different LC_NUMERIC conventions,
 480                 // we will honor them.
 481
 482                 PBD::LocaleGuard lg;
 483                 if (sscanf (gain_display.get_text().c_str(), "%f", &f) != 1) {
 484                         return;
 485                 }
 486         }
 487
 488         /* clamp to displayable values */
 489         if (_data_type == DataType::AUDIO) {
 490                 f = min (f, 6.0f);
 491                 _control->set_value (dB_to_coefficient(f), Controllable::UseGroup);
 492         } else {
 493                 f = min (fabs (f), 2.0f);
 494                 _control->set_value (f, Controllable::UseGroup);
 495         }
 496
 497         if (gain_display.has_focus()) {
 498                 Gtk::Widget* w = gain_display.get_toplevel();
 499                 if (w) {
 500                         Gtk::Window* win = dynamic_cast<Gtk::Window*> (w);
 501
 502                         /* sigh. gtkmm doesn't wrap get_default_widget() */
 503
 504                         if (win) {
 505                                 GtkWidget* f = gtk_window_get_default_widget (win->gobj());
 506                                 if (f) {
 507                                         gtk_widget_grab_focus (f);
 508                                         return;
 509                                 }
 510                         }
 511                 }
 512         }
 513 }
 514
 515 void
 516 GainMeterBase::show_gain ()
 517 {
 518         char buf[32];
 519
 520         float v = gain_adjustment.get_value();
 521
 522         switch (_data_type) {
 523         case DataType::AUDIO:
 524                 if (v == 0.0) {
 525                         strcpy (buf, _("-inf"));
 526                 } else {
 527                         snprintf (buf, sizeof (buf), "%.1f", accurate_coefficient_to_dB (slider_position_to_gain_with_max (v, Config->get_max_gain())));
 528                 }
 529                 break;
 530         case DataType::MIDI:
 531                 snprintf (buf, sizeof (buf), "%.1f", v);
 532                 break;
 533         }
 534
 535         gain_display.set_text (buf);
 536 }
 537
 538 void
 539 GainMeterBase::fader_moved ()
 540 {
 541         if (!ignore_toggle) {
 542
 543                 gain_t value;
 544
 545                 /* convert from adjustment range (0..1) to gain coefficient */
 546
 547                 if (_data_type == DataType::AUDIO) {
 548                         value = slider_position_to_gain_with_max (gain_adjustment.get_value(), Config->get_max_gain());
 549                 } else {
 550                         value = gain_adjustment.get_value();
 551                 }
 552
 553                 _control->set_value (value, Controllable::UseGroup);
 554         }
 555
 556         show_gain ();
 557 }
 558
 559 void
 560 GainMeterBase::effective_gain_display ()
 561 {
 562         gain_t fader_position = 0;
 563
 564         switch (_data_type) {
 565         case DataType::AUDIO:
 566                 /* the position of the fader should reflect any master gain,
 567                  * not just the control's own inherent value
 568                  */
 569                 fader_position = gain_to_slider_position_with_max (_control->get_value(), Config->get_max_gain());
 570                 break;
 571         case DataType::MIDI:
 572                 fader_position = _control->get_value ();
 573                 break;
 574         }
 575
 576         if (gain_adjustment.get_value() != fader_position) {
 577                 ignore_toggle = true;
 578                 gain_adjustment.set_value (fader_position);
 579                 ignore_toggle = false;
 580         }
 581 }
 582
 583 void
 584 GainMeterBase::gain_changed ()
 585 {
 586         Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&GainMeterBase::effective_gain_display, this));
 587 }
 588
 589 void
 590 GainMeterBase::set_meter_strip_name (const char * name)
 591 {
 592         char tmp[256];
 593         meter_metric_area.set_name (name);
 594         sprintf(tmp, "Mark%sLeft", name);
 595         meter_ticks1_area.set_name (tmp);
 596         sprintf(tmp, "Mark%sRight", name);
 597         meter_ticks2_area.set_name (tmp);
 598 }
 599
 600 void
 601 GainMeterBase::set_fader_name (const char * name)
 602 {
 603         gain_slider->set_name (name);
 604 }
 605
 606 void
 607 GainMeterBase::update_gain_sensitive ()
 608 {
 609         bool x = !(_control->alist()->automation_state() & Play);
 610         static_cast<Gtkmm2ext::SliderController*>(gain_slider)->set_sensitive (x);
 611 }
 612
 613 static MeterPoint
 614 next_meter_point (MeterPoint mp)
 615 {
 616         switch (mp) {
 617         case MeterInput:
 618                 return MeterPreFader;
 619                 break;
 620
 621         case MeterPreFader:
 622                 return MeterPostFader;
 623                 break;
 624
 625         case MeterPostFader:
 626                 return MeterOutput;
 627                 break;
 628
 629         case MeterOutput:
 630                 return MeterCustom;
 631                 break;
 632
 633         case MeterCustom:
 634                 return MeterInput;
 635                 break;
 636         }
 637
 638         abort(); /*NOTREACHED*/
 639         return MeterInput;
 640 }
 641
 642 gint
 643 GainMeterBase::meter_press(GdkEventButton* ev)
 644 {
 645         wait_for_release = false;
 646
 647         if (!_route) {
 648                 return FALSE;
 649         }
 650
 651         if (!ignore_toggle) {
 652
 653                 if (Keyboard::is_context_menu_event (ev)) {
 654
 655                         // no menu at this time.
 656
 657                 } else {
 658
 659                         if (Keyboard::is_button2_event(ev)) {
 660
 661                                 // Primary-button2 click is the midi binding click
 662                                 // button2-click is "momentary"
 663
 664                                 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier))) {
 665                                         wait_for_release = true;
 666                                         old_meter_point = _route->meter_point ();
 667                                 }
 668                         }
 669
 670                         if (_route && (ev->button == 1 || Keyboard::is_button2_event (ev))) {
 671
 672                                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
 673
 674                                         /* Primary+Tertiary-click applies change to all routes */
 675
 676                                         _session->foreach_route (this, &GainMeterBase::set_meter_point, next_meter_point (_route->meter_point()));
 677
 678
 679                                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 680
 681                                         /* Primary-click: solo mix group.
 682                                            NOTE: Primary-button2 is MIDI learn.
 683                                         */
 684
 685                                         if (ev->button == 1) {
 686                                                 set_route_group_meter_point (*_route, next_meter_point (_route->meter_point()));
 687                                         }
 688
 689                                 } else {
 690
 691                                         /* click: change just this route */
 692
 693                                         // XXX no undo yet
 694
 695                                         _route->set_meter_point (next_meter_point (_route->meter_point()));
 696                                 }
 697                         }
 698                 }
 699         }
 700
 701         return true;
 702
 703 }
 704
 705 gint
 706 GainMeterBase::meter_release(GdkEventButton*)
 707 {
 708         if (!ignore_toggle) {
 709                 if (wait_for_release) {
 710                         wait_for_release = false;
 711
 712                         if (_route) {
 713                                 set_meter_point (*_route, old_meter_point);
 714                         }
 715                 }
 716         }
 717
 718         return true;
 719 }
 720
 721 void
 722 GainMeterBase::set_meter_point (Route& route, MeterPoint mp)
 723 {
 724         route.set_meter_point (mp);
 725 }
 726
 727 void
 728 GainMeterBase::set_route_group_meter_point (Route& route, MeterPoint mp)
 729 {
 730         RouteGroup* route_group;
 731
 732         if ((route_group = route.route_group ()) != 0) {
 733                 route_group->foreach_route (boost::bind (&Route::set_meter_point, _1, mp, false));
 734         } else {
 735                 route.set_meter_point (mp);
 736         }
 737 }
 738
 739 void
 740 GainMeterBase::meter_point_clicked ()
 741 {
 742         if (_route) {
 743                 /* WHAT? */
 744         }
 745 }
 746
 747 void
 748 GainMeterBase::amp_start_touch ()
 749 {
 750         _control->start_touch (_control->session().transport_frame());
 751 }
 752
 753 void
 754 GainMeterBase::amp_stop_touch ()
 755 {
 756         _control->stop_touch (false, _control->session().transport_frame());
 757 }
 758
 759 gint
 760 GainMeterBase::gain_automation_state_button_event (GdkEventButton *ev)
 761 {
 762         if (ev->type == GDK_BUTTON_RELEASE) {
 763                 return TRUE;
 764         }
 765
 766         switch (ev->button) {
 767                 case 1:
 768                         gain_astate_propagate = Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier | Keyboard::TertiaryModifier));
 769                         gain_astate_menu.popup (1, ev->time);
 770                         break;
 771                 default:
 772                         break;
 773         }
 774
 775         return TRUE;
 776 }
 777
 778 gint
 779 GainMeterBase::gain_automation_style_button_event (GdkEventButton *ev)
 780 {
 781         if (ev->type == GDK_BUTTON_RELEASE) {
 782                 return TRUE;
 783         }
 784
 785         switch (ev->button) {
 786         case 1:
 787                 gain_astyle_menu.popup (1, ev->time);
 788                 break;
 789         default:
 790                 break;
 791         }
 792         return TRUE;
 793 }
 794
 795 string
 796 GainMeterBase::astate_string (AutoState state)
 797 {
 798         return _astate_string (state, false);
 799 }
 800
 801 string
 802 GainMeterBase::short_astate_string (AutoState state)
 803 {
 804         return _astate_string (state, true);
 805 }
 806
 807 string
 808 GainMeterBase::_astate_string (AutoState state, bool shrt)
 809 {
 810         string sstr;
 811
 812         switch (state) {
 813         case ARDOUR::Off:
 814                 sstr = (shrt ? "M" : _("M"));
 815                 break;
 816         case Play:
 817                 sstr = (shrt ? "P" : _("P"));
 818                 break;
 819         case Touch:
 820                 sstr = (shrt ? "T" : _("T"));
 821                 break;
 822         case Write:
 823                 sstr = (shrt ? "W" : _("W"));
 824                 break;
 825         }
 826
 827         return sstr;
 828 }
 829
 830 string
 831 GainMeterBase::astyle_string (AutoStyle style)
 832 {
 833         return _astyle_string (style, false);
 834 }
 835
 836 string
 837 GainMeterBase::short_astyle_string (AutoStyle style)
 838 {
 839         return _astyle_string (style, true);
 840 }
 841
 842 string
 843 GainMeterBase::_astyle_string (AutoStyle style, bool shrt)
 844 {
 845         if (style & Trim) {
 846                 return _("Trim");
 847         } else {
 848                 /* XXX it might different in different languages */
 849
 850                 return (shrt ? _("Abs") : _("Abs"));
 851         }
 852 }
 853
 854 void
 855 GainMeterBase::gain_automation_style_changed ()
 856 {
 857         switch (_width) {
 858         case Wide:
 859                 gain_automation_style_button.set_text (astyle_string(_control->alist()->automation_style()));
 860                 break;
 861         case Narrow:
 862                 gain_automation_style_button.set_text  (short_astyle_string(_control->alist()->automation_style()));
 863                 break;
 864         }
 865 }
 866
 867 void
 868 GainMeterBase::gain_automation_state_changed ()
 869 {
 870         ENSURE_GUI_THREAD (*this, &GainMeterBase::gain_automation_state_changed);
 871
 872         switch (_width) {
 873         case Wide:
 874                 gain_automation_state_button.set_text (astate_string(_control->alist()->automation_state()));
 875                 break;
 876         case Narrow:
 877                 gain_automation_state_button.set_text (short_astate_string(_control->alist()->automation_state()));
 878                 break;
 879         }
 880
 881         const bool automation_watch_required = (_control->alist()->automation_state() != ARDOUR::Off);
 882
 883         if (gain_automation_state_button.get_active() != automation_watch_required) {
 884                 ignore_toggle = true;
 885                 gain_automation_state_button.set_active (automation_watch_required);
 886                 ignore_toggle = false;
 887         }
 888
 889         update_gain_sensitive ();
 890
 891         gain_watching.disconnect();
 892
 893         if (automation_watch_required) {
 894                 /* start watching automation so that things move */
 895                 gain_watching = Timers::rapid_connect (sigc::mem_fun (*this, &GainMeterBase::effective_gain_display));
 896         } else {
 897                 /* update once to get the correct value shown as we re-enter off/manual mode */
 898                 effective_gain_display();
 899         }
 900 }
 901
 902 const ChanCount
 903 GainMeterBase::meter_channels() const
 904 {
 905                 if (_meter) { return _meter->input_streams(); }
 906                 else { return ChanCount(); }
 907 }
 908 void
 909 GainMeterBase::update_meters()
 910 {
 911         char buf[32];
 912         float mpeak = level_meter->update_meters();
 913
 914         if (mpeak > max_peak) {
 915                 max_peak = mpeak;
 916                 if (mpeak <= -200.0f) {
 917                         peak_display.set_text (_("-inf"));
 918                 } else {
 919                         snprintf (buf, sizeof(buf), "%.1f", mpeak);
 920                         peak_display.set_text (buf);
 921                 }
 922         }
 923         if (mpeak >= UIConfiguration::instance().get_meter_peak()) {
 924                 peak_display.set_name ("MixerStripPeakDisplayPeak");
 925         }
 926 }
 927
 928 void GainMeterBase::color_handler(bool /*dpi*/)
 929 {
 930         setup_meters();
 931 }
 932
 933 void
 934 GainMeterBase::set_width (Width w, int len)
 935 {
 936         _width = w;
 937         int meter_width = 5;
 938         if (_width == Wide && _route && _route->shared_peak_meter()->input_streams().n_total() == 1) {
 939                 meter_width = 10;
 940         }
 941         level_meter->setup_meters(len, meter_width);
 942 }
 943
 944
 945 void
 946 GainMeterBase::on_theme_changed()
 947 {
 948 }
 949
 950 void
 951 GainMeterBase::redraw_metrics()
 952 {
 953         meter_metric_area.queue_draw ();
 954         meter_ticks1_area.queue_draw ();
 955         meter_ticks2_area.queue_draw ();
 956 }
 957
 958 #define PX_SCALE(pxmin, dflt) rint(std::max((double)pxmin, (double)dflt * UIConfiguration::instance().get_ui_scale()))
 959
 960 GainMeter::GainMeter (Session* s, int fader_length)
 961         : GainMeterBase (s, false, fader_length, 24)
 962         , gain_display_box(true, 0)
 963         , hbox(true, 2)
 964 {
 965         gain_display_box.set_border_width (0);
 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 }