limit width and resize meterbride window
[ardour.git] / gtk2_ardour / meterbridge.cc
1 /*
2     Copyright (C) 2012 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
21 #ifdef WAF_BUILD
22 #include "gtk2ardour-config.h"
23 #endif
24
25 #include <map>
26 #include <sigc++/bind.h>
27
28 #include <gtkmm/accelmap.h>
29
30 #include <glibmm/threads.h>
31
32 #include <gtkmm2ext/gtk_ui.h>
33 #include <gtkmm2ext/utils.h>
34 #include <gtkmm2ext/window_title.h>
35
36 #include "ardour/debug.h"
37 #include "ardour/midi_track.h"
38 #include "ardour/route_group.h"
39 #include "ardour/session.h"
40
41 #include "ardour/audio_track.h"
42 #include "ardour/midi_track.h"
43
44 #include "meterbridge.h"
45
46 #include "keyboard.h"
47 #include "monitor_section.h"
48 #include "public_editor.h"
49 #include "ardour_ui.h"
50 #include "utils.h"
51 #include "route_sorter.h"
52 #include "actions.h"
53 #include "gui_thread.h"
54 #include "global_signals.h"
55 #include "meter_patterns.h"
56
57 #include "i18n.h"
58
59 using namespace ARDOUR;
60 using namespace PBD;
61 using namespace Gtk;
62 using namespace Glib;
63 using namespace Gtkmm2ext;
64 using namespace std;
65 using namespace ArdourMeter;
66
67 using PBD::atoi;
68
69 Meterbridge* Meterbridge::_instance = 0;
70
71 Meterbridge*
72 Meterbridge::instance ()
73 {
74         if (!_instance) {
75                 _instance  = new Meterbridge;
76         }
77
78         return _instance;
79 }
80
81 /* copy from gtk2_ardour/mixer_ui.cc -- TODO consolidate
82  * used by Meterbridge::set_session() below
83  */
84 struct SignalOrderRouteSorter {
85         bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
86                 if (a->is_master() || a->is_monitor()) {
87                         /* "a" is a special route (master, monitor, etc), and comes
88                          * last in the mixer ordering
89                          */
90                         return false;
91                 } else if (b->is_master() || b->is_monitor()) {
92                         /* everything comes before b */
93                         return true;
94                 }
95                 return a->order_key (MixerSort) < b->order_key (MixerSort);
96         }
97 };
98
99 Meterbridge::Meterbridge ()
100         : Window (Gtk::WINDOW_TOPLEVEL)
101         , VisibilityTracker (*((Gtk::Window*) this))
102         , _visible (false)
103         , _show_busses (false)
104         , metrics_left (1, MeterPeak)
105         , metrics_right (2, MeterPeak)
106         , cur_max_width (-1)
107 {
108         set_name ("Meter Bridge");
109
110         m_width = default_width;
111         m_height = default_height;
112         m_root_x = 1;
113         m_root_y = 1;
114
115         update_title ();
116
117         set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
118
119         Gdk::Geometry geom;
120         geom.max_width = 1<<16;
121         geom.max_height = max_height;
122         geom.height_inc = 16;
123         geom.width_inc = 1;
124         set_geometry_hints(*((Gtk::Window*) this), geom, Gdk::HINT_MAX_SIZE | Gdk::HINT_RESIZE_INC);
125
126         set_keep_above (true);
127         set_border_width (0);
128
129         metrics_vpacker_left.pack_start (metrics_left, true, true);
130         metrics_vpacker_left.pack_start (metrics_spacer_left, false, false);
131         metrics_spacer_left.set_size_request(-1, 0);
132         metrics_spacer_left.set_spacing(0);
133
134         metrics_vpacker_right.pack_start (metrics_right, true, true);
135         metrics_vpacker_right.pack_start (metrics_spacer_right, false, false);
136         metrics_spacer_right.set_size_request(-1, 0);
137         metrics_spacer_right.set_spacing(0);
138
139         signal_delete_event().connect (sigc::mem_fun (*this, &Meterbridge::hide_window));
140         signal_configure_event().connect (sigc::mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
141         Route::SyncOrderKeys.connect (*this, invalidator (*this), boost::bind (&Meterbridge::sync_order_keys, this, _1), gui_context());
142         MeterStrip::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&Meterbridge::remove_strip, this, _1), gui_context());
143         MeterStrip::MetricChanged.connect (*this, invalidator (*this), boost::bind(&Meterbridge::resync_order, this), gui_context());
144         MeterStrip::ConfigurationChanged.connect (*this, invalidator (*this), boost::bind(&Meterbridge::queue_resize, this), gui_context());
145
146         /* work around ScrolledWindowViewport alignment mess Part one */
147         Gtk::HBox * yspc = manage (new Gtk::HBox());
148         yspc->set_size_request(-1, 1);
149         Gtk::VBox * xspc = manage (new Gtk::VBox());
150         xspc->pack_start(meterarea, true, true);
151         xspc->pack_start(*yspc, false, false);
152         yspc->show();
153         xspc->show();
154
155         meterarea.set_spacing(0);
156         scroller.set_shadow_type(Gtk::SHADOW_NONE);
157         scroller.set_border_width(0);
158         scroller.add (*xspc);
159         scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_NEVER);
160
161         global_hpacker.pack_start (metrics_vpacker_left, false, false);
162         global_hpacker.pack_start (scroller, true, true);
163         global_hpacker.pack_start (metrics_vpacker_right, false, false);
164
165         global_vpacker.pack_start (global_hpacker, true, true);
166         add (global_vpacker);
167
168         metrics_left.show();
169         metrics_right.show();
170
171         metrics_vpacker_left.show();
172         metrics_spacer_left.show();
173         metrics_vpacker_right.show();
174         metrics_spacer_right.show();
175
176         meterarea.show();
177         global_vpacker.show();
178         global_hpacker.show();
179         scroller.show();
180
181         /* the return of the ScrolledWindowViewport mess:
182          * remove shadow from scrollWindow's viewport
183          * see http://www.mail-archive.com/gtkmm-list@gnome.org/msg03509.html
184          */
185         Gtk::Viewport* viewport = (Gtk::Viewport*) scroller.get_child();
186         viewport->set_shadow_type(Gtk::SHADOW_NONE);
187         viewport->set_border_width(0);
188
189         UI::instance()->theme_changed.connect (sigc::mem_fun(*this, &Meterbridge::on_theme_changed));
190         ColorsChanged.connect (sigc::mem_fun (*this, &Meterbridge::on_theme_changed));
191         DPIReset.connect (sigc::mem_fun (*this, &Meterbridge::on_theme_changed));
192 }
193
194 Meterbridge::~Meterbridge ()
195 {
196         while (_metrics.size() > 0) {
197                 delete (_metrics.back());
198                 _metrics.pop_back();
199         }
200 }
201
202 void
203 Meterbridge::show_window ()
204 {
205         present();
206         if (!_visible) {
207                 set_window_pos_and_size ();
208         }
209         _visible = true;
210 }
211
212 /* code duplicated from gtk2_ardour/mixer_ui.cc  Mixer_UI::update_title() */
213 void
214 Meterbridge::update_title ()
215 {
216         if (_session) {
217                 string n;
218
219                 if (_session->snap_name() != _session->name()) {
220                         n = _session->snap_name ();
221                 } else {
222                         n = _session->name ();
223                 }
224
225                 if (_session->dirty ()) {
226                         n = "*" + n;
227                 }
228
229                 WindowTitle title (n);
230                 title += S_("Window|Meterbridge");
231                 title += Glib::get_application_name ();
232                 set_title (title.get_string());
233
234         } else {
235
236                 WindowTitle title (S_("Window|Meterbridge"));
237                 title += Glib::get_application_name ();
238                 set_title (title.get_string());
239         }
240 }
241
242 void
243 Meterbridge::set_window_pos_and_size ()
244 {
245         resize (m_width, m_height);
246         if (m_root_x >= 0 && m_root_y >= 0) {
247                 move (m_root_x, m_root_y);
248         }
249 }
250
251 void
252 Meterbridge::get_window_pos_and_size ()
253 {
254         get_position(m_root_x, m_root_y);
255         get_size(m_width, m_height);
256 }
257
258 bool
259 Meterbridge::hide_window (GdkEventAny *ev)
260 {
261         if (!_visible) return 0;
262         get_window_pos_and_size();
263         _visible = false;
264         return just_hide_it(ev, static_cast<Gtk::Window *>(this));
265 }
266
267 bool
268 Meterbridge::on_key_press_event (GdkEventKey* ev)
269 {
270         if (gtk_window_propagate_key_event (GTK_WINDOW(gobj()), ev)) {
271                 return true;
272         }
273         return forward_key_press (ev);
274 }
275
276 bool
277 Meterbridge::on_key_release_event (GdkEventKey* ev)
278 {
279         if (gtk_window_propagate_key_event (GTK_WINDOW(gobj()), ev)) {
280                 return true;
281         }
282         /* don't forward releases */
283         return true;
284 }
285
286 bool
287 Meterbridge::on_scroll_event (GdkEventScroll* ev)
288 {
289         switch (ev->direction) {
290         case GDK_SCROLL_LEFT:
291                 scroll_left ();
292                 return true;
293         case GDK_SCROLL_UP:
294                 if (ev->state & Keyboard::TertiaryModifier) {
295                         scroll_left ();
296                         return true;
297                 }
298                 return false;
299
300         case GDK_SCROLL_RIGHT:
301                 scroll_right ();
302                 return true;
303
304         case GDK_SCROLL_DOWN:
305                 if (ev->state & Keyboard::TertiaryModifier) {
306                         scroll_right ();
307                         return true;
308                 }
309                 return false;
310         }
311
312         return false;
313 }
314
315 void
316 Meterbridge::scroll_left ()
317 {
318         if (!scroller.get_hscrollbar()) return;
319         Adjustment* adj = scroller.get_hscrollbar()->get_adjustment();
320         /* stupid GTK: can't rely on clamping across versions */
321         scroller.get_hscrollbar()->set_value (max (adj->get_lower(), adj->get_value() - adj->get_step_increment()));
322 }
323
324 void
325 Meterbridge::scroll_right ()
326 {
327         if (!scroller.get_hscrollbar()) return;
328         Adjustment* adj = scroller.get_hscrollbar()->get_adjustment();
329         /* stupid GTK: can't rely on clamping across versions */
330         scroller.get_hscrollbar()->set_value (min (adj->get_upper(), adj->get_value() + adj->get_step_increment()));
331 }
332
333 void
334 Meterbridge::on_size_request (Gtk::Requisition* r)
335 {
336         meter_clear_pattern_cache(3);
337         Gtk::Window::on_size_request(r);
338
339         Gdk::Geometry geom;
340         Gtk::Requisition mr = meterarea.size_request();
341         geom.max_width = mr.width + metrics_left.get_width() + metrics_right.get_width();
342         geom.max_height = max_height;
343
344         if (cur_max_width != geom.max_width) {
345                 cur_max_width = geom.max_width;
346                 geom.height_inc = 16;
347                 geom.width_inc = 1;
348                 set_geometry_hints(*((Gtk::Window*) this), geom, Gdk::HINT_MAX_SIZE | Gdk::HINT_RESIZE_INC);
349         }
350 }
351
352 void
353 Meterbridge::on_size_allocate (Gtk::Allocation& a)
354 {
355         const Gtk::Scrollbar * hsc = scroller.get_hscrollbar();
356
357         if (scroller.get_hscrollbar_visible() && hsc) {
358                 gint scrollbar_spacing;
359                 gtk_widget_style_get (GTK_WIDGET (scroller.gobj()),
360                                 "scrollbar-spacing", &scrollbar_spacing, NULL);
361                 const int h = hsc->get_height() + scrollbar_spacing + 1;
362                 metrics_spacer_left.set_size_request(-1, h);
363                 metrics_spacer_right.set_size_request(-1, h);
364         } else {
365                 metrics_spacer_left.set_size_request(-1, 0);
366                 metrics_spacer_right.set_size_request(-1, 0);
367         }
368         Gtk::Window::on_size_allocate(a);
369 }
370
371 void
372 Meterbridge::set_session (Session* s)
373 {
374         SessionHandlePtr::set_session (s);
375
376         if (!_session) {
377                 return;
378         }
379
380         metrics_left.set_session(s);
381         metrics_right.set_session(s);
382
383         XMLNode* node = _session->instant_xml(X_("Meterbridge"));
384         if (node) {
385                 set_state (*node);
386         }
387
388         update_title ();
389         _show_busses = _session->config.get_show_busses_on_meterbridge();
390         _show_master = _session->config.get_show_master_on_meterbridge();
391         _show_midi = _session->config.get_show_midi_on_meterbridge();
392
393         SignalOrderRouteSorter sorter;
394         boost::shared_ptr<RouteList> routes = _session->get_routes();
395
396         RouteList copy(*routes);
397         copy.sort(sorter);
398         add_strips(copy);
399
400         _session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::add_strips, this, _1), gui_context());
401         _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::update_title, this), gui_context());
402         _session->StateSaved.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::update_title, this), gui_context());
403         _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&Meterbridge::parameter_changed, this, _1), gui_context());
404         Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&Meterbridge::parameter_changed, this, _1), gui_context());
405
406         if (_visible) {
407                 show_window();
408                 ActionManager::check_toggleaction ("<Actions>/Common/toggle-meterbridge");
409         }
410         start_updating ();
411 }
412
413 void
414 Meterbridge::session_going_away ()
415 {
416         ENSURE_GUI_THREAD (*this, &Meterbridge::session_going_away);
417
418         for (list<MeterBridgeStrip>::iterator i = strips.begin(); i != strips.end(); ++i) {
419                 delete ((*i).s);
420         }
421
422         strips.clear ();
423         stop_updating ();
424
425         SessionHandlePtr::session_going_away ();
426
427         _session = 0;
428         update_title ();
429 }
430
431 int
432 Meterbridge::set_state (const XMLNode& node)
433 {
434         const XMLProperty* prop;
435         XMLNode* geometry;
436
437         m_width = default_width;
438         m_height = default_height;
439         m_root_x = 1;
440         m_root_y = 1;
441
442         if ((geometry = find_named_node (node, "geometry")) != 0) {
443
444                 XMLProperty* prop;
445
446                 if ((prop = geometry->property("x_size")) == 0) {
447                         prop = geometry->property ("x-size");
448                 }
449                 if (prop) {
450                         m_width = atoi(prop->value());
451                 }
452                 if ((prop = geometry->property("y_size")) == 0) {
453                         prop = geometry->property ("y-size");
454                 }
455                 if (prop) {
456                         m_height = atoi(prop->value());
457                 }
458
459                 if ((prop = geometry->property ("x_pos")) == 0) {
460                         prop = geometry->property ("x-pos");
461                 }
462                 if (prop) {
463                         m_root_x = atoi (prop->value());
464
465                 }
466                 if ((prop = geometry->property ("y_pos")) == 0) {
467                         prop = geometry->property ("y-pos");
468                 }
469                 if (prop) {
470                         m_root_y = atoi (prop->value());
471                 }
472         }
473
474         set_window_pos_and_size ();
475
476         if ((prop = node.property ("show-meterbridge"))) {
477                 if (string_is_affirmative (prop->value())) {
478                        _visible = true;
479                 }
480         }
481
482         return 0;
483 }
484
485 XMLNode&
486 Meterbridge::get_state (void)
487 {
488         char buf[32];
489         XMLNode* node = new XMLNode ("Meterbridge");
490
491         if (is_realized() && _visible) {
492                 get_window_pos_and_size ();
493         }
494
495         XMLNode* geometry = new XMLNode ("geometry");
496         snprintf(buf, sizeof(buf), "%d", m_width);
497         geometry->add_property(X_("x_size"), string(buf));
498         snprintf(buf, sizeof(buf), "%d", m_height);
499         geometry->add_property(X_("y_size"), string(buf));
500         snprintf(buf, sizeof(buf), "%d", m_root_x);
501         geometry->add_property(X_("x_pos"), string(buf));
502         snprintf(buf, sizeof(buf), "%d", m_root_y);
503         geometry->add_property(X_("y_pos"), string(buf));
504         node->add_child_nocopy (*geometry);
505
506         node->add_property ("show-meterbridge", _visible ? "yes" : "no");
507         return *node;
508 }
509
510
511 gint
512 Meterbridge::start_updating ()
513 {
514         fast_screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect (sigc::mem_fun(*this, &Meterbridge::fast_update_strips));
515         return 0;
516 }
517
518 gint
519 Meterbridge::stop_updating ()
520 {
521         fast_screen_update_connection.disconnect();
522         return 0;
523 }
524
525 void
526 Meterbridge::fast_update_strips ()
527 {
528         if (!is_mapped () || !_session) {
529                 return;
530         }
531         for (list<MeterBridgeStrip>::iterator i = strips.begin(); i != strips.end(); ++i) {
532                 if (!(*i).visible) continue;
533                 (*i).s->fast_update ();
534         }
535 }
536
537 void
538 Meterbridge::add_strips (RouteList& routes)
539 {
540         MeterStrip* strip;
541         for (RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
542                 boost::shared_ptr<Route> route = (*x);
543                 if (route->is_auditioner()) {
544                         continue;
545                 }
546                 if (route->is_monitor()) {
547                         continue;
548                 }
549
550                 strip = new MeterStrip (_session, route);
551                 strips.push_back (MeterBridgeStrip(strip));
552                 route->active_changed.connect (*this, invalidator (*this), boost::bind (&Meterbridge::resync_order, this), gui_context ());
553
554                 meterarea.pack_start (*strip, false, false);
555                 strip->show();
556         }
557
558         resync_order();
559 }
560
561 void
562 Meterbridge::remove_strip (MeterStrip* strip)
563 {
564         if (_session && _session->deletion_in_progress()) {
565                 return;
566         }
567
568         list<MeterBridgeStrip>::iterator i;
569         for (list<MeterBridgeStrip>::iterator i = strips.begin(); i != strips.end(); ++i) {
570                 if ( (*i).s == strip) {
571                         strips.erase (i);
572                         break;
573                 }
574         }
575 }
576
577 void
578 Meterbridge::sync_order_keys (RouteSortOrderKey src)
579 {
580         Glib::Threads::Mutex::Lock lm (_resync_mutex);
581
582         MeterOrderRouteSorter sorter;
583         strips.sort(sorter);
584
585         int pos = 0;
586         int vis = 0;
587
588         unsigned int metrics = 0;
589         MeterType lmt = MeterPeak;
590         bool have_midi = false;
591         metrics_left.set_metric_mode(1, lmt);
592
593         for (list<MeterBridgeStrip>::iterator i = strips.begin(); i != strips.end(); ++i) {
594
595                 if (! (*i).s->route()->active()) {
596                         (*i).s->hide();
597                         (*i).visible = false;
598                 }
599                 else if ((*i).s->route()->is_master()) {
600                         if (_show_master) {
601                                 (*i).s->show();
602                                 (*i).visible = true;
603                                 vis++;
604                         } else {
605                                 (*i).s->hide();
606                                 (*i).visible = false;
607                         }
608                 }
609                 else if (boost::dynamic_pointer_cast<AudioTrack>((*i).s->route()) == 0
610                                 && boost::dynamic_pointer_cast<MidiTrack>((*i).s->route()) == 0
611                                 ) {
612                         /* non-master bus */
613                         if (_show_busses) {
614                                 (*i).s->show();
615                                 (*i).visible = true;
616                                 vis++;
617                         } else {
618                                 (*i).s->hide();
619                                 (*i).visible = false;
620                         }
621                 }
622                 else if (boost::dynamic_pointer_cast<MidiTrack>((*i).s->route())) {
623                         if (_show_midi) {
624                                 (*i).s->show();
625                                 (*i).visible = true;
626                                 vis++;
627                         } else {
628                                 (*i).s->hide();
629                                 (*i).visible = false;
630                         }
631                 }
632                 else {
633                         (*i).s->show();
634                         (*i).visible = true;
635                                 vis++;
636                 }
637
638                 MeterType nmt = (*i).s->meter_type();
639                 if (nmt == MeterKrms) nmt = MeterPeak; // identical metrics
640
641                 if ((*i).visible && nmt != lmt && pos == 0) {
642                         lmt = nmt;
643                         metrics_left.set_metric_mode(1, lmt);
644                 } else if ((*i).visible && nmt != lmt) {
645
646                         if (_metrics.size() <= metrics) {
647                                 _metrics.push_back(new MeterStrip(have_midi ? 2 : 3, lmt));
648                                 meterarea.pack_start (*_metrics[metrics], false, false);
649                                 _metrics[metrics]->set_session(_session);
650                                 _metrics[metrics]->show();
651                         } else {
652                                 _metrics[metrics]->set_metric_mode(have_midi ? 2 : 3, lmt);
653                         }
654                         meterarea.reorder_child(*_metrics[metrics], pos++);
655                         metrics++;
656
657                         lmt = nmt;
658
659                         if (_metrics.size() <= metrics) {
660                                 _metrics.push_back(new MeterStrip(1, lmt));
661                                 meterarea.pack_start (*_metrics[metrics], false, false);
662                                 _metrics[metrics]->set_session(_session);
663                                 _metrics[metrics]->show();
664                         } else {
665                                 _metrics[metrics]->set_metric_mode(1, lmt);
666                         }
667                         meterarea.reorder_child(*_metrics[metrics], pos++);
668                         metrics++;
669                         have_midi = false;
670                 }
671
672                 if ((*i).visible && (*i).s->has_midi()) {
673                         have_midi = true;
674                 }
675
676                 meterarea.reorder_child(*((*i).s), pos++);
677         }
678
679         metrics_right.set_metric_mode(have_midi ? 2 : 3, lmt);
680
681         while (_metrics.size() > metrics) {
682                 meterarea.remove(*_metrics.back());
683                 delete (_metrics.back());
684                 _metrics.pop_back();
685         }
686 }
687
688 void
689 Meterbridge::resync_order()
690 {
691         sync_order_keys(MixerSort);
692 }
693
694 void
695 Meterbridge::parameter_changed (std::string const & p)
696 {
697         if (p == "show-busses-on-meterbridge") {
698                 _show_busses = _session->config.get_show_busses_on_meterbridge();
699                 resync_order();
700         }
701         else if (p == "show-master-on-meterbridge") {
702                 _show_master = _session->config.get_show_master_on_meterbridge();
703                 resync_order();
704         }
705         else if (p == "show-midi-on-meterbridge") {
706                 _show_midi = _session->config.get_show_midi_on_meterbridge();
707                 resync_order();
708         }
709         else if (p == "meter-line-up-level") {
710                 meter_clear_pattern_cache();
711         }
712         else if (p == "show-rec-on-meterbridge") {
713                 scroller.queue_resize();
714         }
715         else if (p == "show-mute-on-meterbridge") {
716                 scroller.queue_resize();
717         }
718         else if (p == "show-solo-on-meterbridge") {
719                 scroller.queue_resize();
720         }
721         else if (p == "show-name-on-meterbridge") {
722                 scroller.queue_resize();
723         }
724 }
725
726 void
727 Meterbridge::on_theme_changed ()
728 {
729         meter_clear_pattern_cache();
730 }