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