gtk2_ardour/group_tabs.cc

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <gtkmm/stock.h>
  21 #include "ardour/session.h"
  22 #include "ardour/route_group.h"
  23 #include "ardour/route.h"
  24
  25 #include "gui_thread.h"
  26 #include "route_group_dialog.h"
  27 #include "group_tabs.h"
  28 #include "keyboard.h"
  29 #include "i18n.h"
  30 #include "ardour_ui.h"
  31 #include "utils.h"
  32
  33 using namespace std;
  34 using namespace Gtk;
  35 using namespace ARDOUR;
  36 using Gtkmm2ext::Keyboard;
  37
  38 list<Gdk::Color> GroupTabs::_used_colors;
  39
  40 GroupTabs::GroupTabs ()
  41         : _menu (0)
  42         , _dragging (0)
  43         , _dragging_new_tab (0)
  44 {
  45
  46 }
  47
  48 GroupTabs::~GroupTabs ()
  49 {
  50         delete _menu;
  51 }
  52
  53 void
  54 GroupTabs::set_session (Session* s)
  55 {
  56         SessionHandlePtr::set_session (s);
  57
  58         if (_session) {
  59                 _session->RouteGroupPropertyChanged.connect (
  60                         _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_group_property_changed, this, _1), gui_context()
  61                         );
  62                 _session->RouteAddedToRouteGroup.connect (
  63                         _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_added_to_route_group, this, _1, _2), gui_context()
  64                         );
  65                 _session->RouteRemovedFromRouteGroup.connect (
  66                         _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_removed_from_route_group, this, _1, _2), gui_context()
  67                         );
  68
  69                 _session->route_group_removed.connect (_session_connections, invalidator (*this), boost::bind (&GroupTabs::set_dirty, this), gui_context());
  70         }
  71 }
  72
  73
  74 /** Handle a size request.
  75  *  @param req GTK requisition
  76  */
  77 void
  78 GroupTabs::on_size_request (Gtk::Requisition *req)
  79 {
  80         /* Use a dummy, small width and the actual height that we want */
  81         req->width = 16;
  82         req->height = 16;
  83 }
  84
  85 bool
  86 GroupTabs::on_button_press_event (GdkEventButton* ev)
  87 {
  88         using namespace Menu_Helpers;
  89
  90         double const p = primary_coordinate (ev->x, ev->y);
  91
  92         list<Tab>::iterator prev;
  93         list<Tab>::iterator next;
  94         Tab* t = click_to_tab (p, &prev, &next);
  95
  96         _drag_min = prev != _tabs.end() ? prev->to : 0;
  97         _drag_max = next != _tabs.end() ? next->from : extent ();
  98
  99         if (ev->button == 1) {
 100
 101                 if (t == 0) {
 102                         Tab n;
 103                         n.from = n.to = p;
 104                         _dragging_new_tab = true;
 105
 106                         if (next == _tabs.end()) {
 107                                 _tabs.push_back (n);
 108                                 t = &_tabs.back ();
 109                         } else {
 110                                 list<Tab>::iterator j = _tabs.insert (next, n);
 111                                 t = &(*j);
 112                         }
 113
 114                 } else {
 115                         _dragging_new_tab = false;
 116                         _initial_dragging_routes = routes_for_tab (t);
 117                 }
 118
 119                 _dragging = t;
 120                 _drag_moved = false;
 121                 _drag_first = p;
 122
 123                 double const h = (t->from + t->to) / 2;
 124                 if (p < h) {
 125                         _drag_moving = t->from;
 126                         _drag_fixed = t->to;
 127                         _drag_offset = p - t->from;
 128                 } else {
 129                         _drag_moving = t->to;
 130                         _drag_fixed = t->from;
 131                         _drag_offset = p - t->to;
 132                 }
 133
 134         } else if (ev->button == 3) {
 135
 136                 RouteGroup* g = t ? t->group : 0;
 137                 Menu* m = get_menu (g);
 138                 if (m) {
 139                         m->popup (ev->button, ev->time);
 140                 }
 141
 142         }
 143
 144         return true;
 145 }
 146
 147
 148 bool
 149 GroupTabs::on_motion_notify_event (GdkEventMotion* ev)
 150 {
 151         if (_dragging == 0) {
 152                 return false;
 153         }
 154
 155         double const p = primary_coordinate (ev->x, ev->y);
 156
 157         if (p != _drag_first) {
 158                 _drag_moved = true;
 159         }
 160
 161         _drag_moving = p - _drag_offset;
 162
 163         _dragging->from = min (_drag_moving, _drag_fixed);
 164         _dragging->to = max (_drag_moving, _drag_fixed);
 165
 166         _dragging->from = max (_dragging->from, _drag_min);
 167         _dragging->to = min (_dragging->to, _drag_max);
 168
 169         set_dirty ();
 170         queue_draw ();
 171
 172         return true;
 173 }
 174
 175
 176 bool
 177 GroupTabs::on_button_release_event (GdkEventButton* ev)
 178 {
 179         if (_dragging == 0) {
 180                 return false;
 181         }
 182
 183         if (!_drag_moved) {
 184
 185                 if (_dragging->group) {
 186
 187                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 188
 189                                 /* edit */
 190                                 RouteGroupDialog d (_dragging->group, false);
 191                                 d.do_run ();
 192
 193                         } else {
 194
 195                                 /* toggle active state */
 196                                 _dragging->group->set_active (!_dragging->group->is_active (), this);
 197
 198                         }
 199                 }
 200
 201         } else {
 202                 /* finish drag */
 203                 RouteList routes = routes_for_tab (_dragging);
 204
 205                 if (!routes.empty()) {
 206                         if (_dragging_new_tab) {
 207                                 RouteGroup* g = create_and_add_group ();
 208                                 if (g) {
 209                                         for (RouteList::iterator i = routes.begin(); i != routes.end(); ++i) {
 210                                                 g->add (*i);
 211                                         }
 212                                 }
 213                         } else {
 214                                 boost::shared_ptr<RouteList> r = _session->get_routes ();
 215                                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 216
 217                                         bool const was_in_tab = find (
 218                                                 _initial_dragging_routes.begin(), _initial_dragging_routes.end(), *i
 219                                                 ) != _initial_dragging_routes.end ();
 220
 221                                         bool const now_in_tab = find (routes.begin(), routes.end(), *i) != routes.end();
 222
 223                                         if (was_in_tab && !now_in_tab) {
 224                                                 _dragging->group->remove (*i);
 225                                         } else if (!was_in_tab && now_in_tab) {
 226                                                 _dragging->group->add (*i);
 227                                         }
 228                                 }
 229                         }
 230                 }
 231
 232                 set_dirty ();
 233                 queue_draw ();
 234         }
 235
 236         _dragging = 0;
 237         _initial_dragging_routes.clear ();
 238
 239         return true;
 240 }
 241
 242 void
 243 GroupTabs::render (cairo_t* cr)
 244 {
 245         if (_dragging == 0) {
 246                 _tabs = compute_tabs ();
 247         }
 248
 249         /* background */
 250
 251         cairo_set_source_rgb (cr, 0, 0, 0);
 252         cairo_rectangle (cr, 0, 0, _width, _height);
 253         cairo_fill (cr);
 254
 255         /* tabs */
 256
 257         for (list<Tab>::const_iterator i = _tabs.begin(); i != _tabs.end(); ++i) {
 258                 draw_tab (cr, *i);
 259         }
 260 }
 261
 262
 263 /** Convert a click position to a tab.
 264  *  @param c Click position.
 265  *  @param prev Filled in with the previous tab to the click, or _tabs.end().
 266  *  @param next Filled in with the next tab after the click, or _tabs.end().
 267  *  @return Tab under the click, or 0.
 268  */
 269
 270 GroupTabs::Tab *
 271 GroupTabs::click_to_tab (double c, list<Tab>::iterator* prev, list<Tab>::iterator* next)
 272 {
 273         *prev = *next = _tabs.end ();
 274         Tab* under = 0;
 275
 276         list<Tab>::iterator i = _tabs.begin ();
 277         while (i != _tabs.end()) {
 278
 279                 if (i->from > c) {
 280                         *next = i;
 281                         break;
 282                 }
 283
 284                 if (i->to < c) {
 285                         *prev = i;
 286                         ++i;
 287                         continue;
 288                 }
 289
 290                 if (i->from <= c && c < i->to) {
 291                         under = &(*i);
 292                 }
 293
 294                 ++i;
 295         }
 296
 297         return under;
 298 }
 299
 300 Gtk::Menu*
 301 GroupTabs::get_menu (RouteGroup* g)
 302 {
 303         using namespace Menu_Helpers;
 304
 305         delete _menu;
 306
 307         Menu* new_from = new Menu;
 308         MenuList& f = new_from->items ();
 309         f.push_back (MenuElem (_("Selection..."), sigc::mem_fun (*this, &GroupTabs::new_from_selection)));
 310         f.push_back (MenuElem (_("Record Enabled..."), sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled)));
 311         f.push_back (MenuElem (_("Soloed..."), sigc::mem_fun (*this, &GroupTabs::new_from_soloed)));
 312
 313         _menu = new Menu;
 314         _menu->set_name ("ArdourContextMenu");
 315         MenuList& items = _menu->items();
 316
 317         items.push_back (MenuElem (_("New..."), hide_return (sigc::mem_fun(*this, &GroupTabs::create_and_add_group))));
 318         items.push_back (MenuElem (_("New From"), *new_from));
 319
 320         if (g) {
 321                 items.push_back (MenuElem (_("Edit..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::edit_group), g)));
 322                 items.push_back (MenuElem (_("Add New Subgroup Bus"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, false, PreFader)));
 323                 items.push_back (MenuElem (_("Add New Aux Bus (pre-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PreFader)));
 324                 items.push_back (MenuElem (_("Add New Aux Bus (post-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PostFader)));
 325                 items.push_back (MenuElem (_("Collect"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::collect), g)));
 326                 items.push_back (MenuElem (_("Remove"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::remove_group), g)));
 327         }
 328
 329         add_menu_items (_menu, g);
 330
 331         items.push_back (SeparatorElem());
 332         items.push_back (MenuElem (_("Activate All"), sigc::mem_fun(*this, &GroupTabs::activate_all)));
 333         items.push_back (MenuElem (_("Disable All"), sigc::mem_fun(*this, &GroupTabs::disable_all)));
 334
 335         return _menu;
 336
 337 }
 338
 339 void
 340 GroupTabs::new_from_selection ()
 341 {
 342         RouteList rl = selected_routes ();
 343         if (rl.empty()) {
 344                 return;
 345         }
 346
 347         run_new_group_dialog (rl);
 348 }
 349
 350 void
 351 GroupTabs::new_from_rec_enabled ()
 352 {
 353         boost::shared_ptr<RouteList> rl = _session->get_routes ();
 354
 355         RouteList rec_enabled;
 356
 357         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 358                 if ((*i)->record_enabled()) {
 359                         rec_enabled.push_back (*i);
 360                 }
 361         }
 362
 363         if (rec_enabled.empty()) {
 364                 return;
 365         }
 366
 367         run_new_group_dialog (rec_enabled);
 368 }
 369
 370 void
 371 GroupTabs::new_from_soloed ()
 372 {
 373         boost::shared_ptr<RouteList> rl = _session->get_routes ();
 374
 375         RouteList soloed;
 376
 377         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 378                 if (!(*i)->is_master() && (*i)->soloed()) {
 379                         soloed.push_back (*i);
 380                 }
 381         }
 382
 383         if (soloed.empty()) {
 384                 return;
 385         }
 386
 387         run_new_group_dialog (soloed);
 388 }
 389
 390 void
 391 GroupTabs::run_new_group_dialog (RouteList const & rl)
 392 {
 393         RouteGroup* g = new RouteGroup (*_session, "");
 394         g->apply_changes (default_properties ());
 395
 396         RouteGroupDialog d (g, true);
 397
 398         if (d.do_run ()) {
 399                 delete g;
 400         } else {
 401                 _session->add_route_group (g);
 402                 for (RouteList::const_iterator i = rl.begin(); i != rl.end(); ++i) {
 403                         g->add (*i);
 404                 }
 405         }
 406 }
 407
 408 RouteGroup *
 409 GroupTabs::create_and_add_group () const
 410 {
 411         RouteGroup* g = new RouteGroup (*_session, "");
 412
 413         g->apply_changes (default_properties ());
 414
 415         RouteGroupDialog d (g, true);
 416
 417         if (d.do_run ()) {
 418                 delete g;
 419                 return 0;
 420         }
 421
 422         _session->add_route_group (g);
 423         return g;
 424 }
 425
 426 void
 427 GroupTabs::edit_group (RouteGroup* g)
 428 {
 429         RouteGroupDialog d (g, false);
 430         d.do_run ();
 431 }
 432
 433 void
 434 GroupTabs::subgroup (RouteGroup* g, bool aux, Placement placement)
 435 {
 436         g->make_subgroup (aux, placement);
 437 }
 438
 439 struct CollectSorter {
 440         CollectSorter (std::string const & key) : _key (key) {}
 441
 442         bool operator () (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
 443                 return a->order_key (_key) < b->order_key (_key);
 444         }
 445
 446         std::string _key;
 447 };
 448
 449 /** Collect all members of a RouteGroup so that they are together in the Editor or Mixer.
 450  *  @param g Group to collect.
 451  */
 452 void
 453 GroupTabs::collect (RouteGroup* g)
 454 {
 455         boost::shared_ptr<RouteList> group_routes = g->route_list ();
 456         group_routes->sort (CollectSorter (order_key ()));
 457         int const N = group_routes->size ();
 458
 459         RouteList::iterator i = group_routes->begin ();
 460         boost::shared_ptr<RouteList> routes = _session->get_routes ();
 461         RouteList::const_iterator j = routes->begin ();
 462
 463         int diff = 0;
 464         int coll = -1;
 465         while (i != group_routes->end() && j != routes->end()) {
 466
 467                 int const k = (*j)->order_key (order_key ());
 468
 469                 if (*i == *j) {
 470
 471                         if (coll == -1) {
 472                                 coll = k;
 473                                 diff = N - 1;
 474                         } else {
 475                                 --diff;
 476                         }
 477
 478                         (*j)->set_order_key (order_key (), coll);
 479
 480                         ++coll;
 481                         ++i;
 482
 483                 } else {
 484
 485                         (*j)->set_order_key (order_key (), k + diff);
 486
 487                 }
 488
 489                 ++j;
 490         }
 491
 492         sync_order_keys ();
 493 }
 494
 495 void
 496 GroupTabs::activate_all ()
 497 {
 498         _session->foreach_route_group (
 499                 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), true)
 500                 );
 501 }
 502
 503 void
 504 GroupTabs::disable_all ()
 505 {
 506         _session->foreach_route_group (
 507                 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), false)
 508                 );
 509 }
 510
 511 void
 512 GroupTabs::set_activation (RouteGroup* g, bool a)
 513 {
 514         g->set_active (a, this);
 515 }
 516
 517 void
 518 GroupTabs::remove_group (RouteGroup* g)
 519 {
 520         _session->remove_route_group (*g);
 521 }
 522
 523 /** Set the color of the tab of a route group */
 524 void
 525 GroupTabs::set_group_color (RouteGroup* group, Gdk::Color color)
 526 {
 527         assert (group);
 528
 529         /* Hack to disallow black route groups; force a dark grey instead */
 530         if (color.get_red() == 0 && color.get_green() == 0 && color.get_blue() == 0) {
 531                 color.set_grey_p (0.1);
 532         }
 533
 534         GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
 535
 536         char buf[64];
 537         snprintf (buf, sizeof (buf), "%d:%d:%d", color.get_red(), color.get_green(), color.get_blue());
 538         gui_state.set (group_gui_id (group), "color", buf);
 539
 540         /* This is a bit of a hack, but this might change
 541            our route's effective color, so emit gui_changed
 542            for our routes.
 543         */
 544
 545         emit_gui_changed_for_members (group);
 546 }
 547
 548 /** @return the ID string to use for the GUI state of a route group */
 549 string
 550 GroupTabs::group_gui_id (RouteGroup* group)
 551 {
 552         assert (group);
 553
 554         char buf[64];
 555         snprintf (buf, sizeof (buf), "route_group %s", group->id().to_s().c_str ());
 556
 557         return buf;
 558 }
 559
 560 /** @return the color to use for a route group tab */
 561 Gdk::Color
 562 GroupTabs::group_color (RouteGroup* group)
 563 {
 564         assert (group);
 565
 566         GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
 567
 568         string const gui_id = group_gui_id (group);
 569
 570         bool empty;
 571         string const color = gui_state.get_string (gui_id, "color", &empty);
 572         if (empty) {
 573                 /* no color has yet been set, so use a random one */
 574                 Gdk::Color const color = unique_random_color (_used_colors);
 575                 set_group_color (group, color);
 576                 return color;
 577         }
 578
 579         Gdk::Color c;
 580
 581         int r, g, b;
 582
 583         sscanf (color.c_str(), "%d:%d:%d", &r, &g, &b);
 584
 585         c.set_red (r);
 586         c.set_green (g);
 587         c.set_blue (b);
 588
 589         return c;
 590 }
 591
 592 void
 593 GroupTabs::route_group_property_changed (RouteGroup* rg)
 594 {
 595         /* This is a bit of a hack, but this might change
 596            our route's effective color, so emit gui_changed
 597            for our routes.
 598         */
 599
 600         emit_gui_changed_for_members (rg);
 601
 602         set_dirty ();
 603 }
 604
 605 void
 606 GroupTabs::route_added_to_route_group (RouteGroup*, boost::weak_ptr<Route> w)
 607 {
 608         /* Similarly-spirited hack as in route_group_property_changed */
 609
 610         boost::shared_ptr<Route> r = w.lock ();
 611         if (!r) {
 612                 return;
 613         }
 614
 615         r->gui_changed (X_("color"), 0);
 616
 617         set_dirty ();
 618 }
 619
 620 void
 621 GroupTabs::route_removed_from_route_group (RouteGroup*, boost::weak_ptr<Route> w)
 622 {
 623         /* Similarly-spirited hack as in route_group_property_changed */
 624
 625         boost::shared_ptr<Route> r = w.lock ();
 626         if (!r) {
 627                 return;
 628         }
 629
 630         r->gui_changed (X_("color"), 0);
 631
 632         set_dirty ();
 633 }
 634
 635 void
 636 GroupTabs::emit_gui_changed_for_members (RouteGroup* rg)
 637 {
 638         for (RouteList::iterator i = rg->route_list()->begin(); i != rg->route_list()->end(); ++i) {
 639                 (*i)->gui_changed (X_("color"), 0);
 640         }
 641 }