gtk2_ardour/editor_routes.cc

   1 /*
   2     Copyright (C) 2000-2009 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 #include <cstdlib>
  21 #include <cassert>
  22 #include <cmath>
  23 #include <list>
  24 #include <vector>
  25 #include <algorithm>
  26
  27 #include "pbd/unknown_type.h"
  28 #include "pbd/unwind.h"
  29
  30 #include "ardour/debug.h"
  31 #include "ardour/audio_track.h"
  32 #include "ardour/midi_track.h"
  33 #include "ardour/route.h"
  34 #include "ardour/session.h"
  35 #include "ardour/solo_isolate_control.h"
  36 #include "ardour/utils.h"
  37 #include "ardour/vca.h"
  38 #include "ardour/vca_manager.h"
  39
  40 #include "gtkmm2ext/cell_renderer_pixbuf_multi.h"
  41 #include "gtkmm2ext/cell_renderer_pixbuf_toggle.h"
  42 #include "gtkmm2ext/treeutils.h"
  43
  44 #include "actions.h"
  45 #include "ardour_ui.h"
  46 #include "audio_time_axis.h"
  47 #include "editor.h"
  48 #include "editor_group_tabs.h"
  49 #include "editor_routes.h"
  50 #include "gui_thread.h"
  51 #include "keyboard.h"
  52 #include "midi_time_axis.h"
  53 #include "mixer_strip.h"
  54 #include "plugin_setup_dialog.h"
  55 #include "route_sorter.h"
  56 #include "tooltips.h"
  57 #include "vca_time_axis.h"
  58 #include "utils.h"
  59
  60 #include "i18n.h"
  61
  62 using namespace std;
  63 using namespace ARDOUR;
  64 using namespace ARDOUR_UI_UTILS;
  65 using namespace PBD;
  66 using namespace Gtk;
  67 using namespace Gtkmm2ext;
  68 using namespace Glib;
  69 using Gtkmm2ext::Keyboard;
  70
  71 struct ColumnInfo {
  72         int         index;
  73         const char* label;
  74         const char* tooltip;
  75 };
  76
  77 EditorRoutes::EditorRoutes (Editor* e)
  78         : EditorComponent (e)
  79         , _ignore_reorder (false)
  80         , _no_redisplay (false)
  81         , _adding_routes (false)
  82         , _route_deletion_in_progress (false)
  83         , _redisplay_on_resume (false)
  84         , _redisplay_active (0)
  85         , _queue_tv_update (0)
  86         , _menu (0)
  87         , old_focus (0)
  88         , selection_countdown (0)
  89         , name_editable (0)
  90 {
  91         static const int column_width = 22;
  92
  93         _scroller.add (_display);
  94         _scroller.set_policy (POLICY_NEVER, POLICY_AUTOMATIC);
  95
  96         _model = ListStore::create (_columns);
  97         _display.set_model (_model);
  98
  99         // Record enable toggle
 100         CellRendererPixbufMulti* rec_col_renderer = manage (new CellRendererPixbufMulti());
 101
 102         rec_col_renderer->set_pixbuf (0, ::get_icon("record-normal-disabled"));
 103         rec_col_renderer->set_pixbuf (1, ::get_icon("record-normal-in-progress"));
 104         rec_col_renderer->set_pixbuf (2, ::get_icon("record-normal-enabled"));
 105         rec_col_renderer->set_pixbuf (3, ::get_icon("record-step"));
 106         rec_col_renderer->signal_changed().connect (sigc::mem_fun (*this, &EditorRoutes::on_tv_rec_enable_changed));
 107
 108         TreeViewColumn* rec_state_column = manage (new TreeViewColumn("R", *rec_col_renderer));
 109
 110         rec_state_column->add_attribute(rec_col_renderer->property_state(), _columns.rec_state);
 111         rec_state_column->add_attribute(rec_col_renderer->property_visible(), _columns.is_track);
 112
 113         rec_state_column->set_sizing(TREE_VIEW_COLUMN_FIXED);
 114         rec_state_column->set_alignment(ALIGN_CENTER);
 115         rec_state_column->set_expand(false);
 116         rec_state_column->set_fixed_width(column_width);
 117
 118
 119         // Record safe toggle
 120         CellRendererPixbufMulti* rec_safe_renderer = manage (new CellRendererPixbufMulti ());
 121
 122         rec_safe_renderer->set_pixbuf (0, ::get_icon("rec-safe-disabled"));
 123         rec_safe_renderer->set_pixbuf (1, ::get_icon("rec-safe-enabled"));
 124         rec_safe_renderer->signal_changed().connect (sigc::mem_fun (*this, &EditorRoutes::on_tv_rec_safe_toggled));
 125
 126         TreeViewColumn* rec_safe_column = manage (new TreeViewColumn(_("RS"), *rec_safe_renderer));
 127         rec_safe_column->add_attribute(rec_safe_renderer->property_state(), _columns.rec_safe);
 128         rec_safe_column->add_attribute(rec_safe_renderer->property_visible(), _columns.is_track);
 129         rec_safe_column->set_sizing(TREE_VIEW_COLUMN_FIXED);
 130         rec_safe_column->set_alignment(ALIGN_CENTER);
 131         rec_safe_column->set_expand(false);
 132         rec_safe_column->set_fixed_width(column_width);
 133
 134
 135         // MIDI Input Active
 136
 137         CellRendererPixbufMulti* input_active_col_renderer = manage (new CellRendererPixbufMulti());
 138         input_active_col_renderer->set_pixbuf (0, ::get_icon("midi-input-inactive"));
 139         input_active_col_renderer->set_pixbuf (1, ::get_icon("midi-input-active"));
 140         input_active_col_renderer->signal_changed().connect (sigc::mem_fun (*this, &EditorRoutes::on_input_active_changed));
 141
 142         TreeViewColumn* input_active_column = manage (new TreeViewColumn ("I", *input_active_col_renderer));
 143
 144         input_active_column->add_attribute(input_active_col_renderer->property_state(), _columns.is_input_active);
 145         input_active_column->add_attribute (input_active_col_renderer->property_visible(), _columns.is_midi);
 146
 147         input_active_column->set_sizing(TREE_VIEW_COLUMN_FIXED);
 148         input_active_column->set_alignment(ALIGN_CENTER);
 149         input_active_column->set_expand(false);
 150         input_active_column->set_fixed_width(column_width);
 151
 152         // Mute enable toggle
 153         CellRendererPixbufMulti* mute_col_renderer = manage (new CellRendererPixbufMulti());
 154
 155         mute_col_renderer->set_pixbuf (Gtkmm2ext::Off, ::get_icon("mute-disabled"));
 156         mute_col_renderer->set_pixbuf (Gtkmm2ext::ImplicitActive, ::get_icon("muted-by-others"));
 157         mute_col_renderer->set_pixbuf (Gtkmm2ext::ExplicitActive, ::get_icon("mute-enabled"));
 158         mute_col_renderer->signal_changed().connect (sigc::mem_fun (*this, &EditorRoutes::on_tv_mute_enable_toggled));
 159
 160         TreeViewColumn* mute_state_column = manage (new TreeViewColumn("M", *mute_col_renderer));
 161
 162         mute_state_column->add_attribute(mute_col_renderer->property_state(), _columns.mute_state);
 163         mute_state_column->set_sizing(TREE_VIEW_COLUMN_FIXED);
 164         mute_state_column->set_alignment(ALIGN_CENTER);
 165         mute_state_column->set_expand(false);
 166         mute_state_column->set_fixed_width(15);
 167
 168         // Solo enable toggle
 169         CellRendererPixbufMulti* solo_col_renderer = manage (new CellRendererPixbufMulti());
 170
 171         solo_col_renderer->set_pixbuf (Gtkmm2ext::Off, ::get_icon("solo-disabled"));
 172         solo_col_renderer->set_pixbuf (Gtkmm2ext::ExplicitActive, ::get_icon("solo-enabled"));
 173         solo_col_renderer->set_pixbuf (Gtkmm2ext::ImplicitActive, ::get_icon("soloed-by-others"));
 174         solo_col_renderer->signal_changed().connect (sigc::mem_fun (*this, &EditorRoutes::on_tv_solo_enable_toggled));
 175
 176         TreeViewColumn* solo_state_column = manage (new TreeViewColumn("S", *solo_col_renderer));
 177
 178         solo_state_column->add_attribute(solo_col_renderer->property_state(), _columns.solo_state);
 179         solo_state_column->add_attribute(solo_col_renderer->property_visible(), _columns.solo_visible);
 180         solo_state_column->set_sizing(TREE_VIEW_COLUMN_FIXED);
 181         solo_state_column->set_alignment(ALIGN_CENTER);
 182         solo_state_column->set_expand(false);
 183         solo_state_column->set_fixed_width(column_width);
 184
 185         // Solo isolate toggle
 186         CellRendererPixbufMulti* solo_iso_renderer = manage (new CellRendererPixbufMulti());
 187
 188         solo_iso_renderer->set_pixbuf (0, ::get_icon("solo-isolate-disabled"));
 189         solo_iso_renderer->set_pixbuf (1, ::get_icon("solo-isolate-enabled"));
 190         solo_iso_renderer->signal_changed().connect (sigc::mem_fun (*this, &EditorRoutes::on_tv_solo_isolate_toggled));
 191
 192         TreeViewColumn* solo_isolate_state_column = manage (new TreeViewColumn("SI", *solo_iso_renderer));
 193
 194         solo_isolate_state_column->add_attribute(solo_iso_renderer->property_state(), _columns.solo_isolate_state);
 195         solo_isolate_state_column->add_attribute(solo_iso_renderer->property_visible(), _columns.solo_visible);
 196         solo_isolate_state_column->set_sizing(TREE_VIEW_COLUMN_FIXED);
 197         solo_isolate_state_column->set_alignment(ALIGN_CENTER);
 198         solo_isolate_state_column->set_expand(false);
 199         solo_isolate_state_column->set_fixed_width(column_width);
 200
 201         // Solo safe toggle
 202         CellRendererPixbufMulti* solo_safe_renderer = manage (new CellRendererPixbufMulti ());
 203
 204         solo_safe_renderer->set_pixbuf (0, ::get_icon("solo-safe-disabled"));
 205         solo_safe_renderer->set_pixbuf (1, ::get_icon("solo-safe-enabled"));
 206         solo_safe_renderer->signal_changed().connect (sigc::mem_fun (*this, &EditorRoutes::on_tv_solo_safe_toggled));
 207
 208         TreeViewColumn* solo_safe_state_column = manage (new TreeViewColumn(_("SS"), *solo_safe_renderer));
 209         solo_safe_state_column->add_attribute(solo_safe_renderer->property_state(), _columns.solo_safe_state);
 210         solo_safe_state_column->add_attribute(solo_safe_renderer->property_visible(), _columns.solo_visible);
 211         solo_safe_state_column->set_sizing(TREE_VIEW_COLUMN_FIXED);
 212         solo_safe_state_column->set_alignment(ALIGN_CENTER);
 213         solo_safe_state_column->set_expand(false);
 214         solo_safe_state_column->set_fixed_width(column_width);
 215
 216         _name_column = _display.append_column ("", _columns.text) - 1;
 217         _visible_column = _display.append_column ("", _columns.visible) - 1;
 218         _active_column = _display.append_column ("", _columns.active) - 1;
 219
 220         _display.append_column (*input_active_column);
 221         _display.append_column (*rec_state_column);
 222         _display.append_column (*rec_safe_column);
 223         _display.append_column (*mute_state_column);
 224         _display.append_column (*solo_state_column);
 225         _display.append_column (*solo_isolate_state_column);
 226         _display.append_column (*solo_safe_state_column);
 227
 228
 229         TreeViewColumn* col;
 230         Gtk::Label* l;
 231
 232         ColumnInfo ci[] = {
 233                 { 0,  _("Name"),        _("Track/Bus Name") },
 234                 { 1, S_("Visible|V"),   _("Track/Bus visible ?") },
 235                 { 2, S_("Active|A"),    _("Track/Bus active ?") },
 236                 { 3, S_("MidiInput|I"), _("MIDI input enabled") },
 237                 { 4, S_("Rec|R"),       _("Record enabled") },
 238                 { 5, S_("Rec|RS"),      _("Record Safe") },
 239                 { 6, S_("Mute|M"),      _("Muted") },
 240                 { 7, S_("Solo|S"),      _("Soloed") },
 241                 { 8, S_("SoloIso|SI"),  _("Solo Isolated") },
 242                 { 9, S_("SoloLock|SS"), _("Solo Safe (Locked)") },
 243                 { -1, 0, 0 }
 244         };
 245
 246         for (int i = 0; ci[i].index >= 0; ++i) {
 247                 col = _display.get_column (ci[i].index);
 248                 l = manage (new Label (ci[i].label));
 249                 set_tooltip (*l, ci[i].tooltip);
 250                 col->set_widget (*l);
 251                 l->show ();
 252         }
 253
 254         _display.set_headers_visible (true);
 255         _display.get_selection()->set_mode (SELECTION_SINGLE);
 256         _display.get_selection()->set_select_function (sigc::mem_fun (*this, &EditorRoutes::selection_filter));
 257         _display.get_selection()->signal_changed().connect (sigc::mem_fun (*this, &EditorRoutes::selection_changed));
 258         _display.set_reorderable (true);
 259         _display.set_name (X_("EditGroupList"));
 260         _display.set_rules_hint (true);
 261         _display.set_size_request (100, -1);
 262         _display.add_object_drag (_columns.stripable.index(), "routes");
 263
 264         CellRendererText* name_cell = dynamic_cast<CellRendererText*> (_display.get_column_cell_renderer (_name_column));
 265
 266         assert (name_cell);
 267         name_cell->signal_editing_started().connect (sigc::mem_fun (*this, &EditorRoutes::name_edit_started));
 268
 269         TreeViewColumn* name_column = _display.get_column (_name_column);
 270
 271         assert (name_column);
 272
 273         name_column->add_attribute (name_cell->property_editable(), _columns.name_editable);
 274         name_column->set_sizing(TREE_VIEW_COLUMN_FIXED);
 275         name_column->set_expand(true);
 276         name_column->set_min_width(50);
 277
 278         name_cell->property_editable() = true;
 279         name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRoutes::name_edit));
 280
 281         // Set the visible column cell renderer to radio toggle
 282         CellRendererToggle* visible_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (_visible_column));
 283
 284         visible_cell->property_activatable() = true;
 285         visible_cell->property_radio() = false;
 286         visible_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRoutes::visible_changed));
 287
 288         TreeViewColumn* visible_col = dynamic_cast<TreeViewColumn*> (_display.get_column (_visible_column));
 289         visible_col->set_expand(false);
 290         visible_col->set_sizing(TREE_VIEW_COLUMN_FIXED);
 291         visible_col->set_fixed_width(30);
 292         visible_col->set_alignment(ALIGN_CENTER);
 293
 294         CellRendererToggle* active_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (_active_column));
 295
 296         active_cell->property_activatable() = true;
 297         active_cell->property_radio() = false;
 298         active_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRoutes::active_changed));
 299
 300         TreeViewColumn* active_col = dynamic_cast<TreeViewColumn*> (_display.get_column (_active_column));
 301         active_col->set_expand (false);
 302         active_col->set_sizing (TREE_VIEW_COLUMN_FIXED);
 303         active_col->set_fixed_width (30);
 304         active_col->set_alignment (ALIGN_CENTER);
 305
 306         _model->signal_row_deleted().connect (sigc::mem_fun (*this, &EditorRoutes::row_deleted));
 307         _model->signal_rows_reordered().connect (sigc::mem_fun (*this, &EditorRoutes::reordered));
 308
 309         _display.signal_button_press_event().connect (sigc::mem_fun (*this, &EditorRoutes::button_press), false);
 310         _scroller.signal_key_press_event().connect (sigc::mem_fun(*this, &EditorRoutes::key_press), false);
 311
 312         _scroller.signal_focus_in_event().connect (sigc::mem_fun (*this, &EditorRoutes::focus_in), false);
 313         _scroller.signal_focus_out_event().connect (sigc::mem_fun (*this, &EditorRoutes::focus_out));
 314
 315         _display.signal_enter_notify_event().connect (sigc::mem_fun (*this, &EditorRoutes::enter_notify), false);
 316         _display.signal_leave_notify_event().connect (sigc::mem_fun (*this, &EditorRoutes::leave_notify), false);
 317
 318         _display.set_enable_search (false);
 319
 320         Route::PluginSetup.connect_same_thread (*this, boost::bind (&EditorRoutes::plugin_setup, this, _1, _2, _3));
 321         PresentationInfo::Change.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::sync_treeview_from_presentation_info, this), gui_context());
 322 }
 323
 324 bool
 325 EditorRoutes::focus_in (GdkEventFocus*)
 326 {
 327         Window* win = dynamic_cast<Window*> (_scroller.get_toplevel ());
 328
 329         if (win) {
 330                 old_focus = win->get_focus ();
 331         } else {
 332                 old_focus = 0;
 333         }
 334
 335         name_editable = 0;
 336
 337         /* try to do nothing on focus in (doesn't work, hence selection_count nonsense) */
 338         return true;
 339 }
 340
 341 bool
 342 EditorRoutes::focus_out (GdkEventFocus*)
 343 {
 344         if (old_focus) {
 345                 old_focus->grab_focus ();
 346                 old_focus = 0;
 347         }
 348
 349         return false;
 350 }
 351
 352 bool
 353 EditorRoutes::enter_notify (GdkEventCrossing*)
 354 {
 355         if (name_editable) {
 356                 return true;
 357         }
 358
 359         /* arm counter so that ::selection_filter() will deny selecting anything for the
 360          * next two attempts to change selection status.
 361          */
 362         selection_countdown = 2;
 363         _scroller.grab_focus ();
 364         Keyboard::magic_widget_grab_focus ();
 365         return false;
 366 }
 367
 368 bool
 369 EditorRoutes::leave_notify (GdkEventCrossing*)
 370 {
 371         selection_countdown = 0;
 372
 373         if (old_focus) {
 374                 old_focus->grab_focus ();
 375                 old_focus = 0;
 376         }
 377
 378         Keyboard::magic_widget_drop_focus ();
 379         return false;
 380 }
 381
 382 void
 383 EditorRoutes::set_session (Session* s)
 384 {
 385         SessionHandlePtr::set_session (s);
 386
 387         initial_display ();
 388
 389         if (_session) {
 390                 _session->SoloChanged.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::solo_changed_so_update_mute, this), gui_context());
 391                 _session->RecordStateChanged.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_rec_display, this), gui_context());
 392
 393                 /* TODO: check if these needs to be tied in with DisplaySuspender
 394                  * Given that the UI is single-threaded and DisplaySuspender is only used
 395                  * in loops in the UI thread all should be fine.
 396                  */
 397                 _session->BatchUpdateStart.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::suspend_redisplay, this), gui_context());
 398                 _session->BatchUpdateEnd.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::resume_redisplay, this), gui_context());
 399         }
 400 }
 401
 402 void
 403 EditorRoutes::on_input_active_changed (std::string const & path_string)
 404 {
 405         // Get the model row that has been toggled.
 406         Gtk::TreeModel::Row row = *_model->get_iter (Gtk::TreeModel::Path (path_string));
 407
 408         TimeAxisView* tv = row[_columns.tv];
 409         RouteTimeAxisView *rtv = dynamic_cast<RouteTimeAxisView*> (tv);
 410
 411         if (rtv) {
 412                 boost::shared_ptr<MidiTrack> mt;
 413                 mt = rtv->midi_track();
 414                 if (mt) {
 415                         mt->set_input_active (!mt->input_active());
 416                 }
 417         }
 418 }
 419
 420 void
 421 EditorRoutes::on_tv_rec_enable_changed (std::string const & path_string)
 422 {
 423         // Get the model row that has been toggled.
 424         Gtk::TreeModel::Row row = *_model->get_iter (Gtk::TreeModel::Path (path_string));
 425
 426         TimeAxisView* tv = row[_columns.tv];
 427         RouteTimeAxisView *rtv = dynamic_cast<RouteTimeAxisView*> (tv);
 428
 429         if (!rtv) {
 430                 return;
 431         }
 432
 433         boost::shared_ptr<AutomationControl> ac = rtv->route()->rec_enable_control();
 434
 435         if (ac) {
 436                 ac->set_value (!ac->get_value(), Controllable::UseGroup);
 437         }
 438 }
 439
 440 void
 441 EditorRoutes::on_tv_rec_safe_toggled (std::string const & path_string)
 442 {
 443         Gtk::TreeModel::Row row = *_model->get_iter (Gtk::TreeModel::Path (path_string));
 444         TimeAxisView* tv = row[_columns.tv];
 445         RouteTimeAxisView *rtv = dynamic_cast<RouteTimeAxisView*> (tv);
 446
 447         if (!rtv) {
 448                 return;
 449         }
 450
 451         boost::shared_ptr<AutomationControl> ac (rtv->route()->rec_safe_control());
 452
 453         if (ac) {
 454                 ac->set_value (!ac->get_value(), Controllable::UseGroup);
 455         }
 456 }
 457
 458 void
 459 EditorRoutes::on_tv_mute_enable_toggled (std::string const & path_string)
 460 {
 461         // Get the model row that has been toggled.
 462         Gtk::TreeModel::Row row = *_model->get_iter (Gtk::TreeModel::Path (path_string));
 463
 464         TimeAxisView *tv = row[_columns.tv];
 465         RouteTimeAxisView *rtv = dynamic_cast<RouteTimeAxisView*> (tv);
 466
 467         if (!rtv) {
 468                 return;
 469         }
 470
 471         boost::shared_ptr<AutomationControl> ac (rtv->route()->mute_control());
 472
 473         if (ac) {
 474                 ac->set_value (!ac->get_value(), Controllable::UseGroup);
 475         }
 476 }
 477
 478 void
 479 EditorRoutes::on_tv_solo_enable_toggled (std::string const & path_string)
 480 {
 481         // Get the model row that has been toggled.
 482         Gtk::TreeModel::Row row = *_model->get_iter (Gtk::TreeModel::Path (path_string));
 483
 484         TimeAxisView *tv = row[_columns.tv];
 485         RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*> (tv);
 486
 487         if (!rtv) {
 488                 return;
 489         }
 490
 491         boost::shared_ptr<AutomationControl> ac (rtv->route()->solo_control());
 492
 493         if (ac) {
 494                 ac->set_value (!ac->get_value(), Controllable::UseGroup);
 495         }
 496 }
 497
 498 void
 499 EditorRoutes::on_tv_solo_isolate_toggled (std::string const & path_string)
 500 {
 501         // Get the model row that has been toggled.
 502         Gtk::TreeModel::Row row = *_model->get_iter (Gtk::TreeModel::Path (path_string));
 503
 504         TimeAxisView *tv = row[_columns.tv];
 505         RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*> (tv);
 506
 507         if (!rtv) {
 508                 return;
 509         }
 510
 511         boost::shared_ptr<AutomationControl> ac (rtv->route()->solo_isolate_control());
 512
 513         if (ac) {
 514                 ac->set_value (!ac->get_value(), Controllable::UseGroup);
 515         }
 516 }
 517
 518 void
 519 EditorRoutes::on_tv_solo_safe_toggled (std::string const & path_string)
 520 {
 521         // Get the model row that has been toggled.
 522         Gtk::TreeModel::Row row = *_model->get_iter (Gtk::TreeModel::Path (path_string));
 523
 524         TimeAxisView *tv = row[_columns.tv];
 525         RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*> (tv);
 526
 527         if (!rtv) {
 528                 return;
 529         }
 530
 531         boost::shared_ptr<AutomationControl> ac (rtv->route()->solo_safe_control());
 532
 533         if (ac) {
 534                 ac->set_value (!ac->get_value(), Controllable::UseGroup);
 535         }
 536 }
 537
 538 void
 539 EditorRoutes::build_menu ()
 540 {
 541         using namespace Menu_Helpers;
 542         using namespace Gtk;
 543
 544         _menu = new Menu;
 545
 546         MenuList& items = _menu->items();
 547         _menu->set_name ("ArdourContextMenu");
 548
 549         items.push_back (MenuElem (_("Show All"), sigc::mem_fun (*this, &EditorRoutes::show_all_routes)));
 550         items.push_back (MenuElem (_("Hide All"), sigc::mem_fun (*this, &EditorRoutes::hide_all_routes)));
 551         items.push_back (MenuElem (_("Show All Audio Tracks"), sigc::mem_fun (*this, &EditorRoutes::show_all_audiotracks)));
 552         items.push_back (MenuElem (_("Hide All Audio Tracks"), sigc::mem_fun (*this, &EditorRoutes::hide_all_audiotracks)));
 553         items.push_back (MenuElem (_("Show All Audio Busses"), sigc::mem_fun (*this, &EditorRoutes::show_all_audiobus)));
 554         items.push_back (MenuElem (_("Hide All Audio Busses"), sigc::mem_fun (*this, &EditorRoutes::hide_all_audiobus)));
 555         items.push_back (MenuElem (_("Show All Midi Tracks"), sigc::mem_fun (*this, &EditorRoutes::show_all_miditracks)));
 556         items.push_back (MenuElem (_("Hide All Midi Tracks"), sigc::mem_fun (*this, &EditorRoutes::hide_all_miditracks)));
 557         items.push_back (MenuElem (_("Only Show Tracks with Regions Under Playhead"), sigc::mem_fun (*this, &EditorRoutes::show_tracks_with_regions_at_playhead)));
 558 }
 559
 560 void
 561 EditorRoutes::show_menu ()
 562 {
 563         if (_menu == 0) {
 564                 build_menu ();
 565         }
 566
 567         _menu->popup (1, gtk_get_current_event_time());
 568 }
 569
 570 void
 571 EditorRoutes::redisplay_real ()
 572 {
 573         TreeModel::Children rows = _model->children();
 574         TreeModel::Children::iterator i;
 575         uint32_t position;
 576
 577         /* n will be the count of tracks plus children (updated by TimeAxisView::show_at),
 578          * so we will use that to know where to put things.
 579          */
 580         int n;
 581
 582         for (n = 0, position = 0, i = rows.begin(); i != rows.end(); ++i) {
 583                 TimeAxisView *tv = (*i)[_columns.tv];
 584                 boost::shared_ptr<Stripable> route = (*i)[_columns.stripable];
 585
 586                 if (tv == 0) {
 587                         // just a "title" row
 588                         continue;
 589                 }
 590
 591                 bool visible = tv->marked_for_display ();
 592
 593                 /* show or hide the TimeAxisView */
 594                 if (visible) {
 595                         position += tv->show_at (position, n, &_editor->edit_controls_vbox);
 596                 } else {
 597                         tv->hide ();
 598                 }
 599
 600                 n++;
 601         }
 602
 603         /* whenever we go idle, update the track view list to reflect the new order.
 604          * we can't do this here, because we could mess up something that is traversing
 605          * the track order and has caused a redisplay of the list.
 606          */
 607         Glib::signal_idle().connect (sigc::mem_fun (*_editor, &Editor::sync_track_view_list_and_routes));
 608
 609         _editor->reset_controls_layout_height (position);
 610         _editor->reset_controls_layout_width ();
 611         _editor->_full_canvas_height = position;
 612
 613         if ((_editor->vertical_adjustment.get_value() + _editor->_visible_canvas_height) > _editor->vertical_adjustment.get_upper()) {
 614                 /*
 615                  * We're increasing the size of the canvas while the bottom is visible.
 616                  * We scroll down to keep in step with the controls layout.
 617                  */
 618                 _editor->vertical_adjustment.set_value (_editor->_full_canvas_height - _editor->_visible_canvas_height);
 619         }
 620 }
 621
 622 void
 623 EditorRoutes::redisplay ()
 624 {
 625         if (!_session || _session->deletion_in_progress()) {
 626                 return;
 627         }
 628
 629         if (_no_redisplay) {
 630                 _redisplay_on_resume = true;
 631                 return;
 632         }
 633
 634         // model deprecated g_atomic_int_exchange_and_add(, 1)
 635         g_atomic_int_inc(const_cast<gint*>(&_redisplay_active));
 636         if (!g_atomic_int_compare_and_exchange (const_cast<gint*>(&_redisplay_active), 1, 1)) {
 637                 /* recursive re-display can happen if redisplay shows/hides a TrackView
 638                  * which has children and their display status changes as result.
 639                  */
 640                 return;
 641         }
 642
 643         redisplay_real ();
 644
 645         while (!g_atomic_int_compare_and_exchange (const_cast<gint*>(&_redisplay_active), 1, 0)) {
 646                 g_atomic_int_set(const_cast<gint*>(&_redisplay_active), 1);
 647                 redisplay_real ();
 648         }
 649 }
 650
 651 void
 652 EditorRoutes::row_deleted (Gtk::TreeModel::Path const &)
 653 {
 654         if (!_session || _session->deletion_in_progress()) {
 655                 return;
 656         }
 657         /* this happens as the second step of a DnD within the treeview, and
 658          * when a route is actually removed. we don't differentiate between
 659          * the two cases.
 660          *
 661          * note that the sync_presentation_info_from_treeview() step may not
 662          * actually change any presentation info (e.g. the last track may be
 663          * removed, so all other tracks keep the same presentation info), which
 664          * means that no redisplay would happen. so we have to force a
 665          * redisplay.
 666          */
 667
 668         DEBUG_TRACE (DEBUG::OrderKeys, "editor routes treeview row deleted\n");
 669
 670         DisplaySuspender ds;
 671         sync_presentation_info_from_treeview ();
 672 }
 673
 674 void
 675 EditorRoutes::reordered (TreeModel::Path const &, TreeModel::iterator const &, int* /*what*/)
 676 {
 677         /* reordering implies that RID's will change, so
 678            sync_presentation_info_from_treeview() will cause a redisplay.
 679         */
 680
 681         DEBUG_TRACE (DEBUG::OrderKeys, "editor routes treeview reordered\n");
 682         sync_presentation_info_from_treeview ();
 683 }
 684
 685 void
 686 EditorRoutes::visible_changed (std::string const & path)
 687 {
 688         if (_session && _session->deletion_in_progress()) {
 689                 return;
 690         }
 691
 692         DisplaySuspender ds;
 693         TreeIter iter;
 694
 695         if ((iter = _model->get_iter (path))) {
 696                 TimeAxisView* tv = (*iter)[_columns.tv];
 697                 if (tv) {
 698                         bool visible = (*iter)[_columns.visible];
 699
 700                         if (tv->set_marked_for_display (!visible)) {
 701                                 update_visibility ();
 702                         }
 703                 }
 704         }
 705 }
 706
 707 void
 708 EditorRoutes::active_changed (std::string const & path)
 709 {
 710         if (_session && _session->deletion_in_progress ()) {
 711                 return;
 712         }
 713
 714         Gtk::TreeModel::Row row = *_model->get_iter (path);
 715         boost::shared_ptr<Stripable> stripable = row[_columns.stripable];
 716         boost::shared_ptr<Route> route = boost::dynamic_pointer_cast<Route> (stripable);
 717         if (route) {
 718                 bool const active = row[_columns.active];
 719                 route->set_active (!active, this);
 720         }
 721 }
 722
 723 void
 724 EditorRoutes::time_axis_views_added (list<TimeAxisView*> tavs)
 725 {
 726         PBD::Unwinder<bool> at (_adding_routes, true);
 727         bool from_scratch = (_model->children().size() == 0);
 728         Gtk::TreeModel::Children::iterator insert_iter = _model->children().end();
 729
 730         for (Gtk::TreeModel::Children::iterator it = _model->children().begin(); it != _model->children().end(); ++it) {
 731
 732                 boost::shared_ptr<Stripable> r = (*it)[_columns.stripable];
 733
 734                 if (r->presentation_info().order() == (tavs.front()->stripable()->presentation_info().order() + tavs.size())) {
 735                         insert_iter = it;
 736                         break;
 737                 }
 738         }
 739
 740         _display.set_model (Glib::RefPtr<ListStore>());
 741
 742         for (list<TimeAxisView*>::iterator x = tavs.begin(); x != tavs.end(); ++x) {
 743
 744                 VCATimeAxisView* vtav = dynamic_cast<VCATimeAxisView*> (*x);
 745                 RouteTimeAxisView* rtav = dynamic_cast<RouteTimeAxisView*> (*x);
 746
 747                 TreeModel::Row row = *(_model->insert (insert_iter));
 748
 749                 boost::shared_ptr<Stripable> stripable;
 750                 boost::shared_ptr<MidiTrack> midi_trk;
 751
 752                 if (vtav) {
 753
 754                         stripable = vtav->vca();
 755
 756                         row[_columns.is_track] = false;
 757                         row[_columns.is_input_active] = false;
 758                         row[_columns.is_midi] = false;
 759
 760                 } else if (rtav) {
 761
 762                         stripable = rtav->route ();
 763                         midi_trk= boost::dynamic_pointer_cast<MidiTrack> (stripable);
 764
 765                         row[_columns.is_track] = (boost::dynamic_pointer_cast<Track> (stripable) != 0);
 766
 767
 768                         if (midi_trk) {
 769                                 row[_columns.is_input_active] = midi_trk->input_active ();
 770                                 row[_columns.is_midi] = true;
 771                         } else {
 772                                 row[_columns.is_input_active] = false;
 773                                 row[_columns.is_midi] = false;
 774                         }
 775                 }
 776
 777                 if (!stripable) {
 778                         continue;
 779                 }
 780
 781                 row[_columns.text] = stripable->name();
 782                 row[_columns.visible] = (*x)->marked_for_display();
 783                 row[_columns.active] = true;
 784                 row[_columns.tv] = *x;
 785                 row[_columns.stripable] = stripable;
 786                 row[_columns.mute_state] = RouteUI::mute_active_state (_session, stripable);
 787                 row[_columns.solo_state] = RouteUI::solo_active_state (stripable);
 788                 row[_columns.solo_visible] = true;
 789                 row[_columns.solo_isolate_state] = RouteUI::solo_isolate_active_state (stripable);
 790                 row[_columns.solo_safe_state] = RouteUI::solo_safe_active_state (stripable);
 791                 row[_columns.name_editable] = true;
 792
 793                 boost::weak_ptr<Stripable> ws (stripable);
 794
 795                 /* for now, we need both of these. PropertyChanged covers on
 796                  * pre-defined, "global" things of interest to a
 797                  * UI. gui_changed covers arbitrary, un-enumerated, un-typed
 798                  * changes that may only be of interest to a particular
 799                  * UI (e.g. track-height is not of any relevant to OSC)
 800                  */
 801
 802                 stripable->gui_changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::handle_gui_changes, this, _1, _2), gui_context());
 803                 stripable->PropertyChanged.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::route_property_changed, this, _1, ws), gui_context());
 804
 805                 if (boost::dynamic_pointer_cast<Track> (stripable)) {
 806                         boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (stripable);
 807                         t->rec_enable_control()->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_rec_display, this), gui_context());
 808                         t->rec_safe_control()->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_rec_display, this), gui_context());
 809                 }
 810
 811                 if (midi_trk) {
 812                         midi_trk->StepEditStatusChange.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_rec_display, this), gui_context());
 813                         midi_trk->InputActiveChanged.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_input_active_display, this), gui_context());
 814                 }
 815
 816                 boost::shared_ptr<AutomationControl> ac;
 817
 818                 if ((ac = stripable->mute_control()) != 0) {
 819                         ac->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_mute_display, this), gui_context());
 820                 }
 821                 if ((ac = stripable->solo_control()) != 0) {
 822                         ac->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_solo_display, this), gui_context());
 823                 }
 824                 if ((ac = stripable->solo_isolate_control()) != 0) {
 825                         ac->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_solo_isolate_display, this), gui_context());
 826                 }
 827                 if ((ac = stripable->solo_safe_control()) != 0) {
 828                         ac->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_solo_safe_display, this), gui_context());
 829                 }
 830
 831                 if (rtav) {
 832                         rtav->route()->active_changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_active_display, this), gui_context ());
 833                 }
 834         }
 835
 836         update_rec_display ();
 837         update_mute_display ();
 838         update_solo_display ();
 839         update_solo_isolate_display ();
 840         update_solo_safe_display ();
 841         update_input_active_display ();
 842         update_active_display ();
 843
 844         _display.set_model (_model);
 845
 846         /* now update route order keys from the treeview/track display order */
 847
 848         if (!from_scratch) {
 849                 sync_presentation_info_from_treeview ();
 850         }
 851
 852         redisplay ();
 853 }
 854
 855 void
 856 EditorRoutes::handle_gui_changes (string const & what, void*)
 857 {
 858         if (_adding_routes) {
 859                 return;
 860         }
 861
 862         if (what == "track_height") {
 863                 /* Optional :make tracks change height while it happens, instead
 864                    of on first-idle
 865                 */
 866                 redisplay ();
 867         }
 868
 869         if (what == "visible_tracks") {
 870                 redisplay ();
 871         }
 872 }
 873
 874 void
 875 EditorRoutes::route_removed (TimeAxisView *tv)
 876 {
 877         ENSURE_GUI_THREAD (*this, &EditorRoutes::route_removed, tv)
 878
 879         TreeModel::Children rows = _model->children();
 880         TreeModel::Children::iterator ri;
 881
 882         for (ri = rows.begin(); ri != rows.end(); ++ri) {
 883                 if ((*ri)[_columns.tv] == tv) {
 884                         PBD::Unwinder<bool> uw (_route_deletion_in_progress, true);
 885                         _model->erase (ri);
 886                         break;
 887                 }
 888         }
 889
 890         /* the deleted signal for the treeview/model will take
 891            care of any updates.
 892         */
 893 }
 894
 895 void
 896 EditorRoutes::route_property_changed (const PropertyChange& what_changed, boost::weak_ptr<Stripable> s)
 897 {
 898         if (_adding_routes) {
 899                 return;
 900         }
 901
 902         if (what_changed.contains (ARDOUR::Properties::name)) {
 903
 904                 boost::shared_ptr<Stripable> stripable = s.lock ();
 905
 906                 if (!stripable) {
 907                         return;
 908                 }
 909
 910                 TreeModel::Children rows = _model->children();
 911                 TreeModel::Children::iterator i;
 912
 913                 for (i = rows.begin(); i != rows.end(); ++i) {
 914                         boost::shared_ptr<Stripable> ss = (*i)[_columns.stripable];
 915                         if (ss == stripable) {
 916                                 (*i)[_columns.text] = stripable->name();
 917                                 break;
 918                         }
 919                 }
 920         }
 921 }
 922
 923 void
 924 EditorRoutes::update_active_display ()
 925 {
 926         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
 927                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
 928         }
 929 }
 930
 931 void
 932 EditorRoutes::update_visibility ()
 933 {
 934         TreeModel::Children rows = _model->children();
 935         TreeModel::Children::iterator i;
 936
 937         DisplaySuspender ds;
 938
 939         for (i = rows.begin(); i != rows.end(); ++i) {
 940                 TimeAxisView *tv = (*i)[_columns.tv];
 941                 (*i)[_columns.visible] = tv->marked_for_display ();
 942         }
 943
 944         /* force route order keys catch up with visibility changes
 945          */
 946
 947         sync_presentation_info_from_treeview ();
 948 }
 949
 950 void
 951 EditorRoutes::hide_track_in_display (TimeAxisView& tv)
 952 {
 953         TreeModel::Children rows = _model->children();
 954         TreeModel::Children::iterator i;
 955
 956         for (i = rows.begin(); i != rows.end(); ++i) {
 957                 if ((*i)[_columns.tv] == &tv) {
 958                         tv.set_marked_for_display (false);
 959                         (*i)[_columns.visible] = false;
 960                         redisplay ();
 961                         break;
 962                 }
 963         }
 964 }
 965
 966 void
 967 EditorRoutes::show_track_in_display (TimeAxisView& tv)
 968 {
 969         TreeModel::Children rows = _model->children();
 970         TreeModel::Children::iterator i;
 971
 972
 973         for (i = rows.begin(); i != rows.end(); ++i) {
 974                 if ((*i)[_columns.tv] == &tv) {
 975                         tv.set_marked_for_display (true);
 976                         (*i)[_columns.visible] = true;
 977                         redisplay ();
 978                         break;
 979                 }
 980         }
 981 }
 982
 983 void
 984 EditorRoutes::sync_presentation_info_from_treeview ()
 985 {
 986         if (_ignore_reorder || !_session || _session->deletion_in_progress()) {
 987                 return;
 988         }
 989
 990         TreeModel::Children rows = _model->children();
 991
 992         if (rows.empty()) {
 993                 return;
 994         }
 995
 996         DEBUG_TRACE (DEBUG::OrderKeys, "editor sync presentation info from treeview\n");
 997
 998         TreeModel::Children::iterator ri;
 999         bool change = false;
1000         PresentationInfo::order_t order = 0;
1001
1002         for (ri = rows.begin(); ri != rows.end(); ++ri) {
1003
1004                 boost::shared_ptr<Stripable> stripable = (*ri)[_columns.stripable];
1005                 bool visible = (*ri)[_columns.visible];
1006
1007                 /* Monitor and Auditioner do not get their presentation
1008                  * info reset here.
1009                  */
1010
1011                 if (stripable->is_monitor() || stripable->is_auditioner()) {
1012                         continue;
1013                 }
1014
1015                 stripable->presentation_info().set_hidden (!visible);
1016
1017                 if (order != stripable->presentation_info().order()) {
1018                         stripable->set_presentation_order_explicit (order);
1019                         change = true;
1020                 }
1021
1022                 ++order;
1023         }
1024
1025         if (change) {
1026                 DEBUG_TRACE (DEBUG::OrderKeys, "... notify PI change from editor GUI\n");
1027                 _session->notify_presentation_info_change ();
1028         }
1029 }
1030
1031 void
1032 EditorRoutes::sync_treeview_from_presentation_info ()
1033 {
1034         /* Some route order key(s) have been changed, make sure that
1035            we update out tree/list model and GUI to reflect the change.
1036         */
1037
1038         if (_ignore_reorder || !_session || _session->deletion_in_progress()) {
1039                 return;
1040         }
1041
1042         DEBUG_TRACE (DEBUG::OrderKeys, "editor sync model from presentation info.\n");
1043
1044         vector<int> neworder;
1045         TreeModel::Children rows = _model->children();
1046         uint32_t old_order = 0;
1047         bool changed = false;
1048
1049         if (rows.empty()) {
1050                 return;
1051         }
1052
1053         OrderingKeys sorted;
1054
1055         for (TreeModel::Children::iterator ri = rows.begin(); ri != rows.end(); ++ri, ++old_order) {
1056                 boost::shared_ptr<Stripable> stripable = (*ri)[_columns.stripable];
1057                 /* use global order */
1058                 sorted.push_back (OrderKeys (old_order, stripable->presentation_info().order()));
1059         }
1060
1061         SortByNewDisplayOrder cmp;
1062
1063         sort (sorted.begin(), sorted.end(), cmp);
1064         neworder.assign (sorted.size(), 0);
1065
1066         uint32_t n = 0;
1067
1068         for (OrderingKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
1069
1070                 neworder[n] = sr->old_display_order;
1071
1072                 if (sr->old_display_order != n) {
1073                         changed = true;
1074                 }
1075         }
1076
1077         if (changed) {
1078                 Unwinder<bool> uw (_ignore_reorder, true);
1079                 _model->reorder (neworder);
1080         }
1081
1082         redisplay ();
1083 }
1084
1085 void
1086 EditorRoutes::hide_all_tracks (bool /*with_select*/)
1087 {
1088         TreeModel::Children rows = _model->children();
1089         TreeModel::Children::iterator i;
1090
1091         DisplaySuspender ds;
1092
1093         for (i = rows.begin(); i != rows.end(); ++i) {
1094
1095                 TreeModel::Row row = (*i);
1096                 TimeAxisView *tv = row[_columns.tv];
1097
1098                 if (tv == 0) {
1099                         continue;
1100                 }
1101
1102                 row[_columns.visible] = false;
1103         }
1104 }
1105
1106 void
1107 EditorRoutes::set_all_tracks_visibility (bool yn)
1108 {
1109         TreeModel::Children rows = _model->children();
1110         TreeModel::Children::iterator i;
1111
1112         DisplaySuspender ds;
1113
1114         for (i = rows.begin(); i != rows.end(); ++i) {
1115
1116                 TreeModel::Row row = (*i);
1117                 TimeAxisView* tv = row[_columns.tv];
1118
1119                 if (tv == 0) {
1120                         continue;
1121                 }
1122
1123                 tv->set_marked_for_display (yn);
1124                 (*i)[_columns.visible] = yn;
1125         }
1126
1127         /* force route order keys catch up with visibility changes
1128          */
1129
1130         sync_presentation_info_from_treeview ();
1131 }
1132
1133 void
1134 EditorRoutes::set_all_audio_midi_visibility (int tracks, bool yn)
1135 {
1136         TreeModel::Children rows = _model->children();
1137         TreeModel::Children::iterator i;
1138
1139         DisplaySuspender ds;
1140
1141         for (i = rows.begin(); i != rows.end(); ++i) {
1142
1143                 TreeModel::Row row = (*i);
1144                 TimeAxisView* tv = row[_columns.tv];
1145
1146                 AudioTimeAxisView* atv;
1147                 MidiTimeAxisView* mtv;
1148
1149                 if (tv == 0) {
1150                         continue;
1151                 }
1152
1153                 if ((atv = dynamic_cast<AudioTimeAxisView*>(tv)) != 0) {
1154                         switch (tracks) {
1155                         case 0:
1156                                 atv->set_marked_for_display (yn);
1157                                 (*i)[_columns.visible] = yn;
1158                                 break;
1159
1160                         case 1:
1161                                 if (atv->is_audio_track()) {
1162                                         atv->set_marked_for_display (yn);
1163                                         (*i)[_columns.visible] = yn;
1164                                 }
1165                                 break;
1166
1167                         case 2:
1168                                 if (!atv->is_audio_track()) {
1169                                         atv->set_marked_for_display (yn);
1170                                         (*i)[_columns.visible] = yn;
1171                                 }
1172                                 break;
1173                         }
1174                 }
1175                 else if ((mtv = dynamic_cast<MidiTimeAxisView*>(tv)) != 0) {
1176                         switch (tracks) {
1177                         case 0:
1178                                 mtv->set_marked_for_display (yn);
1179                                 (*i)[_columns.visible] = yn;
1180                                 break;
1181
1182                         case 3:
1183                                 if (mtv->is_midi_track()) {
1184                                         mtv->set_marked_for_display (yn);
1185                                         (*i)[_columns.visible] = yn;
1186                                 }
1187                                 break;
1188                         }
1189                 }
1190         }
1191
1192         /* force route order keys catch up with visibility changes
1193          */
1194
1195         sync_presentation_info_from_treeview ();
1196 }
1197
1198 void
1199 EditorRoutes::hide_all_routes ()
1200 {
1201         set_all_tracks_visibility (false);
1202 }
1203
1204 void
1205 EditorRoutes::show_all_routes ()
1206 {
1207         set_all_tracks_visibility (true);
1208 }
1209
1210 void
1211 EditorRoutes::show_all_audiotracks()
1212 {
1213         set_all_audio_midi_visibility (1, true);
1214 }
1215 void
1216 EditorRoutes::hide_all_audiotracks ()
1217 {
1218         set_all_audio_midi_visibility (1, false);
1219 }
1220
1221 void
1222 EditorRoutes::show_all_audiobus ()
1223 {
1224         set_all_audio_midi_visibility (2, true);
1225 }
1226 void
1227 EditorRoutes::hide_all_audiobus ()
1228 {
1229         set_all_audio_midi_visibility (2, false);
1230 }
1231
1232 void
1233 EditorRoutes::show_all_miditracks()
1234 {
1235         set_all_audio_midi_visibility (3, true);
1236 }
1237 void
1238 EditorRoutes::hide_all_miditracks ()
1239 {
1240         set_all_audio_midi_visibility (3, false);
1241 }
1242
1243 bool
1244 EditorRoutes::key_press (GdkEventKey* ev)
1245 {
1246         TreeViewColumn *col;
1247         boost::shared_ptr<RouteList> rl (new RouteList);
1248         TreePath path;
1249
1250         switch (ev->keyval) {
1251                 case GDK_Tab:
1252                 case GDK_ISO_Left_Tab:
1253
1254                         /* If we appear to be editing something, leave that cleanly and appropriately. */
1255                         if (name_editable) {
1256                                 name_editable->editing_done ();
1257                                 name_editable = 0;
1258                         }
1259
1260                         col = _display.get_column (_name_column); // select&focus on name column
1261
1262                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
1263                                 treeview_select_previous (_display, _model, col);
1264                         } else {
1265                                 treeview_select_next (_display, _model, col);
1266                         }
1267
1268                         return true;
1269                         break;
1270
1271                 case 'm':
1272                         if (get_relevant_routes (rl)) {
1273                                 _session->set_controls (route_list_to_control_list (rl, &Stripable::mute_control), rl->front()->muted() ? 0.0 : 1.0, Controllable::NoGroup);
1274                         }
1275                         return true;
1276                         break;
1277
1278                 case 's':
1279                         if (get_relevant_routes (rl)) {
1280                                 _session->set_controls (route_list_to_control_list (rl, &Stripable::solo_control), rl->front()->self_soloed() ? 0.0 : 1.0, Controllable::NoGroup);
1281                         }
1282                         return true;
1283                         break;
1284
1285                 case 'r':
1286                         if (get_relevant_routes (rl)) {
1287                                 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
1288                                         boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*r);
1289                                         if (t) {
1290                                                 _session->set_controls (route_list_to_control_list (rl, &Stripable::rec_enable_control), !t->rec_enable_control()->get_value(), Controllable::NoGroup);
1291                                                 break;
1292                                         }
1293                                 }
1294                         }
1295                         break;
1296
1297                 default:
1298                         break;
1299         }
1300
1301         return false;
1302 }
1303
1304 bool
1305 EditorRoutes::get_relevant_routes (boost::shared_ptr<RouteList> rl)
1306 {
1307         TimeAxisView* tv;
1308         RouteTimeAxisView* rtv;
1309         RefPtr<TreeSelection> selection = _display.get_selection();
1310         TreePath path;
1311         TreeIter iter;
1312
1313         if (selection->count_selected_rows() != 0) {
1314
1315                 /* use selection */
1316
1317                 RefPtr<TreeModel> tm = RefPtr<TreeModel>::cast_dynamic (_model);
1318                 iter = selection->get_selected (tm);
1319
1320         } else {
1321                 /* use mouse pointer */
1322
1323                 int x, y;
1324                 int bx, by;
1325
1326                 _display.get_pointer (x, y);
1327                 _display.convert_widget_to_bin_window_coords (x, y, bx, by);
1328
1329                 if (_display.get_path_at_pos (bx, by, path)) {
1330                         iter = _model->get_iter (path);
1331                 }
1332         }
1333
1334         if (iter) {
1335                 tv = (*iter)[_columns.tv];
1336                 if (tv) {
1337                         rtv = dynamic_cast<RouteTimeAxisView*>(tv);
1338                         if (rtv) {
1339                                 rl->push_back (rtv->route());
1340                         }
1341                 }
1342         }
1343
1344         return !rl->empty();
1345 }
1346
1347 bool
1348 EditorRoutes::button_press (GdkEventButton* ev)
1349 {
1350         if (Keyboard::is_context_menu_event (ev)) {
1351                 show_menu ();
1352                 return true;
1353         }
1354
1355         TreeModel::Path path;
1356         TreeViewColumn *tvc;
1357         int cell_x;
1358         int cell_y;
1359
1360         if (!_display.get_path_at_pos ((int) ev->x, (int) ev->y, path, tvc, cell_x, cell_y)) {
1361                 /* cancel selection */
1362                 _display.get_selection()->unselect_all ();
1363                 /* end any editing by grabbing focus */
1364                 _display.grab_focus ();
1365                 return true;
1366         }
1367
1368         //Scroll editor canvas to selected track
1369         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1370
1371                 Gtk::TreeModel::Row row = *_model->get_iter (path);
1372                 TimeAxisView *tv = row[_columns.tv];
1373
1374                 if (tv) {
1375                         _editor->ensure_time_axis_view_is_visible (*tv, true);
1376                 }
1377         }
1378
1379         return false;
1380 }
1381
1382 void
1383 EditorRoutes::selection_changed ()
1384 {
1385         _editor->begin_reversible_selection_op (X_("Select Track from Route List"));
1386
1387         if (_display.get_selection()->count_selected_rows() > 0) {
1388
1389                 TreeIter iter;
1390                 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
1391                 TrackViewList selected;
1392
1393                 _editor->get_selection().clear_regions ();
1394
1395                 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
1396
1397                         if ((iter = _model->get_iter (*i))) {
1398
1399                                 TimeAxisView* tv = (*iter)[_columns.tv];
1400                                 selected.push_back (tv);
1401                         }
1402
1403                 }
1404
1405                 _editor->get_selection().set (selected);
1406                 _editor->ensure_time_axis_view_is_visible (*(selected.front()), true);
1407
1408         } else {
1409                 _editor->get_selection().clear_tracks ();
1410         }
1411
1412         _editor->commit_reversible_selection_op ();
1413 }
1414
1415 bool
1416 EditorRoutes::selection_filter (Glib::RefPtr<TreeModel> const &, TreeModel::Path const&, bool /*selected*/)
1417 {
1418         if (selection_countdown) {
1419                 if (--selection_countdown == 0) {
1420                         return true;
1421                 } else {
1422                         /* no selection yet ... */
1423                         return false;
1424                 }
1425         }
1426         return true;
1427 }
1428
1429 struct PresentationInfoRouteSorter
1430 {
1431         bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
1432                 if (a->is_master()) {
1433                         /* master before everything else */
1434                         return true;
1435                 } else if (b->is_master()) {
1436                         /* everything else before master */
1437                         return false;
1438                 }
1439                 return a->presentation_info().order () < b->presentation_info().order ();
1440         }
1441 };
1442
1443 struct PresentationInfoVCASorter
1444 {
1445         bool operator() (boost::shared_ptr<VCA> a, boost::shared_ptr<VCA> b) {
1446                 return a->presentation_info().order () < b->presentation_info().order ();
1447         }
1448 };
1449
1450 void
1451 EditorRoutes::initial_display ()
1452 {
1453         DisplaySuspender ds;
1454         _model->clear ();
1455
1456         if (!_session) {
1457                 return;
1458         }
1459
1460         StripableList s;
1461
1462         RouteList r (*_session->get_routes());
1463         for (RouteList::iterator ri = r.begin(); ri != r.end(); ++ri) {
1464                 s.push_back (*ri);
1465         }
1466
1467         VCAList v (_session->vca_manager().vcas());
1468         for (VCAList::iterator vi = v.begin(); vi != v.end(); ++vi) {
1469                 s.push_back (*vi);
1470         }
1471
1472         _editor->add_stripables (s);
1473 }
1474
1475 void
1476 EditorRoutes::display_drag_data_received (const RefPtr<Gdk::DragContext>& context,
1477                                              int x, int y,
1478                                              const SelectionData& data,
1479                                              guint info, guint time)
1480 {
1481         if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1482                 _display.on_drag_data_received (context, x, y, data, info, time);
1483                 return;
1484         }
1485
1486         context->drag_finish (true, false, time);
1487 }
1488
1489 struct ViewStripable {
1490         TimeAxisView* tav;
1491         boost::shared_ptr<Stripable> stripable;
1492         uint32_t old_order;
1493
1494         ViewStripable (TimeAxisView* t, boost::shared_ptr<Stripable> s, uint32_t n)
1495                 : tav (t), stripable (s), old_order (n) {}
1496 };
1497
1498 void
1499 EditorRoutes::move_selected_tracks (bool up)
1500 {
1501         if (_editor->selection->tracks.empty()) {
1502                 return;
1503         }
1504
1505         std::list<ViewStripable> view_stripables;
1506         std::vector<int> neworder;
1507         TreeModel::Children rows = _model->children();
1508         TreeModel::Children::iterator ri;
1509         TreeModel::Children::size_type n;
1510
1511         for (n = 0, ri = rows.begin(); ri != rows.end(); ++ri, ++n) {
1512                 TimeAxisView* tv = (*ri)[_columns.tv];
1513                 boost::shared_ptr<Stripable> stripable = (*ri)[_columns.stripable];
1514                 view_stripables.push_back (ViewStripable (tv, stripable, n));
1515         }
1516
1517         list<ViewStripable>::iterator trailing;
1518         list<ViewStripable>::iterator leading;
1519
1520         if (up) {
1521
1522                 trailing = view_stripables.begin();
1523                 leading = view_stripables.begin();
1524
1525                 ++leading;
1526
1527                 while (leading != view_stripables.end()) {
1528                         if (_editor->selection->selected (leading->tav)) {
1529                                 view_stripables.insert (trailing, ViewStripable (*leading));
1530                                 leading = view_stripables.erase (leading);
1531                         } else {
1532                                 ++leading;
1533                                 ++trailing;
1534                         }
1535                 }
1536
1537         } else {
1538
1539                 /* if we could use reverse_iterator in list::insert, this code
1540                    would be a beautiful reflection of the code above. but we can't
1541                    and so it looks like a bit of a mess.
1542                 */
1543
1544                 trailing = view_stripables.end();
1545                 leading = view_stripables.end();
1546
1547                 --leading; if (leading == view_stripables.begin()) { return; }
1548                 --leading;
1549                 --trailing;
1550
1551                 while (1) {
1552
1553                         if (_editor->selection->selected (leading->tav)) {
1554                                 list<ViewStripable>::iterator tmp;
1555
1556                                 /* need to insert *after* trailing, not *before* it,
1557                                    which is what insert (iter, val) normally does.
1558                                 */
1559
1560                                 tmp = trailing;
1561                                 tmp++;
1562
1563                                 view_stripables.insert (tmp, ViewStripable (*leading));
1564
1565                                 /* can't use iter = cont.erase (iter); form here, because
1566                                    we need iter to move backwards.
1567                                 */
1568
1569                                 tmp = leading;
1570                                 --tmp;
1571
1572                                 bool done = false;
1573
1574                                 if (leading == view_stripables.begin()) {
1575                                         /* the one we've just inserted somewhere else
1576                                            was the first in the list. erase this copy,
1577                                            and then break, because we're done.
1578                                         */
1579                                         done = true;
1580                                 }
1581
1582                                 view_stripables.erase (leading);
1583
1584                                 if (done) {
1585                                         break;
1586                                 }
1587
1588                                 leading = tmp;
1589
1590                         } else {
1591                                 if (leading == view_stripables.begin()) {
1592                                         break;
1593                                 }
1594                                 --leading;
1595                                 --trailing;
1596                         }
1597                 };
1598         }
1599
1600         for (leading = view_stripables.begin(); leading != view_stripables.end(); ++leading) {
1601                 neworder.push_back (leading->old_order);
1602 #ifndef NDEBUG
1603                 if (leading->old_order != neworder.size() - 1) {
1604                         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("move %1 to %2\n", leading->old_order, neworder.size() - 1));
1605                 }
1606 #endif
1607
1608         }
1609 #ifndef NDEBUG
1610         DEBUG_TRACE (DEBUG::OrderKeys, "New order after moving tracks:\n");
1611         for (vector<int>::iterator i = neworder.begin(); i != neworder.end(); ++i) {
1612                 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("\t%1\n", *i));
1613         }
1614         DEBUG_TRACE (DEBUG::OrderKeys, "-------\n");
1615 #endif
1616
1617
1618         _model->reorder (neworder);
1619 }
1620
1621 void
1622 EditorRoutes::update_input_active_display ()
1623 {
1624         TreeModel::Children rows = _model->children();
1625         TreeModel::Children::iterator i;
1626
1627         for (i = rows.begin(); i != rows.end(); ++i) {
1628                 boost::shared_ptr<Stripable> stripable = (*i)[_columns.stripable];
1629
1630                 if (boost::dynamic_pointer_cast<Track> (stripable)) {
1631                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (stripable);
1632
1633                         if (mt) {
1634                                 (*i)[_columns.is_input_active] = mt->input_active();
1635                         }
1636                 }
1637         }
1638 }
1639
1640 void
1641 EditorRoutes::update_rec_display ()
1642 {
1643         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
1644                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
1645         }
1646 }
1647
1648 bool
1649 EditorRoutes::idle_update_mute_rec_solo_etc()
1650 {
1651         g_atomic_int_set (const_cast<gint*>(&_queue_tv_update), 0);
1652         TreeModel::Children rows = _model->children();
1653         TreeModel::Children::iterator i;
1654
1655         for (i = rows.begin(); i != rows.end(); ++i) {
1656                 boost::shared_ptr<Stripable> stripable = (*i)[_columns.stripable];
1657                 boost::shared_ptr<Route> route = boost::dynamic_pointer_cast<Route> (stripable);
1658                 (*i)[_columns.mute_state] = RouteUI::mute_active_state (_session, stripable);
1659                 (*i)[_columns.solo_state] = RouteUI::solo_active_state (stripable);
1660                 (*i)[_columns.solo_isolate_state] = RouteUI::solo_isolate_active_state (stripable) ? 1 : 0;
1661                 (*i)[_columns.solo_safe_state] = RouteUI::solo_safe_active_state (stripable) ? 1 : 0;
1662                 if (route) {
1663                         (*i)[_columns.active] = route->active ();
1664                 } else {
1665                         (*i)[_columns.active] = true;
1666                 }
1667
1668                 boost::shared_ptr<Track> trk (boost::dynamic_pointer_cast<Track>(route));
1669
1670                 if (trk) {
1671                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (route);
1672
1673                         if (trk->rec_enable_control()->get_value()) {
1674                                 if (_session->record_status() == Session::Recording) {
1675                                         (*i)[_columns.rec_state] = 1;
1676                                 } else {
1677                                         (*i)[_columns.rec_state] = 2;
1678                                 }
1679                         } else if (mt && mt->step_editing()) {
1680                                 (*i)[_columns.rec_state] = 3;
1681                         } else {
1682                                 (*i)[_columns.rec_state] = 0;
1683                         }
1684
1685                         (*i)[_columns.rec_safe] = trk->rec_safe_control()->get_value();
1686                         (*i)[_columns.name_editable] = !trk->rec_enable_control()->get_value();
1687                 }
1688         }
1689
1690         return false; // do not call again (until needed)
1691 }
1692
1693
1694 void
1695 EditorRoutes::update_mute_display ()
1696 {
1697         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
1698                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
1699         }
1700 }
1701
1702 void
1703 EditorRoutes::update_solo_display ()
1704 {
1705         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
1706                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
1707         }
1708 }
1709
1710 void
1711 EditorRoutes::update_solo_isolate_display ()
1712 {
1713         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
1714                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
1715         }
1716 }
1717
1718 void
1719 EditorRoutes::update_solo_safe_display ()
1720 {
1721         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
1722                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
1723         }
1724 }
1725
1726 list<TimeAxisView*>
1727 EditorRoutes::views () const
1728 {
1729         list<TimeAxisView*> v;
1730         for (TreeModel::Children::iterator i = _model->children().begin(); i != _model->children().end(); ++i) {
1731                 v.push_back ((*i)[_columns.tv]);
1732         }
1733
1734         return v;
1735 }
1736
1737 void
1738 EditorRoutes::clear ()
1739 {
1740         _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1741         _model->clear ();
1742         _display.set_model (_model);
1743 }
1744
1745 void
1746 EditorRoutes::name_edit_started (CellEditable* ce, const Glib::ustring&)
1747 {
1748         name_editable = ce;
1749
1750         /* give it a special name */
1751
1752         Gtk::Entry *e = dynamic_cast<Gtk::Entry*> (ce);
1753
1754         if (e) {
1755                 e->set_name (X_("RouteNameEditorEntry"));
1756         }
1757 }
1758
1759 void
1760 EditorRoutes::name_edit (std::string const & path, std::string const & new_text)
1761 {
1762         name_editable = 0;
1763
1764         TreeIter iter = _model->get_iter (path);
1765
1766         if (!iter) {
1767                 return;
1768         }
1769
1770         boost::shared_ptr<Stripable> stripable = (*iter)[_columns.stripable];
1771
1772         if (stripable && stripable->name() != new_text) {
1773                 stripable->set_name (new_text);
1774         }
1775 }
1776
1777 void
1778 EditorRoutes::solo_changed_so_update_mute ()
1779 {
1780         update_mute_display ();
1781 }
1782
1783 void
1784 EditorRoutes::show_tracks_with_regions_at_playhead ()
1785 {
1786         boost::shared_ptr<RouteList> const r = _session->get_routes_with_regions_at (_session->transport_frame ());
1787
1788         set<TimeAxisView*> show;
1789         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
1790                 TimeAxisView* tav = _editor->axis_view_from_route (*i);
1791                 if (tav) {
1792                         show.insert (tav);
1793                 }
1794         }
1795
1796         DisplaySuspender ds;
1797
1798         TreeModel::Children rows = _model->children ();
1799         for (TreeModel::Children::iterator i = rows.begin(); i != rows.end(); ++i) {
1800                 TimeAxisView* tv = (*i)[_columns.tv];
1801                 bool to_show = (show.find (tv) != show.end());
1802
1803                 tv->set_marked_for_display (to_show);
1804                 (*i)[_columns.visible] = to_show;
1805         }
1806
1807         /* force route order keys catch up with visibility changes
1808          */
1809
1810         sync_presentation_info_from_treeview ();
1811 }
1812
1813 int
1814 EditorRoutes::plugin_setup (boost::shared_ptr<Route> r, boost::shared_ptr<PluginInsert> pi, ARDOUR::Route::PluginSetupOptions flags)
1815 {
1816         PluginSetupDialog psd (r, pi, flags);
1817         return psd.run ();
1818 }