Update GUI: meter-type API and meter-type state changes
[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 <pangomm.h>
23
24 #include <gtkmm/alignment.h>
25 #include <gdkmm/color.h>
26 #include <gtkmm/style.h>
27
28 #include "ardour/amp.h"
29 #include "ardour/logmeter.h"
30 #include "ardour/route_group.h"
31 #include "ardour/session_route.h"
32 #include "ardour/dB.h"
33 #include "ardour/utils.h"
34
35 #include "gtkmm2ext/utils.h"
36 #include "gtkmm2ext/gtk_ui.h"
37
38 #include "widgets/tooltips.h"
39
40 #include "pbd/fastlog.h"
41 #include "pbd/stacktrace.h"
42
43 #include "gain_meter.h"
44 #include "gui_thread.h"
45 #include "keyboard.h"
46 #include "public_editor.h"
47 #include "utils.h"
48 #include "meter_patterns.h"
49 #include "timers.h"
50 #include "ui_config.h"
51
52 #include "ardour/session.h"
53 #include "ardour/route.h"
54 #include "ardour/meter.h"
55 #include "ardour/audio_track.h"
56 #include "ardour/midi_track.h"
57 #include "ardour/dB.h"
58
59 #include "pbd/i18n.h"
60
61 using namespace ARDOUR;
62 using namespace ArdourWidgets;
63 using namespace PBD;
64 using namespace Gtkmm2ext;
65 using namespace Gtk;
66 using namespace std;
67 using Gtkmm2ext::Keyboard;
68 using namespace ArdourMeter;
69
70 static void
71 reset_cursor_to_default (Gtk::Entry* widget)
72 {
73         Glib::RefPtr<Gdk::Window> win = widget->get_text_window ();
74         if (win) {
75                 /* C++ doesn't provide a pointer argument version of this
76                    (i.e. you cannot set to NULL to get the default/parent
77                    cursor)
78                 */
79                 gdk_window_set_cursor (win->gobj(), 0);
80         }
81 }
82
83 static void
84 reset_cursor_to_default_state (Gtk::StateType, Gtk::Entry* widget)
85 {
86         reset_cursor_to_default (widget);
87 }
88
89 sigc::signal<void, ARDOUR::AutoState> GainMeterBase::ChangeGainAutomationState;
90
91 GainMeterBase::GainMeterBase (Session* s, bool horizontal, int fader_length, int fader_girth)
92         : gain_adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()),  // value
93                            0.0,  // lower
94                            1.0,  // upper
95                            dB_coeff_step(Config->get_max_gain()) / 10.0,  // step increment
96                            dB_coeff_step(Config->get_max_gain()))  // page increment
97         , gain_automation_state_button ("")
98         , meter_point_button (_("pre"))
99         , gain_astate_propagate (false)
100         , _data_type (DataType::AUDIO)
101 {
102         using namespace Menu_Helpers;
103
104         set_session (s);
105
106         ignore_toggle = false;
107         meter_menu = 0;
108         next_release_selects = false;
109         _width = Wide;
110
111         fader_length = rint (fader_length * UIConfiguration::instance().get_ui_scale());
112         fader_girth = rint (fader_girth * UIConfiguration::instance().get_ui_scale());
113
114         if (horizontal) {
115                 gain_slider = manage (new HSliderController (&gain_adjustment, boost::shared_ptr<PBD::Controllable>(), fader_length, fader_girth));
116                 gain_slider->set_tweaks (ArdourFader::Tweaks(ArdourFader::NoButtonForward | ArdourFader::NoVerticalScroll));
117         } else {
118                 gain_slider = manage (new VSliderController (&gain_adjustment, boost::shared_ptr<PBD::Controllable>(), fader_length, fader_girth));
119                 gain_slider->set_tweaks (ArdourFader::NoButtonForward);
120         }
121
122         level_meter = new LevelMeterHBox(_session);
123
124         level_meter->ButtonPress.connect_same_thread (_level_meter_connection, boost::bind (&GainMeterBase::level_meter_button_press, this, _1));
125         meter_metric_area.signal_button_press_event().connect (sigc::mem_fun (*this, &GainMeterBase::level_meter_button_press));
126         meter_metric_area.add_events (Gdk::BUTTON_PRESS_MASK);
127
128         gain_slider->StartGesture.connect (sigc::mem_fun (*this, &GainMeter::amp_start_touch));
129         gain_slider->StopGesture.connect (sigc::mem_fun (*this, &GainMeter::amp_stop_touch));
130         gain_slider->set_name ("GainFader");
131
132         gain_display.set_name ("MixerStripGainDisplay");
133         set_size_request_to_display_given_text (gain_display, "-80.g", 2, 6); /* note the descender */
134         gain_display.signal_activate().connect (sigc::mem_fun (*this, &GainMeter::gain_activated));
135         gain_display.signal_focus_in_event().connect (sigc::mem_fun (*this, &GainMeter::gain_focused), false);
136         gain_display.signal_focus_out_event().connect (sigc::mem_fun (*this, &GainMeter::gain_focused), false);
137         gain_display.set_alignment (0.5);
138
139         peak_display.set_name ("MixerStripPeakDisplay");
140         set_size_request_to_display_given_text (peak_display, "-80.g", 2, 6); /* note the descender */
141         max_peak = minus_infinity();
142         peak_display.set_text (_("-inf"));
143         peak_display.set_alignment (0.5);
144
145         /* stuff related to the fact that the peak display is not, in
146            fact, supposed to be a text entry.
147         */
148         peak_display.set_events (peak_display.get_events() & ~(Gdk::EventMask (Gdk::LEAVE_NOTIFY_MASK|Gdk::ENTER_NOTIFY_MASK|Gdk::POINTER_MOTION_MASK)));
149         peak_display.signal_map().connect (sigc::bind (sigc::ptr_fun (reset_cursor_to_default), &peak_display));
150         peak_display.signal_state_changed().connect (sigc::bind (sigc::ptr_fun (reset_cursor_to_default_state), &peak_display));
151         peak_display.unset_flags (Gtk::CAN_FOCUS);
152         peak_display.set_editable (false);
153
154         gain_automation_state_button.set_name ("mixer strip button");
155
156         set_tooltip (gain_automation_state_button, _("Fader automation mode"));
157
158         gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
159
160         gain_automation_state_button.set_size_request(15, 15);
161
162         gain_astate_menu.set_name ("ArdourContextMenu");
163         gain_astate_menu.set_reserve_toggle_size(false);
164
165         meter_point_button.set_name ("mixer strip button");
166
167         set_tooltip (&meter_point_button, _("Metering point"));
168
169         meter_point_button.unset_flags (Gtk::CAN_FOCUS);
170
171         meter_point_button.set_size_request(15, 15);
172
173         meter_point_menu.set_name ("ArdourContextMenu");
174         meter_point_menu.set_reserve_toggle_size(false);
175
176         meter_point_menu.items().clear ();
177         meter_point_menu.items().push_back (MenuElem(_("Input"),
178          sigc::bind (sigc::mem_fun (*this,
179          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterInput)));
180         meter_point_menu.items().push_back (MenuElem(_("Pre Fader"),
181          sigc::bind (sigc::mem_fun (*this,
182          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterPreFader)));
183         meter_point_menu.items().push_back (MenuElem(_("Post Fader"),
184          sigc::bind (sigc::mem_fun (*this,
185          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterPostFader)));
186         meter_point_menu.items().push_back (MenuElem(_("Output"),
187          sigc::bind (sigc::mem_fun (*this,
188          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterOutput)));
189         meter_point_menu.items().push_back (MenuElem(_("Custom"),
190          sigc::bind (sigc::mem_fun (*this,
191          &GainMeterBase::meter_point_clicked), (MeterPoint) MeterCustom)));
192         meter_point_button.signal_button_press_event().connect (sigc::mem_fun (*this, &GainMeter::meter_press), false);
193
194         gain_adjustment.signal_value_changed().connect (sigc::mem_fun(*this, &GainMeterBase::fader_moved));
195         peak_display.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::peak_button_press), false);
196         peak_display.signal_button_release_event().connect (sigc::mem_fun(*this, &GainMeterBase::peak_button_release), false);
197         gain_display.signal_key_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_key_press), false);
198
199         ResetAllPeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_peak_display));
200         ResetRoutePeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_route_peak_display));
201         ResetGroupPeakDisplays.connect (sigc::mem_fun(*this, &GainMeterBase::reset_group_peak_display));
202         RedrawMetrics.connect (sigc::mem_fun(*this, &GainMeterBase::redraw_metrics));
203
204         UI::instance()->theme_changed.connect (sigc::mem_fun(*this, &GainMeterBase::on_theme_changed));
205         UIConfiguration::instance().ColorsChanged.connect (sigc::bind(sigc::mem_fun (*this, &GainMeterBase::color_handler), false));
206         UIConfiguration::instance().DPIReset.connect (sigc::bind(sigc::mem_fun (*this, &GainMeterBase::color_handler), true));
207 }
208
209 GainMeterBase::~GainMeterBase ()
210 {
211         delete meter_menu;
212         delete level_meter;
213 }
214
215 void
216 GainMeterBase::set_controls (boost::shared_ptr<Route> r,
217                              boost::shared_ptr<PeakMeter> pm,
218                              boost::shared_ptr<Amp> amp,
219                              boost::shared_ptr<GainControl> control)
220 {
221         connections.clear ();
222         model_connections.drop_connections ();
223
224         /* no meter and no control? nothing to do ... */
225
226         if (!pm && !control) {
227                 level_meter->set_meter (0);
228                 gain_slider->set_controllable (boost::shared_ptr<PBD::Controllable>());
229                 _meter.reset ();
230                 _amp.reset ();
231                 _route.reset ();
232                 _control.reset ();
233                 return;
234         }
235
236         _meter = pm;
237         _amp = amp;
238         _route = r;
239         _control = control;
240
241         level_meter->set_meter (pm.get());
242         gain_slider->set_controllable (_control);
243
244         if (amp) {
245                 amp->ConfigurationChanged.connect (
246                         model_connections, invalidator (*this), boost::bind (&GainMeterBase::setup_gain_adjustment, this), gui_context ()
247                         );
248         }
249
250         setup_gain_adjustment ();
251
252         if (!_route || !_route->is_auditioner()) {
253
254                 using namespace Menu_Helpers;
255
256                 gain_astate_menu.items().clear ();
257
258                 gain_astate_menu.items().push_back (MenuElem (S_("Automation|Manual"),
259                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Off)));
260                 gain_astate_menu.items().push_back (MenuElem (_("Play"),
261                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Play)));
262                 gain_astate_menu.items().push_back (MenuElem (_("Write"),
263                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Write)));
264                 gain_astate_menu.items().push_back (MenuElem (_("Touch"),
265                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Touch)));
266                 gain_astate_menu.items().push_back (MenuElem (_("Latch"),
267                                                               sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Latch)));
268
269                 connections.push_back (gain_automation_state_button.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_automation_state_button_event), false));
270                 connections.push_back (ChangeGainAutomationState.connect (sigc::mem_fun(*this, &GainMeterBase::set_gain_astate)));
271
272                 _control->alist()->automation_state_changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeter::gain_automation_state_changed, this), gui_context());
273
274                 gain_automation_state_changed ();
275         }
276
277         _control->Changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeterBase::gain_changed, this), gui_context());
278
279         gain_changed ();
280         show_gain ();
281         update_gain_sensitive ();
282
283         if (!_meter) {
284                 peak_display.hide ();
285         } else {
286                 peak_display.show ();
287         }
288 }
289
290 void
291 GainMeterBase::set_gain_astate (AutoState as)
292 {
293         if (gain_astate_propagate) {
294                 gain_astate_propagate = false;
295                 ChangeGainAutomationState (as);
296                 return;
297         }
298         if (_amp) {
299                 _amp->set_parameter_automation_state (Evoral::Parameter (GainAutomation), as);
300         } else if (_control) {
301                 _control->set_automation_state (as);
302                 _session->set_dirty ();
303         }
304 }
305
306 void
307 GainMeterBase::setup_gain_adjustment ()
308 {
309         if (!_amp) {
310                 return;
311         }
312
313         if (_previous_amp_output_streams == _amp->output_streams ()) {
314                 return;
315         }
316
317         ignore_toggle = true;
318
319         if (_amp->output_streams().n_midi() <=  _amp->output_streams().n_audio()) {
320                 _data_type = DataType::AUDIO;
321                 gain_adjustment.set_lower (GAIN_COEFF_ZERO);
322                 gain_adjustment.set_upper (GAIN_COEFF_UNITY);
323                 gain_adjustment.set_step_increment (dB_coeff_step(Config->get_max_gain()) / 10.0);
324                 gain_adjustment.set_page_increment (dB_coeff_step(Config->get_max_gain()));
325                 gain_slider->set_default_value (gain_to_slider_position_with_max (GAIN_COEFF_UNITY, Config->get_max_gain()));
326         } else {
327                 _data_type = DataType::MIDI;
328                 gain_adjustment.set_lower (0.0);
329                 gain_adjustment.set_upper (2.0);
330                 gain_adjustment.set_step_increment (1.0/128.0);
331                 gain_adjustment.set_page_increment (10.0/128.0);
332                 gain_slider->set_default_value (1.0);
333         }
334
335         ignore_toggle = false;
336
337         effective_gain_display ();
338
339         _previous_amp_output_streams = _amp->output_streams ();
340 }
341
342 void
343 GainMeterBase::hide_all_meters ()
344 {
345         level_meter->hide_meters();
346 }
347
348 void
349 GainMeter::hide_all_meters ()
350 {
351         GainMeterBase::hide_all_meters ();
352 }
353
354 void
355 GainMeterBase::setup_meters (int len)
356 {
357         int meter_width = 5;
358         uint32_t meter_channels = 0;
359         if (_meter) {
360                 meter_channels = _meter->input_streams().n_total();
361         } else if (_route) {
362                 meter_channels = _route->shared_peak_meter()->input_streams().n_total();
363         }
364
365         switch (_width) {
366                 case Wide:
367                         //meter_ticks1_area.show();
368                         //meter_ticks2_area.show();
369                         meter_metric_area.show();
370                         if (meter_channels == 1) {
371                                 meter_width = 10;
372                         }
373                         break;
374                 case Narrow:
375                         if (meter_channels > 1) {
376                                 meter_width = 4;
377                         }
378                         //meter_ticks1_area.hide();
379                         //meter_ticks2_area.hide();
380                         meter_metric_area.hide();
381                         break;
382         }
383         level_meter->setup_meters(len, meter_width);
384 }
385
386 void
387 GainMeter::setup_meters (int len)
388 {
389         switch (_width) {
390                 case Wide:
391                         {
392                                 uint32_t meter_channels = 0;
393                                 if (_meter) {
394                                         meter_channels = _meter->input_streams().n_total();
395                                 } else if (_route) {
396                                         meter_channels = _route->shared_peak_meter()->input_streams().n_total();
397                                 }
398                                 hbox.set_homogeneous(meter_channels < 7 ? true : false);
399                         }
400                         break;
401                 case Narrow:
402                         hbox.set_homogeneous(false);
403                         break;
404         }
405         GainMeterBase::setup_meters (len);
406 }
407
408 bool
409 GainMeterBase::gain_key_press (GdkEventKey* ev)
410 {
411         if (ARDOUR_UI_UTILS::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         ENSURE_GUI_THREAD (*this, &GainMeterBase::gain_automation_state_changed);
621         effective_gain_display ();
622 }
623
624 void
625 GainMeterBase::set_meter_strip_name (const char * name)
626 {
627         char tmp[256];
628         meter_metric_area.set_name (name);
629         sprintf(tmp, "Mark%sLeft", name);
630         meter_ticks1_area.set_name (tmp);
631         sprintf(tmp, "Mark%sRight", name);
632         meter_ticks2_area.set_name (tmp);
633 }
634
635 void
636 GainMeterBase::set_fader_name (const char * name)
637 {
638         gain_slider->set_name (name);
639 }
640
641 void
642 GainMeterBase::update_gain_sensitive ()
643 {
644         bool x = !(_control->alist()->automation_state() & Play);
645         static_cast<ArdourWidgets::SliderController*>(gain_slider)->set_sensitive (x);
646 }
647
648 gint
649 GainMeterBase::meter_press(GdkEventButton* ev)
650 {
651         if (!_route) {
652                 return false;
653         }
654         if (!ignore_toggle) {
655                 switch (ev->button) {
656                         case 1:
657                                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
658
659                                         /* Primary+Tertiary-click applies change to all routes */
660
661                                         meter_point_change_target = MeterPointChangeAll;
662
663                                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
664
665                                         /* Primary-click: apply change to all routes in group */
666
667                                         meter_point_change_target = MeterPointChangeGroup;
668
669                                 } else {
670
671                                         /* click: change just this route */
672
673                                         meter_point_change_target = MeterPointChangeSingle;
674                                 }
675                                 Gtkmm2ext::anchored_menu_popup(&meter_point_menu,
676                                                                &meter_point_button,
677                                                                "", 1, ev->time);
678                                 break;
679                         default:
680                                 break;
681                 }
682         }
683         return true;
684 }
685
686 void
687 GainMeterBase::set_meter_point (Route& route, MeterPoint mp)
688 {
689         route.set_meter_point (mp);
690 }
691
692 void
693 GainMeterBase::set_route_group_meter_point (Route& route, MeterPoint mp)
694 {
695         RouteGroup* route_group;
696
697         if ((route_group = route.route_group ()) != 0) {
698                 route_group->foreach_route (boost::bind (&Route::set_meter_point, _1, mp, false));
699         } else {
700                 route.set_meter_point (mp);
701         }
702 }
703
704 void
705 GainMeterBase::meter_point_clicked (MeterPoint mp)
706 {
707         if (_route) {
708                 switch (meter_point_change_target) {
709                         case MeterPointChangeAll:
710                                 _session->foreach_route (this, &GainMeterBase::set_meter_point, mp);
711                                 break;
712                         case MeterPointChangeGroup:
713                                 set_route_group_meter_point (*_route, mp);
714                                 break;
715                         case MeterPointChangeSingle:
716                                 _route->set_meter_point (mp);
717                                 break;
718                 }
719         }
720 }
721
722 void
723 GainMeterBase::amp_start_touch ()
724 {
725         _control->start_touch (_control->session().transport_sample());
726 }
727
728 void
729 GainMeterBase::amp_stop_touch ()
730 {
731         _control->stop_touch (_control->session().transport_sample());
732         effective_gain_display ();
733 }
734
735 gint
736 GainMeterBase::gain_automation_state_button_event (GdkEventButton *ev)
737 {
738         if (ev->type == GDK_BUTTON_RELEASE) {
739                 return TRUE;
740         }
741
742         switch (ev->button) {
743                 case 1:
744                         gain_astate_propagate = Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier | Keyboard::TertiaryModifier));
745                         Gtkmm2ext::anchored_menu_popup(&gain_astate_menu,
746                                                        &gain_automation_state_button,
747                                                        "", 1, ev->time);
748                         break;
749                 default:
750                         break;
751         }
752
753         return TRUE;
754 }
755
756
757 string
758 GainMeterBase::astate_string (AutoState state)
759 {
760         return _astate_string (state, false);
761 }
762
763 string
764 GainMeterBase::short_astate_string (AutoState state)
765 {
766         return _astate_string (state, true);
767 }
768
769 string
770 GainMeterBase::_astate_string (AutoState state, bool shrt)
771 {
772         string sstr;
773
774         switch (state) {
775         case ARDOUR::Off:
776                 sstr = (shrt ? "M" : S_("Manual|M"));
777                 break;
778         case Play:
779                 sstr = (shrt ? "P" : S_("Play|P"));
780                 break;
781         case Touch:
782                 sstr = (shrt ? "T" : S_("Trim|T"));
783                 break;
784         case Latch:
785                 sstr = (shrt ? "L" : S_("Latch|L"));
786                 break;
787         case Write:
788                 sstr = (shrt ? "W" : S_("Write|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->MeterTypeChanged.connect (
963                         model_connections, invalidator (*this), boost::bind (&GainMeter::redraw_metrics, this), 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 }