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