2 Copyright (C) 2009 Paul Davis
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.
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.
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.
20 #include <gtkmm/stock.h>
21 #include "ardour/session.h"
22 #include "ardour/route_group.h"
23 #include "ardour/route.h"
25 #include "gui_thread.h"
26 #include "route_group_dialog.h"
27 #include "group_tabs.h"
30 #include "ardour_ui.h"
31 #include "rgb_macros.h"
32 #include "ui_config.h"
37 using namespace ARDOUR;
38 using namespace ARDOUR_UI_UTILS;
39 using Gtkmm2ext::Keyboard;
41 list<Gdk::Color> GroupTabs::_used_colors;
43 GroupTabs::GroupTabs ()
46 , _dragging_new_tab (0)
48 add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::POINTER_MOTION_MASK);
49 UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &GroupTabs::queue_draw));
52 GroupTabs::~GroupTabs ()
58 GroupTabs::set_session (Session* s)
60 SessionHandlePtr::set_session (s);
63 _session->RouteGroupPropertyChanged.connect (
64 _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_group_property_changed, this, _1), gui_context()
66 _session->RouteAddedToRouteGroup.connect (
67 _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_added_to_route_group, this, _1, _2), gui_context()
69 _session->RouteRemovedFromRouteGroup.connect (
70 _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_removed_from_route_group, this, _1, _2), gui_context()
73 _session->route_group_removed.connect (_session_connections, invalidator (*this), boost::bind (&GroupTabs::set_dirty, this, (cairo_rectangle_t*)0), gui_context());
78 /** Handle a size request.
79 * @param req GTK requisition
82 GroupTabs::on_size_request (Gtk::Requisition *req)
84 /* Use a dummy, small width and the actual height that we want */
90 GroupTabs::on_button_press_event (GdkEventButton* ev)
92 using namespace Menu_Helpers;
94 double const p = primary_coordinate (ev->x, ev->y);
96 list<Tab>::iterator prev;
97 list<Tab>::iterator next;
98 Tab* t = click_to_tab (p, &prev, &next);
100 _drag_min = prev != _tabs.end() ? prev->to : 0;
101 _drag_max = next != _tabs.end() ? next->from : extent ();
103 if (ev->button == 1) {
108 _dragging_new_tab = true;
110 if (next == _tabs.end()) {
114 list<Tab>::iterator j = _tabs.insert (next, n);
119 _dragging_new_tab = false;
120 _initial_dragging_routes = routes_for_tab (t);
127 double const h = (t->from + t->to) / 2;
129 _drag_moving = t->from;
131 _drag_offset = p - t->from;
133 _drag_moving = t->to;
134 _drag_fixed = t->from;
135 _drag_offset = p - t->to;
138 } else if (ev->button == 3) {
140 RouteGroup* g = t ? t->group : 0;
142 if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier) && g) {
144 RouteGroupDialog d (g, false);
147 Menu* m = get_menu (g, true);
149 m->popup (ev->button, ev->time);
159 GroupTabs::on_motion_notify_event (GdkEventMotion* ev)
161 if (_dragging == 0) {
165 double const p = primary_coordinate (ev->x, ev->y);
167 if (p != _drag_first) {
171 _drag_moving = p - _drag_offset;
173 _dragging->from = min (_drag_moving, _drag_fixed);
174 _dragging->to = max (_drag_moving, _drag_fixed);
176 _dragging->from = max (_dragging->from, _drag_min);
177 _dragging->to = min (_dragging->to, _drag_max);
182 gdk_event_request_motions(ev);
189 GroupTabs::on_button_release_event (GdkEventButton*)
191 if (_dragging == 0) {
197 if (_dragging->group) {
198 /* toggle active state */
199 _dragging->group->set_active (!_dragging->group->is_active (), this);
204 RouteList routes = routes_for_tab (_dragging);
206 if (!routes.empty()) {
207 if (_dragging_new_tab) {
208 RouteGroup* g = create_and_add_group ();
210 for (RouteList::iterator i = routes.begin(); i != routes.end(); ++i) {
215 boost::shared_ptr<RouteList> r = _session->get_routes ();
216 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
218 bool const was_in_tab = find (
219 _initial_dragging_routes.begin(), _initial_dragging_routes.end(), *i
220 ) != _initial_dragging_routes.end ();
222 bool const now_in_tab = find (routes.begin(), routes.end(), *i) != routes.end();
224 if (was_in_tab && !now_in_tab) {
225 _dragging->group->remove (*i);
226 } else if (!was_in_tab && now_in_tab) {
227 _dragging->group->add (*i);
238 _initial_dragging_routes.clear ();
244 GroupTabs::render (cairo_t* cr, cairo_rectangle_t*)
246 if (_dragging == 0) {
247 _tabs = compute_tabs ();
252 Gdk::Color c = get_style()->get_base (Gtk::STATE_NORMAL);
254 cairo_set_source_rgb (cr, c.get_red_p(), c.get_green_p(), c.get_blue_p());
255 cairo_rectangle (cr, 0, 0, get_width(), get_height());
260 for (list<Tab>::const_iterator i = _tabs.begin(); i != _tabs.end(); ++i) {
266 /** Convert a click position to a tab.
267 * @param c Click position.
268 * @param prev Filled in with the previous tab to the click, or _tabs.end().
269 * @param next Filled in with the next tab after the click, or _tabs.end().
270 * @return Tab under the click, or 0.
274 GroupTabs::click_to_tab (double c, list<Tab>::iterator* prev, list<Tab>::iterator* next)
276 *prev = *next = _tabs.end ();
279 list<Tab>::iterator i = _tabs.begin ();
280 while (i != _tabs.end()) {
293 if (i->from <= c && c < i->to) {
304 GroupTabs::get_menu (RouteGroup* g, bool TabArea)
306 using namespace Menu_Helpers;
311 _menu->set_name ("ArdourContextMenu");
312 MenuList& items = _menu->items();
315 items.push_back (MenuElem (_("Create New Group ..."), hide_return (sigc::mem_fun(*this, &GroupTabs::create_and_add_group))));
316 items.push_back (MenuElem (_("Create New Control Master ..."), hide_return (sigc::mem_fun(*this, &GroupTabs::create_and_add_master))));
317 items.push_back (MenuElem (_("Create New Group & Control Master ..."), hide_return (sigc::mem_fun(*this, &GroupTabs::create_and_add_group_with_master))));
320 Menu* new_from = new Menu;
322 MenuList& f = new_from->items ();
323 f.push_back (MenuElem (_("Selection..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_selection), false, false)));
324 f.push_back (MenuElem (_("Record Enabled..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled), false, false)));
325 f.push_back (MenuElem (_("Soloed..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_soloed), false, false)));
327 items.push_back (MenuElem (_("Create New Group From"), *new_from));
331 MenuList& f = new_from->items ();
332 f.push_back (MenuElem (_("Selection..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_selection), true, false)));
333 f.push_back (MenuElem (_("Record Enabled..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled), true, false)));
334 f.push_back (MenuElem (_("Soloed..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_soloed), true, false)));
336 items.push_back (MenuElem (_("Create New Master From"), *new_from));
340 MenuList& f = new_from->items ();
341 f.push_back (MenuElem (_("Selection..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_selection), true, true)));
342 f.push_back (MenuElem (_("Record Enabled..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled), true, true)));
343 f.push_back (MenuElem (_("Soloed..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_soloed), true, true)));
345 items.push_back (MenuElem (_("Create New Group & Master From"), *new_from));
350 items.push_back (MenuElem (_("Edit Group..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::edit_group), g)));
351 items.push_back (MenuElem (_("Collect Group"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::collect), g)));
352 items.push_back (MenuElem (_("Remove Group"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::remove_group), g)));
353 items.push_back (SeparatorElem());
354 if (g->has_subgroup()) {
355 items.push_back (MenuElem (_("Remove Subgroup Bus"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::un_subgroup), g)));
357 items.push_back (MenuElem (_("Add New Subgroup Bus"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, false, PreFader)));
359 items.push_back (MenuElem (_("Add New Aux Bus (pre-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PreFader)));
360 items.push_back (MenuElem (_("Add New Aux Bus (post-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PostFader)));
361 items.push_back (SeparatorElem());
364 MenuList& f (vca_menu->items());
365 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_selection_to_master), 0)));
366 f.push_back (MenuElem ("VCA 1", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_selection_to_master), 1)));
367 items.push_back (MenuElem (_("Assign Group to Control Master..."), *vca_menu));
370 add_menu_items (_menu, g);
372 items.push_back (SeparatorElem());
373 items.push_back (MenuElem (_("Enable All Groups"), sigc::mem_fun(*this, &GroupTabs::activate_all)));
374 items.push_back (MenuElem (_("Disable All Groups"), sigc::mem_fun(*this, &GroupTabs::disable_all)));
375 items.push_back (SeparatorElem());
379 MenuList& f (vca_menu->items());
380 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_selection_to_master), 0)));
381 f.push_back (MenuElem ("VCA 1", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_selection_to_master), 1)));
385 items.push_back (MenuElem (_("Assign Selection to Control Master..."), *vca_menu));
389 MenuList& f (vca_menu->items());
390 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_selection_to_master), 0)));
391 f.push_back (MenuElem ("VCA 1", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_recenabled_to_master), 1)));
394 items.push_back (MenuElem (_("Assign Record Enabled to Control Master..."), *vca_menu));
398 MenuList& f (vca_menu->items());
399 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_selection_to_master), 0)));
400 f.push_back (MenuElem ("VCA 1", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_soloed_to_master), 1)));
403 items.push_back (MenuElem (_("Assign Soloed to Control Master...")));
410 GroupTabs::assign_selection_to_master (uint32_t which)
415 GroupTabs::assign_recenabled_to_master (uint32_t which)
420 GroupTabs::assign_soloed_to_master (uint32_t which)
425 GroupTabs::new_from_selection (bool just_master, bool with_master)
427 RouteList rl = selected_routes ();
432 run_new_group_dialog (rl, with_master);
436 GroupTabs::new_from_rec_enabled (bool just_master, bool with_master)
438 boost::shared_ptr<RouteList> rl = _session->get_routes ();
440 RouteList rec_enabled;
442 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
443 boost::shared_ptr<Track> trk (boost::dynamic_pointer_cast<Track> (*i));
444 if (trk && trk->rec_enable_control()->get_value()) {
445 rec_enabled.push_back (*i);
449 if (rec_enabled.empty()) {
453 run_new_group_dialog (rec_enabled, with_master);
457 GroupTabs::new_from_soloed (bool just_master, bool with_master)
459 boost::shared_ptr<RouteList> rl = _session->get_routes ();
463 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
464 if (!(*i)->is_master() && (*i)->soloed()) {
465 soloed.push_back (*i);
469 if (soloed.empty()) {
473 run_new_group_dialog (soloed, with_master);
477 GroupTabs::run_new_group_dialog (RouteList const & rl, bool with_master)
479 RouteGroup* g = new RouteGroup (*_session, "");
480 RouteGroupDialog d (g, true);
485 _session->add_route_group (g);
486 for (RouteList::const_iterator i = rl.begin(); i != rl.end(); ++i) {
493 GroupTabs::create_and_add_group () const
495 RouteGroup* g = new RouteGroup (*_session, "");
496 RouteGroupDialog d (g, true);
503 _session->add_route_group (g);
508 GroupTabs::create_and_add_master () const
514 GroupTabs::create_and_add_group_with_master () const
516 RouteGroup* g = new RouteGroup (*_session, "");
517 RouteGroupDialog d (g, true);
524 _session->add_route_group (g);
529 GroupTabs::edit_group (RouteGroup* g)
531 RouteGroupDialog d (g, false);
536 GroupTabs::subgroup (RouteGroup* g, bool aux, Placement placement)
538 g->make_subgroup (aux, placement);
542 GroupTabs::un_subgroup (RouteGroup* g)
544 g->destroy_subgroup ();
547 struct CollectSorter {
548 bool operator () (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
549 return a->presentation_info () < b->presentation_info();
554 bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
555 return a->presentation_info() < b->presentation_info();
559 /** Collect all members of a RouteGroup so that they are together in the Editor or Mixer.
560 * @param g Group to collect.
563 GroupTabs::collect (RouteGroup* g)
565 boost::shared_ptr<RouteList> group_routes = g->route_list ();
566 group_routes->sort (CollectSorter ());
567 int const N = group_routes->size ();
569 RouteList::iterator i = group_routes->begin ();
570 boost::shared_ptr<RouteList> routes = _session->get_routes ();
571 routes->sort (OrderSorter ());
572 RouteList::const_iterator j = routes->begin ();
576 while (i != group_routes->end() && j != routes->end()) {
578 PresentationInfo::order_t const k = (*j)->presentation_info ().group_order();
589 (*j)->set_presentation_group_order_explicit (coll);
596 (*j)->set_presentation_group_order_explicit (k + diff);
603 _session->notify_presentation_info_change ();
607 GroupTabs::activate_all ()
609 _session->foreach_route_group (
610 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), true)
615 GroupTabs::disable_all ()
617 _session->foreach_route_group (
618 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), false)
623 GroupTabs::set_activation (RouteGroup* g, bool a)
625 g->set_active (a, this);
629 GroupTabs::remove_group (RouteGroup* g)
631 _session->remove_route_group (*g);
634 /** Set the color of the tab of a route group */
636 GroupTabs::set_group_color (RouteGroup* group, uint32_t color)
641 UINT_TO_RGBA (color, &r, &g, &b, &a);
643 /* Hack to disallow black route groups; force a dark grey instead */
645 if (r == 0 && g == 0 && b == 0) {
651 GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
655 /* for historical reasons the colors must be stored as 16 bit color
659 snprintf (buf, sizeof (buf), "%d:%d:%d", (r<<8), (g<<8), (b<<8));
660 gui_state.set_property (group_gui_id (group), "color", buf);
662 /* the group color change notification */
664 PBD::PropertyChange change;
665 change.add (Properties::color);
666 group->PropertyChanged (change);
668 /* This is a bit of a hack, but this might change
669 our route's effective color, so emit gui_changed
673 emit_gui_changed_for_members (group);
676 /** @return the ID string to use for the GUI state of a route group */
678 GroupTabs::group_gui_id (RouteGroup* group)
683 snprintf (buf, sizeof (buf), "route_group %s", group->id().to_s().c_str ());
688 /** @return the color to use for a route group tab */
690 GroupTabs::group_color (RouteGroup* group)
694 GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
695 string const gui_id = group_gui_id (group);
697 string const color = gui_state.get_string (gui_id, "color", &empty);
700 /* no color has yet been set, so use a random one */
701 uint32_t c = gdk_color_to_rgba (unique_random_color (_used_colors));
702 set_group_color (group, c);
708 /* for historical reasons, colors are stored as 16 bit values.
711 sscanf (color.c_str(), "%d:%d:%d", &r, &g, &b);
717 return RGBA_TO_UINT (r, g, b, 255);
721 GroupTabs::route_group_property_changed (RouteGroup* rg)
723 /* This is a bit of a hack, but this might change
724 our route's effective color, so emit gui_changed
728 emit_gui_changed_for_members (rg);
734 GroupTabs::route_added_to_route_group (RouteGroup*, boost::weak_ptr<Route> w)
736 /* Similarly-spirited hack as in route_group_property_changed */
738 boost::shared_ptr<Route> r = w.lock ();
743 r->gui_changed (X_("color"), 0);
749 GroupTabs::route_removed_from_route_group (RouteGroup*, boost::weak_ptr<Route> w)
751 /* Similarly-spirited hack as in route_group_property_changed */
753 boost::shared_ptr<Route> r = w.lock ();
758 r->gui_changed (X_("color"), 0);
764 GroupTabs::emit_gui_changed_for_members (RouteGroup* rg)
766 for (RouteList::iterator i = rg->route_list()->begin(); i != rg->route_list()->end(); ++i) {
767 (*i)->gui_changed (X_("color"), 0);