leave route-button show/hide up to route-UI.
[ardour.git] / gtk2_ardour / meter_strip.cc
1 /*
2     Copyright (C) 2013 Paul Davis
3     Author: Robin Gareus
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with this program; if not, write to the Free Software
17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 #include <list>
21
22 #include <sigc++/bind.h>
23
24 #include "ardour/session.h"
25 #include "ardour/route.h"
26 #include "ardour/route_group.h"
27 #include "ardour/meter.h"
28
29 #include "ardour/audio_track.h"
30 #include "ardour/midi_track.h"
31
32 #include <gtkmm2ext/gtk_ui.h>
33 #include <gtkmm2ext/keyboard.h>
34 #include <gtkmm2ext/utils.h>
35 #include <gtkmm2ext/rgb_macros.h>
36
37 #include "ardour_ui.h"
38 #include "global_signals.h"
39 #include "logmeter.h"
40 #include "gui_thread.h"
41 #include "ardour_window.h"
42 #include "utils.h"
43
44 #include "meterbridge.h"
45 #include "meter_strip.h"
46 #include "meter_patterns.h"
47
48 #include "i18n.h"
49
50 using namespace ARDOUR;
51 using namespace PBD;
52 using namespace Gtk;
53 using namespace Gtkmm2ext;
54 using namespace std;
55
56 PBD::Signal1<void,MeterStrip*> MeterStrip::CatchDeletion;
57 PBD::Signal0<void> MeterStrip::MetricChanged;
58
59 MeterStrip::MeterStrip (int metricmode)
60         : AxisView(0)
61         , RouteUI(0)
62 {
63         level_meter = 0;
64         _strip_type = 0;
65         set_spacing(2);
66         peakbx.set_size_request(-1, 14);
67         namebx.set_size_request(18, 52);
68         update_button_box();
69
70         set_metric_mode(metricmode);
71
72         meter_metric_area.set_size_request(25, 10);
73         meter_metric_area.signal_expose_event().connect (
74                         sigc::mem_fun(*this, &MeterStrip::meter_metrics_expose));
75         RedrawMetrics.connect (sigc::mem_fun(*this, &MeterStrip::redraw_metrics));
76
77         meterbox.pack_start(meter_metric_area, true, false);
78
79         pack_start (peakbx, false, false);
80         pack_start (meterbox, true, true);
81         pack_start (btnbox, false, false);
82         pack_start (namebx, false, false);
83
84         peakbx.show();
85         btnbox.show();
86         meter_metric_area.show();
87         meterbox.show();
88         namebx.show();
89
90         UI::instance()->theme_changed.connect (sigc::mem_fun(*this, &MeterStrip::on_theme_changed));
91         ColorsChanged.connect (sigc::mem_fun (*this, &MeterStrip::on_theme_changed));
92         DPIReset.connect (sigc::mem_fun (*this, &MeterStrip::on_theme_changed));
93 }
94
95 MeterStrip::MeterStrip (Session* sess, boost::shared_ptr<ARDOUR::Route> rt)
96         : AxisView(sess)
97         , RouteUI(sess)
98         , _route(rt)
99         , peak_display()
100 {
101         set_spacing(2);
102         RouteUI::set_route (rt);
103         SessionHandlePtr::set_session (sess);
104
105         _has_midi = false;
106
107         int meter_width = 6;
108         if (_route->shared_peak_meter()->input_streams().n_total() == 1) {
109                 meter_width = 12;
110         }
111
112         // level meter + ticks
113         level_meter = new LevelMeter(sess);
114         level_meter->set_meter (_route->shared_peak_meter().get());
115         level_meter->clear_meters();
116         level_meter->setup_meters (220, meter_width, 6);
117         level_meter->set_type (_route->meter_type());
118         level_meter->ButtonPress.connect_same_thread (level_meter_connection, boost::bind (&MeterStrip::level_meter_button_press, this, _1));
119         level_meter->MeterTypeChanged.connect_same_thread (level_meter_connection, boost::bind (&MeterStrip::meter_type_changed, this, _1));
120
121         meter_align.set(0.5, 0.5, 0.0, 1.0);
122         meter_align.add(*level_meter);
123
124         meterbox.pack_start(meter_ticks1_area, true, false);
125         meterbox.pack_start(meter_align, true, true);
126         meterbox.pack_start(meter_ticks2_area, true, false);
127
128         // peak display
129         peak_display.set_name ("meterbridge peakindicator");
130         peak_display.set_elements((ArdourButton::Element) (ArdourButton::Edge|ArdourButton::Body));
131         max_peak = minus_infinity();
132         peak_display.unset_flags (Gtk::CAN_FOCUS);
133         peak_display.set_size_request(12, 8);
134         peak_display.set_corner_radius(2);
135
136         peak_align.set(0.5, 1.0, 1.0, 0.8);
137         peak_align.add(peak_display);
138         peakbx.pack_start(peak_align, true, true, 3);
139         peakbx.set_size_request(-1, 14);
140
141         // add track-name label
142         name_label.set_text(_route->name().c_str());
143         name_label.set_corner_radius(2);
144         name_label.set_name("meterbridge label");
145         name_label.set_angle(-90.0);
146         name_label.layout()->set_ellipsize (Pango::ELLIPSIZE_END);
147         name_label.layout()->set_width(48 * PANGO_SCALE);
148         name_label.set_size_request(18, 50);
149         name_label.set_alignment(-1.0, .5);
150
151         number_label.set_alignment(1.0, .5);
152         number_label.set_name("meterbridge numlabel");
153
154         if (_route->unique_id() > 0) {
155                 char buf[16];
156                 snprintf(buf, 15, "%d", _route->unique_id());
157                 number_label.set_text(buf);
158                 number_label.show();
159                 name_label.hide();
160         } else {
161                 name_label.show();
162                 number_label.hide();
163         }
164
165         namebx.set_size_request(18, 52);
166         namebx.pack_start(name_label, true, false, 3);
167         namebx.pack_start(number_label, true, false, 0);
168
169         recbox.pack_start(*rec_enable_button, true, false);
170         btnbox.pack_start(recbox, false, false, 1);
171         mutebox.pack_start(*mute_button, true, false);
172         btnbox.pack_start(mutebox, false, false, 1);
173         solobox.pack_start(*solo_button, true, false);
174         btnbox.pack_start(solobox, false, false, 1);
175
176         rec_enable_button->set_corner_radius(2);
177         rec_enable_button->set_size_request(16, 16);
178
179         mute_button->set_corner_radius(2);
180         mute_button->set_size_request(16, 16);
181
182         solo_button->set_corner_radius(2);
183         solo_button->set_size_request(16, 16);
184
185         mutebox.set_size_request(16, 16);
186         solobox.set_size_request(16, 16);
187         recbox.set_size_request(16, 16);
188
189         update_button_box();
190
191         pack_start (peakbx, false, false);
192         pack_start (meterbox, true, true);
193         pack_start (btnbox, false, false);
194         pack_start (namebx, false, false);
195
196         peak_display.show();
197         peakbx.show();
198         meter_ticks1_area.show();
199         meter_ticks2_area.show();
200         meterbox.show();
201         level_meter->show();
202         meter_align.show();
203         peak_align.show();
204         btnbox.show();
205         namebx.show();
206
207         _route->shared_peak_meter()->ConfigurationChanged.connect (
208                         route_connections, invalidator (*this), boost::bind (&MeterStrip::meter_configuration_changed, this, _1), gui_context()
209                         );
210
211         ResetAllPeakDisplays.connect (sigc::mem_fun(*this, &MeterStrip::reset_peak_display));
212         ResetRoutePeakDisplays.connect (sigc::mem_fun(*this, &MeterStrip::reset_route_peak_display));
213         ResetGroupPeakDisplays.connect (sigc::mem_fun(*this, &MeterStrip::reset_group_peak_display));
214         RedrawMetrics.connect (sigc::mem_fun(*this, &MeterStrip::redraw_metrics));
215         SetMeterTypeMulti.connect (sigc::mem_fun(*this, &MeterStrip::set_meter_type_multi));
216
217         meter_configuration_changed (_route->shared_peak_meter()->input_streams ());
218
219         meter_ticks1_area.set_size_request(3,-1);
220         meter_ticks2_area.set_size_request(3,-1);
221         meter_ticks1_area.signal_expose_event().connect (sigc::mem_fun(*this, &MeterStrip::meter_ticks1_expose));
222         meter_ticks2_area.signal_expose_event().connect (sigc::mem_fun(*this, &MeterStrip::meter_ticks2_expose));
223
224         _route->DropReferences.connect (route_connections, invalidator (*this), boost::bind (&MeterStrip::self_delete, this), gui_context());
225         _route->PropertyChanged.connect (route_connections, invalidator (*this), boost::bind (&MeterStrip::strip_property_changed, this, _1), gui_context());
226
227         peak_display.signal_button_release_event().connect (sigc::mem_fun(*this, &MeterStrip::peak_button_release), false);
228
229         UI::instance()->theme_changed.connect (sigc::mem_fun(*this, &MeterStrip::on_theme_changed));
230         ColorsChanged.connect (sigc::mem_fun (*this, &MeterStrip::on_theme_changed));
231         DPIReset.connect (sigc::mem_fun (*this, &MeterStrip::on_theme_changed));
232         Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&MeterStrip::parameter_changed, this, _1), gui_context());
233         sess->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&MeterStrip::parameter_changed, this, _1), gui_context());
234
235         if (_route->is_master()) {
236                 _strip_type = 4;
237         }
238         else if (boost::dynamic_pointer_cast<AudioTrack>(_route) == 0
239                         && boost::dynamic_pointer_cast<MidiTrack>(_route) == 0) {
240                 /* non-master bus */
241                 _strip_type = 3;
242         }
243         else if (boost::dynamic_pointer_cast<MidiTrack>(_route)) {
244                 _strip_type = 2;
245         }
246         else {
247                 _strip_type = 1;
248         }
249 }
250
251 MeterStrip::~MeterStrip ()
252 {
253         delete level_meter;
254         CatchDeletion (this);
255 }
256
257 void
258 MeterStrip::self_delete ()
259 {
260         delete this;
261 }
262
263 void
264 MeterStrip::set_session (Session* s)
265 {
266         SessionHandlePtr::set_session (s);
267         s->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&MeterStrip::parameter_changed, this, _1), gui_context());
268         update_button_box();
269 }
270
271 void
272 MeterStrip::update_rec_display ()
273 {
274         RouteUI::update_rec_display ();
275 }
276
277 std::string
278 MeterStrip::state_id() const
279 {
280         return string_compose ("mtrs %1", _route->id().to_s());
281 }
282
283 void
284 MeterStrip::set_button_names()
285 {
286         mute_button->set_text (_("M"));
287         solo_button->set_text (_("S"));
288         rec_enable_button->set_text ("");
289         rec_enable_button->set_image (::get_icon (X_("record_normal_red")));
290 }
291
292 void
293 MeterStrip::strip_property_changed (const PropertyChange& what_changed)
294 {
295         if (!what_changed.contains (ARDOUR::Properties::name)) {
296                 return;
297         }
298         ENSURE_GUI_THREAD (*this, &MeterStrip::strip_name_changed, what_changed)
299         name_label.set_text(_route->name());
300
301         if (_route->unique_id() > 0) {
302                 char buf[16];
303                 snprintf(buf, 15, "%d", _route->unique_id());
304                 number_label.set_text(buf);
305                 number_label.show();
306                 name_label.hide();
307         } else {
308                 name_label.show();
309                 number_label.hide();
310         }
311 }
312
313 void
314 MeterStrip::fast_update ()
315 {
316         float mpeak = level_meter->update_meters();
317         if (mpeak > max_peak) {
318                 max_peak = mpeak;
319                 if (mpeak >= Config->get_meter_peak()) {
320                         peak_display.set_name ("meterbridge peakindicator on");
321                         peak_display.set_elements((ArdourButton::Element) (ArdourButton::Edge|ArdourButton::Body));
322                 }
323         }
324 }
325
326 void
327 MeterStrip::on_theme_changed()
328 {
329         if (level_meter && _route) {
330                 int meter_width = 6;
331                 if (_route->shared_peak_meter()->input_streams().n_total() == 1) {
332                         meter_width = 12;
333                 }
334                 level_meter->setup_meters (220, meter_width, 6);
335         }
336 }
337
338 void
339 MeterStrip::meter_configuration_changed (ChanCount c)
340 {
341         int type = 0;
342         _types.clear ();
343         bool old_has_midi = _has_midi;
344
345         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
346                 if (c.get (*i) > 0) {
347                         _types.push_back (*i);
348                         type |= 1 << (*i);
349                 }
350         }
351
352         // TODO draw Inactive routes or busses with different styles
353         if (boost::dynamic_pointer_cast<AudioTrack>(_route) == 0
354                         && boost::dynamic_pointer_cast<MidiTrack>(_route) == 0
355                         ) {
356                 meter_ticks1_area.set_name ("AudioBusMetricsLeft");
357                 meter_ticks2_area.set_name ("AudioBusMetricsRight");
358                 _has_midi = false;
359         }
360         else if (type == (1 << DataType::AUDIO)) {
361                 meter_ticks1_area.set_name ("AudioTrackMetricsLeft");
362                 meter_ticks2_area.set_name ("AudioTrackMetricsRight");
363                 _has_midi = false;
364         }
365         else if (type == (1 << DataType::MIDI)) {
366                 meter_ticks1_area.set_name ("MidiTrackMetricsLeft");
367                 meter_ticks2_area.set_name ("MidiTrackMetricsRight");
368                 _has_midi = true;
369         } else {
370                 meter_ticks1_area.set_name ("AudioMidiTrackMetricsLeft");
371                 meter_ticks2_area.set_name ("AudioMidiTrackMetricsRight");
372                 _has_midi = true;
373         }
374
375         if (old_has_midi != _has_midi) MetricChanged();
376         on_theme_changed();
377 }
378
379 void
380 MeterStrip::on_size_request (Gtk::Requisition* r)
381 {
382         meter_clear_pattern_cache();
383         VBox::on_size_request(r);
384 }
385
386 void
387 MeterStrip::on_size_allocate (Gtk::Allocation& a)
388 {
389         meter_clear_pattern_cache();
390         const int wh = a.get_height();
391         int nh = ceilf(wh * .11f);
392         if (nh < 52) nh = 52;
393         if (nh > 148) nh = 148;
394         namebx.set_size_request(18, nh);
395         if (_route) {
396                 name_label.set_size_request(18, nh-2);
397                 name_label.layout()->set_width((nh-4) * PANGO_SCALE);
398         }
399         VBox::on_size_allocate(a);
400 }
401
402 gint
403 MeterStrip::meter_metrics_expose (GdkEventExpose *ev)
404 {
405         return meter_expose_metrics(ev, _types, &meter_metric_area);
406 }
407
408 void
409 MeterStrip::set_metric_mode (int metricmode)
410 {
411         _types.clear ();
412         switch(metricmode) {
413                 case 0:
414                         meter_metric_area.set_name ("MidiTrackMetricsLeft");
415                         _types.push_back (DataType::MIDI);
416                         break;
417                 case 1:
418                         meter_metric_area.set_name ("AudioTrackMetricsLeft");
419                         _types.push_back (DataType::AUDIO);
420                         break;
421                 case 2:
422                         meter_metric_area.set_name ("MidiTrackMetricsRight");
423                         _types.push_back (DataType::MIDI);
424                         break;
425                 case 3:
426                 default:
427                         meter_metric_area.set_name ("AudioTrackMetricsRight");
428                         _types.push_back (DataType::AUDIO);
429                         break;
430         }
431
432         meter_metric_area.queue_draw ();
433 }
434
435 void
436 MeterStrip::set_pos (int pos)
437 {
438         number_label.set_alignment(1.0, pos%2 ? .25 : .75 );
439 }
440
441 gint
442 MeterStrip::meter_ticks1_expose (GdkEventExpose *ev)
443 {
444         return meter_expose_ticks(ev, _types, &meter_ticks1_area);
445 }
446
447 gint
448 MeterStrip::meter_ticks2_expose (GdkEventExpose *ev)
449 {
450         return meter_expose_ticks(ev, _types, &meter_ticks2_area);
451 }
452
453 void
454 MeterStrip::reset_route_peak_display (Route* route)
455 {
456         if (_route && _route.get() == route) {
457                 reset_peak_display ();
458         }
459 }
460
461 void
462 MeterStrip::reset_group_peak_display (RouteGroup* group)
463 {
464         if (_route && group == _route->route_group()) {
465                 reset_peak_display ();
466         }
467 }
468
469 void
470 MeterStrip::reset_peak_display ()
471 {
472         _route->shared_peak_meter()->reset_max();
473         level_meter->clear_meters();
474         max_peak = -INFINITY;
475         peak_display.set_name ("meterbridge peakindicator");
476         peak_display.set_elements((ArdourButton::Element) (ArdourButton::Edge|ArdourButton::Body));
477 }
478
479 bool
480 MeterStrip::peak_button_release (GdkEventButton* ev)
481 {
482         if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier|Keyboard::TertiaryModifier)) {
483                 ResetAllPeakDisplays ();
484         } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
485                 if (_route) {
486                         ResetGroupPeakDisplays (_route->route_group());
487                 }
488         } else {
489                 ResetRoutePeakDisplays (_route.get());
490         }
491         return true;
492 }
493
494 void
495 MeterStrip::redraw_metrics ()
496 {
497         meter_metric_area.queue_draw();
498         meter_ticks1_area.queue_draw();
499         meter_ticks2_area.queue_draw();
500 }
501
502 void
503 MeterStrip::update_button_box ()
504 {
505         if (!_session) return;
506         int height = 0;
507         if (_session->config.get_show_mute_on_meterbridge()) {
508                 height += 18;
509                 mutebox.w();
510         } else {
511                 mutebox.e();
512         }
513         if (_session->config.get_show_solo_on_meterbridge()) {
514                 height += 18;
515                 solobox.>show();
516         } else {
517                 solobox.>hide();
518         }
519         if (_session->config.get_show_rec_on_meterbridge()) {
520                 height += 18;
521                 recbox.show();
522         } else {
523                 recbox.hide();
524         }
525         btnbox.set_size_request(16, height);
526         check_resize();
527 }
528
529 void
530 MeterStrip::parameter_changed (std::string const & p)
531 {
532         if (p == "meter-peak") {
533                 max_peak = -INFINITY;
534         }
535         else if (p == "show-rec-on-meterbridge") {
536                 update_button_box();
537         }
538         else if (p == "show-mute-on-meterbridge") {
539                 update_button_box();
540         }
541         else if (p == "show-solo-on-meterbridge") {
542                 update_button_box();
543         }
544 }
545
546
547 bool
548 MeterStrip::level_meter_button_press (GdkEventButton* ev)
549 {
550         if (ev->button == 3) {
551                 popup_level_meter_menu (ev);
552                 return true;
553         }
554
555         return false;
556 }
557
558 void
559 MeterStrip::popup_level_meter_menu (GdkEventButton* ev)
560 {
561         using namespace Gtk::Menu_Helpers;
562
563         Gtk::Menu* m = manage (new Menu);
564         MenuList& items = m->items ();
565
566         RadioMenuItem::Group group;
567
568         _suspend_menu_callbacks = true;
569         add_level_meter_item (items, group, _("Peak"), MeterPeak);
570         add_level_meter_item (items, group, _("RMS + Peak"), MeterKrms);
571
572         items.push_back (SeparatorElem());
573         items.push_back (MenuElem (_("Change all in Group to Peak"), sigc::bind (SetMeterTypeMulti, -1, _route->route_group(), MeterPeak)));
574         items.push_back (MenuElem (_("Change all in Group to RMS + Peak"), sigc::bind (SetMeterTypeMulti, -1, _route->route_group(), MeterKrms)));
575         items.push_back (MenuElem (_("Change all to Peak"), sigc::bind (SetMeterTypeMulti, 0, _route->route_group(), MeterPeak)));
576         items.push_back (MenuElem (_("Change all to RMS + Peak"), sigc::bind (SetMeterTypeMulti, 0, _route->route_group(), MeterKrms)));
577         items.push_back (MenuElem (_("Change same track-type to Peak"), sigc::bind (SetMeterTypeMulti, _strip_type, _route->route_group(), MeterPeak)));
578         items.push_back (MenuElem (_("Change same track-type to RMS + Peak"), sigc::bind (SetMeterTypeMulti, _strip_type, _route->route_group(), MeterKrms)));
579
580         m->popup (ev->button, ev->time);
581         _suspend_menu_callbacks = false;
582 }
583
584 void
585 MeterStrip::add_level_meter_item (Menu_Helpers::MenuList& items, RadioMenuItem::Group& group, string const & name, MeterType type)
586 {
587         using namespace Menu_Helpers;
588
589         items.push_back (RadioMenuElem (group, name, sigc::bind (sigc::mem_fun (*this, &MeterStrip::set_meter_type), type)));
590         RadioMenuItem* i = dynamic_cast<RadioMenuItem *> (&items.back ());
591         i->set_active (_route->meter_type() == type);
592 }
593
594 void
595 MeterStrip::set_meter_type (MeterType type)
596 {
597         if (_suspend_menu_callbacks) return;
598         level_meter->set_type (type);
599 }
600
601 void
602 MeterStrip::meter_type_changed (MeterType type)
603 {
604         _route->set_meter_type(type);
605 }
606
607 void
608 MeterStrip::set_meter_type_multi (int what, RouteGroup* group, MeterType type)
609 {
610         switch (what) {
611                 case -1:
612                         if (_route && group == _route->route_group()) {
613                                 level_meter->set_type (type);
614                         }
615                         break;
616                 case 0:
617                         level_meter->set_type (type);
618                 default:
619                         if (what == _strip_type) {
620                                 level_meter->set_type (type);
621                         }
622                         break;
623         }
624 }