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