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 "meterbridge.h"
  42
  43 #include "monitor_section.h"
  44 #include "public_editor.h"
  45 #include "ardour_ui.h"
  46 #include "utils.h"
  47 #include "route_sorter.h"
  48 #include "actions.h"
  49 #include "gui_thread.h"
  50
  51 #include "i18n.h"
  52
  53 using namespace ARDOUR;
  54 using namespace PBD;
  55 using namespace Gtk;
  56 using namespace Glib;
  57 using namespace Gtkmm2ext;
  58 using namespace std;
  59
  60 using PBD::atoi;
  61
  62 Meterbridge* Meterbridge::_instance = 0;
  63
  64 Meterbridge*
  65 Meterbridge::instance ()
  66 {
  67         if (!_instance) {
  68                 _instance  = new Meterbridge;
  69         }
  70
  71         return _instance;
  72 }
  73
  74 /* copy from gtk2_ardour/mixer_ui.cc -- TODO consolidate
  75  * used by Meterbridge::set_session() below
  76  */
  77 struct SignalOrderRouteSorter {
  78         bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
  79                 if (a->is_master() || a->is_monitor()) {
  80                         /* "a" is a special route (master, monitor, etc), and comes
  81                          * last in the mixer ordering
  82                          */
  83                         return false;
  84                 } else if (b->is_master() || b->is_monitor()) {
  85                         /* everything comes before b */
  86                         return true;
  87                 }
  88                 return a->order_key (MixerSort) < b->order_key (MixerSort);
  89         }
  90 };
  91
  92 /* modified version of above
  93  * used in Meterbridge::sync_order_keys()
  94  */
  95 struct MeterOrderRouteSorter {
  96         bool operator() (MeterStrip *ma, MeterStrip *mb) {
  97                 boost::shared_ptr<Route> a = ma->route();
  98                 boost::shared_ptr<Route> b = mb->route();
  99                 if (a->is_master() || a->is_monitor()) {
 100                         /* "a" is a special route (master, monitor, etc), and comes
 101                          * last in the mixer ordering
 102                          */
 103                         return false;
 104                 } else if (b->is_master() || b->is_monitor()) {
 105                         /* everything comes before b */
 106                         return true;
 107                 }
 108                 return a->order_key (MixerSort) < b->order_key (MixerSort);
 109         }
 110 };
 111
 112
 113 Meterbridge::Meterbridge ()
 114         : Window (Gtk::WINDOW_TOPLEVEL)
 115         , VisibilityTracker (*((Gtk::Window*) this))
 116         , _visible (false)
 117 {
 118         set_name ("Meter Bridge");
 119
 120         update_title ();
 121
 122         set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
 123
 124         Gdk::Geometry geom;
 125         geom.max_width = 1<<16;
 126         geom.max_height = 1024; // XXX see FastMeter::max_pattern_metric_size
 127         set_geometry_hints(*((Gtk::Window*) this), geom, Gdk::HINT_MAX_SIZE);
 128
 129         /* disable "maximize" button because it overrides size hint from above,
 130          * this also keeps window on top..
 131          */
 132         set_type_hint(Gdk::WINDOW_TYPE_HINT_UTILITY);
 133
 134         signal_delete_event().connect (sigc::mem_fun (*this, &Meterbridge::hide_window));
 135         signal_configure_event().connect (sigc::mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
 136         Route::SyncOrderKeys.connect (*this, invalidator (*this), boost::bind (&Meterbridge::sync_order_keys, this, _1), gui_context());
 137
 138         MeterStrip::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&Meterbridge::remove_strip, this, _1), gui_context());
 139
 140         global_hpacker.set_spacing(1);
 141         scroller.add (global_hpacker);
 142         scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_NEVER);
 143         global_vpacker.pack_start (scroller, true, true);
 144         add (global_vpacker);
 145
 146         global_hpacker.show();
 147         global_vpacker.show();
 148         scroller.show();
 149 }
 150
 151 Meterbridge::~Meterbridge ()
 152 {
 153 }
 154
 155 void
 156 Meterbridge::show_window ()
 157 {
 158         present();
 159         if (!_visible) {
 160                 set_window_pos_and_size ();
 161         }
 162         _visible = true;
 163 }
 164
 165 /* code duplicated from gtk2_ardour/mixer_ui.cc  Mixer_UI::update_title() */
 166 void
 167 Meterbridge::update_title ()
 168 {
 169         if (_session) {
 170                 string n;
 171
 172                 if (_session->snap_name() != _session->name()) {
 173                         n = _session->snap_name ();
 174                 } else {
 175                         n = _session->name ();
 176                 }
 177
 178                 if (_session->dirty ()) {
 179                         n = "*" + n;
 180                 }
 181
 182                 WindowTitle title (n);
 183                 title += S_("Window|Meterbridge");
 184                 title += Glib::get_application_name ();
 185                 set_title (title.get_string());
 186
 187         } else {
 188
 189                 WindowTitle title (S_("Window|Meterbridge"));
 190                 title += Glib::get_application_name ();
 191                 set_title (title.get_string());
 192         }
 193 }
 194
 195 void
 196 Meterbridge::set_window_pos_and_size ()
 197 {
 198         resize (m_width, m_height);
 199         move (m_root_x, m_root_y);
 200 }
 201
 202 void
 203 Meterbridge::get_window_pos_and_size ()
 204 {
 205         get_position(m_root_x, m_root_y);
 206         get_size(m_width, m_height);
 207 }
 208
 209 bool
 210 Meterbridge::hide_window (GdkEventAny *ev)
 211 {
 212         get_window_pos_and_size();
 213         _visible = false;
 214         return just_hide_it(ev, static_cast<Gtk::Window *>(this));
 215 }
 216
 217 bool
 218 Meterbridge::on_key_press_event (GdkEventKey* ev)
 219 {
 220         if (gtk_window_propagate_key_event (GTK_WINDOW(gobj()), ev)) {
 221                 return true;
 222         }
 223         return forward_key_press (ev);
 224 }
 225
 226 bool
 227 Meterbridge::on_key_release_event (GdkEventKey* ev)
 228 {
 229         if (gtk_window_propagate_key_event (GTK_WINDOW(gobj()), ev)) {
 230                 return true;
 231         }
 232         /* don't forward releases */
 233         return true;
 234 }
 235
 236 void
 237 Meterbridge::set_session (Session* s)
 238 {
 239         SessionHandlePtr::set_session (s);
 240
 241         if (!_session) {
 242                 return;
 243         }
 244
 245         XMLNode* node = _session->instant_xml(X_("Meterbridge"));
 246         if (node) {
 247                 set_state (*node);
 248         }
 249
 250         update_title ();
 251
 252         SignalOrderRouteSorter sorter;
 253         boost::shared_ptr<RouteList> routes = _session->get_routes();
 254
 255         RouteList copy(*routes);
 256         copy.sort(sorter);
 257         add_strips(copy);
 258
 259         _session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::add_strips, this, _1), gui_context());
 260         _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::update_title, this), gui_context());
 261         _session->StateSaved.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::update_title, this), gui_context());
 262
 263         if (_visible) {
 264                 show_window();
 265                 ActionManager::check_toggleaction ("<Actions>/Common/toggle-meterbridge");
 266         }
 267         start_updating ();
 268 }
 269
 270 void
 271 Meterbridge::session_going_away ()
 272 {
 273         ENSURE_GUI_THREAD (*this, &Meterbridge::session_going_away);
 274
 275         for (list<MeterStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
 276                 delete (*i);
 277         }
 278
 279         strips.clear ();
 280         stop_updating ();
 281
 282         SessionHandlePtr::session_going_away ();
 283
 284         _session = 0;
 285         update_title ();
 286 }
 287
 288 int
 289 Meterbridge::set_state (const XMLNode& node)
 290 {
 291         const XMLProperty* prop;
 292         XMLNode* geometry;
 293
 294         m_width = default_width;
 295         m_height = default_height;
 296         m_root_x = 1;
 297         m_root_y = 1;
 298
 299         if ((geometry = find_named_node (node, "geometry")) != 0) {
 300
 301                 XMLProperty* prop;
 302
 303                 if ((prop = geometry->property("x_size")) == 0) {
 304                         prop = geometry->property ("x-size");
 305                 }
 306                 if (prop) {
 307                         m_width = atoi(prop->value());
 308                 }
 309                 if ((prop = geometry->property("y_size")) == 0) {
 310                         prop = geometry->property ("y-size");
 311                 }
 312                 if (prop) {
 313                         m_height = atoi(prop->value());
 314                 }
 315
 316                 if ((prop = geometry->property ("x_pos")) == 0) {
 317                         prop = geometry->property ("x-pos");
 318                 }
 319                 if (prop) {
 320                         m_root_x = atoi (prop->value());
 321
 322                 }
 323                 if ((prop = geometry->property ("y_pos")) == 0) {
 324                         prop = geometry->property ("y-pos");
 325                 }
 326                 if (prop) {
 327                         m_root_y = atoi (prop->value());
 328                 }
 329         }
 330
 331         set_window_pos_and_size ();
 332
 333         if ((prop = node.property ("show-meterbridge"))) {
 334                 if (string_is_affirmative (prop->value())) {
 335                        _visible = true;
 336                 }
 337         }
 338
 339         return 0;
 340 }
 341
 342 XMLNode&
 343 Meterbridge::get_state (void)
 344 {
 345         XMLNode* node = new XMLNode ("Meterbridge");
 346
 347         if (is_realized()) {
 348                 Glib::RefPtr<Gdk::Window> win = get_window();
 349
 350                 get_window_pos_and_size ();
 351
 352                 XMLNode* geometry = new XMLNode ("geometry");
 353                 char buf[32];
 354                 snprintf(buf, sizeof(buf), "%d", m_width);
 355                 geometry->add_property(X_("x_size"), string(buf));
 356                 snprintf(buf, sizeof(buf), "%d", m_height);
 357                 geometry->add_property(X_("y_size"), string(buf));
 358                 snprintf(buf, sizeof(buf), "%d", m_root_x);
 359                 geometry->add_property(X_("x_pos"), string(buf));
 360                 snprintf(buf, sizeof(buf), "%d", m_root_y);
 361                 geometry->add_property(X_("y_pos"), string(buf));
 362                 node->add_child_nocopy (*geometry);
 363         }
 364
 365         node->add_property ("show-meterbridge", _visible ? "yes" : "no");
 366         return *node;
 367 }
 368
 369
 370 gint
 371 Meterbridge::start_updating ()
 372 {
 373         fast_screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect (sigc::mem_fun(*this, &Meterbridge::fast_update_strips));
 374         return 0;
 375 }
 376
 377 gint
 378 Meterbridge::stop_updating ()
 379 {
 380         fast_screen_update_connection.disconnect();
 381         return 0;
 382 }
 383
 384 void
 385 Meterbridge::fast_update_strips ()
 386 {
 387         if (!is_mapped () || !_session) {
 388                 return;
 389         }
 390         for (list<MeterStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
 391                 (*i)->fast_update ();
 392         }
 393 }
 394
 395 void
 396 Meterbridge::add_strips (RouteList& routes)
 397 {
 398         MeterStrip* strip;
 399         for (RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
 400                 boost::shared_ptr<Route> route = (*x);
 401                 if (route->is_auditioner()) {
 402                         continue;
 403                 }
 404                 if (route->is_monitor()) {
 405                         continue;
 406                 }
 407
 408                 strip = new MeterStrip (*this, _session, route);
 409                 strips.push_back (strip);
 410
 411                 global_hpacker.pack_start (*strip, false, false);
 412                 strip->show();
 413         }
 414
 415         sync_order_keys(MixerSort);
 416 }
 417
 418 void
 419 Meterbridge::remove_strip (MeterStrip* strip)
 420 {
 421         if (_session && _session->deletion_in_progress()) {
 422                 return;
 423         }
 424
 425         list<MeterStrip *>::iterator i;
 426         if ((i = find (strips.begin(), strips.end(), strip)) != strips.end()) {
 427                 strips.erase (i);
 428         }
 429 }
 430
 431 void
 432 Meterbridge::sync_order_keys (RouteSortOrderKey src)
 433 {
 434         MeterOrderRouteSorter sorter;
 435         std::list<MeterStrip *> copy (strips);
 436         copy.sort(sorter);
 437
 438         int pos = 0;
 439         for (list<MeterStrip *>::iterator i = copy.begin(); i != copy.end(); ++i) {
 440                 global_hpacker.reorder_child(*(*i), pos++);
 441         }
 442 }