gtk2_ardour/mixer_ui.cc

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