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