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