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