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