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