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
  22 #include "ardour/session.h"
  23 #include "ardour/route_group.h"
  24 #include "ardour/route.h"
  25 #include "ardour/vca_manager.h"
  26 #include "ardour/vca.h"
  27
  28 #include "gtkmm2ext/doi.h"
  29
  30 #include "gui_thread.h"
  31 #include "route_group_dialog.h"
  32 #include "group_tabs.h"
  33 #include "keyboard.h"
  34 #include "pbd/i18n.h"
  35 #include "ardour_ui.h"
  36 #include "rgb_macros.h"
  37 #include "ui_config.h"
  38 #include "utils.h"
  39
  40 using namespace std;
  41 using namespace Gtk;
  42 using namespace ARDOUR;
  43 using namespace ARDOUR_UI_UTILS;
  44 using Gtkmm2ext::Keyboard;
  45
  46 list<Gdk::Color> GroupTabs::_used_colors;
  47
  48 GroupTabs::GroupTabs ()
  49         : _menu (0)
  50         , _dragging (0)
  51         , _dragging_new_tab (0)
  52 {
  53         add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::POINTER_MOTION_MASK);
  54         UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &GroupTabs::queue_draw));
  55 }
  56
  57 GroupTabs::~GroupTabs ()
  58 {
  59         delete _menu;
  60 }
  61
  62 void
  63 GroupTabs::set_session (Session* s)
  64 {
  65         SessionHandlePtr::set_session (s);
  66
  67         if (_session) {
  68                 _session->RouteGroupPropertyChanged.connect (
  69                         _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_group_property_changed, this, _1), gui_context()
  70                         );
  71                 _session->RouteAddedToRouteGroup.connect (
  72                         _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_added_to_route_group, this, _1, _2), gui_context()
  73                         );
  74                 _session->RouteRemovedFromRouteGroup.connect (
  75                         _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_removed_from_route_group, this, _1, _2), gui_context()
  76                         );
  77
  78                 _session->route_group_removed.connect (_session_connections, invalidator (*this), boost::bind (&GroupTabs::set_dirty, this, (cairo_rectangle_t*)0), gui_context());
  79         }
  80 }
  81
  82
  83 /** Handle a size request.
  84  *  @param req GTK requisition
  85  */
  86 void
  87 GroupTabs::on_size_request (Gtk::Requisition *req)
  88 {
  89         /* Use a dummy, small width and the actual height that we want */
  90         req->width = 16;
  91         req->height = 16;
  92 }
  93
  94 bool
  95 GroupTabs::on_button_press_event (GdkEventButton* ev)
  96 {
  97         using namespace Menu_Helpers;
  98
  99         double const p = primary_coordinate (ev->x, ev->y);
 100
 101         list<Tab>::iterator prev;
 102         list<Tab>::iterator next;
 103         Tab* t = click_to_tab (p, &prev, &next);
 104
 105         _drag_min = prev != _tabs.end() ? prev->to : 0;
 106         _drag_max = next != _tabs.end() ? next->from : extent ();
 107
 108         if (ev->button == 1) {
 109
 110                 if (t == 0) {
 111                         Tab n;
 112                         n.from = n.to = p;
 113                         _dragging_new_tab = true;
 114
 115                         if (next == _tabs.end()) {
 116                                 _tabs.push_back (n);
 117                                 t = &_tabs.back ();
 118                         } else {
 119                                 list<Tab>::iterator j = _tabs.insert (next, n);
 120                                 t = &(*j);
 121                         }
 122
 123                 } else {
 124                         _dragging_new_tab = false;
 125                         _initial_dragging_routes = routes_for_tab (t);
 126                 }
 127
 128                 _dragging = t;
 129                 _drag_moved = false;
 130                 _drag_first = p;
 131
 132                 double const h = (t->from + t->to) / 2;
 133                 if (p < h) {
 134                         _drag_moving = t->from;
 135                         _drag_fixed = t->to;
 136                         _drag_offset = p - t->from;
 137                 } else {
 138                         _drag_moving = t->to;
 139                         _drag_fixed = t->from;
 140                         _drag_offset = p - t->to;
 141                 }
 142
 143         } else if (ev->button == 3) {
 144
 145                 RouteGroup* g = t ? t->group : 0;
 146
 147                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier) && g) {
 148                         remove_group (g);
 149                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier) && g) {
 150                         edit_group (g);
 151                 } else {
 152                         Menu* m = get_menu (g, true);
 153                         if (m) {
 154                                 m->popup (ev->button, ev->time);
 155                         }
 156                 }
 157         }
 158
 159         return true;
 160 }
 161
 162
 163 bool
 164 GroupTabs::on_motion_notify_event (GdkEventMotion* ev)
 165 {
 166         if (_dragging == 0) {
 167                 return false;
 168         }
 169
 170         double const p = primary_coordinate (ev->x, ev->y);
 171
 172         if (p != _drag_first) {
 173                 _drag_moved = true;
 174         }
 175
 176         _drag_moving = p - _drag_offset;
 177
 178         _dragging->from = min (_drag_moving, _drag_fixed);
 179         _dragging->to = max (_drag_moving, _drag_fixed);
 180
 181         _dragging->from = max (_dragging->from, _drag_min);
 182         _dragging->to = min (_dragging->to, _drag_max);
 183
 184         set_dirty ();
 185         queue_draw ();
 186
 187         gdk_event_request_motions(ev);
 188
 189         return true;
 190 }
 191
 192
 193 bool
 194 GroupTabs::on_button_release_event (GdkEventButton*)
 195 {
 196         if (_dragging == 0) {
 197                 return false;
 198         }
 199
 200         if (!_drag_moved) {
 201
 202                 if (_dragging->group) {
 203                         /* toggle active state */
 204                         _dragging->group->set_active (!_dragging->group->is_active (), this);
 205                 }
 206
 207         } else {
 208                 /* finish drag */
 209                 RouteList routes = routes_for_tab (_dragging);
 210
 211                 if (!routes.empty()) {
 212                         if (_dragging_new_tab) {
 213                                 run_new_group_dialog (&routes, false);
 214                         } else {
 215                                 boost::shared_ptr<RouteList> r = _session->get_routes ();
 216                                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 217
 218                                         bool const was_in_tab = find (
 219                                                 _initial_dragging_routes.begin(), _initial_dragging_routes.end(), *i
 220                                                 ) != _initial_dragging_routes.end ();
 221
 222                                         bool const now_in_tab = find (routes.begin(), routes.end(), *i) != routes.end();
 223
 224                                         if (was_in_tab && !now_in_tab) {
 225                                                 _dragging->group->remove (*i);
 226                                         } else if (!was_in_tab && now_in_tab) {
 227                                                 _dragging->group->add (*i);
 228                                         }
 229                                 }
 230                         }
 231                 }
 232
 233                 set_dirty ();
 234                 queue_draw ();
 235         }
 236
 237         _dragging = 0;
 238         _initial_dragging_routes.clear ();
 239
 240         return true;
 241 }
 242
 243 void
 244 GroupTabs::render (Cairo::RefPtr<Cairo::Context> const& ctx, cairo_rectangle_t*)
 245 {
 246         cairo_t* cr = ctx->cobj();
 247         if (_dragging == 0) {
 248                 _tabs = compute_tabs ();
 249         }
 250
 251         /* background */
 252
 253         Gdk::Color c = get_style()->get_base (Gtk::STATE_NORMAL);
 254
 255         cairo_set_source_rgb (cr, c.get_red_p(), c.get_green_p(), c.get_blue_p());
 256         cairo_rectangle (cr, 0, 0, get_width(), get_height());
 257         cairo_fill (cr);
 258
 259         /* tabs */
 260
 261         for (list<Tab>::const_iterator i = _tabs.begin(); i != _tabs.end(); ++i) {
 262                 draw_tab (cr, *i);
 263         }
 264 }
 265
 266
 267 /** Convert a click position to a tab.
 268  *  @param c Click position.
 269  *  @param prev Filled in with the previous tab to the click, or _tabs.end().
 270  *  @param next Filled in with the next tab after the click, or _tabs.end().
 271  *  @return Tab under the click, or 0.
 272  */
 273
 274 GroupTabs::Tab *
 275 GroupTabs::click_to_tab (double c, list<Tab>::iterator* prev, list<Tab>::iterator* next)
 276 {
 277         *prev = *next = _tabs.end ();
 278         Tab* under = 0;
 279
 280         list<Tab>::iterator i = _tabs.begin ();
 281         while (i != _tabs.end()) {
 282
 283                 if (i->from > c) {
 284                         *next = i;
 285                         break;
 286                 }
 287
 288                 if (i->to < c) {
 289                         *prev = i;
 290                         ++i;
 291                         continue;
 292                 }
 293
 294                 if (i->from <= c && c < i->to) {
 295                         under = &(*i);
 296                 }
 297
 298                 ++i;
 299         }
 300
 301         return under;
 302 }
 303
 304 void
 305 GroupTabs::add_new_from_items (Menu_Helpers::MenuList& items)
 306 {
 307         using namespace Menu_Helpers;
 308         Menu *new_from;
 309
 310         new_from = manage (new Menu);
 311         {
 312                 MenuList& f = new_from->items ();
 313                 f.push_back (MenuElem (_("Selection..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_selection), false)));
 314                 f.push_back (MenuElem (_("Record Enabled..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled), false)));
 315                 f.push_back (MenuElem (_("Soloed..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_soloed), false)));
 316         }
 317         items.push_back (MenuElem (_("Create New Group From..."), *new_from));
 318
 319         new_from = manage (new Menu);
 320         {
 321                 MenuList& f = new_from->items ();
 322                 f.push_back (MenuElem (_("Selection..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_selection), true)));
 323                 f.push_back (MenuElem (_("Record Enabled..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled), true)));
 324                 f.push_back (MenuElem (_("Soloed..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_soloed), true)));
 325         }
 326         items.push_back (MenuElem (_("Create New Group with Master From..."), *new_from));
 327 }
 328
 329 Gtk::Menu*
 330 GroupTabs::get_menu (RouteGroup* g, bool in_tab_area)
 331 {
 332         using namespace Menu_Helpers;
 333
 334         delete _menu;
 335
 336         _menu = new Menu;
 337         _menu->set_name ("ArdourContextMenu");
 338
 339         MenuList& items = _menu->items();
 340         Menu* vca_menu;
 341
 342         const VCAList vcas = _session->vca_manager().vcas ();
 343
 344         if (!in_tab_area) {
 345                 /* context menu is not for a group tab, show the "create new
 346                    from" items here
 347                 */
 348                 add_new_from_items (items);
 349         }
 350
 351         if (g) {
 352                 items.push_back (SeparatorElem());
 353                 items.push_back (MenuElem (_("Edit Group..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::edit_group), g)));
 354                 items.push_back (MenuElem (_("Collect Group"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::collect), g)));
 355                 items.push_back (MenuElem (_("Remove Group"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::remove_group), g)));
 356
 357                 items.push_back (SeparatorElem());
 358
 359                 if (g->has_control_master()) {
 360                         items.push_back (MenuElem (_("Drop Group from VCA..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::unassign_group_to_master), g->group_master_number(), g)));
 361                 } else {
 362                         vca_menu = manage (new Menu);
 363                         MenuList& f (vca_menu->items());
 364                         f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_group_to_master), 0, g, true)));
 365
 366                         for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
 367                                 f.push_back (MenuElem ((*v)->name().empty() ? string_compose ("VCA %1", (*v)->number()) : (*v)->name(), sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_group_to_master), (*v)->number(), g, true)));
 368                         }
 369                         items.push_back (MenuElem (_("Assign Group to VCA..."), *vca_menu));
 370                 }
 371
 372                 items.push_back (SeparatorElem());
 373
 374                 if (g->has_subgroup()) {
 375                         items.push_back (MenuElem (_("Remove Subgroup Bus"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::un_subgroup), g)));
 376                 } else {
 377                         items.push_back (MenuElem (_("Add New Subgroup Bus"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, false, PreFader)));
 378                 }
 379                 items.push_back (MenuElem (_("Add New Aux Bus (pre-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PreFader)));
 380                 items.push_back (MenuElem (_("Add New Aux Bus (post-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PostFader)));
 381                 items.push_back (SeparatorElem());
 382
 383         }
 384
 385         add_menu_items (_menu, g);
 386
 387         if (in_tab_area) {
 388                 /* context menu is for a group tab, show the "create new
 389                    from" items here
 390                 */
 391                 add_new_from_items (items);
 392         }
 393
 394         items.push_back (SeparatorElem());
 395
 396         vca_menu = manage (new Menu);
 397         {
 398                 MenuList& f (vca_menu->items());
 399                 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_selection_to_master), 0)));
 400                 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
 401                         f.push_back (MenuElem ((*v)->name().empty() ? string_compose ("VCA %1", (*v)->number()) : (*v)->name(), sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_selection_to_master), (*v)->number())));
 402                 }
 403         }
 404
 405         items.push_back (MenuElem (_("Assign Selection to VCA..."), *vca_menu));
 406
 407         vca_menu = manage (new Menu);
 408         {
 409                 MenuList& f (vca_menu->items());
 410                 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_recenabled_to_master), 0)));
 411                 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
 412                         f.push_back (MenuElem ((*v)->name().empty() ? string_compose ("VCA %1", (*v)->number()) : (*v)->name(), sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_recenabled_to_master), (*v)->number())));
 413                 }
 414
 415         }
 416         items.push_back (MenuElem (_("Assign Record Enabled to VCA..."), *vca_menu));
 417
 418         vca_menu = manage (new Menu);
 419         {
 420                 MenuList& f (vca_menu->items());
 421                 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_soloed_to_master), 0)));
 422                 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
 423                         f.push_back (MenuElem ((*v)->name().empty() ? string_compose ("VCA %1", (*v)->number()) : (*v)->name(), sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_soloed_to_master), (*v)->number())));
 424                 }
 425
 426         }
 427         items.push_back (MenuElem (_("Assign Soloed to VCA..."), *vca_menu));
 428
 429         items.push_back (SeparatorElem());
 430         items.push_back (MenuElem (_("Enable All Groups"), sigc::mem_fun(*this, &GroupTabs::activate_all)));
 431         items.push_back (MenuElem (_("Disable All Groups"), sigc::mem_fun(*this, &GroupTabs::disable_all)));
 432
 433         return _menu;
 434 }
 435
 436 void
 437 GroupTabs::assign_group_to_master (uint32_t which, RouteGroup* group, bool rename_master) const
 438 {
 439         if (!_session || !group) {
 440                 return;
 441         }
 442
 443         boost::shared_ptr<VCA> master;
 444
 445         if (which == 0) {
 446                 if (_session->vca_manager().create_vca (1)) {
 447                         /* error */
 448                         return;
 449                 }
 450
 451                 /* Get most recently created VCA... */
 452                 which = _session->vca_manager().vcas().back()->number();
 453         }
 454
 455         master = _session->vca_manager().vca_by_number (which);
 456
 457         if (!master) {
 458                 /* should never happen; if it does, basically something deeply
 459                    odd happened, no reason to tell user because there's no
 460                    sensible explanation.
 461                 */
 462                 return;
 463         }
 464
 465         group->assign_master (master);
 466
 467         if (rename_master){
 468                 master->set_name (group->name());
 469         }
 470 }
 471
 472 void
 473 GroupTabs::unassign_group_to_master (uint32_t which, RouteGroup* group) const
 474 {
 475         if (!_session || !group) {
 476                 return;
 477         }
 478
 479         boost::shared_ptr<VCA> master = _session->vca_manager().vca_by_number (which);
 480
 481         if (!master) {
 482                 /* should never happen; if it does, basically something deeply
 483                    odd happened, no reason to tell user because there's no
 484                    sensible explanation.
 485                 */
 486                 return;
 487         }
 488
 489         group->unassign_master (master);
 490 }
 491
 492 void
 493 GroupTabs::assign_some_to_master (uint32_t which, RouteList rl)
 494 {
 495         if (!_session) {
 496                 return;
 497         }
 498
 499         boost::shared_ptr<VCA> master;
 500
 501         if (which == 0) {
 502                 if (_session->vca_manager().create_vca (1)) {
 503                         /* error */
 504                         return;
 505                 }
 506
 507                 /* Get most recently created VCA... */
 508                 which = _session->vca_manager().vcas().back()->number();
 509         }
 510
 511         master = _session->vca_manager().vca_by_number (which);
 512
 513         if (!master) {
 514                 /* should never happen; if it does, basically something deeply
 515                    odd happened, no reason to tell user because there's no
 516                    sensible explanation.
 517                 */
 518                 return;
 519         }
 520
 521
 522         if (rl.empty()) {
 523                 return;
 524         }
 525
 526         for (RouteList::iterator r = rl.begin(); r != rl.end(); ++r) {
 527                 (*r)->assign (master, false);
 528         }
 529 }
 530
 531 RouteList
 532 GroupTabs::get_rec_enabled ()
 533 {
 534         RouteList rec_enabled;
 535
 536         if (!_session) {
 537                 return rec_enabled;
 538         }
 539
 540         boost::shared_ptr<RouteList> rl = _session->get_routes ();
 541
 542         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 543                 boost::shared_ptr<Track> trk (boost::dynamic_pointer_cast<Track> (*i));
 544                 if (trk && trk->rec_enable_control()->get_value()) {
 545                         rec_enabled.push_back (*i);
 546                 }
 547         }
 548
 549         return rec_enabled;
 550 }
 551
 552
 553 RouteList
 554 GroupTabs::get_soloed ()
 555 {
 556         boost::shared_ptr<RouteList> rl = _session->get_routes ();
 557
 558         RouteList soloed;
 559
 560         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 561                 if (!(*i)->is_master() && (*i)->soloed()) {
 562                         soloed.push_back (*i);
 563                 }
 564         }
 565
 566         return soloed;
 567 }
 568
 569 void
 570 GroupTabs::assign_selection_to_master (uint32_t which)
 571 {
 572         assign_some_to_master (which, selected_routes ());
 573 }
 574
 575 void
 576 GroupTabs::assign_recenabled_to_master (uint32_t which)
 577 {
 578         assign_some_to_master (which, get_rec_enabled());
 579 }
 580
 581 void
 582 GroupTabs::assign_soloed_to_master (uint32_t which)
 583 {
 584         assign_some_to_master (which, get_soloed());
 585 }
 586
 587 void
 588 GroupTabs::new_from_selection (bool with_master)
 589 {
 590         RouteList rl (selected_routes());
 591         run_new_group_dialog (&rl, with_master);
 592 }
 593
 594 void
 595 GroupTabs::new_from_rec_enabled (bool with_master)
 596 {
 597         RouteList rl (get_rec_enabled());
 598         run_new_group_dialog (&rl, with_master);
 599 }
 600
 601 void
 602 GroupTabs::new_from_soloed (bool with_master)
 603 {
 604         RouteList rl (get_soloed());
 605         run_new_group_dialog (&rl, with_master);
 606 }
 607
 608 void
 609 GroupTabs::run_new_group_dialog (RouteList const * rl, bool with_master)
 610 {
 611         if (rl && rl->empty()) {
 612                 return;
 613         }
 614
 615         RouteGroup* g = new RouteGroup (*_session, "");
 616         RouteGroupDialog* d = new RouteGroupDialog (g, true);
 617
 618         d->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_group_dialog_finished), d, rl ? new RouteList (*rl): 0, with_master));
 619         d->present ();
 620 }
 621
 622 void
 623 GroupTabs::new_group_dialog_finished (int r, RouteGroupDialog* d, RouteList const * rl, bool with_master) const
 624 {
 625         if (r == RESPONSE_OK) {
 626
 627                 if (!d->name_check()) {
 628                         return;
 629                 }
 630
 631                 _session->add_route_group (d->group());
 632
 633                 if (rl) {
 634                         for (RouteList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
 635                                 d->group()->add (*i);
 636                         }
 637
 638                         if (with_master) {
 639                                 assign_group_to_master (0, d->group(), true); /* zero => new master */
 640                         }
 641                 }
 642         } else {
 643                 delete d->group ();
 644         }
 645
 646         delete rl;
 647         delete_when_idle (d);
 648 }
 649
 650 void
 651 GroupTabs::edit_group (RouteGroup* g)
 652 {
 653         RouteGroupDialog* d = new RouteGroupDialog (g, false);
 654         d->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &GroupTabs::edit_group_dialog_finished), d));
 655         d->present ();
 656 }
 657
 658 void
 659 GroupTabs::edit_group_dialog_finished (int r, RouteGroupDialog* d) const
 660 {
 661         delete_when_idle (d);
 662 }
 663
 664 void
 665 GroupTabs::subgroup (RouteGroup* g, bool aux, Placement placement)
 666 {
 667         g->make_subgroup (aux, placement);
 668 }
 669
 670 void
 671 GroupTabs::un_subgroup (RouteGroup* g)
 672 {
 673         g->destroy_subgroup ();
 674 }
 675
 676 /** Collect all members of a RouteGroup so that they are together in the Editor or Mixer.
 677  *  @param g Group to collect.
 678  */
 679 void
 680 GroupTabs::collect (RouteGroup* g)
 681 {
 682         boost::shared_ptr<RouteList> group_routes = g->route_list ();
 683         group_routes->sort (Stripable::PresentationOrderSorter());
 684         int const N = group_routes->size ();
 685
 686         RouteList::iterator i = group_routes->begin ();
 687         boost::shared_ptr<RouteList> routes = _session->get_routes ();
 688         routes->sort (Stripable::PresentationOrderSorter());
 689         RouteList::const_iterator j = routes->begin ();
 690
 691         int diff = 0;
 692         int coll = -1;
 693
 694         PresentationInfo::ChangeSuspender cs;
 695
 696         while (i != group_routes->end() && j != routes->end()) {
 697
 698                 PresentationInfo::order_t const k = (*j)->presentation_info ().order();
 699
 700                 if (*i == *j) {
 701
 702                         if (coll == -1) {
 703                                 coll = k;
 704                                 diff = N - 1;
 705                         } else {
 706                                 --diff;
 707                         }
 708
 709                         (*j)->set_presentation_order (coll);
 710
 711                         ++coll;
 712                         ++i;
 713
 714                 } else {
 715
 716                         (*j)->set_presentation_order (k + diff);
 717
 718                 }
 719
 720                 ++j;
 721         }
 722 }
 723
 724 void
 725 GroupTabs::activate_all ()
 726 {
 727         _session->foreach_route_group (
 728                 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), true)
 729                 );
 730 }
 731
 732 void
 733 GroupTabs::disable_all ()
 734 {
 735         _session->foreach_route_group (
 736                 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), false)
 737                 );
 738 }
 739
 740 void
 741 GroupTabs::set_activation (RouteGroup* g, bool a)
 742 {
 743         g->set_active (a, this);
 744 }
 745
 746 void
 747 GroupTabs::remove_group (RouteGroup* g)
 748 {
 749         RouteList rl (*(g->route_list().get()));
 750         _session->remove_route_group (*g);
 751
 752         PresentationInfo::ChangeSuspender cs;
 753
 754         for (RouteList::iterator i = rl.begin(); i != rl.end(); ++i) {
 755                 (*i)->presentation_info().PropertyChanged (Properties::color);
 756         }
 757 }
 758
 759 /** Set the color of the tab of a route group */
 760 void
 761 GroupTabs::set_group_color (RouteGroup* group, uint32_t color)
 762 {
 763         assert (group);
 764         uint32_t r, g, b, a;
 765
 766         UINT_TO_RGBA (color, &r, &g, &b, &a);
 767
 768         /* Hack to disallow black route groups; force a dark grey instead */
 769         const uint32_t dark_gray = 25;
 770
 771         if (r < dark_gray && g < dark_gray && b < dark_gray) {
 772                 r = dark_gray;
 773                 g = dark_gray;
 774                 b = dark_gray;
 775         }
 776
 777         GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
 778
 779         char buf[64];
 780
 781         /* for historical reasons the colors must be stored as 16 bit color
 782          * values. Ugh.
 783          */
 784
 785         snprintf (buf, sizeof (buf), "%d:%d:%d", (r<<8), (g<<8), (b<<8));
 786         gui_state.set_property (group_gui_id (group), "color", buf);
 787
 788         /* the group color change notification */
 789
 790         PBD::PropertyChange change;
 791         change.add (Properties::color);
 792         group->PropertyChanged (change);
 793
 794         /* This is a bit of a hack, but this might change
 795            our route's effective color, so emit gui_changed
 796            for our routes.
 797         */
 798
 799         emit_gui_changed_for_members (group);
 800 }
 801
 802 /** @return the ID string to use for the GUI state of a route group */
 803 string
 804 GroupTabs::group_gui_id (RouteGroup* group)
 805 {
 806         assert (group);
 807
 808         char buf[64];
 809         snprintf (buf, sizeof (buf), "route_group %s", group->id().to_s().c_str ());
 810
 811         return buf;
 812 }
 813
 814 /** @return the color to use for a route group tab */
 815 uint32_t
 816 GroupTabs::group_color (RouteGroup* group)
 817 {
 818         assert (group);
 819
 820         GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
 821         string const gui_id = group_gui_id (group);
 822         bool empty;
 823         string const color = gui_state.get_string (gui_id, "color", &empty);
 824
 825         if (empty) {
 826                 /* no color has yet been set, so use a random one */
 827                 uint32_t c = gdk_color_to_rgba (unique_random_color (_used_colors));
 828                 set_group_color (group, c);
 829                 return c;
 830         }
 831
 832         int r, g, b;
 833
 834         /* for historical reasons, colors are stored as 16 bit values.
 835          */
 836
 837         sscanf (color.c_str(), "%d:%d:%d", &r, &g, &b);
 838
 839         r /= 256;
 840         g /= 256;
 841         b /= 256;
 842
 843         return RGBA_TO_UINT (r, g, b, 255);
 844 }
 845
 846 void
 847 GroupTabs::route_group_property_changed (RouteGroup* rg)
 848 {
 849         /* This is a bit of a hack, but this might change
 850            our route's effective color, so emit gui_changed
 851            for our routes.
 852         */
 853
 854         emit_gui_changed_for_members (rg);
 855
 856         set_dirty ();
 857 }
 858
 859 void
 860 GroupTabs::route_added_to_route_group (RouteGroup*, boost::weak_ptr<Route> w)
 861 {
 862         /* Similarly-spirited hack as in route_group_property_changed */
 863
 864         boost::shared_ptr<Route> r = w.lock ();
 865         if (!r) {
 866                 return;
 867         }
 868
 869         r->presentation_info().PropertyChanged (Properties::color);
 870
 871         set_dirty ();
 872 }
 873
 874 void
 875 GroupTabs::route_removed_from_route_group (RouteGroup*, boost::weak_ptr<Route> w)
 876 {
 877         /* Similarly-spirited hack as in route_group_property_changed */
 878
 879         boost::shared_ptr<Route> r = w.lock ();
 880         if (!r) {
 881                 return;
 882         }
 883
 884         r->presentation_info().PropertyChanged (Properties::color);
 885
 886         set_dirty ();
 887 }
 888
 889 void
 890 GroupTabs::emit_gui_changed_for_members (RouteGroup* rg)
 891 {
 892         PresentationInfo::ChangeSuspender cs;
 893
 894         for (RouteList::iterator i = rg->route_list()->begin(); i != rg->route_list()->end(); ++i) {
 895                 (*i)->presentation_info().PropertyChanged (Properties::color);
 896         }
 897 }