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