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