gtk2_ardour/mixer_ui.cc

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