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