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