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