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