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