add locale-guard when saving engine states, also #6418
[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/unwind.h"
32
33 #include <glibmm/threads.h>
34
35 #include <gtkmm2ext/gtk_ui.h>
36 #include <gtkmm2ext/utils.h>
37 #include <gtkmm2ext/tearoff.h>
38 #include <gtkmm2ext/window_title.h>
39
40 #include "ardour/debug.h"
41 #include "ardour/midi_track.h"
42 #include "ardour/plugin_manager.h"
43 #include "ardour/route_group.h"
44 #include "ardour/route_sorters.h"
45 #include "ardour/session.h"
46
47 #include "keyboard.h"
48 #include "mixer_ui.h"
49 #include "mixer_strip.h"
50 #include "monitor_section.h"
51 #include "plugin_selector.h"
52 #include "public_editor.h"
53 #include "ardour_ui.h"
54 #include "prompter.h"
55 #include "utils.h"
56 #include "route_sorter.h"
57 #include "actions.h"
58 #include "gui_thread.h"
59 #include "mixer_group_tabs.h"
60 #include "timers.h"
61
62 #include "i18n.h"
63
64 using namespace ARDOUR;
65 using namespace ARDOUR_UI_UTILS;
66 using namespace PBD;
67 using namespace Gtk;
68 using namespace Glib;
69 using namespace Gtkmm2ext;
70 using namespace std;
71
72 using PBD::atoi;
73 using PBD::Unwinder;
74
75 Mixer_UI* Mixer_UI::_instance = 0;
76
77 Mixer_UI*
78 Mixer_UI::instance () 
79 {
80         if (!_instance) {
81                 _instance  = new Mixer_UI;
82         } 
83
84         return _instance;
85 }
86
87 Mixer_UI::Mixer_UI ()
88         : Window (Gtk::WINDOW_TOPLEVEL)
89         , VisibilityTracker (*((Gtk::Window*) this))
90         , _visible (false)
91         , no_track_list_redisplay (false)
92         , in_group_row_change (false)
93         , track_menu (0)
94         , _monitor_section (0)
95         , _strip_width (ARDOUR_UI::config()->get_default_narrow_ms() ? Narrow : Wide)
96         , ignore_reorder (false)
97         , _in_group_rebuild_or_clear (false)
98         , _route_deletion_in_progress (false)
99         , _following_editor_selection (false)
100         , _maximised (false)
101 {
102         /* allow this window to become the key focus window */
103         set_flags (CAN_FOCUS);
104
105         Route::SyncOrderKeys.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::sync_treeview_from_order_keys, this), gui_context());
106
107         scroller.set_can_default (true);
108         set_default (scroller);
109
110         scroller_base.set_flags (Gtk::CAN_FOCUS);
111         scroller_base.add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
112         scroller_base.set_name ("MixerWindow");
113         scroller_base.signal_button_release_event().connect (sigc::mem_fun(*this, &Mixer_UI::strip_scroller_button_release));
114         // add as last item of strip packer
115         strip_packer.pack_end (scroller_base, true, true);
116
117         _group_tabs = new MixerGroupTabs (this);
118         VBox* b = manage (new VBox);
119         b->pack_start (*_group_tabs, PACK_SHRINK);
120         b->pack_start (strip_packer);
121         b->show_all ();
122
123         scroller.add (*b);
124         scroller.set_policy (Gtk::POLICY_ALWAYS, Gtk::POLICY_AUTOMATIC);
125
126         setup_track_display ();
127
128         group_model = ListStore::create (group_columns);
129         group_display.set_model (group_model);
130         group_display.append_column (_("Group"), group_columns.text);
131         group_display.append_column (_("Show"), group_columns.visible);
132         group_display.get_column (0)->set_data (X_("colnum"), GUINT_TO_POINTER(0));
133         group_display.get_column (1)->set_data (X_("colnum"), GUINT_TO_POINTER(1));
134         group_display.get_column (0)->set_expand(true);
135         group_display.get_column (1)->set_expand(false);
136         group_display.set_name ("EditGroupList");
137         group_display.get_selection()->set_mode (Gtk::SELECTION_SINGLE);
138         group_display.set_reorderable (true);
139         group_display.set_headers_visible (true);
140         group_display.set_rules_hint (true);
141
142         /* name is directly editable */
143
144         CellRendererText* name_cell = dynamic_cast<CellRendererText*>(group_display.get_column_cell_renderer (0));
145         name_cell->property_editable() = true;
146         name_cell->signal_edited().connect (sigc::mem_fun (*this, &Mixer_UI::route_group_name_edit));
147
148         /* use checkbox for the active column */
149
150         CellRendererToggle* active_cell = dynamic_cast<CellRendererToggle*>(group_display.get_column_cell_renderer (1));
151         active_cell->property_activatable() = true;
152         active_cell->property_radio() = false;
153
154         group_model->signal_row_changed().connect (sigc::mem_fun (*this, &Mixer_UI::route_group_row_change));
155         /* We use this to notice drag-and-drop reorders of the group list */
156         group_model->signal_row_deleted().connect (sigc::mem_fun (*this, &Mixer_UI::route_group_row_deleted));
157         group_display.signal_button_press_event().connect (sigc::mem_fun (*this, &Mixer_UI::group_display_button_press), false);
158
159         group_display_scroller.add (group_display);
160         group_display_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
161
162         HBox* route_group_display_button_box = manage (new HBox());
163
164         Button* route_group_add_button = manage (new Button ());
165         Button* route_group_remove_button = manage (new Button ());
166
167         Widget* w;
168
169         w = manage (new Image (Stock::ADD, ICON_SIZE_BUTTON));
170         w->show();
171         route_group_add_button->add (*w);
172
173         w = manage (new Image (Stock::REMOVE, ICON_SIZE_BUTTON));
174         w->show();
175         route_group_remove_button->add (*w);
176
177         route_group_display_button_box->set_homogeneous (true);
178
179         route_group_add_button->signal_clicked().connect (sigc::mem_fun (*this, &Mixer_UI::new_route_group));
180         route_group_remove_button->signal_clicked().connect (sigc::mem_fun (*this, &Mixer_UI::remove_selected_route_group));
181
182         route_group_display_button_box->add (*route_group_add_button);
183         route_group_display_button_box->add (*route_group_remove_button);
184
185         group_display_vbox.pack_start (group_display_scroller, true, true);
186         group_display_vbox.pack_start (*route_group_display_button_box, false, false);
187
188         group_display_frame.set_name ("BaseFrame");
189         group_display_frame.set_shadow_type (Gtk::SHADOW_IN);
190         group_display_frame.add (group_display_vbox);
191
192         rhs_pane1.pack1 (track_display_frame);
193         rhs_pane1.pack2 (group_display_frame);
194
195         list_vpacker.pack_start (rhs_pane1, true, true);
196
197         global_hpacker.pack_start (scroller, true, true);
198 #ifdef GTKOSX
199         /* current gtk-quartz has dirty updates on borders like this one */
200         global_hpacker.pack_start (out_packer, false, false, 0);
201 #else
202         global_hpacker.pack_start (out_packer, false, false, 12);
203 #endif
204         list_hpane.pack1(list_vpacker, false, false);
205         list_hpane.pack2(global_hpacker, true, false);
206
207         rhs_pane1.signal_size_allocate().connect (sigc::bind (sigc::mem_fun(*this, &Mixer_UI::pane_allocation_handler),
208                                                         static_cast<Gtk::Paned*> (&rhs_pane1)));
209         list_hpane.signal_size_allocate().connect (sigc::bind (sigc::mem_fun(*this, &Mixer_UI::pane_allocation_handler),
210                                                          static_cast<Gtk::Paned*> (&list_hpane)));
211
212         global_vpacker.pack_start (list_hpane, true, true);
213
214         add (global_vpacker);
215         set_name ("MixerWindow");
216
217         update_title ();
218
219         set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
220
221         signal_delete_event().connect (sigc::mem_fun (*this, &Mixer_UI::hide_window));
222         add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
223
224         signal_configure_event().connect (sigc::mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
225
226         route_group_display_button_box->show();
227         route_group_add_button->show();
228         route_group_remove_button->show();
229
230         global_hpacker.show();
231         global_vpacker.show();
232         scroller.show();
233         scroller_base.show();
234         scroller_hpacker.show();
235         mixer_scroller_vpacker.show();
236         list_vpacker.show();
237         group_display_button_label.show();
238         group_display_button.show();
239         group_display_scroller.show();
240         group_display_vbox.show();
241         group_display_frame.show();
242         rhs_pane1.show();
243         strip_packer.show();
244         out_packer.show();
245         list_hpane.show();
246         group_display.show();
247
248         MixerStrip::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::remove_strip, this, _1), gui_context());
249
250 #ifndef DEFER_PLUGIN_SELECTOR_LOAD
251         _plugin_selector = new PluginSelector (PluginManager::instance ());
252 #endif
253 }
254
255 Mixer_UI::~Mixer_UI ()
256 {
257         if (_monitor_section) {
258                 delete _monitor_section;
259         }
260 }
261
262 void
263 Mixer_UI::track_editor_selection ()
264 {
265         PublicEditor::instance().get_selection().TracksChanged.connect (sigc::mem_fun (*this, &Mixer_UI::follow_editor_selection));
266 }
267
268
269 void
270 Mixer_UI::ensure_float (Window& win)
271 {
272         win.set_transient_for (*this);
273 }
274
275 void
276 Mixer_UI::show_window ()
277 {
278         present ();
279         if (!_visible) {
280                 set_window_pos_and_size ();
281
282                 /* show/hide group tabs as required */
283                 parameter_changed ("show-group-tabs");
284
285                 /* now reset each strips width so the right widgets are shown */
286                 MixerStrip* ms;
287
288                 TreeModel::Children rows = track_model->children();
289                 TreeModel::Children::iterator ri;
290
291                 for (ri = rows.begin(); ri != rows.end(); ++ri) {
292                         ms = (*ri)[track_columns.strip];
293                         ms->set_width_enum (ms->get_width_enum (), ms->width_owner());
294                         /* Fix visibility of mixer strip stuff */
295                         ms->parameter_changed (X_("mixer-element-visibility"));
296                 }
297         }
298         
299         /* force focus into main area */
300         scroller_base.grab_focus ();
301
302         _visible = true;
303 }
304
305 bool
306 Mixer_UI::hide_window (GdkEventAny *ev)
307 {
308         get_window_pos_and_size ();
309
310         _visible = false;
311         return just_hide_it(ev, static_cast<Gtk::Window *>(this));
312 }
313
314
315 void
316 Mixer_UI::add_strips (RouteList& routes)
317 {
318         bool from_scratch = track_model->children().size() == 0;
319         Gtk::TreeModel::Children::iterator insert_iter = track_model->children().end();
320
321         for (Gtk::TreeModel::Children::iterator it = track_model->children().begin(); it != track_model->children().end(); ++it) {
322                 boost::shared_ptr<Route> r = (*it)[track_columns.route];
323
324                 if (r->order_key() == (routes.front()->order_key() + routes.size())) {
325                         insert_iter = it;
326                         break;
327                 }
328         }
329
330         if(!from_scratch) {
331                 _selection.clear_routes ();
332         }
333
334         MixerStrip* strip;
335
336         try {
337                 no_track_list_redisplay = true;
338                 track_display.set_model (Glib::RefPtr<ListStore>());
339
340                 for (RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
341                         boost::shared_ptr<Route> route = (*x);
342                         
343                         if (route->is_auditioner()) {
344                                 continue;
345                         }
346                         
347                         if (route->is_monitor()) {
348                                 
349                                 if (!_monitor_section) {
350                                         _monitor_section = new MonitorSection (_session);
351                                         
352                                         XMLNode* mnode = ARDOUR_UI::instance()->tearoff_settings (X_("monitor-section"));
353                                         if (mnode) {
354                                                 _monitor_section->tearoff().set_state (*mnode);
355                                         }
356                                 } 
357                                 
358                                 out_packer.pack_end (_monitor_section->tearoff(), false, false);
359                                 _monitor_section->set_session (_session);
360                                 _monitor_section->tearoff().show_all ();
361                                 
362                                 route->DropReferences.connect (*this, invalidator(*this), boost::bind (&Mixer_UI::monitor_section_going_away, this), gui_context());
363                                 
364                                 /* no regular strip shown for control out */
365                                 
366                                 continue;
367                         }
368                         
369                         strip = new MixerStrip (*this, _session, route);
370                         strips.push_back (strip);
371
372                         ARDOUR_UI::config()->get_default_narrow_ms() ? _strip_width = Narrow : _strip_width = Wide;
373                         
374                         if (strip->width_owner() != strip) {
375                                 strip->set_width_enum (_strip_width, this);
376                         }
377                         
378                         show_strip (strip);
379                         
380                         TreeModel::Row row = *(track_model->insert(insert_iter));
381                         row[track_columns.text] = route->name();
382                         row[track_columns.visible] = strip->route()->is_master() ? true : strip->marked_for_display();
383                         row[track_columns.route] = route;
384                         row[track_columns.strip] = strip;
385
386                         if (!from_scratch) {
387                                 _selection.add (strip);
388                         }
389                         
390                         route->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::strip_property_changed, this, _1, strip), gui_context());
391                         
392                         strip->WidthChanged.connect (sigc::mem_fun(*this, &Mixer_UI::strip_width_changed));
393                         strip->signal_button_release_event().connect (sigc::bind (sigc::mem_fun(*this, &Mixer_UI::strip_button_release_event), strip));
394                 }
395
396         } catch (...) {
397         }
398
399         no_track_list_redisplay = false;
400         track_display.set_model (track_model);
401         
402         sync_order_keys_from_treeview ();
403         redisplay_track_list ();
404 }
405
406 void
407 Mixer_UI::deselect_all_strip_processors ()
408 {
409         for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
410                 (*i)->deselect_all_processors();
411         }
412 }
413
414 void
415 Mixer_UI::select_none ()
416 {
417         _selection.clear_routes();
418         deselect_all_strip_processors();
419 }
420
421 void
422 Mixer_UI::delete_processors ()
423 {
424         for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
425                 (*i)->delete_processors();
426         }
427 }
428
429
430 void
431 Mixer_UI::remove_strip (MixerStrip* strip)
432 {
433         if (_session && _session->deletion_in_progress()) {
434                 /* its all being taken care of */
435                 return;
436         }
437
438         TreeModel::Children rows = track_model->children();
439         TreeModel::Children::iterator ri;
440         list<MixerStrip *>::iterator i;
441         
442         if ((i = find (strips.begin(), strips.end(), strip)) != strips.end()) {
443                 strips.erase (i);
444         }
445         
446         for (ri = rows.begin(); ri != rows.end(); ++ri) {
447                 if ((*ri)[track_columns.strip] == strip) {
448                         PBD::Unwinder<bool> uw (_route_deletion_in_progress, true);
449                         track_model->erase (ri);
450                         break;
451                 }
452         }
453 }
454
455 void
456 Mixer_UI::reset_remote_control_ids ()
457 {
458         if (Config->get_remote_model() == UserOrdered || !_session || _session->deletion_in_progress()) {
459                 return;
460         }
461
462         TreeModel::Children rows = track_model->children();
463         
464         if (rows.empty()) {
465                 return;
466         }
467
468         DEBUG_TRACE (DEBUG::OrderKeys, "mixer resets remote control ids after remote model change\n");
469
470         TreeModel::Children::iterator ri;
471         bool rid_change = false;
472         uint32_t rid = 1;
473         uint32_t invisible_key = UINT32_MAX;
474
475         for (ri = rows.begin(); ri != rows.end(); ++ri) {
476
477                 /* skip two special values */
478                 
479                 if (rid == Route::MasterBusRemoteControlID) {
480                         rid++;
481                 }
482                 
483                 if (rid == Route::MonitorBusRemoteControlID) {
484                         rid++;
485                 }
486
487                 boost::shared_ptr<Route> route = (*ri)[track_columns.route];
488                 bool visible = (*ri)[track_columns.visible];
489
490                 if (!route->is_master() && !route->is_monitor()) {
491                         
492                         uint32_t new_rid = (visible ? rid : invisible_key--);
493                         
494                         if (new_rid != route->remote_control_id()) {
495                                 route->set_remote_control_id_explicit (new_rid);        
496                                 rid_change = true;
497                         }
498                         
499                         if (visible) {
500                                 rid++;
501                         }
502                 }
503         }
504
505         if (rid_change) {
506                 /* tell the world that we changed the remote control IDs */
507                 _session->notify_remote_id_change ();
508         }
509 }
510
511 void
512 Mixer_UI::sync_order_keys_from_treeview ()
513 {
514         if (ignore_reorder || !_session || _session->deletion_in_progress()) {
515                 return;
516         }
517
518         TreeModel::Children rows = track_model->children();
519         
520         if (rows.empty()) {
521                 return;
522         }
523
524         DEBUG_TRACE (DEBUG::OrderKeys, "mixer sync order keys from model\n");
525
526         TreeModel::Children::iterator ri;
527         bool changed = false;
528         bool rid_change = false;
529         uint32_t order = 0;
530         uint32_t rid = 1;
531         uint32_t invisible_key = UINT32_MAX;
532
533         for (ri = rows.begin(); ri != rows.end(); ++ri) {
534                 boost::shared_ptr<Route> route = (*ri)[track_columns.route];
535                 bool visible = (*ri)[track_columns.visible];
536
537                 uint32_t old_key = route->order_key ();
538
539                 if (order != old_key) {
540                         route->set_order_key (order);
541                         changed = true;
542                 }
543
544                 if ((Config->get_remote_model() == MixerOrdered) && !route->is_master() && !route->is_monitor()) {
545
546                         uint32_t new_rid = (visible ? rid : invisible_key--);
547
548                         if (new_rid != route->remote_control_id()) {
549                                 route->set_remote_control_id_explicit (new_rid);        
550                                 rid_change = true;
551                         }
552                         
553                         if (visible) {
554                                 rid++;
555                         }
556
557                 }
558
559                 ++order;
560         }
561
562         if (changed) {
563                 /* tell everyone that we changed the mixer sort keys */
564                 _session->sync_order_keys ();
565         }
566
567         if (rid_change) {
568                 /* tell the world that we changed the remote control IDs */
569                 _session->notify_remote_id_change ();
570         }
571 }
572
573 void
574 Mixer_UI::sync_treeview_from_order_keys ()
575 {
576         if (!_session || _session->deletion_in_progress()) {
577                 return;
578         }
579
580         DEBUG_TRACE (DEBUG::OrderKeys, "mixer sync model from order keys.\n");
581
582         /* we could get here after either a change in the Mixer or Editor sort
583          * order, but either way, the mixer order keys reflect the intended
584          * order for the GUI, so reorder the treeview model to match it.
585          */
586
587         vector<int> neworder;
588         TreeModel::Children rows = track_model->children();
589         uint32_t old_order = 0;
590         bool changed = false;
591
592         if (rows.empty()) {
593                 return;
594         }
595
596         OrderKeySortedRoutes sorted_routes;
597
598         for (TreeModel::Children::iterator ri = rows.begin(); ri != rows.end(); ++ri, ++old_order) {
599                 boost::shared_ptr<Route> route = (*ri)[track_columns.route];
600                 sorted_routes.push_back (RoutePlusOrderKey (route, old_order, route->order_key ()));
601         }
602
603         SortByNewDisplayOrder cmp;
604
605         sort (sorted_routes.begin(), sorted_routes.end(), cmp);
606         neworder.assign (sorted_routes.size(), 0);
607
608         uint32_t n = 0;
609         
610         for (OrderKeySortedRoutes::iterator sr = sorted_routes.begin(); sr != sorted_routes.end(); ++sr, ++n) {
611
612                 neworder[n] = sr->old_display_order;
613
614                 if (sr->old_display_order != n) {
615                         changed = true;
616                 }
617
618                 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("MIXER change order for %1 from %2 to %3\n",
619                                                                sr->route->name(), sr->old_display_order, n));
620         }
621
622         if (changed) {
623                 Unwinder<bool> uw (ignore_reorder, true);
624                 track_model->reorder (neworder);
625         }
626
627         redisplay_track_list ();
628 }
629
630 void
631 Mixer_UI::follow_editor_selection ()
632 {
633         if (_following_editor_selection) {
634                 return;
635         }
636
637         _following_editor_selection = true;
638         _selection.block_routes_changed (true);
639         
640         TrackSelection& s (PublicEditor::instance().get_selection().tracks);
641
642         _selection.clear_routes ();
643
644         for (TrackViewList::iterator i = s.begin(); i != s.end(); ++i) {
645                 RouteTimeAxisView* rtav = dynamic_cast<RouteTimeAxisView*> (*i);
646                 if (rtav) {
647                         MixerStrip* ms = strip_by_route (rtav->route());
648                         if (ms) {
649                                 _selection.add (ms);
650                         }
651                 }
652         }
653
654         _following_editor_selection = false;
655         _selection.block_routes_changed (false);
656 }
657
658
659 MixerStrip*
660 Mixer_UI::strip_by_route (boost::shared_ptr<Route> r)
661 {
662         for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
663                 if ((*i)->route() == r) {
664                         return (*i);
665                 }
666         }
667
668         return 0;
669 }
670
671 bool
672 Mixer_UI::strip_button_release_event (GdkEventButton *ev, MixerStrip *strip)
673 {
674         if (ev->button == 1) {
675                 if (_selection.selected (strip)) {
676                         /* primary-click: toggle selection state of strip */
677                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
678                                 _selection.remove (strip);
679                         } else if (_selection.routes.size() > 1) {
680                                 /* de-select others */
681                                 _selection.set (strip);
682                         }
683                 } else {
684                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
685                                 _selection.add (strip);
686                         } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::RangeSelectModifier)) {
687
688                                 if (!_selection.selected(strip)) {
689                                 
690                                         /* extend selection */
691                                         
692                                         vector<MixerStrip*> tmp;
693                                         bool accumulate = false;
694                                         bool found_another = false;
695                                         
696                                         tmp.push_back (strip);
697
698                                         for (list<MixerStrip*>::iterator i = strips.begin(); i != strips.end(); ++i) {
699                                                 if ((*i) == strip) {
700                                                         /* hit clicked strip, start accumulating till we hit the first 
701                                                            selected strip
702                                                         */
703                                                         if (accumulate) {
704                                                                 /* done */
705                                                                 break;
706                                                         } else {
707                                                                 accumulate = true;
708                                                         }
709                                                 } else if (_selection.selected (*i)) {
710                                                         /* hit selected strip. if currently accumulating others,
711                                                            we're done. if not accumulating others, start doing so.
712                                                         */
713                                                         found_another = true;
714                                                         if (accumulate) {
715                                                                 /* done */
716                                                                 break;
717                                                         } else {
718                                                                 accumulate = true;
719                                                         }
720                                                 } else {
721                                                         if (accumulate) {
722                                                                 tmp.push_back (*i);
723                                                         }
724                                                 }
725                                         }
726
727                                         if (found_another) {
728                                                 for (vector<MixerStrip*>::iterator i = tmp.begin(); i != tmp.end(); ++i) {
729                                                         _selection.add (*i);
730                                                 }
731                                         } else
732                                                 _selection.set (strip);  //user wants to start a range selection, but there aren't any others selected yet
733                                 }
734
735                         } else {
736                                 _selection.set (strip);
737                         }
738                 }
739         }
740
741         return true;
742 }
743
744 void
745 Mixer_UI::set_session (Session* sess)
746 {
747         SessionHandlePtr::set_session (sess);
748
749         if (_plugin_selector) {
750                 _plugin_selector->set_session (_session);
751         }
752
753         _group_tabs->set_session (sess);
754
755         if (!_session) {
756                 return;
757         }
758
759         XMLNode* node = ARDOUR_UI::instance()->mixer_settings();
760         set_state (*node);
761
762         update_title ();
763
764         initial_track_display ();
765
766         _session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::add_strips, this, _1), gui_context());
767         _session->route_group_added.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::add_route_group, this, _1), gui_context());
768         _session->route_group_removed.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::route_groups_changed, this), gui_context());
769         _session->route_groups_reordered.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::route_groups_changed, this), gui_context());
770         _session->config.ParameterChanged.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::parameter_changed, this, _1), gui_context());
771         _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::update_title, this), gui_context());
772         _session->StateSaved.connect (_session_connections, invalidator (*this), boost::bind (&Mixer_UI::update_title, this), gui_context());
773
774         Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::parameter_changed, this, _1), gui_context ());
775
776         route_groups_changed ();
777
778         if (_visible) {
779                 show_window();
780         }
781
782         start_updating ();
783 }
784
785 void
786 Mixer_UI::session_going_away ()
787 {
788         ENSURE_GUI_THREAD (*this, &Mixer_UI::session_going_away);
789
790         _in_group_rebuild_or_clear = true;
791         group_model->clear ();
792         _in_group_rebuild_or_clear = false;
793
794         _selection.clear ();
795         track_model->clear ();
796
797         for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
798                 delete (*i);
799         }
800
801         if (_monitor_section) {
802                 _monitor_section->tearoff().hide_visible ();
803         }
804
805         strips.clear ();
806
807         stop_updating ();
808
809         SessionHandlePtr::session_going_away ();
810
811         _session = 0;
812         update_title ();
813 }
814
815 void
816 Mixer_UI::track_visibility_changed (std::string const & path)
817 {
818         if (_session && _session->deletion_in_progress()) {
819                 return;
820         }
821
822         TreeIter iter;
823
824         if ((iter = track_model->get_iter (path))) {
825                 MixerStrip* strip = (*iter)[track_columns.strip];
826                 if (strip) {
827                         bool visible = (*iter)[track_columns.visible];
828
829                         if (strip->set_marked_for_display (!visible)) {
830                                 update_track_visibility ();
831                         }
832                 }
833         }
834 }
835
836 void
837 Mixer_UI::update_track_visibility ()
838 {
839         TreeModel::Children rows = track_model->children();
840         TreeModel::Children::iterator i;
841
842         {
843                 Unwinder<bool> uw (no_track_list_redisplay, true);
844                 
845                 for (i = rows.begin(); i != rows.end(); ++i) {
846                         MixerStrip *strip = (*i)[track_columns.strip];
847                         (*i)[track_columns.visible] = strip->marked_for_display ();
848                 }
849                 
850                 /* force route order keys catch up with visibility changes
851                  */
852                 
853                 sync_order_keys_from_treeview ();
854         }
855
856         redisplay_track_list ();
857 }
858
859 void
860 Mixer_UI::show_strip (MixerStrip* ms)
861 {
862         TreeModel::Children rows = track_model->children();
863         TreeModel::Children::iterator i;
864
865         for (i = rows.begin(); i != rows.end(); ++i) {
866
867                 MixerStrip* strip = (*i)[track_columns.strip];
868                 if (strip == ms) {
869                         (*i)[track_columns.visible] = true;
870                         redisplay_track_list ();
871                         break;
872                 }
873         }
874 }
875
876 void
877 Mixer_UI::hide_strip (MixerStrip* ms)
878 {
879         TreeModel::Children rows = track_model->children();
880         TreeModel::Children::iterator i;
881
882         for (i = rows.begin(); i != rows.end(); ++i) {
883
884                 MixerStrip* strip = (*i)[track_columns.strip];
885                 if (strip == ms) {
886                         (*i)[track_columns.visible] = false;
887                         redisplay_track_list ();
888                         break;
889                 }
890         }
891 }
892
893 gint
894 Mixer_UI::start_updating ()
895 {
896     fast_screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &Mixer_UI::fast_update_strips));
897     return 0;
898 }
899
900 gint
901 Mixer_UI::stop_updating ()
902 {
903     fast_screen_update_connection.disconnect();
904     return 0;
905 }
906
907 void
908 Mixer_UI::fast_update_strips ()
909 {
910         if (is_mapped () && _session) {
911                 for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
912                         (*i)->fast_update ();
913                 }
914         }
915 }
916
917 void
918 Mixer_UI::set_all_strips_visibility (bool yn)
919 {
920         TreeModel::Children rows = track_model->children();
921         TreeModel::Children::iterator i;
922
923         {
924                 Unwinder<bool> uw (no_track_list_redisplay, true);
925                 
926                 for (i = rows.begin(); i != rows.end(); ++i) {
927                         
928                         TreeModel::Row row = (*i);
929                         MixerStrip* strip = row[track_columns.strip];
930                         
931                         if (strip == 0) {
932                                 continue;
933                         }
934                         
935                         if (strip->route()->is_master() || strip->route()->is_monitor()) {
936                                 continue;
937                         }
938                         
939                         (*i)[track_columns.visible] = yn;
940                 }
941         }
942
943         redisplay_track_list ();
944 }
945
946
947 void
948 Mixer_UI::set_all_audio_visibility (int tracks, bool yn)
949 {
950         TreeModel::Children rows = track_model->children();
951         TreeModel::Children::iterator i;
952
953         {
954                 Unwinder<bool> uw (no_track_list_redisplay, true);
955                 
956                 for (i = rows.begin(); i != rows.end(); ++i) {
957                         TreeModel::Row row = (*i);
958                         MixerStrip* strip = row[track_columns.strip];
959                         
960                         if (strip == 0) {
961                                 continue;
962                         }
963                         
964                         if (strip->route()->is_master() || strip->route()->is_monitor()) {
965                                 continue;
966                         }
967                         
968                         boost::shared_ptr<AudioTrack> at = strip->audio_track();
969                         
970                         switch (tracks) {
971                         case 0:
972                                 (*i)[track_columns.visible] = yn;
973                                 break;
974                                 
975                         case 1:
976                                 if (at) { /* track */
977                                         (*i)[track_columns.visible] = yn;
978                                 }
979                                 break;
980                                 
981                         case 2:
982                                 if (!at) { /* bus */
983                                         (*i)[track_columns.visible] = yn;
984                                 }
985                                 break;
986                         }
987                 }
988         }
989
990         redisplay_track_list ();
991 }
992
993 void
994 Mixer_UI::hide_all_routes ()
995 {
996         set_all_strips_visibility (false);
997 }
998
999 void
1000 Mixer_UI::show_all_routes ()
1001 {
1002         set_all_strips_visibility (true);
1003 }
1004
1005 void
1006 Mixer_UI::show_all_audiobus ()
1007 {
1008         set_all_audio_visibility (2, true);
1009 }
1010 void
1011 Mixer_UI::hide_all_audiobus ()
1012 {
1013         set_all_audio_visibility (2, false);
1014 }
1015
1016 void
1017 Mixer_UI::show_all_audiotracks()
1018 {
1019         set_all_audio_visibility (1, true);
1020 }
1021 void
1022 Mixer_UI::hide_all_audiotracks ()
1023 {
1024         set_all_audio_visibility (1, false);
1025 }
1026
1027 void
1028 Mixer_UI::track_list_reorder (const TreeModel::Path&, const TreeModel::iterator&, int* /*new_order*/)
1029 {
1030         DEBUG_TRACE (DEBUG::OrderKeys, "mixer UI treeview reordered\n");
1031         sync_order_keys_from_treeview ();
1032 }
1033
1034 void
1035 Mixer_UI::track_list_delete (const Gtk::TreeModel::Path&)
1036 {
1037         /* this happens as the second step of a DnD within the treeview as well
1038            as when a row/route is actually deleted.
1039            
1040            if it was a deletion then we have to force a redisplay because
1041            order keys may not have changed.
1042         */
1043
1044         DEBUG_TRACE (DEBUG::OrderKeys, "mixer UI treeview row deleted\n");
1045         sync_order_keys_from_treeview ();
1046
1047         if (_route_deletion_in_progress) {
1048                 redisplay_track_list ();
1049         }
1050 }
1051
1052 void
1053 Mixer_UI::redisplay_track_list ()
1054 {
1055         TreeModel::Children rows = track_model->children();
1056         TreeModel::Children::iterator i;
1057         
1058         if (no_track_list_redisplay) {
1059                 return;
1060         }
1061
1062         for (i = rows.begin(); i != rows.end(); ++i) {
1063
1064                 MixerStrip* strip = (*i)[track_columns.strip];
1065
1066                 if (strip == 0) {
1067                         /* we're in the middle of changing a row, don't worry */
1068                         continue;
1069                 }
1070
1071                 bool const visible = (*i)[track_columns.visible];
1072
1073                 if (visible) {
1074                         strip->set_gui_property ("visible", true);
1075
1076                         if (strip->packed()) {
1077
1078                                 if (strip->route()->is_master() || strip->route()->is_monitor()) {
1079                                         out_packer.reorder_child (*strip, -1);
1080
1081                                 } else {
1082                                         strip_packer.reorder_child (*strip, -1); /* put at end */
1083                                 }
1084
1085                         } else {
1086
1087                                 if (strip->route()->is_master() || strip->route()->is_monitor()) {
1088                                         out_packer.pack_start (*strip, false, false);
1089                                 } else {
1090                                         strip_packer.pack_start (*strip, false, false);
1091                                 }
1092                                 strip->set_packed (true);
1093                         }
1094
1095                 } else {
1096
1097                         strip->set_gui_property ("visible", false);
1098
1099                         if (strip->route()->is_master() || strip->route()->is_monitor()) {
1100                                 /* do nothing, these cannot be hidden */
1101                         } else {
1102                                 if (strip->packed()) {
1103                                         strip_packer.remove (*strip);
1104                                         strip->set_packed (false);
1105                                 }
1106                         }
1107                 }
1108         }
1109
1110         _group_tabs->set_dirty ();
1111 }
1112
1113 void
1114 Mixer_UI::strip_width_changed ()
1115 {
1116         _group_tabs->set_dirty ();
1117
1118 #ifdef GTKOSX
1119         TreeModel::Children rows = track_model->children();
1120         TreeModel::Children::iterator i;
1121         long order;
1122
1123         for (order = 0, i = rows.begin(); i != rows.end(); ++i, ++order) {
1124                 MixerStrip* strip = (*i)[track_columns.strip];
1125
1126                 if (strip == 0) {
1127                         continue;
1128                 }
1129
1130                 bool visible = (*i)[track_columns.visible];
1131
1132                 if (visible) {
1133                         strip->queue_draw();
1134                 }
1135         }
1136 #endif
1137
1138 }
1139
1140 void
1141 Mixer_UI::initial_track_display ()
1142 {
1143         boost::shared_ptr<RouteList> routes = _session->get_routes();
1144         RouteList copy (*routes);
1145         ARDOUR::SignalOrderRouteSorter sorter;
1146
1147         copy.sort (sorter);
1148
1149         {
1150                 Unwinder<bool> uw1 (no_track_list_redisplay, true);
1151                 Unwinder<bool> uw2 (ignore_reorder, true);
1152
1153                 track_model->clear ();
1154                 add_strips (copy);
1155         }
1156         
1157         _session->sync_order_keys ();
1158
1159         redisplay_track_list ();
1160 }
1161
1162 void
1163 Mixer_UI::show_track_list_menu ()
1164 {
1165         if (track_menu == 0) {
1166                 build_track_menu ();
1167         }
1168
1169         track_menu->popup (1, gtk_get_current_event_time());
1170 }
1171
1172 bool
1173 Mixer_UI::track_display_button_press (GdkEventButton* ev)
1174 {
1175         if (Keyboard::is_context_menu_event (ev)) {
1176                 show_track_list_menu ();
1177                 return true;
1178         }
1179
1180         return false;
1181 }
1182
1183 void
1184 Mixer_UI::build_track_menu ()
1185 {
1186         using namespace Menu_Helpers;
1187         using namespace Gtk;
1188
1189         track_menu = new Menu;
1190         track_menu->set_name ("ArdourContextMenu");
1191         MenuList& items = track_menu->items();
1192
1193         items.push_back (MenuElem (_("Show All"), sigc::mem_fun(*this, &Mixer_UI::show_all_routes)));
1194         items.push_back (MenuElem (_("Hide All"), sigc::mem_fun(*this, &Mixer_UI::hide_all_routes)));
1195         items.push_back (MenuElem (_("Show All Audio Tracks"), sigc::mem_fun(*this, &Mixer_UI::show_all_audiotracks)));
1196         items.push_back (MenuElem (_("Hide All Audio Tracks"), sigc::mem_fun(*this, &Mixer_UI::hide_all_audiotracks)));
1197         items.push_back (MenuElem (_("Show All Audio Busses"), sigc::mem_fun(*this, &Mixer_UI::show_all_audiobus)));
1198         items.push_back (MenuElem (_("Hide All Audio Busses"), sigc::mem_fun(*this, &Mixer_UI::hide_all_audiobus)));
1199
1200 }
1201
1202 void
1203 Mixer_UI::strip_property_changed (const PropertyChange& what_changed, MixerStrip* mx)
1204 {
1205         if (!what_changed.contains (ARDOUR::Properties::name)) {
1206                 return;
1207         }
1208
1209         ENSURE_GUI_THREAD (*this, &Mixer_UI::strip_name_changed, what_changed, mx)
1210
1211         TreeModel::Children rows = track_model->children();
1212         TreeModel::Children::iterator i;
1213
1214         for (i = rows.begin(); i != rows.end(); ++i) {
1215                 if ((*i)[track_columns.strip] == mx) {
1216                         (*i)[track_columns.text] = mx->route()->name();
1217                         return;
1218                 }
1219         }
1220
1221         error << _("track display list item for renamed strip not found!") << endmsg;
1222 }
1223
1224 bool
1225 Mixer_UI::group_display_button_press (GdkEventButton* ev)
1226 {
1227         TreeModel::Path path;
1228         TreeViewColumn* column;
1229         int cellx;
1230         int celly;
1231
1232         if (!group_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1233                 _group_tabs->get_menu(0)->popup (1, ev->time);
1234                 return true;
1235         }
1236
1237         TreeIter iter = group_model->get_iter (path);
1238         if (!iter) {
1239                 _group_tabs->get_menu(0)->popup (1, ev->time);
1240                 return true;
1241         }
1242
1243         RouteGroup* group = (*iter)[group_columns.group];
1244
1245         if (Keyboard::is_context_menu_event (ev)) {
1246                 _group_tabs->get_menu(group)->popup (1, ev->time);
1247                 return true;
1248         }
1249
1250         switch (GPOINTER_TO_UINT (column->get_data (X_("colnum")))) {
1251         case 0:
1252                 if (Keyboard::is_edit_event (ev)) {
1253                         if (group) {
1254                                 // edit_route_group (group);
1255 #ifdef GTKOSX
1256                                 group_display.queue_draw();
1257 #endif
1258                                 return true;
1259                         }
1260                 }
1261                 break;
1262
1263         case 1:
1264         {
1265                 bool visible = (*iter)[group_columns.visible];
1266                 (*iter)[group_columns.visible] = !visible;
1267 #ifdef GTKOSX
1268                 group_display.queue_draw();
1269 #endif
1270                 return true;
1271         }
1272
1273         default:
1274                 break;
1275         }
1276
1277         return false;
1278  }
1279
1280 void
1281 Mixer_UI::activate_all_route_groups ()
1282 {
1283         _session->foreach_route_group (sigc::bind (sigc::mem_fun (*this, &Mixer_UI::set_route_group_activation), true));
1284 }
1285
1286 void
1287 Mixer_UI::disable_all_route_groups ()
1288 {
1289         _session->foreach_route_group (sigc::bind (sigc::mem_fun (*this, &Mixer_UI::set_route_group_activation), false));
1290 }
1291
1292 void
1293 Mixer_UI::route_groups_changed ()
1294 {
1295         ENSURE_GUI_THREAD (*this, &Mixer_UI::route_groups_changed);
1296
1297         _in_group_rebuild_or_clear = true;
1298
1299         /* just rebuild the while thing */
1300
1301         group_model->clear ();
1302
1303 #if 0
1304         /* this is currently not used,
1305          * Mixer_UI::group_display_button_press() has a case for it,
1306          * and a commented edit_route_group() but that's n/a since 2011.
1307          *
1308          * This code is left as reminder that
1309          * row[group_columns.group] = 0 has special meaning.
1310          */
1311         {
1312                 TreeModel::Row row;
1313                 row = *(group_model->append());
1314                 row[group_columns.visible] = true;
1315                 row[group_columns.text] = (_("-all-"));
1316                 row[group_columns.group] = 0;
1317         }
1318 #endif
1319
1320         _session->foreach_route_group (sigc::mem_fun (*this, &Mixer_UI::add_route_group));
1321
1322         _group_tabs->set_dirty ();
1323         _in_group_rebuild_or_clear = false;
1324 }
1325
1326 void
1327 Mixer_UI::new_route_group ()
1328 {
1329         RouteList rl;
1330
1331         _group_tabs->run_new_group_dialog (rl);
1332 }
1333
1334 void
1335 Mixer_UI::remove_selected_route_group ()
1336 {
1337         Glib::RefPtr<TreeSelection> selection = group_display.get_selection();
1338         TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1339
1340         if (rows.empty()) {
1341                 return;
1342         }
1343
1344         TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1345         TreeIter iter;
1346
1347         /* selection mode is single, so rows.begin() is it */
1348
1349         if ((iter = group_model->get_iter (*i))) {
1350
1351                 RouteGroup* rg = (*iter)[group_columns.group];
1352
1353                 if (rg) {
1354                         _session->remove_route_group (*rg);
1355                 }
1356         }
1357 }
1358
1359 void
1360 Mixer_UI::route_group_property_changed (RouteGroup* group, const PropertyChange& change)
1361 {
1362         if (in_group_row_change) {
1363                 return;
1364         }
1365
1366         /* force an update of any mixer strips that are using this group,
1367            otherwise mix group names don't change in mixer strips
1368         */
1369
1370         for (list<MixerStrip *>::iterator i = strips.begin(); i != strips.end(); ++i) {
1371                 if ((*i)->route_group() == group) {
1372                         (*i)->route_group_changed();
1373                 }
1374         }
1375
1376         TreeModel::iterator i;
1377         TreeModel::Children rows = group_model->children();
1378         Glib::RefPtr<TreeSelection> selection = group_display.get_selection();
1379
1380         in_group_row_change = true;
1381
1382         for (i = rows.begin(); i != rows.end(); ++i) {
1383                 if ((*i)[group_columns.group] == group) {
1384                         (*i)[group_columns.visible] = !group->is_hidden ();
1385                         (*i)[group_columns.text] = group->name ();
1386                         break;
1387                 }
1388         }
1389
1390         in_group_row_change = false;
1391
1392         if (change.contains (Properties::name)) {
1393                 _group_tabs->set_dirty ();
1394         }
1395
1396         for (list<MixerStrip*>::iterator j = strips.begin(); j != strips.end(); ++j) {
1397                 if ((*j)->route_group() == group) {
1398                         if (group->is_hidden ()) {
1399                                 hide_strip (*j);
1400                         } else {
1401                                 show_strip (*j);
1402                         }
1403                 }
1404         }
1405 }
1406
1407 void
1408 Mixer_UI::route_group_name_edit (const std::string& path, const std::string& new_text)
1409 {
1410         RouteGroup* group;
1411         TreeIter iter;
1412
1413         if ((iter = group_model->get_iter (path))) {
1414
1415                 if ((group = (*iter)[group_columns.group]) == 0) {
1416                         return;
1417                 }
1418
1419                 if (new_text != group->name()) {
1420                         group->set_name (new_text);
1421                 }
1422         }
1423 }
1424
1425 void
1426 Mixer_UI::route_group_row_change (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator& iter)
1427 {
1428         RouteGroup* group;
1429
1430         if (in_group_row_change) {
1431                 return;
1432         }
1433
1434         if ((group = (*iter)[group_columns.group]) == 0) {
1435                 return;
1436         }
1437
1438         std::string name = (*iter)[group_columns.text];
1439
1440         if (name != group->name()) {
1441                 group->set_name (name);
1442         }
1443
1444         bool hidden = !(*iter)[group_columns.visible];
1445
1446         if (hidden != group->is_hidden ()) {
1447                 group->set_hidden (hidden, this);
1448         }
1449 }
1450
1451 /** Called when a group model row is deleted, but also when the model is
1452  *  reordered by a user drag-and-drop; the latter is what we are
1453  *  interested in here.
1454  */
1455 void
1456 Mixer_UI::route_group_row_deleted (Gtk::TreeModel::Path const &)
1457 {
1458         if (_in_group_rebuild_or_clear) {
1459                 return;
1460         }
1461
1462         /* Re-write the session's route group list so that the new order is preserved */
1463
1464         list<RouteGroup*> new_list;
1465
1466         Gtk::TreeModel::Children children = group_model->children();
1467         for (Gtk::TreeModel::Children::iterator i = children.begin(); i != children.end(); ++i) {
1468                 RouteGroup* g = (*i)[group_columns.group];
1469                 if (g) {
1470                         new_list.push_back (g);
1471                 }
1472         }
1473
1474         _session->reorder_route_groups (new_list);
1475 }
1476
1477
1478 void
1479 Mixer_UI::add_route_group (RouteGroup* group)
1480 {
1481         ENSURE_GUI_THREAD (*this, &Mixer_UI::add_route_group, group)
1482         bool focus = false;
1483
1484         in_group_row_change = true;
1485
1486         TreeModel::Row row = *(group_model->append());
1487         row[group_columns.visible] = !group->is_hidden ();
1488         row[group_columns.group] = group;
1489         if (!group->name().empty()) {
1490                 row[group_columns.text] = group->name();
1491         } else {
1492                 row[group_columns.text] = _("unnamed");
1493                 focus = true;
1494         }
1495
1496         group->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&Mixer_UI::route_group_property_changed, this, group, _1), gui_context());
1497
1498         if (focus) {
1499                 TreeViewColumn* col = group_display.get_column (0);
1500                 CellRendererText* name_cell = dynamic_cast<CellRendererText*>(group_display.get_column_cell_renderer (0));
1501                 group_display.set_cursor (group_model->get_path (row), *col, *name_cell, true);
1502         }
1503
1504         _group_tabs->set_dirty ();
1505
1506         in_group_row_change = false;
1507 }
1508
1509 bool
1510 Mixer_UI::strip_scroller_button_release (GdkEventButton* ev)
1511 {
1512         using namespace Menu_Helpers;
1513
1514         if (Keyboard::is_context_menu_event (ev)) {
1515                 ARDOUR_UI::instance()->add_route (this);
1516                 return true;
1517         }
1518
1519         return false;
1520 }
1521
1522 void
1523 Mixer_UI::set_strip_width (Width w, bool save)
1524 {
1525         _strip_width = w;
1526
1527         for (list<MixerStrip*>::iterator i = strips.begin(); i != strips.end(); ++i) {
1528                 (*i)->set_width_enum (w, save ? (*i)->width_owner() : this);
1529         }
1530 }
1531
1532 void
1533 Mixer_UI::set_window_pos_and_size ()
1534 {
1535         resize (m_width, m_height);
1536         move (m_root_x, m_root_y);
1537 }
1538
1539         void
1540 Mixer_UI::get_window_pos_and_size ()
1541 {
1542         get_position(m_root_x, m_root_y);
1543         get_size(m_width, m_height);
1544 }
1545
1546 int
1547 Mixer_UI::set_state (const XMLNode& node)
1548 {
1549         const XMLProperty* prop;
1550         XMLNode* geometry;
1551
1552         m_width = default_width;
1553         m_height = default_height;
1554         m_root_x = 1;
1555         m_root_y = 1;
1556
1557         if ((geometry = find_named_node (node, "geometry")) != 0) {
1558
1559                 XMLProperty* prop;
1560
1561                 if ((prop = geometry->property("x_size")) == 0) {
1562                         prop = geometry->property ("x-size");
1563                 }
1564                 if (prop) {
1565                         m_width = atoi(prop->value());
1566                 }
1567                 if ((prop = geometry->property("y_size")) == 0) {
1568                         prop = geometry->property ("y-size");
1569                 }
1570                 if (prop) {
1571                         m_height = atoi(prop->value());
1572                 }
1573
1574                 if ((prop = geometry->property ("x_pos")) == 0) {
1575                         prop = geometry->property ("x-pos");
1576                 }
1577                 if (prop) {
1578                         m_root_x = atoi (prop->value());
1579
1580                 }
1581                 if ((prop = geometry->property ("y_pos")) == 0) {
1582                         prop = geometry->property ("y-pos");
1583                 }
1584                 if (prop) {
1585                         m_root_y = atoi (prop->value());
1586                 }
1587         }
1588
1589         set_window_pos_and_size ();
1590
1591         if ((prop = node.property ("narrow-strips"))) {
1592                 if (string_is_affirmative (prop->value())) {
1593                         set_strip_width (Narrow);
1594                 } else {
1595                         set_strip_width (Wide);
1596                 }
1597         }
1598
1599         if ((prop = node.property ("show-mixer"))) {
1600                 if (string_is_affirmative (prop->value())) {
1601                        _visible = true;
1602                 }
1603         }
1604
1605         if ((prop = node.property ("maximised"))) {
1606                 bool yn = string_is_affirmative (prop->value());
1607                 Glib::RefPtr<Action> act = ActionManager::get_action (X_("Common"), X_("ToggleMaximalMixer"));
1608                 assert (act);
1609                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
1610                 bool fs = tact && tact->get_active();
1611                 if (yn ^ fs) {
1612                         ActionManager::do_action ("Common",
1613                                         "ToggleMaximalMixer");
1614                 }
1615         }
1616
1617
1618         return 0;
1619 }
1620
1621 XMLNode&
1622 Mixer_UI::get_state (void)
1623 {
1624         XMLNode* node = new XMLNode ("Mixer");
1625
1626         if (is_realized()) {
1627                 Glib::RefPtr<Gdk::Window> win = get_window();
1628
1629                 get_window_pos_and_size ();
1630
1631                 XMLNode* geometry = new XMLNode ("geometry");
1632                 char buf[32];
1633                 snprintf(buf, sizeof(buf), "%d", m_width);
1634                 geometry->add_property(X_("x_size"), string(buf));
1635                 snprintf(buf, sizeof(buf), "%d", m_height);
1636                 geometry->add_property(X_("y_size"), string(buf));
1637                 snprintf(buf, sizeof(buf), "%d", m_root_x);
1638                 geometry->add_property(X_("x_pos"), string(buf));
1639                 snprintf(buf, sizeof(buf), "%d", m_root_y);
1640                 geometry->add_property(X_("y_pos"), string(buf));
1641
1642                 // written only for compatibility, they are not used.
1643                 snprintf(buf, sizeof(buf), "%d", 0);
1644                 geometry->add_property(X_("x_off"), string(buf));
1645                 snprintf(buf, sizeof(buf), "%d", 0);
1646                 geometry->add_property(X_("y_off"), string(buf));
1647
1648                 snprintf(buf,sizeof(buf), "%d",gtk_paned_get_position (static_cast<Paned*>(&rhs_pane1)->gobj()));
1649                 geometry->add_property(X_("mixer_rhs_pane1_pos"), string(buf));
1650                 snprintf(buf,sizeof(buf), "%d",gtk_paned_get_position (static_cast<Paned*>(&list_hpane)->gobj()));
1651                 geometry->add_property(X_("mixer_list_hpane_pos"), string(buf));
1652
1653                 node->add_child_nocopy (*geometry);
1654         }
1655
1656         node->add_property ("narrow-strips", _strip_width == Narrow ? "yes" : "no");
1657
1658         node->add_property ("show-mixer", _visible ? "yes" : "no");
1659
1660         node->add_property ("maximised", _maximised ? "yes" : "no");
1661
1662         return *node;
1663 }
1664
1665
1666 void
1667 Mixer_UI::pane_allocation_handler (Allocation&, Gtk::Paned* which)
1668 {
1669         int pos;
1670         XMLProperty* prop = 0;
1671         char buf[32];
1672         XMLNode* node = ARDOUR_UI::instance()->mixer_settings();
1673         XMLNode* geometry;
1674         int height;
1675         static int32_t done[3] = { 0, 0, 0 };
1676
1677         height = default_height;
1678
1679         if ((geometry = find_named_node (*node, "geometry")) != 0) {
1680
1681                 if ((prop = geometry->property ("y_size")) == 0) {
1682                         prop = geometry->property ("y-size");
1683                 }
1684                 if (prop) {
1685                         height = atoi (prop->value());
1686                 }
1687         }
1688
1689         if (which == static_cast<Gtk::Paned*> (&rhs_pane1)) {
1690
1691                 if (done[0]) {
1692                         return;
1693                 }
1694
1695                 if (!geometry || (prop = geometry->property("mixer-rhs-pane1-pos")) == 0) {
1696                         pos = height / 3;
1697                         snprintf (buf, sizeof(buf), "%d", pos);
1698                 } else {
1699                         pos = atoi (prop->value());
1700                 }
1701
1702                 if ((done[0] = GTK_WIDGET(rhs_pane1.gobj())->allocation.height > pos)) {
1703                         rhs_pane1.set_position (pos);
1704                 }
1705
1706         } else if (which == static_cast<Gtk::Paned*> (&list_hpane)) {
1707
1708                 if (done[2]) {
1709                         return;
1710                 }
1711
1712                 if (!geometry || (prop = geometry->property("mixer-list-hpane-pos")) == 0) {
1713                         pos = 75;
1714                         snprintf (buf, sizeof(buf), "%d", pos);
1715                 } else {
1716                         pos = atoi (prop->value());
1717                 }
1718
1719                 if ((done[2] = GTK_WIDGET(list_hpane.gobj())->allocation.width > pos)) {
1720                         list_hpane.set_position (pos);
1721                 }
1722         }
1723 }
1724 void
1725 Mixer_UI::scroll_left ()
1726 {
1727         if (!scroller.get_hscrollbar()) return;
1728         Adjustment* adj = scroller.get_hscrollbar()->get_adjustment();
1729         /* stupid GTK: can't rely on clamping across versions */
1730         scroller.get_hscrollbar()->set_value (max (adj->get_lower(), adj->get_value() - adj->get_step_increment()));
1731 }
1732
1733 void
1734 Mixer_UI::scroll_right ()
1735 {
1736         if (!scroller.get_hscrollbar()) return;
1737         Adjustment* adj = scroller.get_hscrollbar()->get_adjustment();
1738         /* stupid GTK: can't rely on clamping across versions */
1739         scroller.get_hscrollbar()->set_value (min (adj->get_upper(), adj->get_value() + adj->get_step_increment()));
1740 }
1741
1742 bool
1743 Mixer_UI::on_key_press_event (GdkEventKey* ev)
1744 {
1745         /* focus widget gets first shot, then bindings, otherwise
1746            forward to main window
1747         */
1748
1749         if (gtk_window_propagate_key_event (GTK_WINDOW(gobj()), ev)) {
1750                 return true;
1751         }
1752
1753         KeyboardKey k (ev->state, ev->keyval);
1754
1755         if (bindings.activate (k, Bindings::Press)) {
1756                 return true;
1757         }
1758
1759         return forward_key_press (ev);
1760 }
1761
1762 bool
1763 Mixer_UI::on_key_release_event (GdkEventKey* ev)
1764 {
1765         if (gtk_window_propagate_key_event (GTK_WINDOW(gobj()), ev)) {
1766                 return true;
1767         }
1768
1769         KeyboardKey k (ev->state, ev->keyval);
1770         
1771         if (bindings.activate (k, Bindings::Release)) {
1772                 return true;
1773         }
1774
1775         /* don't forward releases */
1776
1777         return true;
1778 }
1779
1780 bool
1781 Mixer_UI::on_scroll_event (GdkEventScroll* ev)
1782 {
1783         switch (ev->direction) {
1784         case GDK_SCROLL_LEFT:
1785                 scroll_left ();
1786                 return true;
1787         case GDK_SCROLL_UP:
1788                 if (ev->state & Keyboard::TertiaryModifier) {
1789                         scroll_left ();
1790                         return true;
1791                 }
1792                 return false;
1793
1794         case GDK_SCROLL_RIGHT:
1795                 scroll_right ();
1796                 return true;
1797
1798         case GDK_SCROLL_DOWN:
1799                 if (ev->state & Keyboard::TertiaryModifier) {
1800                         scroll_right ();
1801                         return true;
1802                 }
1803                 return false;
1804         }
1805
1806         return false;
1807 }
1808
1809
1810 void
1811 Mixer_UI::parameter_changed (string const & p)
1812 {
1813         if (p == "show-group-tabs") {
1814                 bool const s = _session->config.get_show_group_tabs ();
1815                 if (s) {
1816                         _group_tabs->show ();
1817                 } else {
1818                         _group_tabs->hide ();
1819                 }
1820         } else if (p == "default-narrow_ms") {
1821                 bool const s = ARDOUR_UI::config()->get_default_narrow_ms ();
1822                 for (list<MixerStrip*>::iterator i = strips.begin(); i != strips.end(); ++i) {
1823                         (*i)->set_width_enum (s ? Narrow : Wide, this);
1824                 }
1825         } else if (p == "remote-model") {
1826                 reset_remote_control_ids ();
1827         }
1828 }
1829
1830 void
1831 Mixer_UI::set_route_group_activation (RouteGroup* g, bool a)
1832 {
1833         g->set_active (a, this);
1834 }
1835
1836 PluginSelector*
1837 Mixer_UI::plugin_selector()
1838 {
1839 #ifdef DEFER_PLUGIN_SELECTOR_LOAD
1840         if (!_plugin_selector)
1841                 _plugin_selector = new PluginSelector (PluginManager::instance());
1842 #endif
1843
1844         return _plugin_selector;
1845 }
1846
1847 void
1848 Mixer_UI::setup_track_display ()
1849 {
1850         track_model = ListStore::create (track_columns);
1851         track_display.set_model (track_model);
1852         track_display.append_column (_("Strips"), track_columns.text);
1853         track_display.append_column (_("Show"), track_columns.visible);
1854         track_display.get_column (0)->set_data (X_("colnum"), GUINT_TO_POINTER(0));
1855         track_display.get_column (1)->set_data (X_("colnum"), GUINT_TO_POINTER(1));
1856         track_display.get_column (0)->set_expand(true);
1857         track_display.get_column (1)->set_expand(false);
1858         track_display.get_column (0)->set_sizing (Gtk::TREE_VIEW_COLUMN_FIXED);
1859         track_display.set_name (X_("EditGroupList"));
1860         track_display.get_selection()->set_mode (Gtk::SELECTION_NONE);
1861         track_display.set_reorderable (true);
1862         track_display.set_headers_visible (true);
1863
1864         track_model->signal_row_deleted().connect (sigc::mem_fun (*this, &Mixer_UI::track_list_delete));
1865         track_model->signal_rows_reordered().connect (sigc::mem_fun (*this, &Mixer_UI::track_list_reorder));
1866
1867         CellRendererToggle* track_list_visible_cell = dynamic_cast<CellRendererToggle*>(track_display.get_column_cell_renderer (1));
1868         track_list_visible_cell->property_activatable() = true;
1869         track_list_visible_cell->property_radio() = false;
1870         track_list_visible_cell->signal_toggled().connect (sigc::mem_fun (*this, &Mixer_UI::track_visibility_changed));
1871
1872         track_display.signal_button_press_event().connect (sigc::mem_fun (*this, &Mixer_UI::track_display_button_press), false);
1873
1874         track_display_scroller.add (track_display);
1875         track_display_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1876
1877         VBox* v = manage (new VBox);
1878         v->show ();
1879         v->pack_start (track_display_scroller, true, true);
1880
1881         Button* b = manage (new Button);
1882         b->show ();
1883         Widget* w = manage (new Image (Stock::ADD, ICON_SIZE_BUTTON));
1884         w->show ();
1885         b->add (*w);
1886
1887         b->signal_clicked().connect (sigc::mem_fun (*this, &Mixer_UI::new_track_or_bus));
1888
1889         v->pack_start (*b, false, false);
1890
1891         track_display_frame.set_name("BaseFrame");
1892         track_display_frame.set_shadow_type (Gtk::SHADOW_IN);
1893         track_display_frame.add (*v);
1894
1895         track_display_scroller.show();
1896         track_display_frame.show();
1897         track_display.show();
1898 }
1899
1900 void
1901 Mixer_UI::new_track_or_bus ()
1902 {
1903         ARDOUR_UI::instance()->add_route (this);
1904 }
1905
1906
1907 void
1908 Mixer_UI::update_title ()
1909 {
1910         if (_session) {
1911                 string n;
1912                 
1913                 if (_session->snap_name() != _session->name()) {
1914                         n = _session->snap_name ();
1915                 } else {
1916                         n = _session->name ();
1917                 }
1918
1919                 if (_session->dirty ()) {
1920                         n = "*" + n;
1921                 }
1922                 
1923                 WindowTitle title (n);
1924                 title += S_("Window|Mixer");
1925                 title += Glib::get_application_name ();
1926                 set_title (title.get_string());
1927
1928         } else {
1929                 
1930                 WindowTitle title (S_("Window|Mixer"));
1931                 title += Glib::get_application_name ();
1932                 set_title (title.get_string());
1933         }
1934 }
1935
1936 MixerStrip*
1937 Mixer_UI::strip_by_x (int x)
1938 {
1939         for (list<MixerStrip*>::iterator i = strips.begin(); i != strips.end(); ++i) {
1940                 int x1, x2, y;
1941
1942                 (*i)->translate_coordinates (*this, 0, 0, x1, y);
1943                 x2 = x1 + (*i)->get_width();
1944
1945                 if (x >= x1 && x <= x2) {
1946                         return (*i);
1947                 }
1948         }
1949
1950         return 0;
1951 }
1952
1953 void
1954 Mixer_UI::set_route_targets_for_operation ()
1955 {
1956         _route_targets.clear ();
1957
1958         if (!_selection.empty()) {
1959                 _route_targets = _selection.routes;
1960                 return;
1961         }
1962
1963 //  removed "implicit" selections of strips, after discussion on IRC
1964
1965 }
1966
1967 void
1968 Mixer_UI::monitor_section_going_away ()
1969 {
1970         if (_monitor_section) {
1971                 out_packer.remove (_monitor_section->tearoff());
1972                 _monitor_section->set_session (0);
1973         }
1974 }
1975
1976 void
1977 Mixer_UI::toggle_midi_input_active (bool flip_others)
1978 {
1979         boost::shared_ptr<RouteList> rl (new RouteList);
1980         bool onoff = false;
1981
1982         set_route_targets_for_operation ();
1983
1984         for (RouteUISelection::iterator r = _route_targets.begin(); r != _route_targets.end(); ++r) {
1985                 boost::shared_ptr<MidiTrack> mt = (*r)->midi_track();
1986
1987                 if (mt) {
1988                         rl->push_back ((*r)->route());
1989                         onoff = !mt->input_active();
1990                 }
1991         }
1992         
1993         _session->set_exclusive_input_active (rl, onoff, flip_others);
1994 }
1995
1996 void
1997 Mixer_UI::maximise_mixer_space ()
1998 {
1999         if (_maximised) {
2000                 return;
2001         }
2002
2003         fullscreen ();
2004
2005         _maximised = true;
2006 }
2007
2008 void
2009 Mixer_UI::restore_mixer_space ()
2010 {
2011         if (!_maximised) {
2012                 return;
2013         }
2014
2015         unfullscreen();
2016
2017         _maximised = false;
2018 }