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