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 req->width = std::max (16.f, rintf (16.f * UIConfiguration::instance().get_ui_scale()));
90 req->height = std::max (16.f, rintf (16.f * UIConfiguration::instance().get_ui_scale()));
94 GroupTabs::on_button_press_event (GdkEventButton* ev)
96 using namespace Menu_Helpers;
98 double const p = primary_coordinate (ev->x, ev->y);
100 list<Tab>::iterator prev;
101 list<Tab>::iterator next;
102 Tab* t = click_to_tab (p, &prev, &next);
104 _drag_min = prev != _tabs.end() ? prev->to : 0;
105 _drag_max = next != _tabs.end() ? next->from : extent ();
107 if (ev->button == 1) {
112 _dragging_new_tab = true;
114 if (next == _tabs.end()) {
118 list<Tab>::iterator j = _tabs.insert (next, n);
123 _dragging_new_tab = false;
124 _initial_dragging_routes = routes_for_tab (t);
131 double const h = (t->from + t->to) / 2;
133 _drag_moving = t->from;
135 _drag_offset = p - t->from;
137 _drag_moving = t->to;
138 _drag_fixed = t->from;
139 _drag_offset = p - t->to;
142 } else if (ev->button == 3) {
144 RouteGroup* g = t ? t->group : 0;
146 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier) && g) {
148 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier) && g) {
151 Menu* m = get_menu (g, true);
153 m->popup (ev->button, ev->time);
163 GroupTabs::on_motion_notify_event (GdkEventMotion* ev)
165 if (_dragging == 0) {
169 double const p = primary_coordinate (ev->x, ev->y);
171 if (p != _drag_first) {
175 _drag_moving = p - _drag_offset;
177 _dragging->from = min (_drag_moving, _drag_fixed);
178 _dragging->to = max (_drag_moving, _drag_fixed);
180 _dragging->from = max (_dragging->from, _drag_min);
181 _dragging->to = min (_dragging->to, _drag_max);
186 gdk_event_request_motions(ev);
193 GroupTabs::on_button_release_event (GdkEventButton*)
195 if (_dragging == 0) {
201 if (_dragging->group) {
202 /* toggle active state */
203 _dragging->group->set_active (!_dragging->group->is_active (), this);
208 RouteList routes = routes_for_tab (_dragging);
210 if (!routes.empty()) {
211 if (_dragging_new_tab) {
212 run_new_group_dialog (&routes, false);
214 boost::shared_ptr<RouteList> r = _session->get_routes ();
215 /* First add new ones, then remove old ones.
216 * We cannot allow the group to become temporarily empty, because
217 * Session::route_removed_from_route_group() will delete empty groups.
219 for (RouteList::const_iterator i = routes.begin(); i != routes.end(); ++i) {
220 /* RouteGroup::add () ignores routes already present in the set */
221 _dragging->group->add (*i);
223 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
225 bool const was_in_tab = find (
226 _initial_dragging_routes.begin(), _initial_dragging_routes.end(), *i
227 ) != _initial_dragging_routes.end ();
229 bool const now_in_tab = find (routes.begin(), routes.end(), *i) != routes.end();
231 if (was_in_tab && !now_in_tab) {
232 _dragging->group->remove (*i);
244 _initial_dragging_routes.clear ();
250 GroupTabs::render (Cairo::RefPtr<Cairo::Context> const& ctx, cairo_rectangle_t*)
252 cairo_t* cr = ctx->cobj();
253 if (_dragging == 0) {
254 _tabs = compute_tabs ();
259 Gdk::Color c = get_style()->get_base (Gtk::STATE_NORMAL);
261 cairo_set_source_rgb (cr, c.get_red_p(), c.get_green_p(), c.get_blue_p());
262 cairo_rectangle (cr, 0, 0, get_width(), get_height());
267 for (list<Tab>::const_iterator i = _tabs.begin(); i != _tabs.end(); ++i) {
273 /** Convert a click position to a tab.
274 * @param c Click position.
275 * @param prev Filled in with the previous tab to the click, or _tabs.end().
276 * @param next Filled in with the next tab after the click, or _tabs.end().
277 * @return Tab under the click, or 0.
281 GroupTabs::click_to_tab (double c, list<Tab>::iterator* prev, list<Tab>::iterator* next)
283 *prev = *next = _tabs.end ();
286 list<Tab>::iterator i = _tabs.begin ();
287 while (i != _tabs.end()) {
300 if (i->from <= c && c < i->to) {
311 GroupTabs::add_new_from_items (Menu_Helpers::MenuList& items)
313 using namespace Menu_Helpers;
316 new_from = manage (new Menu);
318 MenuList& f = new_from->items ();
319 f.push_back (MenuElem (_("Selection..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_selection), false)));
320 f.push_back (MenuElem (_("Record Enabled..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled), false)));
321 f.push_back (MenuElem (_("Soloed..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_soloed), false)));
323 items.push_back (MenuElem (_("Create New Group From..."), *new_from));
325 new_from = manage (new Menu);
327 MenuList& f = new_from->items ();
328 f.push_back (MenuElem (_("Selection..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_selection), true)));
329 f.push_back (MenuElem (_("Record Enabled..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_rec_enabled), true)));
330 f.push_back (MenuElem (_("Soloed..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_from_soloed), true)));
332 items.push_back (MenuElem (_("Create New Group with Master From..."), *new_from));
336 GroupTabs::get_menu (RouteGroup* g, bool in_tab_area)
338 using namespace Menu_Helpers;
343 _menu->set_name ("ArdourContextMenu");
345 MenuList& items = _menu->items();
348 const VCAList vcas = _session->vca_manager().vcas ();
351 /* context menu is not for a group tab, show the "create new
354 add_new_from_items (items);
358 items.push_back (SeparatorElem());
359 items.push_back (MenuElem (_("Edit Group..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::edit_group), g)));
360 items.push_back (MenuElem (_("Collect Group"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::collect), g)));
361 items.push_back (MenuElem (_("Remove Group"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::remove_group), g)));
363 items.push_back (SeparatorElem());
365 if (g->has_control_master()) {
366 items.push_back (MenuElem (_("Drop Group from VCA..."), sigc::bind (sigc::mem_fun (*this, &GroupTabs::unassign_group_to_master), g->group_master_number(), g)));
368 vca_menu = manage (new Menu);
369 MenuList& f (vca_menu->items());
370 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_group_to_master), 0, g, true)));
372 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
373 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)));
375 items.push_back (MenuElem (_("Assign Group to VCA..."), *vca_menu));
378 items.push_back (SeparatorElem());
380 if (g->has_subgroup()) {
381 items.push_back (MenuElem (_("Remove Subgroup Bus"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::un_subgroup), g)));
383 items.push_back (MenuElem (_("Add New Subgroup Bus"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, false, PreFader)));
385 items.push_back (MenuElem (_("Add New Aux Bus (pre-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PreFader)));
386 items.push_back (MenuElem (_("Add New Aux Bus (post-fader)"), sigc::bind (sigc::mem_fun (*this, &GroupTabs::subgroup), g, true, PostFader)));
387 items.push_back (SeparatorElem());
391 add_menu_items (_menu, g);
394 /* context menu is for a group tab, show the "create new
397 add_new_from_items (items);
400 items.push_back (SeparatorElem());
402 vca_menu = manage (new Menu);
404 MenuList& f (vca_menu->items());
405 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_selection_to_master), 0)));
406 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
407 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())));
411 items.push_back (MenuElem (_("Assign Selection to VCA..."), *vca_menu));
413 vca_menu = manage (new Menu);
415 MenuList& f (vca_menu->items());
416 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_recenabled_to_master), 0)));
417 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
418 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())));
422 items.push_back (MenuElem (_("Assign Record Enabled to VCA..."), *vca_menu));
424 vca_menu = manage (new Menu);
426 MenuList& f (vca_menu->items());
427 f.push_back (MenuElem ("New", sigc::bind (sigc::mem_fun (*this, &GroupTabs::assign_soloed_to_master), 0)));
428 for (VCAList::const_iterator v = vcas.begin(); v != vcas.end(); ++v) {
429 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())));
433 items.push_back (MenuElem (_("Assign Soloed to VCA..."), *vca_menu));
435 items.push_back (SeparatorElem());
436 items.push_back (MenuElem (_("Enable All Groups"), sigc::mem_fun(*this, &GroupTabs::activate_all)));
437 items.push_back (MenuElem (_("Disable All Groups"), sigc::mem_fun(*this, &GroupTabs::disable_all)));
443 GroupTabs::assign_group_to_master (uint32_t which, RouteGroup* group, bool rename_master) const
445 if (!_session || !group) {
449 boost::shared_ptr<VCA> master;
452 if (_session->vca_manager().create_vca (1).empty ()) {
457 /* Get most recently created VCA... */
458 which = _session->vca_manager().vcas().back()->number();
461 master = _session->vca_manager().vca_by_number (which);
464 /* should never happen; if it does, basically something deeply
465 odd happened, no reason to tell user because there's no
466 sensible explanation.
471 group->assign_master (master);
474 master->set_name (group->name());
479 GroupTabs::unassign_group_to_master (uint32_t which, RouteGroup* group) const
481 if (!_session || !group) {
485 boost::shared_ptr<VCA> master = _session->vca_manager().vca_by_number (which);
488 /* should never happen; if it does, basically something deeply
489 odd happened, no reason to tell user because there's no
490 sensible explanation.
495 group->unassign_master (master);
499 GroupTabs::assign_some_to_master (uint32_t which, RouteList rl, std::string vcaname)
505 boost::shared_ptr<VCA> master;
506 bool set_name = false;
509 if (_session->vca_manager().create_vca (1).empty ()) {
515 /* Get most recently created VCA... */
516 which = _session->vca_manager().vcas().back()->number();
519 master = _session->vca_manager().vca_by_number (which);
522 /* should never happen; if it does, basically something deeply
523 odd happened, no reason to tell user because there's no
524 sensible explanation.
534 for (RouteList::iterator r = rl.begin(); r != rl.end(); ++r) {
535 (*r)->assign (master);
537 if (set_name && !vcaname.empty()) {
538 master->set_name (vcaname);
543 GroupTabs::get_rec_enabled ()
545 RouteList rec_enabled;
551 boost::shared_ptr<RouteList> rl = _session->get_routes ();
553 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
554 boost::shared_ptr<Track> trk (boost::dynamic_pointer_cast<Track> (*i));
555 if (trk && trk->rec_enable_control()->get_value()) {
556 rec_enabled.push_back (*i);
565 GroupTabs::get_soloed ()
567 RouteList rl = _session->get_routelist ();
570 for (RouteList::iterator i = rl.begin(); i != rl.end(); ++i) {
571 if (!(*i)->is_master() && (*i)->soloed()) {
572 soloed.push_back (*i);
580 GroupTabs::assign_selection_to_master (uint32_t which)
582 assign_some_to_master (which, selected_routes (), _("Selection"));
586 GroupTabs::assign_recenabled_to_master (uint32_t which)
588 assign_some_to_master (which, get_rec_enabled());
592 GroupTabs::assign_soloed_to_master (uint32_t which)
594 assign_some_to_master (which, get_soloed());
598 GroupTabs::new_from_selection (bool with_master)
600 RouteList rl (selected_routes());
601 run_new_group_dialog (&rl, with_master);
605 GroupTabs::new_from_rec_enabled (bool with_master)
607 RouteList rl (get_rec_enabled());
608 run_new_group_dialog (&rl, with_master);
612 GroupTabs::new_from_soloed (bool with_master)
614 RouteList rl (get_soloed());
615 run_new_group_dialog (&rl, with_master);
619 GroupTabs::run_new_group_dialog (RouteList const * rl, bool with_master)
621 if (rl && rl->empty()) {
625 RouteGroup* g = new RouteGroup (*_session, "");
626 RouteGroupDialog* d = new RouteGroupDialog (g, true);
628 d->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &GroupTabs::new_group_dialog_finished), d, rl ? new RouteList (*rl): 0, with_master));
633 GroupTabs::new_group_dialog_finished (int r, RouteGroupDialog* d, RouteList const * rl, bool with_master) const
635 if (r == RESPONSE_OK) {
637 if (!d->name_check()) {
641 _session->add_route_group (d->group());
644 for (RouteList::const_iterator i = rl->begin(); i != rl->end(); ++i) {
645 d->group()->add (*i);
649 assign_group_to_master (0, d->group(), true); /* zero => new master */
657 delete_when_idle (d);
661 GroupTabs::edit_group (RouteGroup* g)
663 RouteGroupDialog* d = new RouteGroupDialog (g, false);
664 d->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &GroupTabs::edit_group_dialog_finished), d));
669 GroupTabs::edit_group_dialog_finished (int r, RouteGroupDialog* d) const
671 delete_when_idle (d);
675 GroupTabs::subgroup (RouteGroup* g, bool aux, Placement placement)
677 g->make_subgroup (aux, placement);
681 GroupTabs::un_subgroup (RouteGroup* g)
683 g->destroy_subgroup ();
686 /** Collect all members of a RouteGroup so that they are together in the Editor or Mixer.
687 * @param g Group to collect.
690 GroupTabs::collect (RouteGroup* g)
692 boost::shared_ptr<RouteList> group_routes = g->route_list ();
693 group_routes->sort (Stripable::Sorter());
694 int const N = group_routes->size ();
696 RouteList::iterator i = group_routes->begin ();
697 RouteList routes = _session->get_routelist ();
698 routes.sort (Stripable::Sorter());
699 RouteList::const_iterator j = routes.begin ();
704 PresentationInfo::ChangeSuspender cs;
706 while (i != group_routes->end() && j != routes.end()) {
708 PresentationInfo::order_t const k = (*j)->presentation_info ().order();
719 (*j)->set_presentation_order (coll);
726 (*j)->set_presentation_order (k + diff);
735 GroupTabs::activate_all ()
737 _session->foreach_route_group (
738 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), true)
743 GroupTabs::disable_all ()
745 _session->foreach_route_group (
746 sigc::bind (sigc::mem_fun (*this, &GroupTabs::set_activation), false)
751 GroupTabs::set_activation (RouteGroup* g, bool a)
753 g->set_active (a, this);
757 GroupTabs::remove_group (RouteGroup* g)
759 boost::shared_ptr<RouteList> rl (g->route_list ());
760 _session->remove_route_group (*g);
762 emit_gui_changed_for_members (rl);
765 /** Set the color of the tab of a route group */
767 GroupTabs::set_group_color (RouteGroup* group, uint32_t color)
770 PresentationInfo::ChangeSuspender cs;
771 group->set_rgba (color);
774 /** @return the ID string to use for the GUI state of a route group */
776 GroupTabs::group_gui_id (RouteGroup* group)
781 snprintf (buf, sizeof (buf), "route_group %s", group->id().to_s().c_str ());
786 /** @return the color to use for a route group tab */
788 GroupTabs::group_color (RouteGroup* group)
792 /* prefer libardour color, if set */
793 uint32_t rgba = group->rgba ();
798 /* backwards compatibility, load old color */
800 GUIObjectState& gui_state = *ARDOUR_UI::instance()->gui_object_state;
801 string const gui_id = group_gui_id (group);
803 string const color = gui_state.get_string (gui_id, "color", &empty);
806 /* no color has yet been set, so use a random one */
807 uint32_t c = gdk_color_to_rgba (unique_random_color (_used_colors));
808 set_group_color (group, c);
814 /* for historical reasons, colors are stored as 16 bit values. */
816 sscanf (color.c_str(), "%d:%d:%d", &r, &g, &b);
822 group->migrate_rgba (RGBA_TO_UINT (r, g, b, 255));
823 gui_state.remove_node (gui_id);
825 return RGBA_TO_UINT (r, g, b, 255);
829 GroupTabs::route_group_property_changed (RouteGroup* rg)
831 /* This is a bit of a hack, but this might change
832 our route's effective color, so emit gui_changed
836 emit_gui_changed_for_members (rg->route_list ());
842 GroupTabs::route_added_to_route_group (RouteGroup*, boost::weak_ptr<Route> w)
844 /* Similarly-spirited hack as in route_group_property_changed */
846 boost::shared_ptr<Route> r = w.lock ();
851 r->presentation_info().PropertyChanged (Properties::color);
857 GroupTabs::route_removed_from_route_group (RouteGroup*, boost::weak_ptr<Route> w)
859 /* Similarly-spirited hack as in route_group_property_changed */
861 boost::shared_ptr<Route> r = w.lock ();
866 r->presentation_info().PropertyChanged (Properties::color);
872 GroupTabs::emit_gui_changed_for_members (boost::shared_ptr<RouteList> rl)
874 PresentationInfo::ChangeSuspender cs;
876 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
877 (*i)->presentation_info().PropertyChanged (Properties::color);