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 {
 122         set_name ("Meter Bridge");
 123
 124         update_title ();
 125
 126         set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
 127
 128         Gdk::Geometry geom;
 129         geom.max_width = 1<<16;
 130         geom.max_height = 1024; // XXX see FastMeter::max_pattern_metric_size
 131         set_geometry_hints(*((Gtk::Window*) this), geom, Gdk::HINT_MAX_SIZE);
 132
 133         /* disable "maximize" button because it overrides size hint from above,
 134          * this also keeps window on top..
 135          */
 136         set_type_hint(Gdk::WINDOW_TYPE_HINT_UTILITY);
 137
 138         metrics_left = manage(new MeterStrip (2));
 139         global_hpacker.pack_start (*metrics_left, false, false);
 140         metrics_left->show();
 141
 142         metrics_right = manage(new MeterStrip (3));
 143         global_hpacker.pack_start (*metrics_right, false, false);
 144         metrics_right->show();
 145
 146         signal_delete_event().connect (sigc::mem_fun (*this, &Meterbridge::hide_window));
 147         signal_configure_event().connect (sigc::mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
 148         Route::SyncOrderKeys.connect (*this, invalidator (*this), boost::bind (&Meterbridge::sync_order_keys, this, _1), gui_context());
 149         MeterStrip::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&Meterbridge::remove_strip, this, _1), gui_context());
 150
 151         global_hpacker.set_spacing(0);
 152         scroller.add (global_hpacker);
 153         scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_NEVER);
 154         global_vpacker.pack_start (scroller, true, true);
 155         add (global_vpacker);
 156
 157         global_hpacker.show();
 158         global_vpacker.show();
 159         scroller.show();
 160 }
 161
 162 Meterbridge::~Meterbridge ()
 163 {
 164 }
 165
 166 void
 167 Meterbridge::show_window ()
 168 {
 169         present();
 170         if (!_visible) {
 171                 set_window_pos_and_size ();
 172         }
 173         _visible = true;
 174 }
 175
 176 /* code duplicated from gtk2_ardour/mixer_ui.cc  Mixer_UI::update_title() */
 177 void
 178 Meterbridge::update_title ()
 179 {
 180         if (_session) {
 181                 string n;
 182
 183                 if (_session->snap_name() != _session->name()) {
 184                         n = _session->snap_name ();
 185                 } else {
 186                         n = _session->name ();
 187                 }
 188
 189                 if (_session->dirty ()) {
 190                         n = "*" + n;
 191                 }
 192
 193                 WindowTitle title (n);
 194                 title += S_("Window|Meterbridge");
 195                 title += Glib::get_application_name ();
 196                 set_title (title.get_string());
 197
 198         } else {
 199
 200                 WindowTitle title (S_("Window|Meterbridge"));
 201                 title += Glib::get_application_name ();
 202                 set_title (title.get_string());
 203         }
 204 }
 205
 206 void
 207 Meterbridge::set_window_pos_and_size ()
 208 {
 209         resize (m_width, m_height);
 210         move (m_root_x, m_root_y);
 211 }
 212
 213 void
 214 Meterbridge::get_window_pos_and_size ()
 215 {
 216         get_position(m_root_x, m_root_y);
 217         get_size(m_width, m_height);
 218 }
 219
 220 bool
 221 Meterbridge::hide_window (GdkEventAny *ev)
 222 {
 223         get_window_pos_and_size();
 224         _visible = false;
 225         return just_hide_it(ev, static_cast<Gtk::Window *>(this));
 226 }
 227
 228 bool
 229 Meterbridge::on_key_press_event (GdkEventKey* ev)
 230 {
 231         if (gtk_window_propagate_key_event (GTK_WINDOW(gobj()), ev)) {
 232                 return true;
 233         }
 234         return forward_key_press (ev);
 235 }
 236
 237 bool
 238 Meterbridge::on_key_release_event (GdkEventKey* ev)
 239 {
 240         if (gtk_window_propagate_key_event (GTK_WINDOW(gobj()), ev)) {
 241                 return true;
 242         }
 243         /* don't forward releases */
 244         return true;
 245 }
 246
 247 void
 248 Meterbridge::set_session (Session* s)
 249 {
 250         SessionHandlePtr::set_session (s);
 251
 252         if (!_session) {
 253                 return;
 254         }
 255
 256         XMLNode* node = _session->instant_xml(X_("Meterbridge"));
 257         if (node) {
 258                 set_state (*node);
 259         }
 260
 261         update_title ();
 262         _show_busses = _session->config.get_show_busses_in_meterbridge();
 263
 264         SignalOrderRouteSorter sorter;
 265         boost::shared_ptr<RouteList> routes = _session->get_routes();
 266
 267         RouteList copy(*routes);
 268         copy.sort(sorter);
 269         add_strips(copy);
 270
 271         _session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::add_strips, this, _1), gui_context());
 272         _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::update_title, this), gui_context());
 273         _session->StateSaved.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::update_title, this), gui_context());
 274         _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&Meterbridge::parameter_changed, this, _1), gui_context());
 275
 276         if (_visible) {
 277                 show_window();
 278                 ActionManager::check_toggleaction ("<Actions>/Common/toggle-meterbridge");
 279         }
 280         start_updating ();
 281 }
 282
 283 void
 284 Meterbridge::session_going_away ()
 285 {
 286         ENSURE_GUI_THREAD (*this, &Meterbridge::session_going_away);
 287
 288         for (list<MeterStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
 289                 delete (*i);
 290         }
 291
 292         strips.clear ();
 293         stop_updating ();
 294
 295         SessionHandlePtr::session_going_away ();
 296
 297         _session = 0;
 298         update_title ();
 299 }
 300
 301 int
 302 Meterbridge::set_state (const XMLNode& node)
 303 {
 304         const XMLProperty* prop;
 305         XMLNode* geometry;
 306
 307         m_width = default_width;
 308         m_height = default_height;
 309         m_root_x = 1;
 310         m_root_y = 1;
 311
 312         if ((geometry = find_named_node (node, "geometry")) != 0) {
 313
 314                 XMLProperty* prop;
 315
 316                 if ((prop = geometry->property("x_size")) == 0) {
 317                         prop = geometry->property ("x-size");
 318                 }
 319                 if (prop) {
 320                         m_width = atoi(prop->value());
 321                 }
 322                 if ((prop = geometry->property("y_size")) == 0) {
 323                         prop = geometry->property ("y-size");
 324                 }
 325                 if (prop) {
 326                         m_height = atoi(prop->value());
 327                 }
 328
 329                 if ((prop = geometry->property ("x_pos")) == 0) {
 330                         prop = geometry->property ("x-pos");
 331                 }
 332                 if (prop) {
 333                         m_root_x = atoi (prop->value());
 334
 335                 }
 336                 if ((prop = geometry->property ("y_pos")) == 0) {
 337                         prop = geometry->property ("y-pos");
 338                 }
 339                 if (prop) {
 340                         m_root_y = atoi (prop->value());
 341                 }
 342         }
 343
 344         set_window_pos_and_size ();
 345
 346         if ((prop = node.property ("show-meterbridge"))) {
 347                 if (string_is_affirmative (prop->value())) {
 348                        _visible = true;
 349                 }
 350         }
 351
 352         return 0;
 353 }
 354
 355 XMLNode&
 356 Meterbridge::get_state (void)
 357 {
 358         XMLNode* node = new XMLNode ("Meterbridge");
 359
 360         if (is_realized()) {
 361                 Glib::RefPtr<Gdk::Window> win = get_window();
 362
 363                 get_window_pos_and_size ();
 364
 365                 XMLNode* geometry = new XMLNode ("geometry");
 366                 char buf[32];
 367                 snprintf(buf, sizeof(buf), "%d", m_width);
 368                 geometry->add_property(X_("x_size"), string(buf));
 369                 snprintf(buf, sizeof(buf), "%d", m_height);
 370                 geometry->add_property(X_("y_size"), string(buf));
 371                 snprintf(buf, sizeof(buf), "%d", m_root_x);
 372                 geometry->add_property(X_("x_pos"), string(buf));
 373                 snprintf(buf, sizeof(buf), "%d", m_root_y);
 374                 geometry->add_property(X_("y_pos"), string(buf));
 375                 node->add_child_nocopy (*geometry);
 376         }
 377
 378         node->add_property ("show-meterbridge", _visible ? "yes" : "no");
 379         return *node;
 380 }
 381
 382
 383 gint
 384 Meterbridge::start_updating ()
 385 {
 386         fast_screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect (sigc::mem_fun(*this, &Meterbridge::fast_update_strips));
 387         return 0;
 388 }
 389
 390 gint
 391 Meterbridge::stop_updating ()
 392 {
 393         fast_screen_update_connection.disconnect();
 394         return 0;
 395 }
 396
 397 void
 398 Meterbridge::fast_update_strips ()
 399 {
 400         if (!is_mapped () || !_session) {
 401                 return;
 402         }
 403         for (list<MeterStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
 404                 (*i)->fast_update ();
 405         }
 406 }
 407
 408 void
 409 Meterbridge::add_strips (RouteList& routes)
 410 {
 411         MeterStrip* strip;
 412         for (RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
 413                 boost::shared_ptr<Route> route = (*x);
 414                 if (route->is_auditioner()) {
 415                         continue;
 416                 }
 417                 if (route->is_monitor()) {
 418                         continue;
 419                 }
 420
 421                 strip = new MeterStrip (_session, route);
 422                 strips.push_back (strip);
 423
 424                 global_hpacker.pack_start (*strip, false, false);
 425                 strip->show();
 426         }
 427
 428         sync_order_keys(MixerSort);
 429 }
 430
 431 void
 432 Meterbridge::remove_strip (MeterStrip* strip)
 433 {
 434         if (_session && _session->deletion_in_progress()) {
 435                 return;
 436         }
 437
 438         list<MeterStrip *>::iterator i;
 439         if ((i = find (strips.begin(), strips.end(), strip)) != strips.end()) {
 440                 strips.erase (i);
 441         }
 442 }
 443
 444 void
 445 Meterbridge::sync_order_keys (RouteSortOrderKey src)
 446 {
 447         MeterOrderRouteSorter sorter;
 448         std::list<MeterStrip *> copy (strips);
 449         copy.sort(sorter);
 450
 451         int pos = 0;
 452         global_hpacker.reorder_child(*metrics_left, pos++);
 453
 454         for (list<MeterStrip *>::iterator i = copy.begin(); i != copy.end(); ++i) {
 455
 456 #if 0 // TODO subscribe to route active,inactive changes, merge w/ bus
 457                 if (! (*i)->route()->active()) {
 458                         (*i)->hide();
 459                 } else {
 460                         (*i)->show();
 461                 }
 462 #endif
 463
 464                 // TODO simplyfy, abstract ->is_bus()
 465                 if ((*i)->route()->is_master()) {
 466                         /* always show master */
 467                         (*i)->show();
 468                 }
 469                 else if (boost::dynamic_pointer_cast<AudioTrack>((*i)->route()) == 0
 470                                 && boost::dynamic_pointer_cast<MidiTrack>((*i)->route()) == 0
 471                                 ) {
 472                         /* non-master bus */
 473                         if (_show_busses) {
 474                                 (*i)->show();
 475                         } else {
 476                                 (*i)->hide();
 477                         }
 478                 }
 479                 else {
 480                         (*i)->show();
 481                 }
 482
 483                 global_hpacker.reorder_child(*(*i), pos++);
 484         }
 485         global_hpacker.reorder_child(*metrics_right, pos);
 486 }
 487
 488 void
 489 Meterbridge::parameter_changed (std::string const & p)
 490 {
 491         if (p == "show-busses-in-meterbridge") {
 492                 _show_busses = _session->config.get_show_busses_in_meterbridge();
 493                 sync_order_keys(MixerSort);
 494         }
 495 }