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->RouteGroupChanged.connect (_session_connections, invalidator (*this), boost::bind (&GroupTabs::set_dirty, this), gui_context());
  60                 _session->route_group_removed.connect (_session_connections, invalidator (*this), boost::bind (&GroupTabs::set_dirty, this), gui_context());
  61         }
  62 }
  63
  64
  65 /** Handle a size request.
  66  *  @param req GTK requisition
  67  */
  68 void
  69 GroupTabs::on_size_request (Gtk::Requisition *req)
  70 {
  71         /* Use a dummy, small width and the actual height that we want */
  72         req->width = 16;
  73         req->height = 16;
  74 }
  75
  76 bool
  77 GroupTabs::on_button_press_event (GdkEventButton* ev)
  78 {
  79         using namespace Menu_Helpers;
  80
  81         double const p = primary_coordinate (ev->x, ev->y);
  82
  83         list<Tab>::iterator prev;
  84         list<Tab>::iterator next;
  85         Tab* t = click_to_tab (p, &prev, &next);
  86
  87         _drag_min = prev != _tabs.end() ? prev->to : 0;
  88         _drag_max = next != _tabs.end() ? next->from : extent ();
  89
  90         if (ev->button == 1) {
  91
  92                 if (t == 0) {
  93                         Tab n;
  94                         n.from = n.to = p;
  95                         _dragging_new_tab = true;
  96
  97                         if (next == _tabs.end()) {
  98                                 _tabs.push_back (n);
  99                                 t = &_tabs.back ();
 100                         } else {
 101                                 list<Tab>::iterator j = _tabs.insert (next, n);
 102                                 t = &(*j);
 103                         }
 104
 105                 } else {
 106                         _dragging_new_tab = false;
 107                         _initial_dragging_routes = routes_for_tab (t);
 108                 }
 109
 110                 _dragging = t;
 111                 _drag_moved = false;
 112                 _drag_first = p;
 113
 114                 double const h = (t->from + t->to) / 2;
 115                 if (p < h) {
 116                         _drag_moving = t->from;
 117                         _drag_fixed = t->to;
 118                         _drag_offset = p - t->from;
 119                 } else {
 120                         _drag_moving = t->to;
 121                         _drag_fixed = t->from;
 122                         _drag_offset = p - t->to;
 123                 }
 124
 125         } else if (ev->button == 3) {
 126
 127                 RouteGroup* g = t ? t->group : 0;
 128                 Menu* m = get_menu (g);
 129                 if (m) {
 130                         m->popup (ev->button, ev->time);
 131                 }
 132
 133         }
 134
 135         return true;
 136 }
 137
 138
 139 bool
 140 GroupTabs::on_motion_notify_event (GdkEventMotion* ev)
 141 {
 142         if (_dragging == 0) {
 143                 return false;
 144         }
 145
 146         double const p = primary_coordinate (ev->x, ev->y);
 147
 148         if (p != _drag_first) {
 149                 _drag_moved = true;
 150         }
 151
 152         _drag_moving = p - _drag_offset;
 153
 154         _dragging->from = min (_drag_moving, _drag_fixed);
 155         _dragging->to = max (_drag_moving, _drag_fixed);
 156
 157         _dragging->from = max (_dragging->from, _drag_min);
 158         _dragging->to = min (_dragging->to, _drag_max);
 159
 160         set_dirty ();
 161         queue_draw ();
 162
 163         return true;
 164 }
 165
 166
 167 bool
 168 GroupTabs::on_button_release_event (GdkEventButton* ev)
 169 {
 170         if (_dragging == 0) {
 171                 return false;
 172         }
 173
 174         if (!_drag_moved) {
 175
 176                 if (_dragging->group) {
 177
 178                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 179
 180                                 /* edit */
 181                                 RouteGroupDialog d (_dragging->group, false);
 182                                 d.do_run ();
 183
 184                         } else {
 185
 186                                 /* toggle active state */
 187                                 _dragging->group->set_active (!_dragging->group->is_active (), this);
 188
 189                         }
 190                 }
 191
 192         } else {
 193                 /* finish drag */
 194                 RouteList routes = routes_for_tab (_dragging);
 195
 196                 if (!routes.empty()) {
 197                         if (_dragging_new_tab) {
 198                                 RouteGroup* g = create_and_add_group ();
 199                                 if (g) {
 200                                         for (RouteList::iterator i = routes.begin(); i != routes.end(); ++i) {
 201                                                 g->add (*i);
 202                                         }
 203                                 }
 204                         } else {
 205                                 boost::shared_ptr<RouteList> r = _session->get_routes ();
 206                                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 207
 208                                         bool const was_in_tab = find (
 209                                                 _initial_dragging_routes.begin(), _initial_dragging_routes.end(), *i
 210                                                 ) != _initial_dragging_routes.end ();
 211
 212                                         bool const now_in_tab = find (routes.begin(), routes.end(), *i) != routes.end();
 213
 214                                         if (was_in_tab && !now_in_tab) {
 215                                                 _dragging->group->remove (*i);
 216                                         } else if (!was_in_tab && now_in_tab) {
 217                                                 _dragging->group->add (*i);
 218                                         }
 219                                 }
 220                         }
 221                 }
 222
 223                 set_dirty ();
 224                 queue_draw ();
 225         }
 226
 227         _dragging = 0;
 228         _initial_dragging_routes.clear ();
 229
 230         return true;
 231 }
 232
 233 void
 234 GroupTabs::render (cairo_t* cr)
 235 {
 236         if (_dragging == 0) {
 237                 _tabs = compute_tabs ();
 238         }
 239
 240         /* background */
 241
 242         cairo_set_source_rgb (cr, 0, 0, 0);
 243         cairo_rectangle (cr, 0, 0, _width, _height);
 244         cairo_fill (cr);
 245
 246         /* tabs */
 247
 248         for (list<Tab>::const_iterator i = _tabs.begin(); i != _tabs.end(); ++i) {
 249                 draw_tab (cr, *i);
 250         }
 251 }
 252
 253
 254 /** Convert a click position to a tab.
 255  *  @param c Click position.
 256  *  @param prev Filled in with the previous tab to the click, or _tabs.end().
 257  *  @param next Filled in with the next tab after the click, or _tabs.end().
 258  *  @return Tab under the click, or 0.
 259  */
 260
 261 GroupTabs::Tab *
 262 GroupTabs::click_to_tab (double c, list<Tab>::iterator* prev, list<Tab>::iterator* next)
 263 {
 264         *prev = *next = _tabs.end ();
 265         Tab* under = 0;
 266
 267         list<Tab>::iterator i = _tabs.begin ();
 268         while (i != _tabs.end()) {
 269
 270                 if (i->from > c) {
 271                         *next = i;
 272                         break;
 273                 }
 274
 275                 if (i->to < c) {
 276                         *prev = i;
 277                         ++i;
 278                         continue;
 279                 }
 280
 281                 if (i->from <= c && c < i->to) {
 282                         under = &(*i);
 283                 }
 284
 285                 ++i;
 286         }
 287
 288         return under;
 289 }
 290
 291 Gtk::Menu*
 292 GroupTabs::get_menu (RouteGroup* g)
 293 {
 294         using namespace Menu_Helpers;
 295
 296         delete _menu;
 297
 298         Menu* new_from = new Menu;
 299         MenuList& f = new_from->items ();
 300         f.push_back (MenuElem (_("Selection..."), sigc::mem_fun (*this, &GroupTabs::new_from_selection)));
 301         f.push_back (MenuElem (_("Record Enabled..."), sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled)));
 302         f.push_back (MenuElem (_("Soloed..."), sigc::mem_fun (*this, &GroupTabs::new_from_soloed)));
 303
 304         _menu = new Menu;
 305         _menu->set_name ("ArdourContextMenu");
 306         MenuList& items = _menu->items();
 307
 308         items.push_back (MenuElem (_("New..."), hide_return (sigc::mem_fun(*this, &GroupTabs::create_and_add_group))));
 309         items.push_back (MenuElem (_("New From"), *new_from));
 310
 311         if (g) {
 312                 items.push_back (MenuElem (_("Edit..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::edit_group), g)));
 313                 items.push_back (MenuElem (_("Add New Subgroup Bus"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, false, PreFader)));
 314                 items.push_back (MenuElem (_("Add New Aux Bus (pre-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PreFader)));
 315                 items.push_back (MenuElem (_("Add New Aux Bus (post-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PostFader)));
 316                 items.push_back (MenuElem (_("Collect"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::collect), g)));
 317                 items.push_back (MenuElem (_("Remove"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::remove_group), g)));
 318         }
 319
 320         add_menu_items (_menu, g);
 321
 322         items.push_back (SeparatorElem());
 323         items.push_back (MenuElem (_("Activate All"), sigc::mem_fun(*this, &GroupTabs::activate_all)));
 324         items.push_back (MenuElem (_("Disable All"), sigc::mem_fun(*this, &GroupTabs::disable_all)));
 325
 326         return _menu;
 327
 328 }
 329
 330 void
 331 GroupTabs::new_from_selection ()
 332 {
 333         RouteList rl = selected_routes ();
 334         if (rl.empty()) {
 335                 return;
 336         }
 337
 338         run_new_group_dialog (rl);
 339 }
 340
 341 void
 342 GroupTabs::new_from_rec_enabled ()
 343 {
 344         boost::shared_ptr<RouteList> rl = _session->get_routes ();
 345
 346         RouteList rec_enabled;
 347
 348         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 349                 if ((*i)->record_enabled()) {
 350                         rec_enabled.push_back (*i);
 351                 }
 352         }
 353
 354         if (rec_enabled.empty()) {
 355                 return;
 356         }
 357
 358         run_new_group_dialog (rec_enabled);
 359 }
 360
 361 void
 362 GroupTabs::new_from_soloed ()
 363 {
 364         boost::shared_ptr<RouteList> rl = _session->get_routes ();
 365
 366         RouteList soloed;
 367
 368         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 369                 if (!(*i)->is_master() && (*i)->soloed()) {
 370                         soloed.push_back (*i);
 371                 }
 372         }
 373
 374         if (soloed.empty()) {
 375                 return;
 376         }
 377
 378         run_new_group_dialog (soloed);
 379 }
 380
 381 void
 382 GroupTabs::run_new_group_dialog (RouteList const & rl)
 383 {
 384         RouteGroup* g = new RouteGroup (*_session, "");
 385         g->apply_changes (default_properties ());
 386
 387         RouteGroupDialog d (g, true);
 388
 389         if (d.do_run ()) {
 390                 delete g;
 391         } else {
 392                 _session->add_route_group (g);
 393                 for (RouteList::const_iterator i = rl.begin(); i != rl.end(); ++i) {
 394                         g->add (*i);
 395                 }
 396         }
 397 }
 398
 399 RouteGroup *
 400 GroupTabs::create_and_add_group () const
 401 {
 402         RouteGroup* g = new RouteGroup (*_session, "");
 403
 404         g->apply_changes (default_properties ());
 405
 406         RouteGroupDialog d (g, true);
 407
 408         if (d.do_run ()) {
 409                 delete g;
 410                 return 0;
 411         }
 412
 413         _session->add_route_group (g);
 414         return g;
 415 }
 416
 417 void
 418 GroupTabs::edit_group (RouteGroup* g)
 419 {
 420         RouteGroupDialog d (g, false);
 421         d.do_run ();
 422 }
 423
 424 void
 425 GroupTabs::subgroup (RouteGroup* g, bool aux, Placement placement)
 426 {
 427         g->make_subgroup (aux, placement);
 428 }
 429
 430 struct CollectSorter {
 431         CollectSorter (std::string const & key) : _key (key) {}
 432
 433         bool operator () (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
 434                 return a->order_key (_key) < b->order_key (_key);
 435         }
 436
 437         std::string _key;
 438 };
 439
 440 /** Collect all members of a RouteGroup so that they are together in the Editor or Mixer.
 441  *  @param g Group to collect.
 442  */
 443 void
 444 GroupTabs::collect (RouteGroup* g)
 445 {
 446         boost::shared_ptr<RouteList> group_routes = g->route_list ();
 447         group_routes->sort (CollectSorter (order_key ()));
 448         int const N = group_routes->size ();
 449
 450         RouteList::iterator i = group_routes->begin ();
 451         boost::shared_ptr<RouteList> routes = _session->get_routes ();
 452         RouteList::const_iterator j = routes->begin ();
 453
 454         int diff = 0;
 455         int coll = -1;
 456         while (i != group_routes->end() && j != routes->end()) {
 457
 458                 int const k = (*j)->order_key (order_key ());
 459
 460                 if (*i == *j) {
 461
 462                         if (coll == -1) {
 463                                 coll = k;
 464                                 diff = N - 1;
 465                         } else {
 466                                 --diff;
 467                         }
 468
 469                         (*j)->set_order_key (order_key (), coll);
 470
 471                         ++coll;
 472                         ++i;
 473
 474                 } else {
 475
 476                         (*j)->set_order_key (order_key (), k + diff);
 477
 478                 }
 479
 480                 ++j;
 481         }
 482
 483         sync_order_keys ();
 484 }
 485
 486 void
 487 GroupTabs::activate_all ()
 488 {
 489         _session->foreach_route_group (
 490                 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), true)
 491                 );
 492 }
 493
 494 void
 495 GroupTabs::disable_all ()
 496 {
 497         _session->foreach_route_group (
 498                 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), false)
 499                 );
 500 }
 501
 502 void
 503 GroupTabs::set_activation (RouteGroup* g, bool a)
 504 {
 505         g->set_active (a, this);
 506 }
 507
 508 void
 509 GroupTabs::remove_group (RouteGroup* g)
 510 {
 511         _session->remove_route_group (*g);
 512 }
 513
 514 /** Set the color of the tab of a route group */
 515 void
 516 GroupTabs::set_group_color (RouteGroup* group, Gdk::Color color)
 517 {
 518         assert (group);
 519
 520         GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
 521
 522         char buf[64];
 523         snprintf (buf, sizeof (buf), "%d:%d:%d", color.get_red(), color.get_green(), color.get_blue());
 524         gui_state.set (group_gui_id (group), "color", buf);
 525
 526         /* This is a bit of a hack, but this might change
 527            our route's effective color, so emit gui_changed
 528            for our routes.
 529         */
 530
 531         for (RouteList::iterator i = group->route_list()->begin(); i != group->route_list()->end(); ++i) {
 532                 (*i)->gui_changed (X_("color"), 0);
 533         }
 534 }
 535
 536 /** @return the ID string to use for the GUI state of a route group */
 537 string
 538 GroupTabs::group_gui_id (RouteGroup* group)
 539 {
 540         assert (group);
 541
 542         char buf[64];
 543         snprintf (buf, sizeof (buf), "route_group %s", group->id().to_s().c_str ());
 544
 545         return buf;
 546 }
 547
 548 /** @return the color to use for a route group tab */
 549 Gdk::Color
 550 GroupTabs::group_color (RouteGroup* group)
 551 {
 552         assert (group);
 553
 554         GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
 555
 556         string const gui_id = group_gui_id (group);
 557
 558         bool empty;
 559         string const color = gui_state.get_string (gui_id, "color", &empty);
 560         if (empty) {
 561                 /* no color has yet been set, so use a random one */
 562                 Gdk::Color const color = unique_random_color (_used_colors);
 563                 set_group_color (group, color);
 564                 return color;
 565         }
 566
 567         Gdk::Color c;
 568
 569         int r, g, b;
 570
 571         sscanf (color.c_str(), "%d:%d:%d", &r, &g, &b);
 572
 573         c.set_red (r);
 574         c.set_green (g);
 575         c.set_blue (b);
 576
 577         return c;
 578 }
 579