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