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>
22 #include "ardour/session.h"
23 #include "ardour/route_group.h"
24 #include "ardour/route.h"
25 #include "ardour/vca_manager.h"
26 #include "ardour/vca.h"
28 #include "gtkmm2ext/doi.h"
30 #include "gui_thread.h"
31 #include "route_group_dialog.h"
32 #include "group_tabs.h"
35 #include "ardour_ui.h"
36 #include "rgb_macros.h"
37 #include "ui_config.h"
42 using namespace ARDOUR;
43 using namespace ARDOUR_UI_UTILS;
44 using Gtkmm2ext::Keyboard;
46 list<Gdk::Color> GroupTabs::_used_colors;
48 GroupTabs::GroupTabs ()
51 , _dragging_new_tab (0)
53 add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::POINTER_MOTION_MASK);
54 UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &GroupTabs::queue_draw));
57 GroupTabs::~GroupTabs ()
63 GroupTabs::set_session (Session* s)
65 SessionHandlePtr::set_session (s);
68 _session->RouteGroupPropertyChanged.connect (
69 _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_group_property_changed, this, _1), gui_context()
71 _session->RouteAddedToRouteGroup.connect (
72 _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_added_to_route_group, this, _1, _2), gui_context()
74 _session->RouteRemovedFromRouteGroup.connect (
75 _session_connections, invalidator (*this), boost::bind (&GroupTabs::route_removed_from_route_group, this, _1, _2), gui_context()
78 _session->route_group_removed.connect (_session_connections, invalidator (*this), boost::bind (&GroupTabs::set_dirty, this, (cairo_rectangle_t*)0), gui_context());
83 /** Handle a size request.
84 * @param req GTK requisition
87 GroupTabs::on_size_request (Gtk::Requisition *req)
89 /* Use a dummy, small width and the actual height that we want */
95 GroupTabs::on_button_press_event (GdkEventButton* ev)
97 using namespace Menu_Helpers;
99 double const p = primary_coordinate (ev->x, ev->y);
101 list<Tab>::iterator prev;
102 list<Tab>::iterator next;
103 Tab* t = click_to_tab (p, &prev, &next);
105 _drag_min = prev != _tabs.end() ? prev->to : 0;
106 _drag_max = next != _tabs.end() ? next->from : extent ();
108 if (ev->button == 1) {
113 _dragging_new_tab = true;
115 if (next == _tabs.end()) {
119 list<Tab>::iterator j = _tabs.insert (next, n);
124 _dragging_new_tab = false;
125 _initial_dragging_routes = routes_for_tab (t);
132 double const h = (t->from + t->to) / 2;
134 _drag_moving = t->from;
136 _drag_offset = p - t->from;
138 _drag_moving = t->to;
139 _drag_fixed = t->from;
140 _drag_offset = p - t->to;
143 } else if (ev->button == 3) {
145 RouteGroup* g = t ? t->group : 0;
147 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier) && g) {
149 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier) && g) {
152 Menu* m = get_menu (g, true);
154 m->popup (ev->button, ev->time);
164 GroupTabs::on_motion_notify_event (GdkEventMotion* ev)
166 if (_dragging == 0) {
170 double const p = primary_coordinate (ev->x, ev->y);
172 if (p != _drag_first) {
176 _drag_moving = p - _drag_offset;
178 _dragging->from = min (_drag_moving, _drag_fixed);
179 _dragging->to = max (_drag_moving, _drag_fixed);
181 _dragging->from = max (_dragging->from, _drag_min);
182 _dragging->to = min (_dragging->to, _drag_max);
187 gdk_event_request_motions(ev);
194 GroupTabs::on_button_release_event (GdkEventButton*)
196 if (_dragging == 0) {
202 if (_dragging->group) {
203 /* toggle active state */
204 _dragging->group->set_active (!_dragging->group->is_active (), this);
209 RouteList routes = routes_for_tab (_dragging);
211 if (!routes.empty()) {
212 if (_dragging_new_tab) {
213 run_new_group_dialog (&routes, false);
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::RefPtr<Cairo::Context> const& ctx, cairo_rectangle_t*)
246 cairo_t* cr = ctx->cobj();
247 if (_dragging == 0) {
248 _tabs = compute_tabs ();
253 Gdk::Color c = get_style()->get_base (Gtk::STATE_NORMAL);
255 cairo_set_source_rgb (cr, c.get_red_p(), c.get_green_p(), c.get_blue_p());
256 cairo_rectangle (cr, 0, 0, get_width(), get_height());
261 for (list<Tab>::const_iterator i = _tabs.begin(); i != _tabs.end(); ++i) {
267 /** Convert a click position to a tab.
268 * @param c Click position.
269 * @param prev Filled in with the previous tab to the click, or _tabs.end().
270 * @param next Filled in with the next tab after the click, or _tabs.end().
271 * @return Tab under the click, or 0.
275 GroupTabs::click_to_tab (double c, list<Tab>::iterator* prev, list<Tab>::iterator* next)
277 *prev = *next = _tabs.end ();
280 list<Tab>::iterator i = _tabs.begin ();
281 while (i != _tabs.end()) {
294 if (i->from <= c && c < i->to) {
305 GroupTabs::add_new_from_items (Menu_Helpers::MenuList& items)
307 using namespace Menu_Helpers;
310 new_from = manage (new Menu);
312 MenuList& f = new_from->items ();
313 f.push_back (MenuElem (_("Selection..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_selection), false)));
314 f.push_back (MenuElem (_("Record Enabled..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled), false)));
315 f.push_back (MenuElem (_("Soloed..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_soloed), false)));
317 items.push_back (MenuElem (_("Create New Group From..."), *new_from));
319 new_from = manage (new Menu);
321 MenuList& f = new_from->items ();
322 f.push_back (MenuElem (_("Selection..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_selection), true)));
323 f.push_back (MenuElem (_("Record Enabled..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled), true)));
324 f.push_back (MenuElem (_("Soloed..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_soloed), true)));
326 items.push_back (MenuElem (_("Create New Group with Master From..."), *new_from));
330 GroupTabs::get_menu (RouteGroup* g, bool in_tab_area)
332 using namespace Menu_Helpers;
337 _menu->set_name ("ArdourContextMenu");
339 MenuList& items = _menu->items();
342 const VCAList vcas = _session->vca_manager().vcas ();
345 /* context menu is not for a group tab, show the "create new
348 add_new_from_items (items);
352 items.push_back (SeparatorElem());
353 items.push_back (MenuElem (_("Edit Group..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::edit_group), g)));
354 items.push_back (MenuElem (_("Collect Group"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::collect), g)));
355 items.push_back (MenuElem (_("Remove Group"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::remove_group), g)));
357 items.push_back (SeparatorElem());
359 vca_menu = manage (new Menu);
360 MenuList& f (vca_menu->items());
361 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_group_to_master), 0, g, true)));
363 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
364 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)));
366 items.push_back (MenuElem (_("Assign Group to VCA..."), *vca_menu));
369 items.push_back (SeparatorElem());
371 if (g->has_subgroup()) {
372 items.push_back (MenuElem (_("Remove Subgroup Bus"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::un_subgroup), g)));
374 items.push_back (MenuElem (_("Add New Subgroup Bus"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, false, PreFader)));
376 items.push_back (MenuElem (_("Add New Aux Bus (pre-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PreFader)));
377 items.push_back (MenuElem (_("Add New Aux Bus (post-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PostFader)));
378 items.push_back (SeparatorElem());
382 add_menu_items (_menu, g);
385 /* context menu is for a group tab, show the "create new
388 add_new_from_items (items);
391 items.push_back (SeparatorElem());
393 vca_menu = manage (new Menu);
395 MenuList& f (vca_menu->items());
396 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_selection_to_master), 0)));
397 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
398 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())));
402 items.push_back (MenuElem (_("Assign Selection to VCA..."), *vca_menu));
404 vca_menu = manage (new Menu);
406 MenuList& f (vca_menu->items());
407 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_recenabled_to_master), 0)));
408 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
409 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())));
413 items.push_back (MenuElem (_("Assign Record Enabled to VCA..."), *vca_menu));
415 vca_menu = manage (new Menu);
417 MenuList& f (vca_menu->items());
418 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_soloed_to_master), 0)));
419 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
420 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())));
424 items.push_back (MenuElem (_("Assign Soloed to VCA..."), *vca_menu));
426 items.push_back (SeparatorElem());
427 items.push_back (MenuElem (_("Enable All Groups"), sigc::mem_fun(*this, &GroupTabs::activate_all)));
428 items.push_back (MenuElem (_("Disable All Groups"), sigc::mem_fun(*this, &GroupTabs::disable_all)));
434 GroupTabs::assign_group_to_master (uint32_t which, RouteGroup* group, bool rename_master) const
436 if (!_session || !group) {
440 boost::shared_ptr<VCA> master;
443 if (_session->vca_manager().create_vca (1)) {
448 /* Get most recently created VCA... */
449 which = _session->vca_manager().vcas().back()->number();
452 master = _session->vca_manager().vca_by_number (which);
455 /* should never happen; if it does, basically something deeply
456 odd happened, no reason to tell user because there's no
457 sensible explanation.
462 group->assign_master (master);
465 master->set_name (group->name());
470 GroupTabs::assign_some_to_master (uint32_t which, RouteList rl)
476 boost::shared_ptr<VCA> master;
479 if (_session->vca_manager().create_vca (1)) {
484 /* Get most recently created VCA... */
485 which = _session->vca_manager().vcas().back()->number();
488 master = _session->vca_manager().vca_by_number (which);
491 /* should never happen; if it does, basically something deeply
492 odd happened, no reason to tell user because there's no
493 sensible explanation.
503 for (RouteList::iterator r = rl.begin(); r != rl.end(); ++r) {
504 (*r)->assign (master, false);
509 GroupTabs::get_rec_enabled ()
511 RouteList rec_enabled;
517 boost::shared_ptr<RouteList> rl = _session->get_routes ();
519 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
520 boost::shared_ptr<Track> trk (boost::dynamic_pointer_cast<Track> (*i));
521 if (trk && trk->rec_enable_control()->get_value()) {
522 rec_enabled.push_back (*i);
531 GroupTabs::get_soloed ()
533 boost::shared_ptr<RouteList> rl = _session->get_routes ();
537 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
538 if (!(*i)->is_master() && (*i)->soloed()) {
539 soloed.push_back (*i);
547 GroupTabs::assign_selection_to_master (uint32_t which)
549 assign_some_to_master (which, selected_routes ());
553 GroupTabs::assign_recenabled_to_master (uint32_t which)
555 assign_some_to_master (which, get_rec_enabled());
559 GroupTabs::assign_soloed_to_master (uint32_t which)
561 assign_some_to_master (which, get_soloed());
565 GroupTabs::new_from_selection (bool with_master)
567 RouteList rl (selected_routes());
568 run_new_group_dialog (&rl, with_master);
572 GroupTabs::new_from_rec_enabled (bool with_master)
574 RouteList rl (get_rec_enabled());
575 run_new_group_dialog (&rl, with_master);
579 GroupTabs::new_from_soloed (bool with_master)
581 RouteList rl (get_soloed());
582 run_new_group_dialog (&rl, with_master);
586 GroupTabs::run_new_group_dialog (RouteList const * rl, bool with_master)
588 if (rl && rl->empty()) {
592 RouteGroup* g = new RouteGroup (*_session, "");
593 RouteGroupDialog* d = new RouteGroupDialog (g, true);
595 d->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_group_dialog_finished), d, rl ? new RouteList (*rl): 0, with_master));
600 GroupTabs::new_group_dialog_finished (int r, RouteGroupDialog* d, RouteList const * rl, bool with_master) const
602 if (r == RESPONSE_OK) {
604 if (!d->name_check()) {
608 _session->add_route_group (d->group());
611 for (RouteList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
612 d->group()->add (*i);
616 assign_group_to_master (0, d->group(), true); /* zero => new master */
624 delete_when_idle (d);
628 GroupTabs::edit_group (RouteGroup* g)
630 RouteGroupDialog* d = new RouteGroupDialog (g, false);
631 d->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &GroupTabs::edit_group_dialog_finished), d));
636 GroupTabs::edit_group_dialog_finished (int r, RouteGroupDialog* d) const
638 delete_when_idle (d);
642 GroupTabs::subgroup (RouteGroup* g, bool aux, Placement placement)
644 g->make_subgroup (aux, placement);
648 GroupTabs::un_subgroup (RouteGroup* g)
650 g->destroy_subgroup ();
653 /** Collect all members of a RouteGroup so that they are together in the Editor or Mixer.
654 * @param g Group to collect.
657 GroupTabs::collect (RouteGroup* g)
659 boost::shared_ptr<RouteList> group_routes = g->route_list ();
660 group_routes->sort (Stripable::PresentationOrderSorter());
661 int const N = group_routes->size ();
663 RouteList::iterator i = group_routes->begin ();
664 boost::shared_ptr<RouteList> routes = _session->get_routes ();
665 routes->sort (Stripable::PresentationOrderSorter());
666 RouteList::const_iterator j = routes->begin ();
671 PresentationInfo::ChangeSuspender cs;
673 while (i != group_routes->end() && j != routes->end()) {
675 PresentationInfo::order_t const k = (*j)->presentation_info ().order();
686 (*j)->set_presentation_order (coll);
693 (*j)->set_presentation_order (k + diff);
702 GroupTabs::activate_all ()
704 _session->foreach_route_group (
705 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), true)
710 GroupTabs::disable_all ()
712 _session->foreach_route_group (
713 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), false)
718 GroupTabs::set_activation (RouteGroup* g, bool a)
720 g->set_active (a, this);
724 GroupTabs::remove_group (RouteGroup* g)
726 RouteList rl (*(g->route_list().get()));
727 _session->remove_route_group (*g);
729 PresentationInfo::ChangeSuspender cs;
731 for (RouteList::iterator i = rl.begin(); i != rl.end(); ++i) {
732 (*i)->presentation_info().PropertyChanged (Properties::color);
736 /** Set the color of the tab of a route group */
738 GroupTabs::set_group_color (RouteGroup* group, uint32_t color)
743 UINT_TO_RGBA (color, &r, &g, &b, &a);
745 /* Hack to disallow black route groups; force a dark grey instead */
746 const uint32_t dark_gray = 25;
748 if (r < dark_gray && g < dark_gray && b < dark_gray) {
754 GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
758 /* for historical reasons the colors must be stored as 16 bit color
762 snprintf (buf, sizeof (buf), "%d:%d:%d", (r<<8), (g<<8), (b<<8));
763 gui_state.set_property (group_gui_id (group), "color", buf);
765 /* the group color change notification */
767 PBD::PropertyChange change;
768 change.add (Properties::color);
769 group->PropertyChanged (change);
771 /* This is a bit of a hack, but this might change
772 our route's effective color, so emit gui_changed
776 emit_gui_changed_for_members (group);
779 /** @return the ID string to use for the GUI state of a route group */
781 GroupTabs::group_gui_id (RouteGroup* group)
786 snprintf (buf, sizeof (buf), "route_group %s", group->id().to_s().c_str ());
791 /** @return the color to use for a route group tab */
793 GroupTabs::group_color (RouteGroup* group)
797 GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
798 string const gui_id = group_gui_id (group);
800 string const color = gui_state.get_string (gui_id, "color", &empty);
803 /* no color has yet been set, so use a random one */
804 uint32_t c = gdk_color_to_rgba (unique_random_color (_used_colors));
805 set_group_color (group, c);
811 /* for historical reasons, colors are stored as 16 bit values.
814 sscanf (color.c_str(), "%d:%d:%d", &r, &g, &b);
820 return RGBA_TO_UINT (r, g, b, 255);
824 GroupTabs::route_group_property_changed (RouteGroup* rg)
826 /* This is a bit of a hack, but this might change
827 our route's effective color, so emit gui_changed
831 emit_gui_changed_for_members (rg);
837 GroupTabs::route_added_to_route_group (RouteGroup*, boost::weak_ptr<Route> w)
839 /* Similarly-spirited hack as in route_group_property_changed */
841 boost::shared_ptr<Route> r = w.lock ();
846 r->presentation_info().PropertyChanged (Properties::color);
852 GroupTabs::route_removed_from_route_group (RouteGroup*, boost::weak_ptr<Route> w)
854 /* Similarly-spirited hack as in route_group_property_changed */
856 boost::shared_ptr<Route> r = w.lock ();
861 r->presentation_info().PropertyChanged (Properties::color);
867 GroupTabs::emit_gui_changed_for_members (RouteGroup* rg)
869 PresentationInfo::ChangeSuspender cs;
871 for (RouteList::iterator i = rg->route_list()->begin(); i != rg->route_list()->end(); ++i) {
872 (*i)->presentation_info().PropertyChanged (Properties::color);