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