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