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