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