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
 138                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier) && g) {
 139                         /* edit */
 140                         RouteGroupDialog d (g, false);
 141                         d.do_run ();
 142                 } else {
 143                         Menu* m = get_menu (g);
 144                         if (m) {
 145                                 m->popup (ev->button, ev->time);
 146                         }
 147                 }
 148         }
 149
 150         return true;
 151 }
 152
 153
 154 bool
 155 GroupTabs::on_motion_notify_event (GdkEventMotion* ev)
 156 {
 157         if (_dragging == 0) {
 158                 return false;
 159         }
 160
 161         double const p = primary_coordinate (ev->x, ev->y);
 162
 163         if (p != _drag_first) {
 164                 _drag_moved = true;
 165         }
 166
 167         _drag_moving = p - _drag_offset;
 168
 169         _dragging->from = min (_drag_moving, _drag_fixed);
 170         _dragging->to = max (_drag_moving, _drag_fixed);
 171
 172         _dragging->from = max (_dragging->from, _drag_min);
 173         _dragging->to = min (_dragging->to, _drag_max);
 174
 175         set_dirty ();
 176         queue_draw ();
 177
 178         return true;
 179 }
 180
 181
 182 bool
 183 GroupTabs::on_button_release_event (GdkEventButton*)
 184 {
 185         if (_dragging == 0) {
 186                 return false;
 187         }
 188
 189         if (!_drag_moved) {
 190
 191                 if (_dragging->group) {
 192                         /* toggle active state */
 193                         _dragging->group->set_active (!_dragging->group->is_active (), this);
 194                 }
 195
 196         } else {
 197                 /* finish drag */
 198                 RouteList routes = routes_for_tab (_dragging);
 199
 200                 if (!routes.empty()) {
 201                         if (_dragging_new_tab) {
 202                                 RouteGroup* g = create_and_add_group ();
 203                                 if (g) {
 204                                         for (RouteList::iterator i = routes.begin(); i != routes.end(); ++i) {
 205                                                 g->add (*i);
 206                                         }
 207                                 }
 208                         } else {
 209                                 boost::shared_ptr<RouteList> r = _session->get_routes ();
 210                                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 211
 212                                         bool const was_in_tab = find (
 213                                                 _initial_dragging_routes.begin(), _initial_dragging_routes.end(), *i
 214                                                 ) != _initial_dragging_routes.end ();
 215
 216                                         bool const now_in_tab = find (routes.begin(), routes.end(), *i) != routes.end();
 217
 218                                         if (was_in_tab && !now_in_tab) {
 219                                                 _dragging->group->remove (*i);
 220                                         } else if (!was_in_tab && now_in_tab) {
 221                                                 _dragging->group->add (*i);
 222                                         }
 223                                 }
 224                         }
 225                 }
 226
 227                 set_dirty ();
 228                 queue_draw ();
 229         }
 230
 231         _dragging = 0;
 232         _initial_dragging_routes.clear ();
 233
 234         return true;
 235 }
 236
 237 void
 238 GroupTabs::render (cairo_t* cr)
 239 {
 240         if (_dragging == 0) {
 241                 _tabs = compute_tabs ();
 242         }
 243
 244         /* background */
 245
 246         Gdk::Color c = get_style()->get_base (Gtk::STATE_NORMAL);
 247
 248         cairo_set_source_rgb (cr, c.get_red_p(), c.get_green_p(), c.get_blue_p());
 249         cairo_rectangle (cr, 0, 0, get_width(), get_height());
 250         cairo_fill (cr);
 251
 252         /* tabs */
 253
 254         for (list<Tab>::const_iterator i = _tabs.begin(); i != _tabs.end(); ++i) {
 255                 draw_tab (cr, *i);
 256         }
 257 }
 258
 259
 260 /** Convert a click position to a tab.
 261  *  @param c Click position.
 262  *  @param prev Filled in with the previous tab to the click, or _tabs.end().
 263  *  @param next Filled in with the next tab after the click, or _tabs.end().
 264  *  @return Tab under the click, or 0.
 265  */
 266
 267 GroupTabs::Tab *
 268 GroupTabs::click_to_tab (double c, list<Tab>::iterator* prev, list<Tab>::iterator* next)
 269 {
 270         *prev = *next = _tabs.end ();
 271         Tab* under = 0;
 272
 273         list<Tab>::iterator i = _tabs.begin ();
 274         while (i != _tabs.end()) {
 275
 276                 if (i->from > c) {
 277                         *next = i;
 278                         break;
 279                 }
 280
 281                 if (i->to < c) {
 282                         *prev = i;
 283                         ++i;
 284                         continue;
 285                 }
 286
 287                 if (i->from <= c && c < i->to) {
 288                         under = &(*i);
 289                 }
 290
 291                 ++i;
 292         }
 293
 294         return under;
 295 }
 296
 297 Gtk::Menu*
 298 GroupTabs::get_menu (RouteGroup* g)
 299 {
 300         using namespace Menu_Helpers;
 301
 302         delete _menu;
 303
 304         Menu* new_from = new Menu;
 305         MenuList& f = new_from->items ();
 306         f.push_back (MenuElem (_("Selection..."), sigc::mem_fun (*this, &GroupTabs::new_from_selection)));
 307         f.push_back (MenuElem (_("Record Enabled..."), sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled)));
 308         f.push_back (MenuElem (_("Soloed..."), sigc::mem_fun (*this, &GroupTabs::new_from_soloed)));
 309
 310         _menu = new Menu;
 311         _menu->set_name ("ArdourContextMenu");
 312         MenuList& items = _menu->items();
 313
 314         items.push_back (MenuElem (_("Create New Group ..."), hide_return (sigc::mem_fun(*this, &GroupTabs::create_and_add_group))));
 315         items.push_back (MenuElem (_("Create New Group From"), *new_from));
 316
 317         if (g) {
 318                 items.push_back (MenuElem (_("Edit Group..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::edit_group), g)));
 319                 items.push_back (MenuElem (_("Collect Group"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::collect), g)));
 320                 items.push_back (MenuElem (_("Remove Group"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::remove_group), g)));
 321                 items.push_back (SeparatorElem());
 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         }
 326
 327         add_menu_items (_menu, g);
 328
 329         items.push_back (SeparatorElem());
 330         items.push_back (MenuElem (_("Enable All Groups"), sigc::mem_fun(*this, &GroupTabs::activate_all)));
 331         items.push_back (MenuElem (_("Disable All Groups"), sigc::mem_fun(*this, &GroupTabs::disable_all)));
 332
 333         return _menu;
 334
 335 }
 336
 337 void
 338 GroupTabs::new_from_selection ()
 339 {
 340         RouteList rl = selected_routes ();
 341         if (rl.empty()) {
 342                 return;
 343         }
 344
 345         run_new_group_dialog (rl);
 346 }
 347
 348 void
 349 GroupTabs::new_from_rec_enabled ()
 350 {
 351         boost::shared_ptr<RouteList> rl = _session->get_routes ();
 352
 353         RouteList rec_enabled;
 354
 355         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 356                 if ((*i)->record_enabled()) {
 357                         rec_enabled.push_back (*i);
 358                 }
 359         }
 360
 361         if (rec_enabled.empty()) {
 362                 return;
 363         }
 364
 365         run_new_group_dialog (rec_enabled);
 366 }
 367
 368 void
 369 GroupTabs::new_from_soloed ()
 370 {
 371         boost::shared_ptr<RouteList> rl = _session->get_routes ();
 372
 373         RouteList soloed;
 374
 375         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 376                 if (!(*i)->is_master() && (*i)->soloed()) {
 377                         soloed.push_back (*i);
 378                 }
 379         }
 380
 381         if (soloed.empty()) {
 382                 return;
 383         }
 384
 385         run_new_group_dialog (soloed);
 386 }
 387
 388 void
 389 GroupTabs::run_new_group_dialog (RouteList const & rl)
 390 {
 391         RouteGroup* g = new RouteGroup (*_session, "");
 392         g->apply_changes (default_properties ());
 393
 394         RouteGroupDialog d (g, true);
 395
 396         if (d.do_run ()) {
 397                 delete g;
 398         } else {
 399                 _session->add_route_group (g);
 400                 for (RouteList::const_iterator i = rl.begin(); i != rl.end(); ++i) {
 401                         g->add (*i);
 402                 }
 403         }
 404 }
 405
 406 RouteGroup *
 407 GroupTabs::create_and_add_group () const
 408 {
 409         RouteGroup* g = new RouteGroup (*_session, "");
 410
 411         g->apply_changes (default_properties ());
 412
 413         RouteGroupDialog d (g, true);
 414
 415         if (d.do_run ()) {
 416                 delete g;
 417                 return 0;
 418         }
 419
 420         _session->add_route_group (g);
 421         return g;
 422 }
 423
 424 void
 425 GroupTabs::edit_group (RouteGroup* g)
 426 {
 427         RouteGroupDialog d (g, false);
 428         d.do_run ();
 429 }
 430
 431 void
 432 GroupTabs::subgroup (RouteGroup* g, bool aux, Placement placement)
 433 {
 434         g->make_subgroup (aux, placement);
 435 }
 436
 437 struct CollectSorter {
 438         CollectSorter (RouteSortOrderKey key) : _key (key) {}
 439
 440         bool operator () (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
 441                 return a->order_key (_key) < b->order_key (_key);
 442         }
 443
 444         RouteSortOrderKey _key;
 445 };
 446
 447 struct OrderSorter {
 448         OrderSorter (RouteSortOrderKey key) : _key (key) {}
 449
 450         bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
 451                 return a->order_key (_key) < b->order_key (_key);
 452         }
 453
 454         RouteSortOrderKey _key;
 455 };
 456
 457 /** Collect all members of a RouteGroup so that they are together in the Editor or Mixer.
 458  *  @param g Group to collect.
 459  */
 460 void
 461 GroupTabs::collect (RouteGroup* g)
 462 {
 463         boost::shared_ptr<RouteList> group_routes = g->route_list ();
 464         group_routes->sort (CollectSorter (order_key ()));
 465         int const N = group_routes->size ();
 466
 467         RouteList::iterator i = group_routes->begin ();
 468         boost::shared_ptr<RouteList> routes = _session->get_routes ();
 469         routes->sort (OrderSorter (order_key ()));
 470         RouteList::const_iterator j = routes->begin ();
 471
 472         int diff = 0;
 473         int coll = -1;
 474         while (i != group_routes->end() && j != routes->end()) {
 475
 476                 int const k = (*j)->order_key (order_key ());
 477
 478                 if (*i == *j) {
 479
 480                         if (coll == -1) {
 481                                 coll = k;
 482                                 diff = N - 1;
 483                         } else {
 484                                 --diff;
 485                         }
 486
 487                         (*j)->set_order_key (order_key (), coll);
 488
 489                         ++coll;
 490                         ++i;
 491
 492                 } else {
 493
 494                         (*j)->set_order_key (order_key (), k + diff);
 495
 496                 }
 497
 498                 ++j;
 499         }
 500
 501         sync_order_keys ();
 502 }
 503
 504 void
 505 GroupTabs::activate_all ()
 506 {
 507         _session->foreach_route_group (
 508                 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), true)
 509                 );
 510 }
 511
 512 void
 513 GroupTabs::disable_all ()
 514 {
 515         _session->foreach_route_group (
 516                 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), false)
 517                 );
 518 }
 519
 520 void
 521 GroupTabs::set_activation (RouteGroup* g, bool a)
 522 {
 523         g->set_active (a, this);
 524 }
 525
 526 void
 527 GroupTabs::remove_group (RouteGroup* g)
 528 {
 529         _session->remove_route_group (*g);
 530 }
 531
 532 /** Set the color of the tab of a route group */
 533 void
 534 GroupTabs::set_group_color (RouteGroup* group, Gdk::Color color)
 535 {
 536         assert (group);
 537
 538         /* Hack to disallow black route groups; force a dark grey instead */
 539         if (color.get_red() == 0 && color.get_green() == 0 && color.get_blue() == 0) {
 540                 color.set_grey_p (0.1);
 541         }
 542
 543         GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
 544
 545         char buf[64];
 546         snprintf (buf, sizeof (buf), "%d:%d:%d", color.get_red(), color.get_green(), color.get_blue());
 547         gui_state.set_property (group_gui_id (group), "color", buf);
 548
 549         /* the group color change notification */
 550
 551         PBD::PropertyChange change;
 552         change.add (Properties::color);
 553         group->PropertyChanged (change);
 554
 555         /* This is a bit of a hack, but this might change
 556            our route's effective color, so emit gui_changed
 557            for our routes.
 558         */
 559
 560         emit_gui_changed_for_members (group);
 561 }
 562
 563 /** @return the ID string to use for the GUI state of a route group */
 564 string
 565 GroupTabs::group_gui_id (RouteGroup* group)
 566 {
 567         assert (group);
 568
 569         char buf[64];
 570         snprintf (buf, sizeof (buf), "route_group %s", group->id().to_s().c_str ());
 571
 572         return buf;
 573 }
 574
 575 /** @return the color to use for a route group tab */
 576 Gdk::Color
 577 GroupTabs::group_color (RouteGroup* group)
 578 {
 579         assert (group);
 580
 581         GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
 582
 583         string const gui_id = group_gui_id (group);
 584
 585         bool empty;
 586         string const color = gui_state.get_string (gui_id, "color", &empty);
 587         if (empty) {
 588                 /* no color has yet been set, so use a random one */
 589                 Gdk::Color const color = unique_random_color (_used_colors);
 590                 set_group_color (group, color);
 591                 return color;
 592         }
 593
 594         Gdk::Color c;
 595
 596         int r, g, b;
 597
 598         sscanf (color.c_str(), "%d:%d:%d", &r, &g, &b);
 599
 600         c.set_red (r);
 601         c.set_green (g);
 602         c.set_blue (b);
 603
 604         return c;
 605 }
 606
 607 void
 608 GroupTabs::route_group_property_changed (RouteGroup* rg)
 609 {
 610         /* This is a bit of a hack, but this might change
 611            our route's effective color, so emit gui_changed
 612            for our routes.
 613         */
 614
 615         emit_gui_changed_for_members (rg);
 616
 617         set_dirty ();
 618 }
 619
 620 void
 621 GroupTabs::route_added_to_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::route_removed_from_route_group (RouteGroup*, boost::weak_ptr<Route> w)
 637 {
 638         /* Similarly-spirited hack as in route_group_property_changed */
 639
 640         boost::shared_ptr<Route> r = w.lock ();
 641         if (!r) {
 642                 return;
 643         }
 644
 645         r->gui_changed (X_("color"), 0);
 646
 647         set_dirty ();
 648 }
 649
 650 void
 651 GroupTabs::emit_gui_changed_for_members (RouteGroup* rg)
 652 {
 653         for (RouteList::iterator i = rg->route_list()->begin(); i != rg->route_list()->end(); ++i) {
 654                 (*i)->gui_changed (X_("color"), 0);
 655         }
 656 }