2 Copyright (C) 2012 Paul Davis
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.
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.
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.
22 #include "gtk2ardour-config.h"
26 #include <sigc++/bind.h>
28 #include <gtkmm/accelmap.h>
30 #include <glibmm/threads.h>
32 #include <gtkmm2ext/gtk_ui.h>
33 #include <gtkmm2ext/utils.h>
34 #include <gtkmm2ext/window_title.h>
36 #include "ardour/debug.h"
37 #include "ardour/midi_track.h"
38 #include "ardour/route_group.h"
39 #include "ardour/session.h"
41 #include "ardour/audio_track.h"
42 #include "ardour/midi_track.h"
44 #include "meterbridge.h"
47 #include "monitor_section.h"
48 #include "public_editor.h"
49 #include "ardour_ui.h"
51 #include "route_sorter.h"
53 #include "gui_thread.h"
54 #include "global_signals.h"
55 #include "meter_patterns.h"
59 using namespace ARDOUR;
63 using namespace Gtkmm2ext;
65 using namespace ArdourMeter;
69 Meterbridge* Meterbridge::_instance = 0;
72 Meterbridge::instance ()
75 _instance = new Meterbridge;
81 /* copy from gtk2_ardour/mixer_ui.cc -- TODO consolidate
82 * used by Meterbridge::set_session() below
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
91 } else if (b->is_master() || b->is_monitor()) {
92 /* everything comes before b */
95 return a->order_key () < b->order_key ();
99 Meterbridge::Meterbridge ()
100 : Window (Gtk::WINDOW_TOPLEVEL)
101 , VisibilityTracker (*((Gtk::Window*) this))
103 , _show_busses (false)
104 , metrics_left (1, MeterPeak)
105 , metrics_right (2, MeterPeak)
108 set_name ("Meter Bridge");
110 m_width = default_width;
111 m_height = default_height;
117 set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
120 geom.max_width = 1<<16;
121 geom.max_height = max_height;
122 geom.height_inc = 16;
124 set_geometry_hints(*((Gtk::Window*) this), geom, Gdk::HINT_MAX_SIZE | Gdk::HINT_RESIZE_INC);
126 set_keep_above (true);
127 set_border_width (0);
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);
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);
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), 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());
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);
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);
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);
165 global_vpacker.pack_start (global_hpacker, true, true);
166 add (global_vpacker);
169 metrics_right.show();
171 metrics_vpacker_left.show();
172 metrics_spacer_left.show();
173 metrics_vpacker_right.show();
174 metrics_spacer_right.show();
177 global_vpacker.show();
178 global_hpacker.show();
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
185 Gtk::Viewport* viewport = (Gtk::Viewport*) scroller.get_child();
186 viewport->set_shadow_type(Gtk::SHADOW_NONE);
187 viewport->set_border_width(0);
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));
194 Meterbridge::~Meterbridge ()
196 while (_metrics.size() > 0) {
197 delete (_metrics.back());
203 Meterbridge::show_window ()
207 set_window_pos_and_size ();
212 /* code duplicated from gtk2_ardour/mixer_ui.cc Mixer_UI::update_title() */
214 Meterbridge::update_title ()
219 if (_session->snap_name() != _session->name()) {
220 n = _session->snap_name ();
222 n = _session->name ();
225 if (_session->dirty ()) {
229 WindowTitle title (n);
230 title += S_("Window|Meterbridge");
231 title += Glib::get_application_name ();
232 set_title (title.get_string());
236 WindowTitle title (S_("Window|Meterbridge"));
237 title += Glib::get_application_name ();
238 set_title (title.get_string());
243 Meterbridge::set_window_pos_and_size ()
245 resize (m_width, m_height);
246 if (m_root_x >= 0 && m_root_y >= 0) {
247 move (m_root_x, m_root_y);
252 Meterbridge::get_window_pos_and_size ()
254 get_position(m_root_x, m_root_y);
255 get_size(m_width, m_height);
259 Meterbridge::hide_window (GdkEventAny *ev)
261 if (!_visible) return 0;
262 get_window_pos_and_size();
264 return just_hide_it(ev, static_cast<Gtk::Window *>(this));
268 Meterbridge::on_key_press_event (GdkEventKey* ev)
270 if (gtk_window_propagate_key_event (GTK_WINDOW(gobj()), ev)) {
273 return forward_key_press (ev);
277 Meterbridge::on_key_release_event (GdkEventKey* ev)
279 if (gtk_window_propagate_key_event (GTK_WINDOW(gobj()), ev)) {
282 /* don't forward releases */
287 Meterbridge::on_scroll_event (GdkEventScroll* ev)
289 switch (ev->direction) {
290 case GDK_SCROLL_LEFT:
294 if (ev->state & Keyboard::TertiaryModifier) {
300 case GDK_SCROLL_RIGHT:
304 case GDK_SCROLL_DOWN:
305 if (ev->state & Keyboard::TertiaryModifier) {
316 Meterbridge::scroll_left ()
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()));
325 Meterbridge::scroll_right ()
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()));
334 Meterbridge::on_size_request (Gtk::Requisition* r)
336 meter_clear_pattern_cache(3);
337 Gtk::Window::on_size_request(r);
340 Gtk::Requisition mr = meterarea.size_request();
342 geom.max_width = mr.width + metrics_left.get_width() + metrics_right.get_width();
343 geom.max_height = max_height;
346 /* on OSX this leads to a constant live-loop: show/hide scrollbar
347 * on Linux, the window is resized IFF the scrollbar was not visible
349 const Gtk::Scrollbar * hsc = scroller.get_hscrollbar();
350 Glib::RefPtr<Gdk::Screen> screen = get_screen ();
351 Gdk::Rectangle monitor_rect;
352 screen->get_monitor_geometry (0, monitor_rect);
353 const int scr_w = monitor_rect.get_width() - 44;
355 if (cur_max_width < geom.max_width
356 && cur_max_width < scr_w
357 && !(scroller.get_hscrollbar_visible() && hsc)) {
359 *r = Gtk::Requisition();
360 r->width = geom.max_width;
365 if (cur_max_width != geom.max_width) {
366 cur_max_width = geom.max_width;
367 geom.height_inc = 16;
369 set_geometry_hints(*((Gtk::Window*) this), geom, Gdk::HINT_MAX_SIZE | Gdk::HINT_RESIZE_INC);
374 Meterbridge::on_size_allocate (Gtk::Allocation& a)
376 const Gtk::Scrollbar * hsc = scroller.get_hscrollbar();
378 if (scroller.get_hscrollbar_visible() && hsc) {
379 if (!scroll_connection.connected()) {
380 scroll_connection = scroller.get_hscrollbar()->get_adjustment()->signal_value_changed().connect(sigc::mem_fun (*this, &Meterbridge::on_scroll));
381 scroller.get_hscrollbar()->get_adjustment()->signal_changed().connect(sigc::mem_fun (*this, &Meterbridge::on_scroll));
383 gint scrollbar_spacing;
384 gtk_widget_style_get (GTK_WIDGET (scroller.gobj()),
385 "scrollbar-spacing", &scrollbar_spacing, NULL);
386 const int h = hsc->get_height() + scrollbar_spacing + 1;
387 metrics_spacer_left.set_size_request(-1, h);
388 metrics_spacer_right.set_size_request(-1, h);
390 metrics_spacer_left.set_size_request(-1, 0);
391 metrics_spacer_right.set_size_request(-1, 0);
393 Gtk::Window::on_size_allocate(a);
397 Meterbridge::on_scroll()
399 if (!scroller.get_hscrollbar()) return;
401 Adjustment* adj = scroller.get_hscrollbar()->get_adjustment();
402 int leftend = adj->get_value();
403 int rightend = scroller.get_width() + leftend;
405 int mm_left = _mm_left;
406 int mm_right = _mm_right;
407 ARDOUR::MeterType mt_left = _mt_left;
408 ARDOUR::MeterType mt_right = _mt_right;
410 for (unsigned int i = 0; i < _metrics.size(); ++i) {
412 int mm = _metrics[i]->get_metric_mode();
413 sx = (mm & 2) ? _metrics[i]->get_width() : 0;
415 _metrics[i]->translate_coordinates(meterarea, sx, 0, dx, dy);
417 if (dx < leftend && !(mm&2)) {
419 mt_left = _metrics[i]->meter_type();
421 if (dx > rightend && (mm&2)) {
423 mt_right = _metrics[i]->meter_type();
427 metrics_left.set_metric_mode(mm_left, mt_left);
428 metrics_right.set_metric_mode(mm_right, mt_right);
432 Meterbridge::set_session (Session* s)
434 SessionHandlePtr::set_session (s);
440 metrics_left.set_session(s);
441 metrics_right.set_session(s);
443 XMLNode* node = _session->instant_xml(X_("Meterbridge"));
449 _show_busses = _session->config.get_show_busses_on_meterbridge();
450 _show_master = _session->config.get_show_master_on_meterbridge();
451 _show_midi = _session->config.get_show_midi_on_meterbridge();
453 SignalOrderRouteSorter sorter;
454 boost::shared_ptr<RouteList> routes = _session->get_routes();
456 RouteList copy(*routes);
460 _session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::add_strips, this, _1), gui_context());
461 _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::update_title, this), gui_context());
462 _session->StateSaved.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::update_title, this), gui_context());
463 _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&Meterbridge::parameter_changed, this, _1), gui_context());
464 Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&Meterbridge::parameter_changed, this, _1), gui_context());
468 ActionManager::check_toggleaction ("<Actions>/Common/toggle-meterbridge");
474 Meterbridge::session_going_away ()
476 ENSURE_GUI_THREAD (*this, &Meterbridge::session_going_away);
478 for (list<MeterBridgeStrip>::iterator i = strips.begin(); i != strips.end(); ++i) {
485 SessionHandlePtr::session_going_away ();
492 Meterbridge::set_state (const XMLNode& node)
494 const XMLProperty* prop;
497 m_width = default_width;
498 m_height = default_height;
502 if ((geometry = find_named_node (node, "geometry")) != 0) {
506 if ((prop = geometry->property("x_size")) == 0) {
507 prop = geometry->property ("x-size");
510 m_width = atoi(prop->value());
512 if ((prop = geometry->property("y_size")) == 0) {
513 prop = geometry->property ("y-size");
516 m_height = atoi(prop->value());
519 if ((prop = geometry->property ("x_pos")) == 0) {
520 prop = geometry->property ("x-pos");
523 m_root_x = atoi (prop->value());
526 if ((prop = geometry->property ("y_pos")) == 0) {
527 prop = geometry->property ("y-pos");
530 m_root_y = atoi (prop->value());
534 set_window_pos_and_size ();
536 if ((prop = node.property ("show-meterbridge"))) {
537 if (string_is_affirmative (prop->value())) {
546 Meterbridge::get_state (void)
549 XMLNode* node = new XMLNode ("Meterbridge");
551 if (is_realized() && _visible) {
552 get_window_pos_and_size ();
555 XMLNode* geometry = new XMLNode ("geometry");
556 snprintf(buf, sizeof(buf), "%d", m_width);
557 geometry->add_property(X_("x_size"), string(buf));
558 snprintf(buf, sizeof(buf), "%d", m_height);
559 geometry->add_property(X_("y_size"), string(buf));
560 snprintf(buf, sizeof(buf), "%d", m_root_x);
561 geometry->add_property(X_("x_pos"), string(buf));
562 snprintf(buf, sizeof(buf), "%d", m_root_y);
563 geometry->add_property(X_("y_pos"), string(buf));
564 node->add_child_nocopy (*geometry);
566 node->add_property ("show-meterbridge", _visible ? "yes" : "no");
572 Meterbridge::start_updating ()
574 fast_screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect (sigc::mem_fun(*this, &Meterbridge::fast_update_strips));
579 Meterbridge::stop_updating ()
581 fast_screen_update_connection.disconnect();
586 Meterbridge::fast_update_strips ()
588 if (!is_mapped () || !_session) {
591 for (list<MeterBridgeStrip>::iterator i = strips.begin(); i != strips.end(); ++i) {
592 if (!(*i).visible) continue;
593 (*i).s->fast_update ();
598 Meterbridge::add_strips (RouteList& routes)
601 for (RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
602 boost::shared_ptr<Route> route = (*x);
603 if (route->is_auditioner()) {
606 if (route->is_monitor()) {
610 strip = new MeterStrip (_session, route);
611 strips.push_back (MeterBridgeStrip(strip));
612 route->active_changed.connect (*this, invalidator (*this), boost::bind (&Meterbridge::resync_order, this), gui_context ());
614 meterarea.pack_start (*strip, false, false);
622 Meterbridge::remove_strip (MeterStrip* strip)
624 if (_session && _session->deletion_in_progress()) {
628 list<MeterBridgeStrip>::iterator i;
629 for (list<MeterBridgeStrip>::iterator i = strips.begin(); i != strips.end(); ++i) {
630 if ( (*i).s == strip) {
640 Meterbridge::sync_order_keys ()
642 Glib::Threads::Mutex::Lock lm (_resync_mutex);
644 MeterOrderRouteSorter sorter;
649 MeterStrip * last = 0;
651 unsigned int metrics = 0;
652 MeterType lmt = MeterPeak;
653 bool have_midi = false;
654 metrics_left.set_metric_mode(1, lmt);
656 for (list<MeterBridgeStrip>::iterator i = strips.begin(); i != strips.end(); ++i) {
658 if (! (*i).s->route()->active()) {
660 (*i).visible = false;
662 else if ((*i).s->route()->is_master()) {
669 (*i).visible = false;
672 else if (boost::dynamic_pointer_cast<AudioTrack>((*i).s->route()) == 0
673 && boost::dynamic_pointer_cast<MidiTrack>((*i).s->route()) == 0
682 (*i).visible = false;
685 else if (boost::dynamic_pointer_cast<MidiTrack>((*i).s->route())) {
692 (*i).visible = false;
701 (*i).s->set_tick_bar(0);
703 MeterType nmt = (*i).s->meter_type();
704 if (nmt == MeterKrms) nmt = MeterPeak; // identical metrics
706 (*i).s->set_tick_bar(1);
709 if ((*i).visible && nmt != lmt && vis == 1) {
711 metrics_left.set_metric_mode(1, lmt);
712 } else if ((*i).visible && nmt != lmt) {
715 last->set_tick_bar(last->get_tick_bar() | 2);
717 (*i).s->set_tick_bar((*i).s->get_tick_bar() | 1);
719 if (_metrics.size() <= metrics) {
720 _metrics.push_back(new MeterStrip(have_midi ? 2 : 3, lmt));
721 meterarea.pack_start (*_metrics[metrics], false, false);
722 _metrics[metrics]->set_session(_session);
723 _metrics[metrics]->show();
725 _metrics[metrics]->set_metric_mode(have_midi ? 2 : 3, lmt);
727 meterarea.reorder_child(*_metrics[metrics], pos++);
732 if (_metrics.size() <= metrics) {
733 _metrics.push_back(new MeterStrip(1, lmt));
734 meterarea.pack_start (*_metrics[metrics], false, false);
735 _metrics[metrics]->set_session(_session);
736 _metrics[metrics]->show();
738 _metrics[metrics]->set_metric_mode(1, lmt);
740 meterarea.reorder_child(*_metrics[metrics], pos++);
745 if ((*i).visible && (*i).s->has_midi()) {
749 meterarea.reorder_child(*((*i).s), pos++);
756 last->set_tick_bar(last->get_tick_bar() | 2);
759 metrics_right.set_metric_mode(have_midi ? 2 : 3, lmt);
761 while (_metrics.size() > metrics) {
762 meterarea.remove(*_metrics.back());
763 delete (_metrics.back());
767 _mm_left = metrics_left.get_metric_mode();
768 _mt_left = metrics_left.meter_type();
769 _mm_right = metrics_right.get_metric_mode();
770 _mt_right = metrics_right.meter_type();
777 Meterbridge::resync_order()
783 Meterbridge::parameter_changed (std::string const & p)
785 if (p == "show-busses-on-meterbridge") {
786 _show_busses = _session->config.get_show_busses_on_meterbridge();
789 else if (p == "show-master-on-meterbridge") {
790 _show_master = _session->config.get_show_master_on_meterbridge();
793 else if (p == "show-midi-on-meterbridge") {
794 _show_midi = _session->config.get_show_midi_on_meterbridge();
797 else if (p == "meter-line-up-level") {
798 meter_clear_pattern_cache();
800 else if (p == "show-rec-on-meterbridge") {
801 scroller.queue_resize();
803 else if (p == "show-mute-on-meterbridge") {
804 scroller.queue_resize();
806 else if (p == "show-solo-on-meterbridge") {
807 scroller.queue_resize();
809 else if (p == "show-name-on-meterbridge") {
810 scroller.queue_resize();
812 else if (p == "meterbridge-label-height") {
813 scroller.queue_resize();
818 Meterbridge::on_theme_changed ()
820 meter_clear_pattern_cache();