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