GUI tweaks and work on VCA mixer display
[ardour.git] / gtk2_ardour / mixer_ui.cc
1 /*
2     Copyright (C) 2000-2004 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 #ifdef WAF_BUILD
21 #include "gtk2ardour-config.h"
22 #endif
23
24 #include <algorithm>
25 #include <map>
26 #include <sigc++/bind.h>
27
28 #include <gtkmm/accelmap.h>
29
30 #include "pbd/convert.h"
31 #include "pbd/stacktrace.h"
32 #include "pbd/unwind.h"
33
34 #include <glibmm/threads.h>
35
36 #include <gtkmm2ext/gtk_ui.h>
37 #include <gtkmm2ext/keyboard.h>
38 #include <gtkmm2ext/utils.h>
39 #include <gtkmm2ext/tearoff.h>
40 #include <gtkmm2ext/window_title.h>
41 #include <gtkmm2ext/doi.h>
42
43 #include "ardour/amp.h"
44 #include "ardour/debug.h"
45 #include "ardour/audio_track.h"
46 #include "ardour/midi_track.h"
47 #include "ardour/plugin_manager.h"
48 #include "ardour/route_group.h"
49 #include "ardour/session.h"
50 #include "ardour/vca.h"
51 #include "ardour/vca_manager.h"
52
53 #include "keyboard.h"
54 #include "mixer_ui.h"
55 #include "mixer_strip.h"
56 #include "monitor_section.h"
57 #include "plugin_selector.h"
58 #include "public_editor.h"
59 #include "mouse_cursors.h"
60 #include "ardour_ui.h"
61 #include "prompter.h"
62 #include "utils.h"
63 #include "route_sorter.h"
64 #include "actions.h"
65 #include "gui_thread.h"
66 #include "mixer_group_tabs.h"
67 #include "route_sorter.h"
68 #include "timers.h"
69 #include "ui_config.h"
70 #include "vca_master_strip.h"
71
72 #include "i18n.h"
73
74 using namespace ARDOUR;
75 using namespace ARDOUR_UI_UTILS;
76 using namespace PBD;
77 using namespace Gtk;
78 using namespace Glib;
79 using namespace Gtkmm2ext;
80 using namespace std;
81
82 using PBD::atoi;
83 using PBD::Unwinder;
84
85 Mixer_UI* Mixer_UI::_instance = 0;
86
87 Mixer_UI*
88 Mixer_UI::instance ()
89 {
90         if (!_instance) {
91                 _instance  = new Mixer_UI;
92         }
93
94         return _instance;
95 }
96
97 Mixer_UI::Mixer_UI ()
98         : Tabbable (_content, _("Mixer"))
99         , no_track_list_redisplay (false)
100         , in_group_row_change (false)
101         , track_menu (0)
102         , _monitor_section (0)
103         , _plugin_selector (0)
104         , _strip_width (UIConfiguration::instance().get_default_narrow_ms() ? Narrow : Wide)
105         , ignore_reorder (false)
106         , _in_group_rebuild_or_clear (false)
107         , _route_deletion_in_progress (false)
108         , _following_editor_selection (false)
109         , _maximised (false)
110         , _show_mixer_list (true)
111 {
112         PresentationInfo::Change.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::sync_treeview_from_presentation_info, this), gui_context());
113
114         /* bindings was already set in MixerActor constructor */
115
116         _content.set_data ("ardour-bindings", bindings);
117
118         scroller.set_can_default (true);
119         // set_default (scroller);
120
121         scroller_base.set_flags (Gtk::CAN_FOCUS);
122         scroller_base.add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
123         scroller_base.set_name ("MixerWindow");
124         scroller_base.signal_button_release_event().connect (sigc::mem_fun(*this, &Mixer_UI::strip_scroller_button_release));
125
126         /* set up drag-n-drop */
127         vector<TargetEntry> target_table;
128         target_table.push_back (TargetEntry ("PluginFavoritePtr"));
129         scroller_base.drag_dest_set (target_table);
130         scroller_base.signal_drag_data_received().connect (sigc::mem_fun(*this, &Mixer_UI::scroller_drag_data_received));
131
132         // add as last item of strip packer
133         strip_packer.pack_end (scroller_base, true, true);
134
135         _group_tabs = new MixerGroupTabs (this);
136         VBox* b = manage (new VBox);
137         b->pack_start (*_group_tabs, PACK_SHRINK);
138         b->pack_start (strip_packer);
139         b->show_all ();
140
141         scroller.add (*b);
142         scroller.set_policy (Gtk::POLICY_ALWAYS, Gtk::POLICY_AUTOMATIC);
143
144         setup_track_display ();
145
146         group_model = ListStore::create (group_columns);
147         group_display.set_model (group_model);
148         group_display.append_column (_("Group"), group_columns.text);
149         group_display.append_column (_("Show"), group_columns.visible);
150         group_display.get_column (0)->set_data (X_("colnum"), GUINT_TO_POINTER(0));
151         group_display.get_column (1)->set_data (X_("colnum"), GUINT_TO_POINTER(1));
152         group_display.get_column (0)->set_expand(true);
153         group_display.get_column (1)->set_expand(false);
154         group_display.set_name ("EditGroupList");
155         group_display.get_selection()->set_mode (Gtk::SELECTION_SINGLE);
156         group_display.set_reorderable (true);
157         group_display.set_headers_visible (true);
158         group_display.set_rules_hint (true);
159         group_display.set_can_focus(false);
160
161         /* name is directly editable */
162
163         CellRendererText* name_cell = dynamic_cast<CellRendererText*>(group_display.get_column_cell_renderer (0));
164         name_cell->property_editable() = true;
165         name_cell->signal_edited().connect (sigc::mem_fun (*this, &Mixer_UI::route_group_name_edit));
166
167         /* use checkbox for the active column */
168
169         CellRendererToggle* active_cell = dynamic_cast<CellRendererToggle*>(group_display.get_column_cell_renderer (1));
170         active_cell->property_activatable() = true;
171         active_cell->property_radio() = false;
172
173         group_model->signal_row_changed().connect (sigc::mem_fun (*this, &Mixer_UI::route_group_row_change));
174         /* We use this to notice drag-and-drop reorders of the group list */
175         group_model->signal_row_deleted().connect (sigc::mem_fun (*this, &Mixer_UI::route_group_row_deleted));
176         group_display.signal_button_press_event().connect (sigc::mem_fun (*this, &Mixer_UI::group_display_button_press), false);
177
178         group_display_scroller.add (group_display);
179         group_display_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
180
181         HBox* route_group_display_button_box = manage (new HBox());
182
183         Button* route_group_add_button = manage (new Button ());
184         Button* route_group_remove_button = manage (new Button ());
185
186         Widget* w;
187
188         w = manage (new Image (Stock::ADD, ICON_SIZE_BUTTON));
189         w->show();
190         route_group_add_button->add (*w);
191
192         w = manage (new Image (Stock::REMOVE, ICON_SIZE_BUTTON));
193         w->show();
194         route_group_remove_button->add (*w);
195
196         route_group_display_button_box->set_homogeneous (true);
197
198         route_group_add_button->signal_clicked().connect (sigc::mem_fun (*this, &Mixer_UI::new_route_group));
199         route_group_remove_button->signal_clicked().connect (sigc::mem_fun (*this, &Mixer_UI::remove_selected_route_group));
200
201         route_group_display_button_box->add (*route_group_add_button);
202         route_group_display_button_box->add (*route_group_remove_button);
203
204         group_display_vbox.pack_start (group_display_scroller, true, true);
205         group_display_vbox.pack_start (*route_group_display_button_box, false, false);
206
207         group_display_frame.set_name ("BaseFrame");
208         group_display_frame.set_shadow_type (Gtk::SHADOW_IN);
209         group_display_frame.add (group_display_vbox);
210
211
212         list<TargetEntry> target_list;
213         target_list.push_back (TargetEntry ("PluginPresetPtr"));
214
215         favorite_plugins_model = PluginTreeStore::create (favorite_plugins_columns);
216         favorite_plugins_display.set_model (favorite_plugins_model);
217         favorite_plugins_display.append_column (_("Favorite Plugins"), favorite_plugins_columns.name);
218         favorite_plugins_display.set_name ("EditGroupList");
219         favorite_plugins_display.get_selection()->set_mode (Gtk::SELECTION_SINGLE);
220         favorite_plugins_display.set_reorderable (false);
221         favorite_plugins_display.set_headers_visible (true);
222         favorite_plugins_display.set_rules_hint (true);
223         favorite_plugins_display.set_can_focus (false);
224         favorite_plugins_display.add_object_drag (favorite_plugins_columns.plugin.index(), "PluginFavoritePtr");
225         favorite_plugins_display.set_drag_column (favorite_plugins_columns.name.index());
226         favorite_plugins_display.add_drop_targets (target_list);
227         favorite_plugins_display.signal_row_activated().connect (sigc::mem_fun (*this, &Mixer_UI::plugin_row_activated));
228         favorite_plugins_display.signal_button_press_event().connect (sigc::mem_fun (*this, &Mixer_UI::plugin_row_button_press), false);
229         favorite_plugins_display.signal_drop.connect (sigc::mem_fun (*this, &Mixer_UI::plugin_drop));
230         favorite_plugins_display.signal_row_expanded().connect (sigc::mem_fun (*this, &Mixer_UI::save_favorite_ui_state));
231         favorite_plugins_display.signal_row_collapsed().connect (sigc::mem_fun (*this, &Mixer_UI::save_favorite_ui_state));
232         favorite_plugins_model->signal_row_has_child_toggled().connect (sigc::mem_fun (*this, &Mixer_UI::sync_treeview_favorite_ui_state));
233
234         favorite_plugins_scroller.add (favorite_plugins_display);
235         favorite_plugins_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
236
237         favorite_plugins_frame.set_name ("BaseFrame");
238         favorite_plugins_frame.set_shadow_type (Gtk::SHADOW_IN);
239         favorite_plugins_frame.add (favorite_plugins_scroller);
240
241         rhs_pane1.add (favorite_plugins_frame);
242         rhs_pane1.add (track_display_frame);
243         rhs_pane2.add (rhs_pane1);
244         rhs_pane2.add (group_display_frame);
245
246         list_vpacker.pack_start (rhs_pane2, true, true);
247
248         string vca_text = _("Control Masters");
249         Gtk::HBox* vca_top_padding = manage (new Gtk::HBox);
250         vca_top_padding->set_size_request (-1, 2);
251         vca_vpacker.pack_start (*vca_top_padding, false, false);
252         
253         vca_label.set_text (vca_text);
254         vca_label_bar.set_size_request (-1, 16); /* must match height in GroupTabs::set_size_request() */
255
256         vca_label_bar.set_name (X_("VCALabelBar"));
257         vca_label_bar.add (vca_label);
258
259         vca_vpacker.pack_start (vca_label_bar, false, false);
260
261         vca_scroller_base.add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
262         vca_scroller_base.set_name (X_("MixerWindow"));
263         vca_scroller_base.signal_button_release_event().connect (sigc::mem_fun(*this, &Mixer_UI::masters_scroller_button_release), false);
264         vca_hpacker.pack_end (vca_scroller_base, true, true);
265
266         vca_scroller.add (vca_hpacker);
267         vca_scroller.set_policy (Gtk::POLICY_ALWAYS, Gtk::POLICY_AUTOMATIC);
268         vca_scroller.signal_button_release_event().connect (sigc::mem_fun(*this, &Mixer_UI::strip_scroller_button_release));
269
270         vca_vpacker.pack_start (vca_scroller, true, true);
271
272         inner_pane.add (scroller);
273         inner_pane.add (vca_vpacker);
274
275         global_hpacker.pack_start (inner_pane, true, true);
276         global_hpacker.pack_start (out_packer, false, false);
277
278         list_hpane.add (list_vpacker);
279         list_hpane.add (global_hpacker);
280
281
282         XMLNode const * settings = ARDOUR_UI::instance()->mixer_settings();
283         XMLProperty const * prop;
284         float fract;
285
286         {
287                 LocaleGuard lg;
288
289                 if (!settings || ((prop = settings->property ("mixer-rhs-pane1-pos")) == 0) || ((fract = atof (prop->value())) > 1.0)) {
290                         rhs_pane1.set_divider (0, 0.6f);
291                 } else {
292                         rhs_pane1.set_divider (0, fract);
293                 }
294                 if (!settings || ((prop = settings->property ("mixer-rhs-pane2-pos")) == 0) || ((fract = atof (prop->value())) > 1.0)) {
295                         rhs_pane2.set_divider (0, 0.7f);
296                 } else {
297                         rhs_pane2.set_divider (0, fract);
298                 }
299                 if (!settings || ((prop = settings->property ("mixer-list-hpane-pos")) == 0) || ((fract = atof (prop->value())) > 1.0)) {
300                         list_hpane.set_divider (0, 0.2f);
301                 } else {
302                         list_hpane.set_divider (0, fract);
303                 }
304                 if (!settings || ((prop = settings->property ("mixer-inner-pane-pos")) == 0)  || ((fract = atof (prop->value())) > 1.0)) {
305                         inner_pane.set_divider (0, 0.8f);
306                 } else {
307                         inner_pane.set_divider (0, atof (prop->value()));
308                 }
309         }
310
311         rhs_pane1.set_drag_cursor (*PublicEditor::instance().cursors()->expand_up_down);
312         rhs_pane2.set_drag_cursor (*PublicEditor::instance().cursors()->expand_up_down);
313         list_hpane.set_drag_cursor (*PublicEditor::instance().cursors()->expand_left_right);
314         inner_pane.set_drag_cursor (*PublicEditor::instance().cursors()->expand_left_right);
315
316         _content.pack_start (list_hpane, true, true);
317
318         update_title ();
319
320         route_group_display_button_box->show();
321         route_group_add_button->show();
322         route_group_remove_button->show();
323
324         _content.show ();
325         _content.set_name ("MixerWindow");
326
327         global_hpacker.show();
328         scroller.show();
329         scroller_base.show();
330         scroller_hpacker.show();
331         mixer_scroller_vpacker.show();
332         list_vpacker.show();
333         group_display_button_label.show();
334         group_display_button.show();
335         group_display_scroller.show();
336         favorite_plugins_scroller.show();
337         group_display_vbox.show();
338         group_display_frame.show();
339         favorite_plugins_frame.show();
340         rhs_pane1.show();
341         rhs_pane2.show();
342         strip_packer.show();
343         inner_pane.show();
344         vca_top_padding->show ();
345         vca_scroller.show();
346         vca_vpacker.show();
347         vca_hpacker.show();
348         vca_label_bar.show();
349         vca_label.show();
350         vca_scroller_base.show();
351         out_packer.show();
352         list_hpane.show();
353         group_display.show();
354         favorite_plugins_display.show();
355
356         MixerStrip::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::remove_strip, this, _1), gui_context());
357
358         /* handle escape */
359
360         ARDOUR_UI::instance()->Escape.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::escape, this), gui_context());
361
362 #ifndef DEFER_PLUGIN_SELECTOR_LOAD
363         _plugin_selector = new PluginSelector (PluginManager::instance ());
364 #else
365 #error implement deferred Plugin-Favorite list
366 #endif
367         PluginManager::instance ().PluginListChanged.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::refill_favorite_plugins, this), gui_context());
368         PluginManager::instance ().PluginStatusesChanged.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::refill_favorite_plugins, this), gui_context());
369         ARDOUR::Plugin::PresetsChanged.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::refill_favorite_plugins, this), gui_context());
370 }
371
372 Mixer_UI::~Mixer_UI ()
373 {
374         if (_monitor_section) {
375                 monitor_section_detached ();
376                 delete _monitor_section;
377         }
378         delete _plugin_selector;
379 }
380
381 void
382 Mixer_UI::escape ()
383 {
384         select_none ();
385 }
386
387 void
388 Mixer_UI::track_editor_selection ()
389 {
390         PublicEditor::instance().get_selection().TracksChanged.connect (sigc::mem_fun (*this, &Mixer_UI::follow_editor_selection));
391 }
392
393 Gtk::Window*
394 Mixer_UI::use_own_window (bool and_fill_it)
395 {
396         bool new_window = !own_window();
397
398         Gtk::Window* win = Tabbable::use_own_window (and_fill_it);
399
400
401         if (win && new_window) {
402                 win->set_name ("MixerWindow");
403                 ARDOUR_UI::instance()->setup_toplevel_window (*win, _("Mixer"), this);
404                 win->signal_scroll_event().connect (sigc::mem_fun (*this, &Mixer_UI::on_scroll_event), false);
405                 win->signal_event().connect (sigc::bind (sigc::ptr_fun (&Keyboard::catch_user_event_for_pre_dialog_focus), win));
406                 win->set_data ("ardour-bindings", bindings);
407                 update_title ();
408         }
409
410         return win;
411 }
412
413 void
414 Mixer_UI::show_window ()
415 {
416         Tabbable::show_window ();
417
418         /* show/hide group tabs as required */
419         parameter_changed ("show-group-tabs");
420
421         /* now reset each strips width so the right widgets are shown */
422
423         TreeModel::Children rows = track_model->children();
424         TreeModel::Children::iterator ri;
425
426         for (ri = rows.begin(); ri != rows.end(); ++ri) {
427                 AxisView* av = (*ri)[stripable_columns.strip];
428                 MixerStrip* ms = dynamic_cast<MixerStrip*> (av);
429                 if (!ms) {
430                         continue;
431                 }
432                 ms->set_width_enum (ms->get_width_enum (), ms->width_owner());
433                 /* Fix visibility of mixer strip stuff */
434                 ms->parameter_changed (X_("mixer-element-visibility"));
435         }
436
437         /* force focus into main area */
438         scroller_base.grab_focus ();
439 }
440
441 void
442 Mixer_UI::remove_master (VCAMasterStrip* vms)
443 {
444         if (_session && _session->deletion_in_progress()) {
445                 /* its all being taken care of */
446                 return;
447         }
448
449         TreeModel::Children rows = track_model->children();
450         TreeModel::Children::iterator ri;
451
452         for (ri = rows.begin(); ri != rows.end(); ++ri) {
453                 if ((*ri)[stripable_columns.strip] == vms) {
454                         PBD::Unwinder<bool> uw (_route_deletion_in_progress, true);
455                         track_model->erase (ri);
456                         break;
457                 }
458         }
459 }
460
461 bool
462 Mixer_UI::masters_scroller_button_release (GdkEventButton* ev)
463 {
464         using namespace Menu_Helpers;
465
466         if (Keyboard::is_context_menu_event (ev)) {
467                 ARDOUR_UI::instance()->add_route ();
468                 return true;
469         }
470
471         return false;
472 }
473
474 void
475 Mixer_UI::add_masters (VCAList& vlist)
476 {
477         StripableList sl;
478
479         for (VCAList::iterator v = vlist.begin(); v != vlist.end(); ++v) {
480                 sl.push_back (boost::dynamic_pointer_cast<Stripable> (*v));
481         }
482
483         add_stripables (sl);
484 }
485
486 void
487 Mixer_UI::add_routes (RouteList& rlist)
488 {
489         StripableList sl;
490
491         for (RouteList::iterator r = rlist.begin(); r != rlist.end(); ++r) {
492                 sl.push_back (*r);
493         }
494
495         add_stripables (sl);
496 }
497
498 void
499 Mixer_UI::add_stripables (StripableList& slist)
500 {
501         Gtk::TreeModel::Children::iterator insert_iter = track_model->children().end();
502         bool from_scratch = (track_model->children().size() == 0);
503         uint32_t nroutes = 0;
504
505         slist.sort (StripablePresentationInfoSorter());
506
507         for (Gtk::TreeModel::Children::iterator it = track_model->children().begin(); it != track_model->children().end(); ++it) {
508                 boost::shared_ptr<Stripable> s = (*it)[stripable_columns.stripable];
509
510                 if (!s) {
511                         continue;
512                 }
513
514                 nroutes++;
515
516                 if (s->presentation_info().order() == (slist.front()->presentation_info().order() + slist.size())) {
517                         insert_iter = it;
518                         break;
519                 }
520         }
521
522         MixerStrip* strip;
523
524         try {
525                 no_track_list_redisplay = true;
526                 track_display.set_model (Glib::RefPtr<ListStore>());
527
528                 for (StripableList::iterator s = slist.begin(); s != slist.end(); ++s) {
529
530                         boost::shared_ptr<Route> route;
531                         boost::shared_ptr<VCA> vca;
532
533                         if ((vca  = boost::dynamic_pointer_cast<VCA> (*s))) {
534
535                                 VCAMasterStrip* vms = new VCAMasterStrip (_session, vca);
536
537                                 TreeModel::Row row = *(track_model->append());
538
539                                 row[stripable_columns.text] = vca->name();
540                                 row[stripable_columns.visible] = !vca->presentation_info().hidden();
541                                 row[stripable_columns.strip] = vms;
542                                 row[stripable_columns.stripable] = vca;
543
544                                 vms->CatchDeletion.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::remove_master, this, _1), gui_context());
545
546                         } else if ((route = boost::dynamic_pointer_cast<Route> (*s))) {
547
548                                 if (route->is_auditioner()) {
549                                         continue;
550                                 }
551
552                                 if (route->is_monitor()) {
553
554                                         if (!_monitor_section) {
555                                                 _monitor_section = new MonitorSection (_session);
556
557                                                 XMLNode* mnode = ARDOUR_UI::instance()->tearoff_settings (X_("monitor-section"));
558                                                 if (mnode) {
559                                                         _monitor_section->tearoff().set_state (*mnode);
560                                                 }
561                                         }
562
563                                         out_packer.pack_end (_monitor_section->tearoff(), false, false);
564                                         _monitor_section->set_session (_session);
565                                         _monitor_section->tearoff().show_all ();
566
567                                         _monitor_section->tearoff().Detach.connect (sigc::mem_fun(*this, &Mixer_UI::monitor_section_detached));
568                                         _monitor_section->tearoff().Attach.connect (sigc::mem_fun(*this, &Mixer_UI::monitor_section_attached));
569
570                                         monitor_section_attached ();
571
572                                         route->DropReferences.connect (*this, invalidator(*this), boost::bind (&Mixer_UI::monitor_section_going_away, this), gui_context());
573
574                                         /* no regular strip shown for control out */
575
576                                         continue;
577                                 }
578
579                                 strip = new MixerStrip (*this, _session, route);
580                                 strips.push_back (strip);
581
582                                 UIConfiguration::instance().get_default_narrow_ms() ? _strip_width = Narrow : _strip_width = Wide;
583
584                                 if (strip->width_owner() != strip) {
585                                         strip->set_width_enum (_strip_width, this);
586                                 }
587
588                                 show_strip (strip);
589
590                                 TreeModel::Row row = *(track_model->insert (insert_iter));
591
592                                 row[stripable_columns.text] = route->name();
593                                 row[stripable_columns.visible] = route->is_master() ? true : strip->marked_for_display();
594                                 row[stripable_columns.stripable] = route;
595                                 row[stripable_columns.strip] = strip;
596
597                                 if (nroutes != 0) {
598                                         _selection.add (strip);
599                                 }
600
601                                 route->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::strip_property_changed, this, _1, strip), gui_context());
602
603                                 strip->WidthChanged.connect (sigc::mem_fun(*this, &Mixer_UI::strip_width_changed));
604                                 strip->signal_button_release_event().connect (sigc::bind (sigc::mem_fun(*this, &Mixer_UI::strip_button_release_event), strip));
605                         }
606                 }
607
608         } catch (const std::exception& e) {
609                 error << string_compose (_("Error adding GUI elements for new tracks/busses %1"), e.what()) << endmsg;
610         }
611
612         no_track_list_redisplay = false;
613         track_display.set_model (track_model);
614
615         if (!from_scratch) {
616                 sync_presentation_info_from_treeview ();
617         }
618 }
619
620 void
621 Mixer_UI::deselect_all_strip_processors ()
622 {
623         for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
624                 (*i)->deselect_all_processors();
625         }
626 }
627
628 void
629 Mixer_UI::select_strip (MixerStrip& ms, bool add)
630 {
631         if (add) {
632                 _selection.add (&ms);
633         } else {
634                 _selection.set (&ms);
635         }
636 }
637
638 void
639 Mixer_UI::select_none ()
640 {
641         _selection.clear_routes();
642         deselect_all_strip_processors();
643 }
644
645 void
646 Mixer_UI::delete_processors ()
647 {
648         for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
649                 (*i)->delete_processors();
650         }
651 }
652
653
654 void
655 Mixer_UI::remove_strip (MixerStrip* strip)
656 {
657         if (_session && _session->deletion_in_progress()) {
658                 /* its all being taken care of */
659                 return;
660         }
661
662         TreeModel::Children rows = track_model->children();
663         TreeModel::Children::iterator ri;
664         list<MixerStrip *>::iterator i;
665
666         if ((i = find (strips.begin(), strips.end(), strip)) != strips.end()) {
667                 strips.erase (i);
668         }
669
670         for (ri = rows.begin(); ri != rows.end(); ++ri) {
671                 if ((*ri)[stripable_columns.strip] == strip) {
672                         PBD::Unwinder<bool> uw (_route_deletion_in_progress, true);
673                         track_model->erase (ri);
674                         break;
675                 }
676         }
677 }
678
679 void
680 Mixer_UI::sync_presentation_info_from_treeview ()
681 {
682         if (ignore_reorder || !_session || _session->deletion_in_progress()) {
683                 return;
684         }
685
686         TreeModel::Children rows = track_model->children();
687
688         if (rows.empty()) {
689                 return;
690         }
691
692         DEBUG_TRACE (DEBUG::OrderKeys, "mixer sync presentation info from treeview\n");
693
694         TreeModel::Children::iterator ri;
695         bool change = false;
696         uint32_t order = 0;
697
698         for (ri = rows.begin(); ri != rows.end(); ++ri) {
699                 bool visible = (*ri)[stripable_columns.visible];
700                 boost::shared_ptr<Stripable> stripable = (*ri)[stripable_columns.stripable];
701
702                 if (!stripable) {
703                         continue;
704                 }
705
706                 /* Monitor and Auditioner do not get their presentation
707                  * info reset here.
708                  */
709
710                 if (stripable->is_monitor() || stripable->is_auditioner()) {
711                         continue;
712                 }
713
714                 /* Master also doesn't get set here but since the editor allows
715                  * it to be reordered, we need to preserve its ordering.
716                  */
717
718                 stripable->presentation_info().set_hidden (!visible);
719
720                 if (order != stripable->presentation_info().order()) {
721                         stripable->set_presentation_order_explicit (order);
722                         change = true;
723                 }
724
725                 ++order;
726         }
727
728         if (change) {
729                 DEBUG_TRACE (DEBUG::OrderKeys, "... notify PI change from mixer GUI\n");
730                 _session->notify_presentation_info_change ();
731         }
732 }
733
734 void
735 Mixer_UI::sync_treeview_from_presentation_info ()
736 {
737         if (!_session || _session->deletion_in_progress()) {
738                 return;
739         }
740
741         DEBUG_TRACE (DEBUG::OrderKeys, "mixer sync model from presentation info.\n");
742
743         /* we could get here after either a change in the Mixer or Editor sort
744          * order, but either way, the mixer order keys reflect the intended
745          * order for the GUI, so reorder the treeview model to match it.
746          */
747
748         vector<int> neworder;
749         TreeModel::Children rows = track_model->children();
750         uint32_t old_order = 0;
751         bool changed = false;
752
753         if (rows.empty()) {
754                 return;
755         }
756
757         OrderingKeys sorted;
758
759         for (TreeModel::Children::iterator ri = rows.begin(); ri != rows.end(); ++ri, ++old_order) {
760                 boost::shared_ptr<Stripable> stripable = (*ri)[stripable_columns.stripable];
761                 sorted.push_back (OrderKeys (old_order, stripable->presentation_info().order()));
762         }
763
764         SortByNewDisplayOrder cmp;
765
766         sort (sorted.begin(), sorted.end(), cmp);
767         neworder.assign (sorted.size(), 0);
768
769         uint32_t n = 0;
770
771         for (OrderingKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
772
773                 neworder[n] = sr->old_display_order;
774
775                 if (sr->old_display_order != n) {
776                         changed = true;
777                 }
778         }
779
780         if (changed) {
781                 Unwinder<bool> uw (ignore_reorder, true);
782                 track_model->reorder (neworder);
783         }
784
785         redisplay_track_list ();
786 }
787
788 void
789 Mixer_UI::follow_editor_selection ()
790 {
791         if (_following_editor_selection) {
792                 return;
793         }
794
795         _following_editor_selection = true;
796         _selection.block_routes_changed (true);
797
798         TrackSelection& s (PublicEditor::instance().get_selection().tracks);
799
800         _selection.clear_routes ();
801
802         for (TrackViewList::iterator i = s.begin(); i != s.end(); ++i) {
803                 RouteTimeAxisView* rtav = dynamic_cast<RouteTimeAxisView*> (*i);
804                 if (rtav) {
805                         MixerStrip* ms = strip_by_route (rtav->route());
806                         if (ms) {
807                                 _selection.add (ms);
808                         }
809                 }
810         }
811
812         _following_editor_selection = false;
813         _selection.block_routes_changed (false);
814 }
815
816
817 MixerStrip*
818 Mixer_UI::strip_by_route (boost::shared_ptr<Route> r)
819 {
820         for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
821                 if ((*i)->route() == r) {
822                         return (*i);
823                 }
824         }
825
826         return 0;
827 }
828
829 bool
830 Mixer_UI::strip_button_release_event (GdkEventButton *ev, MixerStrip *strip)
831 {
832         if (ev->button == 1) {
833                 if (_selection.selected (strip)) {
834                         /* primary-click: toggle selection state of strip */
835                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
836                                 _selection.remove (strip);
837                         } else if (_selection.routes.size() > 1) {
838                                 /* de-select others */
839                                 _selection.set (strip);
840                         }
841                 } else {
842                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
843                                 _selection.add (strip);
844                         } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::RangeSelectModifier)) {
845
846                                 /* extend selection */
847
848                                 vector<MixerStrip*> tmp;
849                                 bool accumulate = false;
850                                 bool found_another = false;
851
852                                 tmp.push_back (strip);
853
854                                 for (list<MixerStrip*>::iterator i = strips.begin(); i != strips.end(); ++i) {
855                                         if ((*i) == strip) {
856                                                 /* hit clicked strip, start accumulating till we hit the first
857                                                    selected strip
858                                                 */
859                                                 if (accumulate) {
860                                                         /* done */
861                                                         break;
862                                                 } else {
863                                                         accumulate = true;
864                                                 }
865                                         } else if (_selection.selected (*i)) {
866                                                 /* hit selected strip. if currently accumulating others,
867                                                    we're done. if not accumulating others, start doing so.
868                                                 */
869                                                 found_another = true;
870                                                 if (accumulate) {
871                                                         /* done */
872                                                         break;
873                                                 } else {
874                                                         accumulate = true;
875                                                 }
876                                         } else {
877                                                 if (accumulate) {
878                                                         tmp.push_back (*i);
879                                                 }
880                                         }
881                                 }
882
883                                 if (found_another) {
884                                         for (vector<MixerStrip*>::iterator i = tmp.begin(); i != tmp.end(); ++i) {
885                                                 _selection.add (*i);
886                                         }
887                                 } else
888                                         _selection.set (strip);  //user wants to start a range selection, but there aren't any others selected yet
889                         } else {
890                                 _selection.set (strip);
891                         }
892                 }
893         }
894
895         return true;
896 }
897
898 void
899 Mixer_UI::set_session (Session* sess)
900 {
901         SessionHandlePtr::set_session (sess);
902
903         if (_plugin_selector) {
904                 _plugin_selector->set_session (_session);
905         }
906
907         _group_tabs->set_session (sess);
908
909         if (!_session) {
910                 return;
911         }
912
913         refill_favorite_plugins();
914
915         XMLNode* node = ARDOUR_UI::instance()->mixer_settings();
916         set_state (*node, 0);
917
918         update_title ();
919
920         initial_track_display ();
921
922         _session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::add_routes, this, _1), gui_context());
923         _session->route_group_added.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::add_route_group, this, _1), gui_context());
924         _session->route_group_removed.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::route_groups_changed, this), gui_context());
925         _session->route_groups_reordered.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::route_groups_changed, this), gui_context());
926         _session->config.ParameterChanged.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::parameter_changed, this, _1), gui_context());
927         _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::update_title, this), gui_context());
928         _session->StateSaved.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::update_title, this), gui_context());
929
930         _session->vca_manager().VCAAdded.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::add_masters, this, _1), gui_context());
931
932         Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::parameter_changed, this, _1), gui_context ());
933
934         route_groups_changed ();
935
936         if (_visible) {
937                 show_window();
938         }
939         start_updating ();
940 }
941
942 void
943 Mixer_UI::session_going_away ()
944 {
945         ENSURE_GUI_THREAD (*this, &Mixer_UI::session_going_away);
946
947         _in_group_rebuild_or_clear = true;
948         group_model->clear ();
949         _in_group_rebuild_or_clear = false;
950
951         _selection.clear ();
952         track_model->clear ();
953
954         for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
955                 delete (*i);
956         }
957
958         if (_monitor_section) {
959                 _monitor_section->tearoff().hide_visible ();
960         }
961
962         monitor_section_detached ();
963
964         strips.clear ();
965
966         stop_updating ();
967
968         SessionHandlePtr::session_going_away ();
969
970         _session = 0;
971         update_title ();
972 }
973
974 void
975 Mixer_UI::track_visibility_changed (std::string const & path)
976 {
977         if (_session && _session->deletion_in_progress()) {
978                 return;
979         }
980
981         TreeIter iter;
982
983         if ((iter = track_model->get_iter (path))) {
984                 AxisView* av = (*iter)[stripable_columns.strip];
985                 MixerStrip* strip = dynamic_cast<MixerStrip*> (av);
986                 if (strip) {
987                         bool visible = (*iter)[stripable_columns.visible];
988
989                         if (strip->set_marked_for_display (!visible)) {
990                                 update_track_visibility ();
991                         }
992                 }
993         }
994 }
995
996 void
997 Mixer_UI::update_track_visibility ()
998 {
999         TreeModel::Children rows = track_model->children();
1000         TreeModel::Children::iterator i;
1001
1002         {
1003                 Unwinder<bool> uw (no_track_list_redisplay, true);
1004
1005                 for (i = rows.begin(); i != rows.end(); ++i) {
1006                         AxisView* av = (*i)[stripable_columns.strip];
1007                         MixerStrip* strip = dynamic_cast<MixerStrip*> (av);
1008                         if (strip) {
1009                                 (*i)[stripable_columns.visible] = strip->marked_for_display ();
1010                         }
1011                 }
1012
1013                 /* force presentation catch up with visibility changes
1014                  */
1015
1016                 sync_presentation_info_from_treeview ();
1017         }
1018
1019         redisplay_track_list ();
1020 }
1021
1022 void
1023 Mixer_UI::show_strip (MixerStrip* ms)
1024 {
1025         TreeModel::Children rows = track_model->children();
1026         TreeModel::Children::iterator i;
1027
1028         for (i = rows.begin(); i != rows.end(); ++i) {
1029
1030                 AxisView* av = (*i)[stripable_columns.strip];
1031                 MixerStrip* strip = dynamic_cast<MixerStrip*> (av);
1032                 if (strip == ms) {
1033                         (*i)[stripable_columns.visible] = true;
1034                         redisplay_track_list ();
1035                         break;
1036                 }
1037         }
1038 }
1039
1040 void
1041 Mixer_UI::hide_strip (MixerStrip* ms)
1042 {
1043         TreeModel::Children rows = track_model->children();
1044         TreeModel::Children::iterator i;
1045
1046         for (i = rows.begin(); i != rows.end(); ++i) {
1047
1048                 AxisView* av = (*i)[stripable_columns.strip];
1049                 MixerStrip* strip = dynamic_cast<MixerStrip*> (av);
1050                 if (strip == ms) {
1051                         (*i)[stripable_columns.visible] = false;
1052                         redisplay_track_list ();
1053                         break;
1054                 }
1055         }
1056 }
1057
1058 gint
1059 Mixer_UI::start_updating ()
1060 {
1061     fast_screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &Mixer_UI::fast_update_strips));
1062     return 0;
1063 }
1064
1065 gint
1066 Mixer_UI::stop_updating ()
1067 {
1068     fast_screen_update_connection.disconnect();
1069     return 0;
1070 }
1071
1072 void
1073 Mixer_UI::fast_update_strips ()
1074 {
1075         if (_content.is_mapped () && _session) {
1076                 for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
1077                         (*i)->fast_update ();
1078                 }
1079         }
1080 }
1081
1082 void
1083 Mixer_UI::set_all_strips_visibility (bool yn)
1084 {
1085         TreeModel::Children rows = track_model->children();
1086         TreeModel::Children::iterator i;
1087
1088         {
1089                 Unwinder<bool> uw (no_track_list_redisplay, true);
1090
1091                 for (i = rows.begin(); i != rows.end(); ++i) {
1092
1093                         AxisView* av = (*i)[stripable_columns.strip];
1094                         MixerStrip* strip = dynamic_cast<MixerStrip*> (av);
1095
1096                         if (!strip) {
1097                                 continue;
1098                         }
1099
1100                         if (strip->route()->is_master() || strip->route()->is_monitor()) {
1101                                 continue;
1102                         }
1103
1104                         (*i)[stripable_columns.visible] = yn;
1105                 }
1106         }
1107
1108         redisplay_track_list ();
1109 }
1110
1111
1112 void
1113 Mixer_UI::set_all_audio_midi_visibility (int tracks, bool yn)
1114 {
1115         TreeModel::Children rows = track_model->children();
1116         TreeModel::Children::iterator i;
1117
1118         {
1119                 Unwinder<bool> uw (no_track_list_redisplay, true);
1120
1121                 for (i = rows.begin(); i != rows.end(); ++i) {
1122
1123                         AxisView* av = (*i)[stripable_columns.strip];
1124                         MixerStrip* strip = dynamic_cast<MixerStrip*> (av);
1125
1126                         if (!strip) {
1127                                 continue;
1128                         }
1129
1130                         if (strip->route()->is_master() || strip->route()->is_monitor()) {
1131                                 continue;
1132                         }
1133
1134                         boost::shared_ptr<AudioTrack> at = strip->audio_track();
1135                         boost::shared_ptr<MidiTrack> mt = strip->midi_track();
1136
1137                         switch (tracks) {
1138                         case 0:
1139                                 (*i)[stripable_columns.visible] = yn;
1140                                 break;
1141
1142                         case 1:
1143                                 if (at) { /* track */
1144                                         (*i)[stripable_columns.visible] = yn;
1145                                 }
1146                                 break;
1147
1148                         case 2:
1149                                 if (!at && !mt) { /* bus */
1150                                         (*i)[stripable_columns.visible] = yn;
1151                                 }
1152                                 break;
1153
1154                         case 3:
1155                                 if (mt) { /* midi-track */
1156                                         (*i)[stripable_columns.visible] = yn;
1157                                 }
1158                                 break;
1159                         }
1160                 }
1161         }
1162
1163         redisplay_track_list ();
1164 }
1165
1166 void
1167 Mixer_UI::hide_all_routes ()
1168 {
1169         set_all_strips_visibility (false);
1170 }
1171
1172 void
1173 Mixer_UI::show_all_routes ()
1174 {
1175         set_all_strips_visibility (true);
1176 }
1177
1178 void
1179 Mixer_UI::show_all_audiobus ()
1180 {
1181         set_all_audio_midi_visibility (2, true);
1182 }
1183 void
1184 Mixer_UI::hide_all_audiobus ()
1185 {
1186         set_all_audio_midi_visibility (2, false);
1187 }
1188
1189 void
1190 Mixer_UI::show_all_audiotracks()
1191 {
1192         set_all_audio_midi_visibility (1, true);
1193 }
1194 void
1195 Mixer_UI::hide_all_audiotracks ()
1196 {
1197         set_all_audio_midi_visibility (1, false);
1198 }
1199
1200 void
1201 Mixer_UI::show_all_miditracks()
1202 {
1203         set_all_audio_midi_visibility (3, true);
1204 }
1205 void
1206 Mixer_UI::hide_all_miditracks ()
1207 {
1208         set_all_audio_midi_visibility (3, false);
1209 }
1210
1211
1212 void
1213 Mixer_UI::track_list_reorder (const TreeModel::Path&, const TreeModel::iterator&, int* /*new_order*/)
1214 {
1215         DEBUG_TRACE (DEBUG::OrderKeys, "mixer UI treeview reordered\n");
1216         sync_presentation_info_from_treeview ();
1217 }
1218
1219 void
1220 Mixer_UI::track_list_delete (const Gtk::TreeModel::Path&)
1221 {
1222         /* this happens as the second step of a DnD within the treeview as well
1223            as when a row/route is actually deleted.
1224
1225            if it was a deletion then we have to force a redisplay because
1226            order keys may not have changed.
1227         */
1228
1229         DEBUG_TRACE (DEBUG::OrderKeys, "mixer UI treeview row deleted\n");
1230         sync_presentation_info_from_treeview ();
1231
1232         if (_route_deletion_in_progress) {
1233                 redisplay_track_list ();
1234         }
1235 }
1236
1237 void
1238 Mixer_UI::spill_redisplay (boost::shared_ptr<VCA> vca)
1239 {
1240         TreeModel::Children rows = track_model->children();
1241
1242         for (TreeModel::Children::iterator i = rows.begin(); i != rows.end(); ++i) {
1243
1244                 AxisView* av = (*i)[stripable_columns.strip];
1245                 MixerStrip* strip = dynamic_cast<MixerStrip*> (av);
1246
1247                 if (!strip) {
1248                         /* we're in the middle of changing a row, don't worry */
1249                         continue;
1250                 }
1251
1252                 if (!strip->route()) {
1253                         /* non-route element */
1254                         continue;
1255                 }
1256
1257                 if (strip->route()->is_master() || strip->route()->is_monitor()) {
1258                         continue;
1259                 }
1260
1261                 if (strip->route()->slaved_to (vca)) {
1262
1263                         if (strip->packed()) {
1264                                 strip_packer.reorder_child (*strip, -1); /* put at end */
1265                         } else {
1266                                 strip_packer.pack_start (*strip, false, false);
1267                                 strip->set_packed (true);
1268                         }
1269
1270                 } else {
1271
1272                         if (strip->packed()) {
1273                                 strip_packer.remove (*strip);
1274                                 strip->set_packed (false);
1275                         }
1276                 }
1277         }
1278 }
1279
1280 void
1281 Mixer_UI::redisplay_track_list ()
1282 {
1283         if (no_track_list_redisplay) {
1284                 return;
1285         }
1286
1287         boost::shared_ptr<VCA> sv = spilled_vca.lock ();
1288
1289         if (sv) {
1290                 spill_redisplay (sv);
1291                 return;
1292         }
1293
1294         TreeModel::Children rows = track_model->children();
1295         TreeModel::Children::iterator i;
1296         uint32_t n_masters = 0;
1297
1298         container_clear (vca_hpacker);
1299         vca_hpacker.pack_end (vca_scroller_base, true, true);
1300
1301         for (i = rows.begin(); i != rows.end(); ++i) {
1302
1303                 AxisView* s = (*i)[stripable_columns.strip];
1304
1305                 if (!s) {
1306                         /* we're in the middle of changing a row, don't worry */
1307                         continue;
1308                 }
1309
1310                 VCAMasterStrip* vms;
1311
1312                 if ((vms = dynamic_cast<VCAMasterStrip*> (s))) {
1313                         vca_hpacker.pack_start (*vms, false, false);
1314                         vms->show ();
1315                         n_masters++;
1316                         continue;
1317                 }
1318
1319                 MixerStrip* strip = dynamic_cast<MixerStrip*> (s);
1320
1321                 if (!strip) {
1322                         continue;
1323                 }
1324
1325                 bool const visible = (*i)[stripable_columns.visible];
1326
1327                 if (visible) {
1328
1329                         if (strip->packed()) {
1330
1331                                 if (strip->route()->is_master() || strip->route()->is_monitor()) {
1332                                         out_packer.reorder_child (*strip, -1);
1333
1334                                 } else {
1335                                         strip_packer.reorder_child (*strip, -1); /* put at end */
1336                                 }
1337
1338                         } else {
1339
1340                                 if (strip->route()->is_master() || strip->route()->is_monitor()) {
1341                                         out_packer.pack_start (*strip, false, false);
1342                                 } else {
1343                                         strip_packer.pack_start (*strip, false, false);
1344                                 }
1345                                 strip->set_packed (true);
1346                         }
1347
1348                 } else {
1349
1350                         if (strip->route()->is_master() || strip->route()->is_monitor()) {
1351                                 /* do nothing, these cannot be hidden */
1352                         } else {
1353                                 if (strip->packed()) {
1354                                         strip_packer.remove (*strip);
1355                                         strip->set_packed (false);
1356                                 }
1357                         }
1358                 }
1359         }
1360
1361         /* update visibility of VCA assign buttons */
1362
1363         if (n_masters == 0) {
1364                 UIConfiguration::instance().set_mixer_strip_visibility (VisibilityGroup::remove_element (UIConfiguration::instance().get_mixer_strip_visibility(), X_("VCA")));
1365                 vca_scroller.hide ();
1366         } else {
1367                 UIConfiguration::instance().set_mixer_strip_visibility (VisibilityGroup::add_element (UIConfiguration::instance().get_mixer_strip_visibility(), X_("VCA")));
1368                 vca_scroller.show ();
1369         }
1370
1371         _group_tabs->set_dirty ();
1372 }
1373
1374 void
1375 Mixer_UI::strip_width_changed ()
1376 {
1377         _group_tabs->set_dirty ();
1378
1379 #ifdef __APPLE__
1380         TreeModel::Children rows = track_model->children();
1381         TreeModel::Children::iterator i;
1382         long order;
1383
1384         for (order = 0, i = rows.begin(); i != rows.end(); ++i, ++order) {
1385                 AxisView* av = (*i)[stripable_columns.strip];
1386                 MixerStrip* strip = dynamic_cast<MixerStrip*> (av);
1387
1388                 if (strip == 0) {
1389                         continue;
1390                 }
1391
1392                 bool visible = (*i)[stripable_columns.visible];
1393
1394                 if (visible) {
1395                         strip->queue_draw();
1396                 }
1397         }
1398 #endif
1399
1400 }
1401
1402 struct PresentationInfoMixerSorter
1403 {
1404         bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
1405                 if (a->is_master()) {
1406                         /* master after everything else */
1407                         return false;
1408                 } else if (b->is_master()) {
1409                         /* everything else before master */
1410                         return true;
1411                 }
1412                 return a->presentation_info().order () < b->presentation_info().order ();
1413         }
1414 };
1415
1416 void
1417 Mixer_UI::initial_track_display ()
1418 {
1419         StripableList sl;
1420
1421         boost::shared_ptr<RouteList> routes = _session->get_routes();
1422
1423         for (RouteList::iterator r = routes->begin(); r != routes->end(); ++r) {
1424                 sl.push_back (*r);
1425         }
1426
1427         VCAList vcas = _session->vca_manager().vcas();
1428
1429         for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
1430                 sl.push_back (boost::dynamic_pointer_cast<Stripable> (*v));
1431         }
1432
1433         sl.sort (PresentationInfoMixerSorter());
1434
1435         {
1436                 /* These are also used inside ::add_stripables() but we need
1437                  *  them here because we're going to clear the track_model also.
1438                  */
1439                 Unwinder<bool> uw1 (no_track_list_redisplay, true);
1440                 Unwinder<bool> uw2 (ignore_reorder, true);
1441
1442                 track_model->clear ();
1443                 add_stripables (sl);
1444         }
1445
1446         redisplay_track_list ();
1447 }
1448
1449 void
1450 Mixer_UI::show_track_list_menu ()
1451 {
1452         if (track_menu == 0) {
1453                 build_track_menu ();
1454         }
1455
1456         track_menu->popup (1, gtk_get_current_event_time());
1457 }
1458
1459 bool
1460 Mixer_UI::track_display_button_press (GdkEventButton* ev)
1461 {
1462         if (Keyboard::is_context_menu_event (ev)) {
1463                 show_track_list_menu ();
1464                 return true;
1465         }
1466
1467         return false;
1468 }
1469
1470 void
1471 Mixer_UI::build_track_menu ()
1472 {
1473         using namespace Menu_Helpers;
1474         using namespace Gtk;
1475
1476         track_menu = new Menu;
1477         track_menu->set_name ("ArdourContextMenu");
1478         MenuList& items = track_menu->items();
1479
1480         items.push_back (MenuElem (_("Show All"), sigc::mem_fun(*this, &Mixer_UI::show_all_routes)));
1481         items.push_back (MenuElem (_("Hide All"), sigc::mem_fun(*this, &Mixer_UI::hide_all_routes)));
1482         items.push_back (MenuElem (_("Show All Audio Tracks"), sigc::mem_fun(*this, &Mixer_UI::show_all_audiotracks)));
1483         items.push_back (MenuElem (_("Hide All Audio Tracks"), sigc::mem_fun(*this, &Mixer_UI::hide_all_audiotracks)));
1484         items.push_back (MenuElem (_("Show All Audio Busses"), sigc::mem_fun(*this, &Mixer_UI::show_all_audiobus)));
1485         items.push_back (MenuElem (_("Hide All Audio Busses"), sigc::mem_fun(*this, &Mixer_UI::hide_all_audiobus)));
1486         items.push_back (MenuElem (_("Show All Midi Tracks"), sigc::mem_fun (*this, &Mixer_UI::show_all_miditracks)));
1487         items.push_back (MenuElem (_("Hide All Midi Tracks"), sigc::mem_fun (*this, &Mixer_UI::hide_all_miditracks)));
1488
1489 }
1490
1491 void
1492 Mixer_UI::strip_property_changed (const PropertyChange& what_changed, MixerStrip* mx)
1493 {
1494         if (!what_changed.contains (ARDOUR::Properties::name)) {
1495                 return;
1496         }
1497
1498         ENSURE_GUI_THREAD (*this, &Mixer_UI::strip_name_changed, what_changed, mx)
1499
1500         TreeModel::Children rows = track_model->children();
1501         TreeModel::Children::iterator i;
1502
1503         for (i = rows.begin(); i != rows.end(); ++i) {
1504                 if ((*i)[stripable_columns.strip] == mx) {
1505                         (*i)[stripable_columns.text] = mx->route()->name();
1506                         return;
1507                 }
1508         }
1509
1510         error << _("track display list item for renamed strip not found!") << endmsg;
1511 }
1512
1513 bool
1514 Mixer_UI::group_display_button_press (GdkEventButton* ev)
1515 {
1516         TreeModel::Path path;
1517         TreeViewColumn* column;
1518         int cellx;
1519         int celly;
1520
1521         if (!group_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1522                 _group_tabs->get_menu(0)->popup (1, ev->time);
1523                 return true;
1524         }
1525
1526         TreeIter iter = group_model->get_iter (path);
1527         if (!iter) {
1528                 _group_tabs->get_menu(0)->popup (1, ev->time);
1529                 return true;
1530         }
1531
1532         RouteGroup* group = (*iter)[group_columns.group];
1533
1534         if (Keyboard::is_context_menu_event (ev)) {
1535                 _group_tabs->get_menu(group)->popup (1, ev->time);
1536                 return true;
1537         }
1538
1539         switch (GPOINTER_TO_UINT (column->get_data (X_("colnum")))) {
1540         case 0:
1541                 if (Keyboard::is_edit_event (ev)) {
1542                         if (group) {
1543                                 // edit_route_group (group);
1544 #ifdef __APPLE__
1545                                 group_display.queue_draw();
1546 #endif
1547                                 return true;
1548                         }
1549                 }
1550                 break;
1551
1552         case 1:
1553         {
1554                 bool visible = (*iter)[group_columns.visible];
1555                 (*iter)[group_columns.visible] = !visible;
1556 #ifdef __APPLE__
1557                 group_display.queue_draw();
1558 #endif
1559                 return true;
1560         }
1561
1562         default:
1563                 break;
1564         }
1565
1566         return false;
1567  }
1568
1569 void
1570 Mixer_UI::activate_all_route_groups ()
1571 {
1572         _session->foreach_route_group (sigc::bind (sigc::mem_fun (*this, &Mixer_UI::set_route_group_activation), true));
1573 }
1574
1575 void
1576 Mixer_UI::disable_all_route_groups ()
1577 {
1578         _session->foreach_route_group (sigc::bind (sigc::mem_fun (*this, &Mixer_UI::set_route_group_activation), false));
1579 }
1580
1581 void
1582 Mixer_UI::route_groups_changed ()
1583 {
1584         ENSURE_GUI_THREAD (*this, &Mixer_UI::route_groups_changed);
1585
1586         _in_group_rebuild_or_clear = true;
1587
1588         /* just rebuild the while thing */
1589
1590         group_model->clear ();
1591
1592 #if 0
1593         /* this is currently not used,
1594          * Mixer_UI::group_display_button_press() has a case for it,
1595          * and a commented edit_route_group() but that's n/a since 2011.
1596          *
1597          * This code is left as reminder that
1598          * row[group_columns.group] = 0 has special meaning.
1599          */
1600         {
1601                 TreeModel::Row row;
1602                 row = *(group_model->append());
1603                 row[group_columns.visible] = true;
1604                 row[group_columns.text] = (_("-all-"));
1605                 row[group_columns.group] = 0;
1606         }
1607 #endif
1608
1609         _session->foreach_route_group (sigc::mem_fun (*this, &Mixer_UI::add_route_group));
1610
1611         _group_tabs->set_dirty ();
1612         _in_group_rebuild_or_clear = false;
1613 }
1614
1615 void
1616 Mixer_UI::new_route_group ()
1617 {
1618         RouteList rl;
1619
1620         _group_tabs->run_new_group_dialog (rl, false);
1621 }
1622
1623 void
1624 Mixer_UI::remove_selected_route_group ()
1625 {
1626         Glib::RefPtr<TreeSelection> selection = group_display.get_selection();
1627         TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1628
1629         if (rows.empty()) {
1630                 return;
1631         }
1632
1633         TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1634         TreeIter iter;
1635
1636         /* selection mode is single, so rows.begin() is it */
1637
1638         if ((iter = group_model->get_iter (*i))) {
1639
1640                 RouteGroup* rg = (*iter)[group_columns.group];
1641
1642                 if (rg) {
1643                         _session->remove_route_group (*rg);
1644                 }
1645         }
1646 }
1647
1648 void
1649 Mixer_UI::route_group_property_changed (RouteGroup* group, const PropertyChange& change)
1650 {
1651         if (in_group_row_change) {
1652                 return;
1653         }
1654
1655         /* force an update of any mixer strips that are using this group,
1656            otherwise mix group names don't change in mixer strips
1657         */
1658
1659         for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
1660                 if ((*i)->route_group() == group) {
1661                         (*i)->route_group_changed();
1662                 }
1663         }
1664
1665         TreeModel::iterator i;
1666         TreeModel::Children rows = group_model->children();
1667         Glib::RefPtr<TreeSelection> selection = group_display.get_selection();
1668
1669         in_group_row_change = true;
1670
1671         for (i = rows.begin(); i != rows.end(); ++i) {
1672                 if ((*i)[group_columns.group] == group) {
1673                         (*i)[group_columns.visible] = !group->is_hidden ();
1674                         (*i)[group_columns.text] = group->name ();
1675                         break;
1676                 }
1677         }
1678
1679         in_group_row_change = false;
1680
1681         if (change.contains (Properties::name)) {
1682                 _group_tabs->set_dirty ();
1683         }
1684
1685         for (list<MixerStrip*>::iterator j = strips.begin(); j != strips.end(); ++j) {
1686                 if ((*j)->route_group() == group) {
1687                         if (group->is_hidden ()) {
1688                                 hide_strip (*j);
1689                         } else {
1690                                 show_strip (*j);
1691                         }
1692                 }
1693         }
1694 }
1695
1696 void
1697 Mixer_UI::show_mixer_list (bool yn)
1698 {
1699         if (yn) {
1700                 list_vpacker.show ();
1701         } else {
1702                 list_vpacker.hide ();
1703         }
1704
1705         _show_mixer_list = yn;
1706 }
1707
1708 void
1709 Mixer_UI::show_monitor_section (bool yn)
1710 {
1711         if (!monitor_section()) {
1712                 return;
1713         }
1714         if (monitor_section()->tearoff().torn_off()) {
1715                 return;
1716         }
1717
1718         if (yn) {
1719                 monitor_section()->tearoff().show();
1720         } else {
1721                 monitor_section()->tearoff().hide();
1722         }
1723 }
1724
1725 void
1726 Mixer_UI::route_group_name_edit (const std::string& path, const std::string& new_text)
1727 {
1728         RouteGroup* group;
1729         TreeIter iter;
1730
1731         if ((iter = group_model->get_iter (path))) {
1732
1733                 if ((group = (*iter)[group_columns.group]) == 0) {
1734                         return;
1735                 }
1736
1737                 if (new_text != group->name()) {
1738                         group->set_name (new_text);
1739                 }
1740         }
1741 }
1742
1743 void
1744 Mixer_UI::route_group_row_change (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator& iter)
1745 {
1746         RouteGroup* group;
1747
1748         if (in_group_row_change) {
1749                 return;
1750         }
1751
1752         if ((group = (*iter)[group_columns.group]) == 0) {
1753                 return;
1754         }
1755
1756         std::string name = (*iter)[group_columns.text];
1757
1758         if (name != group->name()) {
1759                 group->set_name (name);
1760         }
1761
1762         bool hidden = !(*iter)[group_columns.visible];
1763
1764         if (hidden != group->is_hidden ()) {
1765                 group->set_hidden (hidden, this);
1766         }
1767 }
1768
1769 /** Called when a group model row is deleted, but also when the model is
1770  *  reordered by a user drag-and-drop; the latter is what we are
1771  *  interested in here.
1772  */
1773 void
1774 Mixer_UI::route_group_row_deleted (Gtk::TreeModel::Path const &)
1775 {
1776         if (_in_group_rebuild_or_clear) {
1777                 return;
1778         }
1779
1780         /* Re-write the session's route group list so that the new order is preserved */
1781
1782         list<RouteGroup*> new_list;
1783
1784         Gtk::TreeModel::Children children = group_model->children();
1785         for (Gtk::TreeModel::Children::iterator i = children.begin(); i != children.end(); ++i) {
1786                 RouteGroup* g = (*i)[group_columns.group];
1787                 if (g) {
1788                         new_list.push_back (g);
1789                 }
1790         }
1791
1792         _session->reorder_route_groups (new_list);
1793 }
1794
1795
1796 void
1797 Mixer_UI::add_route_group (RouteGroup* group)
1798 {
1799         ENSURE_GUI_THREAD (*this, &Mixer_UI::add_route_group, group)
1800         bool focus = false;
1801
1802         in_group_row_change = true;
1803
1804         TreeModel::Row row = *(group_model->append());
1805         row[group_columns.visible] = !group->is_hidden ();
1806         row[group_columns.group] = group;
1807         if (!group->name().empty()) {
1808                 row[group_columns.text] = group->name();
1809         } else {
1810                 row[group_columns.text] = _("unnamed");
1811                 focus = true;
1812         }
1813
1814         group->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::route_group_property_changed, this, group, _1), gui_context());
1815
1816         if (focus) {
1817                 TreeViewColumn* col = group_display.get_column (0);
1818                 CellRendererText* name_cell = dynamic_cast<CellRendererText*>(group_display.get_column_cell_renderer (0));
1819                 group_display.set_cursor (group_model->get_path (row), *col, *name_cell, true);
1820         }
1821
1822         _group_tabs->set_dirty ();
1823
1824         in_group_row_change = false;
1825 }
1826
1827 bool
1828 Mixer_UI::strip_scroller_button_release (GdkEventButton* ev)
1829 {
1830         using namespace Menu_Helpers;
1831
1832         if (Keyboard::is_context_menu_event (ev)) {
1833                 ARDOUR_UI::instance()->add_route ();
1834                 return true;
1835         }
1836
1837         return false;
1838 }
1839
1840 void
1841 Mixer_UI::scroller_drag_data_received (const Glib::RefPtr<Gdk::DragContext>& context, int x, int y, const Gtk::SelectionData& data, guint info, guint time)
1842 {
1843         printf ("Mixer_UI::scroller_drag_data_received\n");
1844         if (data.get_target() != "PluginFavoritePtr") {
1845                 context->drag_finish (false, false, time);
1846                 return;
1847         }
1848
1849         const void * d = data.get_data();
1850         const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1851
1852         PluginPresetList nfos;
1853         TreeView* source;
1854         tv->get_object_drag_data (nfos, &source);
1855
1856         Route::ProcessorList pl;
1857         bool ok = false;
1858
1859         for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1860                 PluginPresetPtr ppp = (*i);
1861                 PluginInfoPtr pip = ppp->_pip;
1862                 if (!pip->is_instrument ()) {
1863                         continue;
1864                 }
1865                 ARDOUR_UI::instance()->session_add_midi_track ((RouteGroup*) 0, 1, _("MIDI"), Config->get_strict_io (), pip, ppp->_preset.valid ? &ppp->_preset : 0, PresentationInfo::max_order);
1866                 ok = true;
1867         }
1868
1869         context->drag_finish (ok, false, time);
1870 }
1871
1872 void
1873 Mixer_UI::set_strip_width (Width w, bool save)
1874 {
1875         _strip_width = w;
1876
1877         for (list<MixerStrip*>::iterator i = strips.begin(); i != strips.end(); ++i) {
1878                 (*i)->set_width_enum (w, save ? (*i)->width_owner() : this);
1879         }
1880 }
1881
1882
1883 struct PluginStateSorter {
1884 public:
1885         bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
1886                 std::list<std::string>::const_iterator aiter = std::find(_user.begin(), _user.end(), (*a).unique_id);
1887                 std::list<std::string>::const_iterator biter = std::find(_user.begin(), _user.end(), (*b).unique_id);
1888                 if (aiter != _user.end() && biter != _user.end()) {
1889                         return std::distance (_user.begin(), aiter)  < std::distance (_user.begin(), biter);
1890                 }
1891                 if (aiter != _user.end()) {
1892                         return true;
1893                 }
1894                 if (biter != _user.end()) {
1895                         return false;
1896                 }
1897                 return ARDOUR::cmp_nocase((*a).name, (*b).name) == -1;
1898         }
1899
1900         PluginStateSorter(std::list<std::string> user) : _user (user)  {}
1901 private:
1902         std::list<std::string> _user;
1903 };
1904
1905 int
1906 Mixer_UI::set_state (const XMLNode& node, int version)
1907 {
1908         XMLProperty const * prop;
1909         LocaleGuard lg;
1910
1911         Tabbable::set_state (node, version);
1912
1913         if ((prop = node.property ("narrow-strips"))) {
1914                 if (string_is_affirmative (prop->value())) {
1915                         set_strip_width (Narrow);
1916                 } else {
1917                         set_strip_width (Wide);
1918                 }
1919         }
1920
1921         if ((prop = node.property ("show-mixer"))) {
1922                 if (string_is_affirmative (prop->value())) {
1923                        _visible = true;
1924                 }
1925         }
1926
1927         if ((prop = node.property ("maximised"))) {
1928                 bool yn = string_is_affirmative (prop->value());
1929                 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Common"), X_("ToggleMaximalMixer"));
1930                 assert (act);
1931                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
1932                 bool fs = tact && tact->get_active();
1933                 if (yn ^ fs) {
1934                         ActionManager::do_action ("Common", "ToggleMaximalMixer");
1935                 }
1936         }
1937
1938         if ((prop = node.property ("show-mixer-list"))) {
1939                 bool yn = string_is_affirmative (prop->value());
1940                 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Common"), X_("ToggleMixerList"));
1941                 assert (act);
1942                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
1943
1944                 /* do it twice to force the change */
1945                 tact->set_active (!yn);
1946                 tact->set_active (yn);
1947         }
1948
1949
1950         XMLNode* plugin_order;
1951         if ((plugin_order = find_named_node (node, "PluginOrder")) != 0) {
1952                 store_current_favorite_order ();
1953                 std::list<string> order;
1954                 const XMLNodeList& kids = plugin_order->children("PluginInfo");
1955                 XMLNodeConstIterator i;
1956                 for (i = kids.begin(); i != kids.end(); ++i) {
1957                         if ((prop = (*i)->property ("unique-id"))) {
1958                                 std::string unique_id = prop->value();
1959                                 order.push_back (unique_id);
1960                                 if ((prop = (*i)->property ("expanded"))) {
1961                                         favorite_ui_state[unique_id] = string_is_affirmative (prop->value());
1962                                 }
1963                         }
1964                 }
1965                 PluginStateSorter cmp (order);
1966                 favorite_order.sort (cmp);
1967                 sync_treeview_from_favorite_order ();
1968         }
1969         return 0;
1970 }
1971
1972 XMLNode&
1973 Mixer_UI::get_state ()
1974 {
1975         XMLNode* node = new XMLNode (X_("Mixer"));
1976         char buf[128];
1977         LocaleGuard lg;
1978
1979         node->add_child_nocopy (Tabbable::get_state());
1980
1981         snprintf(buf,sizeof(buf), "%f", rhs_pane1.get_divider());
1982         node->add_property(X_("mixer-rhs-pane1-pos"), string(buf));
1983         snprintf(buf,sizeof(buf), "%f", rhs_pane2.get_divider());
1984         node->add_property(X_("mixer-rhs_pane2-pos"), string(buf));
1985         snprintf(buf,sizeof(buf), "%f", list_hpane.get_divider());
1986         node->add_property(X_("mixer-list-hpane-pos"), string(buf));
1987         snprintf(buf,sizeof(buf), "%f", inner_pane.get_divider());
1988         node->add_property(X_("mixer-inner-pane-pos"), string(buf));
1989
1990         node->add_property ("narrow-strips", _strip_width == Narrow ? "yes" : "no");
1991         node->add_property ("show-mixer", _visible ? "yes" : "no");
1992         node->add_property ("show-mixer-list", _show_mixer_list ? "yes" : "no");
1993         node->add_property ("maximised", _maximised ? "yes" : "no");
1994
1995         store_current_favorite_order ();
1996         XMLNode* plugin_order = new XMLNode ("PluginOrder");
1997         int cnt = 0;
1998         for (PluginInfoList::const_iterator i = favorite_order.begin(); i != favorite_order.end(); ++i, ++cnt) {
1999                 XMLNode* p = new XMLNode ("PluginInfo");
2000                 p->add_property ("sort", cnt);
2001                 p->add_property ("unique-id", (*i)->unique_id);
2002                 if (favorite_ui_state.find ((*i)->unique_id) != favorite_ui_state.end ()) {
2003                         p->add_property ("expanded", favorite_ui_state[(*i)->unique_id]);
2004                 }
2005                 plugin_order->add_child_nocopy (*p);
2006         }
2007         node->add_child_nocopy (*plugin_order);
2008
2009         return *node;
2010 }
2011
2012 void
2013 Mixer_UI::scroll_left ()
2014 {
2015         if (!scroller.get_hscrollbar()) return;
2016         Adjustment* adj = scroller.get_hscrollbar()->get_adjustment();
2017         /* stupid GTK: can't rely on clamping across versions */
2018         scroller.get_hscrollbar()->set_value (max (adj->get_lower(), adj->get_value() - adj->get_step_increment()));
2019 }
2020
2021 void
2022 Mixer_UI::scroll_right ()
2023 {
2024         if (!scroller.get_hscrollbar()) return;
2025         Adjustment* adj = scroller.get_hscrollbar()->get_adjustment();
2026         /* stupid GTK: can't rely on clamping across versions */
2027         scroller.get_hscrollbar()->set_value (min (adj->get_upper(), adj->get_value() + adj->get_step_increment()));
2028 }
2029
2030 bool
2031 Mixer_UI::on_scroll_event (GdkEventScroll* ev)
2032 {
2033         switch (ev->direction) {
2034         case GDK_SCROLL_LEFT:
2035                 scroll_left ();
2036                 return true;
2037         case GDK_SCROLL_UP:
2038                 if (ev->state & Keyboard::TertiaryModifier) {
2039                         scroll_left ();
2040                         return true;
2041                 }
2042                 return false;
2043
2044         case GDK_SCROLL_RIGHT:
2045                 scroll_right ();
2046                 return true;
2047
2048         case GDK_SCROLL_DOWN:
2049                 if (ev->state & Keyboard::TertiaryModifier) {
2050                         scroll_right ();
2051                         return true;
2052                 }
2053                 return false;
2054         }
2055
2056         return false;
2057 }
2058
2059
2060 void
2061 Mixer_UI::parameter_changed (string const & p)
2062 {
2063         if (p == "show-group-tabs") {
2064                 bool const s = _session->config.get_show_group_tabs ();
2065                 if (s) {
2066                         _group_tabs->show ();
2067                 } else {
2068                         _group_tabs->hide ();
2069                 }
2070         } else if (p == "default-narrow_ms") {
2071                 bool const s = UIConfiguration::instance().get_default_narrow_ms ();
2072                 for (list<MixerStrip*>::iterator i = strips.begin(); i != strips.end(); ++i) {
2073                         (*i)->set_width_enum (s ? Narrow : Wide, this);
2074                 }
2075         } else if (p == "use-monitor-bus") {
2076                 if (_session && !_session->monitor_out()) {
2077                         monitor_section_detached ();
2078                 }
2079         }
2080 }
2081
2082 void
2083 Mixer_UI::set_route_group_activation (RouteGroup* g, bool a)
2084 {
2085         g->set_active (a, this);
2086 }
2087
2088 PluginSelector*
2089 Mixer_UI::plugin_selector()
2090 {
2091 #ifdef DEFER_PLUGIN_SELECTOR_LOAD
2092         if (!_plugin_selector)
2093                 _plugin_selector = new PluginSelector (PluginManager::instance());
2094 #endif
2095
2096         return _plugin_selector;
2097 }
2098
2099 void
2100 Mixer_UI::setup_track_display ()
2101 {
2102         track_model = ListStore::create (stripable_columns);
2103         track_display.set_model (track_model);
2104         track_display.append_column (_("Strips"), stripable_columns.text);
2105         track_display.append_column (_("Show"), stripable_columns.visible);
2106         track_display.get_column (0)->set_data (X_("colnum"), GUINT_TO_POINTER(0));
2107         track_display.get_column (1)->set_data (X_("colnum"), GUINT_TO_POINTER(1));
2108         track_display.get_column (0)->set_expand(true);
2109         track_display.get_column (1)->set_expand(false);
2110         track_display.get_column (0)->set_sizing (Gtk::TREE_VIEW_COLUMN_FIXED);
2111         track_display.set_name (X_("EditGroupList"));
2112         track_display.get_selection()->set_mode (Gtk::SELECTION_NONE);
2113         track_display.set_reorderable (true);
2114         track_display.set_headers_visible (true);
2115         track_display.set_can_focus(false);
2116
2117         track_model->signal_row_deleted().connect (sigc::mem_fun (*this, &Mixer_UI::track_list_delete));
2118         track_model->signal_rows_reordered().connect (sigc::mem_fun (*this, &Mixer_UI::track_list_reorder));
2119
2120         CellRendererToggle* track_list_visible_cell = dynamic_cast<CellRendererToggle*>(track_display.get_column_cell_renderer (1));
2121         track_list_visible_cell->property_activatable() = true;
2122         track_list_visible_cell->property_radio() = false;
2123         track_list_visible_cell->signal_toggled().connect (sigc::mem_fun (*this, &Mixer_UI::track_visibility_changed));
2124
2125         track_display.signal_button_press_event().connect (sigc::mem_fun (*this, &Mixer_UI::track_display_button_press), false);
2126
2127         track_display_scroller.add (track_display);
2128         track_display_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
2129
2130         VBox* v = manage (new VBox);
2131         v->show ();
2132         v->pack_start (track_display_scroller, true, true);
2133
2134         Button* b = manage (new Button);
2135         b->show ();
2136         Widget* w = manage (new Image (Stock::ADD, ICON_SIZE_BUTTON));
2137         w->show ();
2138         b->add (*w);
2139
2140         b->signal_clicked().connect (sigc::mem_fun (*this, &Mixer_UI::new_track_or_bus));
2141
2142         v->pack_start (*b, false, false);
2143
2144         track_display_frame.set_name("BaseFrame");
2145         track_display_frame.set_shadow_type (Gtk::SHADOW_IN);
2146         track_display_frame.add (*v);
2147
2148         track_display_scroller.show();
2149         track_display_frame.show();
2150         track_display.show();
2151 }
2152
2153 void
2154 Mixer_UI::new_track_or_bus ()
2155 {
2156         ARDOUR_UI::instance()->add_route ();
2157 }
2158
2159 void
2160 Mixer_UI::update_title ()
2161 {
2162         if (!own_window()) {
2163                 return;
2164         }
2165
2166         if (_session) {
2167                 string n;
2168
2169                 if (_session->snap_name() != _session->name()) {
2170                         n = _session->snap_name ();
2171                 } else {
2172                         n = _session->name ();
2173                 }
2174
2175                 if (_session->dirty ()) {
2176                         n = "*" + n;
2177                 }
2178
2179                 WindowTitle title (n);
2180                 title += S_("Window|Mixer");
2181                 title += Glib::get_application_name ();
2182                 own_window()->set_title (title.get_string());
2183
2184         } else {
2185
2186                 WindowTitle title (S_("Window|Mixer"));
2187                 title += Glib::get_application_name ();
2188                 own_window()->set_title (title.get_string());
2189         }
2190 }
2191
2192 MixerStrip*
2193 Mixer_UI::strip_by_x (int x)
2194 {
2195         for (list<MixerStrip*>::iterator i = strips.begin(); i != strips.end(); ++i) {
2196                 int x1, x2, y;
2197
2198                 (*i)->translate_coordinates (_content, 0, 0, x1, y);
2199                 x2 = x1 + (*i)->get_width();
2200
2201                 if (x >= x1 && x <= x2) {
2202                         return (*i);
2203                 }
2204         }
2205
2206         return 0;
2207 }
2208
2209 void
2210 Mixer_UI::set_route_targets_for_operation ()
2211 {
2212         _route_targets.clear ();
2213
2214         if (!_selection.empty()) {
2215                 _route_targets = _selection.routes;
2216                 return;
2217         }
2218
2219 //  removed "implicit" selections of strips, after discussion on IRC
2220
2221 }
2222
2223 void
2224 Mixer_UI::monitor_section_going_away ()
2225 {
2226         if (_monitor_section) {
2227                 monitor_section_detached ();
2228                 out_packer.remove (_monitor_section->tearoff());
2229                 _monitor_section->set_session (0);
2230                 delete _monitor_section;
2231                 _monitor_section = 0;
2232         }
2233 }
2234
2235 void
2236 Mixer_UI::toggle_midi_input_active (bool flip_others)
2237 {
2238         boost::shared_ptr<RouteList> rl (new RouteList);
2239         bool onoff = false;
2240
2241         set_route_targets_for_operation ();
2242
2243         for (RouteUISelection::iterator r = _route_targets.begin(); r != _route_targets.end(); ++r) {
2244                 boost::shared_ptr<MidiTrack> mt = (*r)->midi_track();
2245
2246                 if (mt) {
2247                         rl->push_back ((*r)->route());
2248                         onoff = !mt->input_active();
2249                 }
2250         }
2251
2252         _session->set_exclusive_input_active (rl, onoff, flip_others);
2253 }
2254
2255 void
2256 Mixer_UI::maximise_mixer_space ()
2257 {
2258         if (!own_window()) {
2259                 return;
2260         }
2261
2262         if (_maximised) {
2263                 return;
2264         }
2265
2266         _window->fullscreen ();
2267         _maximised = true;
2268 }
2269
2270 void
2271 Mixer_UI::restore_mixer_space ()
2272 {
2273         if (!own_window()) {
2274                 return;
2275         }
2276
2277         if (!_maximised) {
2278                 return;
2279         }
2280
2281         own_window()->unfullscreen();
2282         _maximised = false;
2283 }
2284
2285 void
2286 Mixer_UI::monitor_section_attached ()
2287 {
2288         Glib::RefPtr<Action> act = ActionManager::get_action ("Common", "ToggleMonitorSection");
2289         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
2290         act->set_sensitive (true);
2291         tact->set_active ();
2292 }
2293
2294 void
2295 Mixer_UI::monitor_section_detached ()
2296 {
2297         Glib::RefPtr<Action> act = ActionManager::get_action ("Common", "ToggleMonitorSection");
2298         act->set_sensitive (false);
2299 }
2300
2301 void
2302 Mixer_UI::store_current_favorite_order ()
2303 {
2304         typedef Gtk::TreeModel::Children type_children;
2305         type_children children = favorite_plugins_model->children();
2306         favorite_order.clear();
2307         for(type_children::iterator iter = children.begin(); iter != children.end(); ++iter)
2308         {
2309                 Gtk::TreeModel::Row row = *iter;
2310                 ARDOUR::PluginPresetPtr ppp = row[favorite_plugins_columns.plugin];
2311                 favorite_order.push_back (ppp->_pip);
2312                 std::string name = row[favorite_plugins_columns.name];
2313                 favorite_ui_state[(*ppp->_pip).unique_id] = favorite_plugins_display.row_expanded (favorite_plugins_model->get_path(iter));
2314         }
2315 }
2316
2317 void
2318 Mixer_UI::save_favorite_ui_state (const TreeModel::iterator& iter, const TreeModel::Path& path)
2319 {
2320         Gtk::TreeModel::Row row = *iter;
2321         ARDOUR::PluginPresetPtr ppp = row[favorite_plugins_columns.plugin];
2322         assert (ppp);
2323         favorite_ui_state[(*ppp->_pip).unique_id] = favorite_plugins_display.row_expanded (favorite_plugins_model->get_path(iter));
2324 }
2325
2326 void
2327 Mixer_UI::refiller (PluginInfoList& result, const PluginInfoList& plugs)
2328 {
2329         PluginManager& manager (PluginManager::instance());
2330         for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
2331                 if (manager.get_status (*i) != PluginManager::Favorite) {
2332                         continue;
2333                 }
2334                 result.push_back (*i);
2335         }
2336 }
2337
2338 struct PluginCustomSorter {
2339 public:
2340         bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
2341                 PluginInfoList::const_iterator aiter = _user.begin();
2342                 PluginInfoList::const_iterator biter = _user.begin();
2343                 while (aiter != _user.end()) { if ((*aiter)->unique_id == a->unique_id) { break; } ++aiter; }
2344                 while (biter != _user.end()) { if ((*biter)->unique_id == b->unique_id) { break; } ++biter; }
2345
2346                 if (aiter != _user.end() && biter != _user.end()) {
2347                         return std::distance (_user.begin(), aiter) < std::distance (_user.begin(), biter);
2348                 }
2349                 if (aiter != _user.end()) {
2350                         return true;
2351                 }
2352                 if (biter != _user.end()) {
2353                         return false;
2354                 }
2355                 return ARDOUR::cmp_nocase((*a).name, (*b).name) == -1;
2356         }
2357         PluginCustomSorter(PluginInfoList user) : _user (user)  {}
2358 private:
2359         PluginInfoList _user;
2360 };
2361
2362 void
2363 Mixer_UI::refill_favorite_plugins ()
2364 {
2365         PluginInfoList plugs;
2366         PluginManager& mgr (PluginManager::instance());
2367
2368 #ifdef LV2_SUPPORT
2369         refiller (plugs, mgr.lv2_plugin_info ());
2370 #endif
2371 #ifdef WINDOWS_VST_SUPPORT
2372         refiller (plugs, mgr.windows_vst_plugin_info ());
2373 #endif
2374 #ifdef LXVST_SUPPORT
2375         refiller (plugs, mgr.lxvst_plugin_info ());
2376 #endif
2377 #ifdef AUDIOUNIT_SUPPORT
2378         refiller (plugs, mgr.au_plugin_info ());
2379 #endif
2380         refiller (plugs, mgr.ladspa_plugin_info ());
2381         refiller (plugs, mgr.lua_plugin_info ());
2382
2383         store_current_favorite_order ();
2384
2385         PluginCustomSorter cmp (favorite_order);
2386         plugs.sort (cmp);
2387
2388         favorite_order = plugs;
2389
2390         sync_treeview_from_favorite_order ();
2391 }
2392
2393 void
2394 Mixer_UI::sync_treeview_favorite_ui_state (const TreeModel::Path& path, const TreeModel::iterator&)
2395 {
2396         TreeIter iter;
2397         if (!(iter = favorite_plugins_model->get_iter (path))) {
2398                 return;
2399         }
2400         ARDOUR::PluginPresetPtr ppp = (*iter)[favorite_plugins_columns.plugin];
2401         if (!ppp) {
2402                 return;
2403         }
2404         PluginInfoPtr pip = ppp->_pip;
2405         if (favorite_ui_state.find (pip->unique_id) != favorite_ui_state.end ()) {
2406                 if (favorite_ui_state[pip->unique_id]) {
2407                         favorite_plugins_display.expand_row (path, true);
2408                 }
2409         }
2410 }
2411
2412 void
2413 Mixer_UI::sync_treeview_from_favorite_order ()
2414 {
2415         favorite_plugins_model->clear ();
2416         for (PluginInfoList::const_iterator i = favorite_order.begin(); i != favorite_order.end(); ++i) {
2417                 PluginInfoPtr pip = (*i);
2418
2419                 TreeModel::Row newrow = *(favorite_plugins_model->append());
2420                 newrow[favorite_plugins_columns.name] = (*i)->name;
2421                 newrow[favorite_plugins_columns.plugin] = PluginPresetPtr (new PluginPreset(pip));
2422                 if (!_session) {
2423                         continue;
2424                 }
2425
2426                 vector<ARDOUR::Plugin::PresetRecord> presets = (*i)->get_presets (true);
2427                 for (vector<ARDOUR::Plugin::PresetRecord>::const_iterator j = presets.begin(); j != presets.end(); ++j) {
2428                         Gtk::TreeModel::Row child_row = *(favorite_plugins_model->append (newrow.children()));
2429                         child_row[favorite_plugins_columns.name] = (*j).label;
2430                         child_row[favorite_plugins_columns.plugin] = PluginPresetPtr (new PluginPreset(pip, &(*j)));
2431                 }
2432                 if (favorite_ui_state.find (pip->unique_id) != favorite_ui_state.end ()) {
2433                         if (favorite_ui_state[pip->unique_id]) {
2434                                 favorite_plugins_display.expand_row (favorite_plugins_model->get_path(newrow), true);
2435                         }
2436                 }
2437         }
2438 }
2439
2440 void
2441 Mixer_UI::popup_note_context_menu (GdkEventButton *ev)
2442 {
2443         using namespace Gtk::Menu_Helpers;
2444
2445         Gtk::Menu* m = manage (new Menu);
2446         MenuList& items = m->items ();
2447
2448         if (_selection.routes.empty()) {
2449                 items.push_back (MenuElem (_("No Track/Bus is selected.")));
2450         } else {
2451                 items.push_back (MenuElem (_("Add at the top"),
2452                                         sigc::bind (sigc::mem_fun (*this, &Mixer_UI::add_selected_processor), AddTop)));
2453                 items.push_back (MenuElem (_("Add Pre-Fader"),
2454                                         sigc::bind (sigc::mem_fun (*this, &Mixer_UI::add_selected_processor), AddPreFader)));
2455                 items.push_back (MenuElem (_("Add Post-Fader"),
2456                                         sigc::bind (sigc::mem_fun (*this, &Mixer_UI::add_selected_processor), AddPostFader)));
2457                 items.push_back (MenuElem (_("Add at the end"),
2458                                         sigc::bind (sigc::mem_fun (*this, &Mixer_UI::add_selected_processor), AddBottom)));
2459         }
2460
2461         items.push_back (SeparatorElem());
2462
2463         items.push_back (MenuElem (_("Remove from favorites"), sigc::mem_fun (*this, &Mixer_UI::remove_selected_from_favorites)));
2464
2465         ARDOUR::PluginPresetPtr ppp = selected_plugin();
2466         if (ppp && ppp->_preset.valid && ppp->_preset.user) {
2467                 // we cannot currently delete AU presets
2468                 if (!ppp->_pip || ppp->_pip->type != AudioUnit) {
2469                         items.push_back (MenuElem (_("Delete Preset"), sigc::mem_fun (*this, &Mixer_UI::delete_selected_preset)));
2470                 }
2471         }
2472
2473         m->popup (ev->button, ev->time);
2474 }
2475
2476 bool
2477 Mixer_UI::plugin_row_button_press (GdkEventButton *ev)
2478 {
2479         if ((ev->type == GDK_BUTTON_PRESS) && (ev->button == 3) ) {
2480                 TreeModel::Path path;
2481                 TreeViewColumn* column;
2482                 int cellx, celly;
2483                 if (favorite_plugins_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
2484                         Glib::RefPtr<Gtk::TreeView::Selection> selection = favorite_plugins_display.get_selection();
2485                         if (selection) {
2486                                 selection->unselect_all();
2487                                 selection->select(path);
2488                         }
2489                 }
2490                 ARDOUR::PluginPresetPtr ppp = selected_plugin();
2491                 if (ppp) {
2492                         popup_note_context_menu (ev);
2493                 }
2494         }
2495         return false;
2496 }
2497
2498
2499 PluginPresetPtr
2500 Mixer_UI::selected_plugin ()
2501 {
2502         Glib::RefPtr<Gtk::TreeView::Selection> selection = favorite_plugins_display.get_selection();
2503         if (!selection) {
2504                 return PluginPresetPtr();
2505         }
2506         Gtk::TreeModel::iterator iter = selection->get_selected();
2507         if (!iter) {
2508                 return PluginPresetPtr();
2509         }
2510         return (*iter)[favorite_plugins_columns.plugin];
2511 }
2512
2513 void
2514 Mixer_UI::add_selected_processor (ProcessorPosition pos)
2515 {
2516         ARDOUR::PluginPresetPtr ppp = selected_plugin();
2517         if (ppp) {
2518                 add_favorite_processor (ppp, pos);
2519         }
2520 }
2521
2522 void
2523 Mixer_UI::delete_selected_preset ()
2524 {
2525         if (!_session) {
2526                 return;
2527         }
2528         ARDOUR::PluginPresetPtr ppp = selected_plugin();
2529         if (!ppp || !ppp->_preset.valid || !ppp->_preset.user) {
2530                 return;
2531         }
2532         PluginPtr plugin = ppp->_pip->load (*_session);
2533         plugin->get_presets();
2534         plugin->remove_preset (ppp->_preset.label);
2535 }
2536
2537 void
2538 Mixer_UI::remove_selected_from_favorites ()
2539 {
2540         ARDOUR::PluginPresetPtr ppp = selected_plugin();
2541         if (!ppp) {
2542                 return;
2543         }
2544         PluginManager::PluginStatusType status = PluginManager::Normal;
2545         PluginManager& manager (PluginManager::instance());
2546
2547         manager.set_status (ppp->_pip->type, ppp->_pip->unique_id, status);
2548         manager.save_statuses ();
2549 }
2550
2551 void
2552 Mixer_UI::plugin_row_activated (const TreeModel::Path& path, TreeViewColumn* column)
2553 {
2554         TreeIter iter;
2555         if (!(iter = favorite_plugins_model->get_iter (path))) {
2556                 return;
2557         }
2558         ARDOUR::PluginPresetPtr ppp = (*iter)[favorite_plugins_columns.plugin];
2559         add_favorite_processor (ppp, AddPreFader); // TODO: preference?!
2560 }
2561
2562 void
2563 Mixer_UI::add_favorite_processor (ARDOUR::PluginPresetPtr ppp, ProcessorPosition pos)
2564 {
2565         if (!_session || _selection.routes.empty()) {
2566                 return;
2567         }
2568
2569         PluginInfoPtr pip = ppp->_pip;
2570         for (RouteUISelection::iterator i = _selection.routes.begin(); i != _selection.routes.end(); ++i) {
2571                 boost::shared_ptr<ARDOUR::Route> rt = (*i)->route();
2572                 if (!rt) { continue; }
2573
2574                 PluginPtr p = pip->load (*_session);
2575                 if (!p) { continue; }
2576
2577                 if (ppp->_preset.valid) {
2578                         p->load_preset (ppp->_preset);
2579                 }
2580
2581                 Route::ProcessorStreams err;
2582                 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
2583
2584                 switch (pos) {
2585                         case AddTop:
2586                                 rt->add_processor_by_index (processor, 0, &err, Config->get_new_plugins_active ());
2587                                 break;
2588                         case AddPreFader:
2589                                 rt->add_processor (processor, PreFader, &err, Config->get_new_plugins_active ());
2590                                 break;
2591                         case AddPostFader:
2592                                 {
2593                                         int idx = 0;
2594                                         int pos = 0;
2595                                         for (;;++idx) {
2596                                                 boost::shared_ptr<Processor> np = rt->nth_processor (idx);
2597                                                 if (!np) {
2598                                                         break;
2599                                                 }
2600                                                 if (!np->display_to_user()) {
2601                                                         continue;
2602                                                 }
2603                                                 if (boost::dynamic_pointer_cast<Amp> (np) && // Fader, not Trim
2604                                                                 boost::dynamic_pointer_cast<Amp> (np)->gain_control()->parameter().type() == GainAutomation) {
2605                                                         break;
2606                                                 }
2607                                                 ++pos;
2608                                         }
2609                                         rt->add_processor_by_index (processor, ++pos, &err, Config->get_new_plugins_active ());
2610                                 }
2611                                 break;
2612                         case AddBottom:
2613                                 rt->add_processor_by_index (processor, -1, &err, Config->get_new_plugins_active ());
2614                                 break;
2615                 }
2616         }
2617 }
2618
2619 bool
2620 PluginTreeStore::row_drop_possible_vfunc(const Gtk::TreeModel::Path& dest, const Gtk::SelectionData& data) const
2621 {
2622         if (data.get_target() != "GTK_TREE_MODEL_ROW") {
2623                 return false;
2624         }
2625
2626         // only allow to re-order top-level items
2627         TreePath src;
2628         if (TreePath::get_from_selection_data (data, src)) {
2629                 if (src.up() && src.up()) {
2630                         return false;
2631                 }
2632         }
2633
2634         // don't allow to drop as child-rows.
2635         Gtk::TreeModel::Path _dest = dest; // un const
2636         const bool is_child = _dest.up (); // explicit bool for clang
2637         if (!is_child || _dest.empty ()) {
2638                 return true;
2639         }
2640         return false;
2641 }
2642
2643 void
2644 Mixer_UI::plugin_drop (const Glib::RefPtr<Gdk::DragContext>&, const Gtk::SelectionData& data)
2645 {
2646         if (data.get_target() != "PluginPresetPtr") {
2647                 return;
2648         }
2649         if (data.get_length() != sizeof (PluginPresetPtr)) {
2650                 return;
2651         }
2652         const void *d = data.get_data();
2653         const PluginPresetPtr ppp = *(static_cast<const PluginPresetPtr*> (d));
2654
2655         PluginManager::PluginStatusType status = PluginManager::Favorite;
2656         PluginManager& manager (PluginManager::instance());
2657
2658         manager.set_status (ppp->_pip->type, ppp->_pip->unique_id, status);
2659         manager.save_statuses ();
2660 }
2661
2662 void
2663 Mixer_UI::do_vca_assign (boost::shared_ptr<VCA> vca)
2664 {
2665         /* call protected MixerActor:: method */
2666         vca_assign (vca);
2667 }
2668
2669 void
2670 Mixer_UI::do_vca_unassign (boost::shared_ptr<VCA> vca)
2671 {
2672         /* call protected MixerActor:: method */
2673         vca_unassign (vca);
2674 }
2675
2676 void
2677 Mixer_UI::show_vca_slaves (boost::shared_ptr<VCA> vca)
2678 {
2679         boost::shared_ptr<VCA> v = spilled_vca.lock();
2680         if (v != vca) {
2681                 spilled_vca = vca;
2682                 show_vca_change (vca); /* EMIT SIGNAL */
2683                 redisplay_track_list ();
2684         }
2685 }
2686
2687 bool
2688 Mixer_UI::showing_vca_slaves_for (boost::shared_ptr<VCA> vca) const
2689 {
2690        return vca == spilled_vca.lock();
2691 }