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                 if (rtav) {
 796                         rtav->route()->gui_changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::handle_gui_changes, this, _1, _2), gui_context());
 797                 }
 798                 stripable->PropertyChanged.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::route_property_changed, this, _1, ws), gui_context());
 799
 800                 if (boost::dynamic_pointer_cast<Track> (stripable)) {
 801                         boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (stripable);
 802                         t->rec_enable_control()->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_rec_display, this), gui_context());
 803                         t->rec_safe_control()->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_rec_display, this), gui_context());
 804                 }
 805
 806                 if (midi_trk) {
 807                         midi_trk->StepEditStatusChange.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_rec_display, this), gui_context());
 808                         midi_trk->InputActiveChanged.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_input_active_display, this), gui_context());
 809                 }
 810
 811                 boost::shared_ptr<AutomationControl> ac;
 812
 813                 if ((ac = stripable->mute_control()) != 0) {
 814                         ac->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_mute_display, this), gui_context());
 815                 }
 816                 if ((ac = stripable->solo_control()) != 0) {
 817                         ac->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_solo_display, this), gui_context());
 818                 }
 819                 if ((ac = stripable->solo_isolate_control()) != 0) {
 820                         ac->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_solo_isolate_display, this), gui_context());
 821                 }
 822                 if ((ac = stripable->solo_safe_control()) != 0) {
 823                         ac->Changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_solo_safe_display, this), gui_context());
 824                 }
 825
 826                 if (rtav) {
 827                         rtav->route()->active_changed.connect (*this, MISSING_INVALIDATOR, boost::bind (&EditorRoutes::update_active_display, this), gui_context ());
 828                 }
 829         }
 830
 831         update_rec_display ();
 832         update_mute_display ();
 833         update_solo_display ();
 834         update_solo_isolate_display ();
 835         update_solo_safe_display ();
 836         update_input_active_display ();
 837         update_active_display ();
 838
 839         _display.set_model (_model);
 840
 841         /* now update route order keys from the treeview/track display order */
 842
 843         if (!from_scratch) {
 844                 sync_presentation_info_from_treeview ();
 845         }
 846
 847         redisplay ();
 848 }
 849
 850 void
 851 EditorRoutes::handle_gui_changes (string const & what, void*)
 852 {
 853         if (_adding_routes) {
 854                 return;
 855         }
 856
 857         if (what == "track_height") {
 858                 /* Optional :make tracks change height while it happens, instead
 859                    of on first-idle
 860                 */
 861                 redisplay ();
 862         }
 863
 864         if (what == "visible_tracks") {
 865                 redisplay ();
 866         }
 867 }
 868
 869 void
 870 EditorRoutes::route_removed (TimeAxisView *tv)
 871 {
 872         ENSURE_GUI_THREAD (*this, &EditorRoutes::route_removed, tv)
 873
 874         TreeModel::Children rows = _model->children();
 875         TreeModel::Children::iterator ri;
 876
 877         for (ri = rows.begin(); ri != rows.end(); ++ri) {
 878                 if ((*ri)[_columns.tv] == tv) {
 879                         PBD::Unwinder<bool> uw (_route_deletion_in_progress, true);
 880                         _model->erase (ri);
 881                         break;
 882                 }
 883         }
 884
 885         /* the deleted signal for the treeview/model will take
 886            care of any updates.
 887         */
 888 }
 889
 890 void
 891 EditorRoutes::route_property_changed (const PropertyChange& what_changed, boost::weak_ptr<Stripable> s)
 892 {
 893         if (!what_changed.contains (ARDOUR::Properties::name)) {
 894                 return;
 895         }
 896
 897         ENSURE_GUI_THREAD (*this, &EditorRoutes::route_name_changed, r)
 898
 899         boost::shared_ptr<Stripable> stripable = s.lock ();
 900
 901         if (!stripable) {
 902                 return;
 903         }
 904
 905         TreeModel::Children rows = _model->children();
 906         TreeModel::Children::iterator i;
 907
 908         for (i = rows.begin(); i != rows.end(); ++i) {
 909                 boost::shared_ptr<Stripable> ss = (*i)[_columns.stripable];
 910                 if (ss == stripable) {
 911                         (*i)[_columns.text] = stripable->name();
 912                         break;
 913                 }
 914         }
 915 }
 916
 917 void
 918 EditorRoutes::update_active_display ()
 919 {
 920         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
 921                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
 922         }
 923 }
 924
 925 void
 926 EditorRoutes::update_visibility ()
 927 {
 928         TreeModel::Children rows = _model->children();
 929         TreeModel::Children::iterator i;
 930
 931         DisplaySuspender ds;
 932
 933         for (i = rows.begin(); i != rows.end(); ++i) {
 934                 TimeAxisView *tv = (*i)[_columns.tv];
 935                 (*i)[_columns.visible] = tv->marked_for_display ();
 936         }
 937
 938         /* force route order keys catch up with visibility changes
 939          */
 940
 941         sync_presentation_info_from_treeview ();
 942 }
 943
 944 void
 945 EditorRoutes::hide_track_in_display (TimeAxisView& tv)
 946 {
 947         TreeModel::Children rows = _model->children();
 948         TreeModel::Children::iterator i;
 949
 950         for (i = rows.begin(); i != rows.end(); ++i) {
 951                 if ((*i)[_columns.tv] == &tv) {
 952                         tv.set_marked_for_display (false);
 953                         (*i)[_columns.visible] = false;
 954                         redisplay ();
 955                         break;
 956                 }
 957         }
 958 }
 959
 960 void
 961 EditorRoutes::show_track_in_display (TimeAxisView& tv)
 962 {
 963         TreeModel::Children rows = _model->children();
 964         TreeModel::Children::iterator i;
 965
 966
 967         for (i = rows.begin(); i != rows.end(); ++i) {
 968                 if ((*i)[_columns.tv] == &tv) {
 969                         tv.set_marked_for_display (true);
 970                         (*i)[_columns.visible] = true;
 971                         redisplay ();
 972                         break;
 973                 }
 974         }
 975 }
 976
 977 void
 978 EditorRoutes::sync_presentation_info_from_treeview ()
 979 {
 980         if (_ignore_reorder || !_session || _session->deletion_in_progress()) {
 981                 return;
 982         }
 983
 984         TreeModel::Children rows = _model->children();
 985
 986         if (rows.empty()) {
 987                 return;
 988         }
 989
 990         DEBUG_TRACE (DEBUG::OrderKeys, "editor sync presentation info from treeview\n");
 991
 992         TreeModel::Children::iterator ri;
 993         bool change = false;
 994         PresentationInfo::order_t order = 0;
 995
 996         for (ri = rows.begin(); ri != rows.end(); ++ri) {
 997
 998                 boost::shared_ptr<Stripable> stripable = (*ri)[_columns.stripable];
 999                 bool visible = (*ri)[_columns.visible];
1000
1001                 /* Monitor and Auditioner do not get their presentation
1002                  * info reset here.
1003                  */
1004
1005                 if (stripable->is_monitor() || stripable->is_auditioner()) {
1006                         continue;
1007                 }
1008
1009                 stripable->presentation_info().set_hidden (!visible);
1010
1011                 if (order != stripable->presentation_info().order()) {
1012                         stripable->set_presentation_order_explicit (order);
1013                         change = true;
1014                 }
1015
1016                 ++order;
1017         }
1018
1019         if (change) {
1020                 DEBUG_TRACE (DEBUG::OrderKeys, "... notify PI change from editor GUI\n");
1021                 _session->notify_presentation_info_change ();
1022         }
1023 }
1024
1025 void
1026 EditorRoutes::sync_treeview_from_presentation_info ()
1027 {
1028         /* Some route order key(s) have been changed, make sure that
1029            we update out tree/list model and GUI to reflect the change.
1030         */
1031
1032         if (_ignore_reorder || !_session || _session->deletion_in_progress()) {
1033                 return;
1034         }
1035
1036         DEBUG_TRACE (DEBUG::OrderKeys, "editor sync model from presentation info.\n");
1037
1038         vector<int> neworder;
1039         TreeModel::Children rows = _model->children();
1040         uint32_t old_order = 0;
1041         bool changed = false;
1042
1043         if (rows.empty()) {
1044                 return;
1045         }
1046
1047         OrderingKeys sorted;
1048
1049         for (TreeModel::Children::iterator ri = rows.begin(); ri != rows.end(); ++ri, ++old_order) {
1050                 boost::shared_ptr<Stripable> stripable = (*ri)[_columns.stripable];
1051                 /* use global order */
1052                 sorted.push_back (OrderKeys (old_order, stripable->presentation_info().order()));
1053         }
1054
1055         SortByNewDisplayOrder cmp;
1056
1057         sort (sorted.begin(), sorted.end(), cmp);
1058         neworder.assign (sorted.size(), 0);
1059
1060         uint32_t n = 0;
1061
1062         for (OrderingKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
1063
1064                 neworder[n] = sr->old_display_order;
1065
1066                 if (sr->old_display_order != n) {
1067                         changed = true;
1068                 }
1069         }
1070
1071         if (changed) {
1072                 Unwinder<bool> uw (_ignore_reorder, true);
1073                 _model->reorder (neworder);
1074         }
1075
1076         redisplay ();
1077 }
1078
1079 void
1080 EditorRoutes::hide_all_tracks (bool /*with_select*/)
1081 {
1082         TreeModel::Children rows = _model->children();
1083         TreeModel::Children::iterator i;
1084
1085         DisplaySuspender ds;
1086
1087         for (i = rows.begin(); i != rows.end(); ++i) {
1088
1089                 TreeModel::Row row = (*i);
1090                 TimeAxisView *tv = row[_columns.tv];
1091
1092                 if (tv == 0) {
1093                         continue;
1094                 }
1095
1096                 row[_columns.visible] = false;
1097         }
1098 }
1099
1100 void
1101 EditorRoutes::set_all_tracks_visibility (bool yn)
1102 {
1103         TreeModel::Children rows = _model->children();
1104         TreeModel::Children::iterator i;
1105
1106         DisplaySuspender ds;
1107
1108         for (i = rows.begin(); i != rows.end(); ++i) {
1109
1110                 TreeModel::Row row = (*i);
1111                 TimeAxisView* tv = row[_columns.tv];
1112
1113                 if (tv == 0) {
1114                         continue;
1115                 }
1116
1117                 tv->set_marked_for_display (yn);
1118                 (*i)[_columns.visible] = yn;
1119         }
1120
1121         /* force route order keys catch up with visibility changes
1122          */
1123
1124         sync_presentation_info_from_treeview ();
1125 }
1126
1127 void
1128 EditorRoutes::set_all_audio_midi_visibility (int tracks, bool yn)
1129 {
1130         TreeModel::Children rows = _model->children();
1131         TreeModel::Children::iterator i;
1132
1133         DisplaySuspender ds;
1134
1135         for (i = rows.begin(); i != rows.end(); ++i) {
1136
1137                 TreeModel::Row row = (*i);
1138                 TimeAxisView* tv = row[_columns.tv];
1139
1140                 AudioTimeAxisView* atv;
1141                 MidiTimeAxisView* mtv;
1142
1143                 if (tv == 0) {
1144                         continue;
1145                 }
1146
1147                 if ((atv = dynamic_cast<AudioTimeAxisView*>(tv)) != 0) {
1148                         switch (tracks) {
1149                         case 0:
1150                                 atv->set_marked_for_display (yn);
1151                                 (*i)[_columns.visible] = yn;
1152                                 break;
1153
1154                         case 1:
1155                                 if (atv->is_audio_track()) {
1156                                         atv->set_marked_for_display (yn);
1157                                         (*i)[_columns.visible] = yn;
1158                                 }
1159                                 break;
1160
1161                         case 2:
1162                                 if (!atv->is_audio_track()) {
1163                                         atv->set_marked_for_display (yn);
1164                                         (*i)[_columns.visible] = yn;
1165                                 }
1166                                 break;
1167                         }
1168                 }
1169                 else if ((mtv = dynamic_cast<MidiTimeAxisView*>(tv)) != 0) {
1170                         switch (tracks) {
1171                         case 0:
1172                                 mtv->set_marked_for_display (yn);
1173                                 (*i)[_columns.visible] = yn;
1174                                 break;
1175
1176                         case 3:
1177                                 if (mtv->is_midi_track()) {
1178                                         mtv->set_marked_for_display (yn);
1179                                         (*i)[_columns.visible] = yn;
1180                                 }
1181                                 break;
1182                         }
1183                 }
1184         }
1185
1186         /* force route order keys catch up with visibility changes
1187          */
1188
1189         sync_presentation_info_from_treeview ();
1190 }
1191
1192 void
1193 EditorRoutes::hide_all_routes ()
1194 {
1195         set_all_tracks_visibility (false);
1196 }
1197
1198 void
1199 EditorRoutes::show_all_routes ()
1200 {
1201         set_all_tracks_visibility (true);
1202 }
1203
1204 void
1205 EditorRoutes::show_all_audiotracks()
1206 {
1207         set_all_audio_midi_visibility (1, true);
1208 }
1209 void
1210 EditorRoutes::hide_all_audiotracks ()
1211 {
1212         set_all_audio_midi_visibility (1, false);
1213 }
1214
1215 void
1216 EditorRoutes::show_all_audiobus ()
1217 {
1218         set_all_audio_midi_visibility (2, true);
1219 }
1220 void
1221 EditorRoutes::hide_all_audiobus ()
1222 {
1223         set_all_audio_midi_visibility (2, false);
1224 }
1225
1226 void
1227 EditorRoutes::show_all_miditracks()
1228 {
1229         set_all_audio_midi_visibility (3, true);
1230 }
1231 void
1232 EditorRoutes::hide_all_miditracks ()
1233 {
1234         set_all_audio_midi_visibility (3, false);
1235 }
1236
1237 bool
1238 EditorRoutes::key_press (GdkEventKey* ev)
1239 {
1240         TreeViewColumn *col;
1241         boost::shared_ptr<RouteList> rl (new RouteList);
1242         TreePath path;
1243
1244         switch (ev->keyval) {
1245                 case GDK_Tab:
1246                 case GDK_ISO_Left_Tab:
1247
1248                         /* If we appear to be editing something, leave that cleanly and appropriately. */
1249                         if (name_editable) {
1250                                 name_editable->editing_done ();
1251                                 name_editable = 0;
1252                         }
1253
1254                         col = _display.get_column (_name_column); // select&focus on name column
1255
1256                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
1257                                 treeview_select_previous (_display, _model, col);
1258                         } else {
1259                                 treeview_select_next (_display, _model, col);
1260                         }
1261
1262                         return true;
1263                         break;
1264
1265                 case 'm':
1266                         if (get_relevant_routes (rl)) {
1267                                 _session->set_controls (route_list_to_control_list (rl, &Stripable::mute_control), rl->front()->muted() ? 0.0 : 1.0, Controllable::NoGroup);
1268                         }
1269                         return true;
1270                         break;
1271
1272                 case 's':
1273                         if (get_relevant_routes (rl)) {
1274                                 _session->set_controls (route_list_to_control_list (rl, &Stripable::solo_control), rl->front()->self_soloed() ? 0.0 : 1.0, Controllable::NoGroup);
1275                         }
1276                         return true;
1277                         break;
1278
1279                 case 'r':
1280                         if (get_relevant_routes (rl)) {
1281                                 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
1282                                         boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*r);
1283                                         if (t) {
1284                                                 _session->set_controls (route_list_to_control_list (rl, &Stripable::rec_enable_control), !t->rec_enable_control()->get_value(), Controllable::NoGroup);
1285                                                 break;
1286                                         }
1287                                 }
1288                         }
1289                         break;
1290
1291                 default:
1292                         break;
1293         }
1294
1295         return false;
1296 }
1297
1298 bool
1299 EditorRoutes::get_relevant_routes (boost::shared_ptr<RouteList> rl)
1300 {
1301         TimeAxisView* tv;
1302         RouteTimeAxisView* rtv;
1303         RefPtr<TreeSelection> selection = _display.get_selection();
1304         TreePath path;
1305         TreeIter iter;
1306
1307         if (selection->count_selected_rows() != 0) {
1308
1309                 /* use selection */
1310
1311                 RefPtr<TreeModel> tm = RefPtr<TreeModel>::cast_dynamic (_model);
1312                 iter = selection->get_selected (tm);
1313
1314         } else {
1315                 /* use mouse pointer */
1316
1317                 int x, y;
1318                 int bx, by;
1319
1320                 _display.get_pointer (x, y);
1321                 _display.convert_widget_to_bin_window_coords (x, y, bx, by);
1322
1323                 if (_display.get_path_at_pos (bx, by, path)) {
1324                         iter = _model->get_iter (path);
1325                 }
1326         }
1327
1328         if (iter) {
1329                 tv = (*iter)[_columns.tv];
1330                 if (tv) {
1331                         rtv = dynamic_cast<RouteTimeAxisView*>(tv);
1332                         if (rtv) {
1333                                 rl->push_back (rtv->route());
1334                         }
1335                 }
1336         }
1337
1338         return !rl->empty();
1339 }
1340
1341 bool
1342 EditorRoutes::button_press (GdkEventButton* ev)
1343 {
1344         if (Keyboard::is_context_menu_event (ev)) {
1345                 show_menu ();
1346                 return true;
1347         }
1348
1349         TreeModel::Path path;
1350         TreeViewColumn *tvc;
1351         int cell_x;
1352         int cell_y;
1353
1354         if (!_display.get_path_at_pos ((int) ev->x, (int) ev->y, path, tvc, cell_x, cell_y)) {
1355                 /* cancel selection */
1356                 _display.get_selection()->unselect_all ();
1357                 /* end any editing by grabbing focus */
1358                 _display.grab_focus ();
1359                 return true;
1360         }
1361
1362         //Scroll editor canvas to selected track
1363         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1364
1365                 Gtk::TreeModel::Row row = *_model->get_iter (path);
1366                 TimeAxisView *tv = row[_columns.tv];
1367
1368                 if (tv) {
1369                         _editor->ensure_time_axis_view_is_visible (*tv, true);
1370                 }
1371         }
1372
1373         return false;
1374 }
1375
1376 void
1377 EditorRoutes::selection_changed ()
1378 {
1379         _editor->begin_reversible_selection_op (X_("Select Track from Route List"));
1380
1381         if (_display.get_selection()->count_selected_rows() > 0) {
1382
1383                 TreeIter iter;
1384                 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
1385                 TrackViewList selected;
1386
1387                 _editor->get_selection().clear_regions ();
1388
1389                 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
1390
1391                         if ((iter = _model->get_iter (*i))) {
1392
1393                                 TimeAxisView* tv = (*iter)[_columns.tv];
1394                                 selected.push_back (tv);
1395                         }
1396
1397                 }
1398
1399                 _editor->get_selection().set (selected);
1400                 _editor->ensure_time_axis_view_is_visible (*(selected.front()), true);
1401
1402         } else {
1403                 _editor->get_selection().clear_tracks ();
1404         }
1405
1406         _editor->commit_reversible_selection_op ();
1407 }
1408
1409 bool
1410 EditorRoutes::selection_filter (Glib::RefPtr<TreeModel> const &, TreeModel::Path const&, bool /*selected*/)
1411 {
1412         if (selection_countdown) {
1413                 if (--selection_countdown == 0) {
1414                         return true;
1415                 } else {
1416                         /* no selection yet ... */
1417                         return false;
1418                 }
1419         }
1420         return true;
1421 }
1422
1423 struct PresentationInfoRouteSorter
1424 {
1425         bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
1426                 if (a->is_master()) {
1427                         /* master before everything else */
1428                         return true;
1429                 } else if (b->is_master()) {
1430                         /* everything else before master */
1431                         return false;
1432                 }
1433                 return a->presentation_info().order () < b->presentation_info().order ();
1434         }
1435 };
1436
1437 struct PresentationInfoVCASorter
1438 {
1439         bool operator() (boost::shared_ptr<VCA> a, boost::shared_ptr<VCA> b) {
1440                 return a->presentation_info().order () < b->presentation_info().order ();
1441         }
1442 };
1443
1444 void
1445 EditorRoutes::initial_display ()
1446 {
1447         DisplaySuspender ds;
1448         _model->clear ();
1449
1450         if (!_session) {
1451                 return;
1452         }
1453
1454         StripableList s;
1455
1456         RouteList r (*_session->get_routes());
1457         for (RouteList::iterator ri = r.begin(); ri != r.end(); ++ri) {
1458                 s.push_back (*ri);
1459         }
1460
1461         VCAList v (_session->vca_manager().vcas());
1462         for (VCAList::iterator vi = v.begin(); vi != v.end(); ++vi) {
1463                 s.push_back (*vi);
1464         }
1465
1466         _editor->add_stripables (s);
1467 }
1468
1469 void
1470 EditorRoutes::display_drag_data_received (const RefPtr<Gdk::DragContext>& context,
1471                                              int x, int y,
1472                                              const SelectionData& data,
1473                                              guint info, guint time)
1474 {
1475         if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1476                 _display.on_drag_data_received (context, x, y, data, info, time);
1477                 return;
1478         }
1479
1480         context->drag_finish (true, false, time);
1481 }
1482
1483 struct ViewStripable {
1484         TimeAxisView* tav;
1485         boost::shared_ptr<Stripable> stripable;
1486         uint32_t old_order;
1487
1488         ViewStripable (TimeAxisView* t, boost::shared_ptr<Stripable> s, uint32_t n)
1489                 : tav (t), stripable (s), old_order (n) {}
1490 };
1491
1492 void
1493 EditorRoutes::move_selected_tracks (bool up)
1494 {
1495         if (_editor->selection->tracks.empty()) {
1496                 return;
1497         }
1498
1499         std::list<ViewStripable> view_stripables;
1500         std::vector<int> neworder;
1501         TreeModel::Children rows = _model->children();
1502         TreeModel::Children::iterator ri;
1503         TreeModel::Children::size_type n;
1504
1505         for (n = 0, ri = rows.begin(); ri != rows.end(); ++ri, ++n) {
1506                 TimeAxisView* tv = (*ri)[_columns.tv];
1507                 boost::shared_ptr<Stripable> stripable = (*ri)[_columns.stripable];
1508                 view_stripables.push_back (ViewStripable (tv, stripable, n));
1509         }
1510
1511         list<ViewStripable>::iterator trailing;
1512         list<ViewStripable>::iterator leading;
1513
1514         if (up) {
1515
1516                 trailing = view_stripables.begin();
1517                 leading = view_stripables.begin();
1518
1519                 ++leading;
1520
1521                 while (leading != view_stripables.end()) {
1522                         if (_editor->selection->selected (leading->tav)) {
1523                                 view_stripables.insert (trailing, ViewStripable (*leading));
1524                                 leading = view_stripables.erase (leading);
1525                         } else {
1526                                 ++leading;
1527                                 ++trailing;
1528                         }
1529                 }
1530
1531         } else {
1532
1533                 /* if we could use reverse_iterator in list::insert, this code
1534                    would be a beautiful reflection of the code above. but we can't
1535                    and so it looks like a bit of a mess.
1536                 */
1537
1538                 trailing = view_stripables.end();
1539                 leading = view_stripables.end();
1540
1541                 --leading; if (leading == view_stripables.begin()) { return; }
1542                 --leading;
1543                 --trailing;
1544
1545                 while (1) {
1546
1547                         if (_editor->selection->selected (leading->tav)) {
1548                                 list<ViewStripable>::iterator tmp;
1549
1550                                 /* need to insert *after* trailing, not *before* it,
1551                                    which is what insert (iter, val) normally does.
1552                                 */
1553
1554                                 tmp = trailing;
1555                                 tmp++;
1556
1557                                 view_stripables.insert (tmp, ViewStripable (*leading));
1558
1559                                 /* can't use iter = cont.erase (iter); form here, because
1560                                    we need iter to move backwards.
1561                                 */
1562
1563                                 tmp = leading;
1564                                 --tmp;
1565
1566                                 bool done = false;
1567
1568                                 if (leading == view_stripables.begin()) {
1569                                         /* the one we've just inserted somewhere else
1570                                            was the first in the list. erase this copy,
1571                                            and then break, because we're done.
1572                                         */
1573                                         done = true;
1574                                 }
1575
1576                                 view_stripables.erase (leading);
1577
1578                                 if (done) {
1579                                         break;
1580                                 }
1581
1582                                 leading = tmp;
1583
1584                         } else {
1585                                 if (leading == view_stripables.begin()) {
1586                                         break;
1587                                 }
1588                                 --leading;
1589                                 --trailing;
1590                         }
1591                 };
1592         }
1593
1594         for (leading = view_stripables.begin(); leading != view_stripables.end(); ++leading) {
1595                 neworder.push_back (leading->old_order);
1596 #ifndef NDEBUG
1597                 if (leading->old_order != neworder.size() - 1) {
1598                         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("move %1 to %2\n", leading->old_order, neworder.size() - 1));
1599                 }
1600 #endif
1601
1602         }
1603 #ifndef NDEBUG
1604         DEBUG_TRACE (DEBUG::OrderKeys, "New order after moving tracks:\n");
1605         for (vector<int>::iterator i = neworder.begin(); i != neworder.end(); ++i) {
1606                 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("\t%1\n", *i));
1607         }
1608         DEBUG_TRACE (DEBUG::OrderKeys, "-------\n");
1609 #endif
1610
1611
1612         _model->reorder (neworder);
1613 }
1614
1615 void
1616 EditorRoutes::update_input_active_display ()
1617 {
1618         TreeModel::Children rows = _model->children();
1619         TreeModel::Children::iterator i;
1620
1621         for (i = rows.begin(); i != rows.end(); ++i) {
1622                 boost::shared_ptr<Stripable> stripable = (*i)[_columns.stripable];
1623
1624                 if (boost::dynamic_pointer_cast<Track> (stripable)) {
1625                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (stripable);
1626
1627                         if (mt) {
1628                                 (*i)[_columns.is_input_active] = mt->input_active();
1629                         }
1630                 }
1631         }
1632 }
1633
1634 void
1635 EditorRoutes::update_rec_display ()
1636 {
1637         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
1638                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
1639         }
1640 }
1641
1642 bool
1643 EditorRoutes::idle_update_mute_rec_solo_etc()
1644 {
1645         g_atomic_int_set (const_cast<gint*>(&_queue_tv_update), 0);
1646         TreeModel::Children rows = _model->children();
1647         TreeModel::Children::iterator i;
1648
1649         for (i = rows.begin(); i != rows.end(); ++i) {
1650                 boost::shared_ptr<Stripable> stripable = (*i)[_columns.stripable];
1651                 boost::shared_ptr<Route> route = boost::dynamic_pointer_cast<Route> (stripable);
1652                 (*i)[_columns.mute_state] = RouteUI::mute_active_state (_session, stripable);
1653                 (*i)[_columns.solo_state] = RouteUI::solo_active_state (stripable);
1654                 (*i)[_columns.solo_isolate_state] = RouteUI::solo_isolate_active_state (stripable) ? 1 : 0;
1655                 (*i)[_columns.solo_safe_state] = RouteUI::solo_safe_active_state (stripable) ? 1 : 0;
1656                 if (route) {
1657                         (*i)[_columns.active] = route->active ();
1658                 } else {
1659                         (*i)[_columns.active] = true;
1660                 }
1661
1662                 boost::shared_ptr<Track> trk (boost::dynamic_pointer_cast<Track>(route));
1663
1664                 if (trk) {
1665                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (route);
1666
1667                         if (trk->rec_enable_control()->get_value()) {
1668                                 if (_session->record_status() == Session::Recording) {
1669                                         (*i)[_columns.rec_state] = 1;
1670                                 } else {
1671                                         (*i)[_columns.rec_state] = 2;
1672                                 }
1673                         } else if (mt && mt->step_editing()) {
1674                                 (*i)[_columns.rec_state] = 3;
1675                         } else {
1676                                 (*i)[_columns.rec_state] = 0;
1677                         }
1678
1679                         (*i)[_columns.rec_safe] = trk->rec_safe_control()->get_value();
1680                         (*i)[_columns.name_editable] = !trk->rec_enable_control()->get_value();
1681                 }
1682         }
1683
1684         return false; // do not call again (until needed)
1685 }
1686
1687
1688 void
1689 EditorRoutes::update_mute_display ()
1690 {
1691         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
1692                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
1693         }
1694 }
1695
1696 void
1697 EditorRoutes::update_solo_display ()
1698 {
1699         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
1700                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
1701         }
1702 }
1703
1704 void
1705 EditorRoutes::update_solo_isolate_display ()
1706 {
1707         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
1708                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
1709         }
1710 }
1711
1712 void
1713 EditorRoutes::update_solo_safe_display ()
1714 {
1715         if (g_atomic_int_compare_and_exchange (const_cast<gint*>(&_queue_tv_update), 0, 1)) {
1716                 Glib::signal_idle().connect (sigc::mem_fun (*this, &EditorRoutes::idle_update_mute_rec_solo_etc));
1717         }
1718 }
1719
1720 list<TimeAxisView*>
1721 EditorRoutes::views () const
1722 {
1723         list<TimeAxisView*> v;
1724         for (TreeModel::Children::iterator i = _model->children().begin(); i != _model->children().end(); ++i) {
1725                 v.push_back ((*i)[_columns.tv]);
1726         }
1727
1728         return v;
1729 }
1730
1731 void
1732 EditorRoutes::clear ()
1733 {
1734         _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1735         _model->clear ();
1736         _display.set_model (_model);
1737 }
1738
1739 void
1740 EditorRoutes::name_edit_started (CellEditable* ce, const Glib::ustring&)
1741 {
1742         name_editable = ce;
1743
1744         /* give it a special name */
1745
1746         Gtk::Entry *e = dynamic_cast<Gtk::Entry*> (ce);
1747
1748         if (e) {
1749                 e->set_name (X_("RouteNameEditorEntry"));
1750         }
1751 }
1752
1753 void
1754 EditorRoutes::name_edit (std::string const & path, std::string const & new_text)
1755 {
1756         name_editable = 0;
1757
1758         TreeIter iter = _model->get_iter (path);
1759
1760         if (!iter) {
1761                 return;
1762         }
1763
1764         boost::shared_ptr<Stripable> stripable = (*iter)[_columns.stripable];
1765
1766         if (stripable && stripable->name() != new_text) {
1767                 stripable->set_name (new_text);
1768         }
1769 }
1770
1771 void
1772 EditorRoutes::solo_changed_so_update_mute ()
1773 {
1774         update_mute_display ();
1775 }
1776
1777 void
1778 EditorRoutes::show_tracks_with_regions_at_playhead ()
1779 {
1780         boost::shared_ptr<RouteList> const r = _session->get_routes_with_regions_at (_session->transport_frame ());
1781
1782         set<TimeAxisView*> show;
1783         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
1784                 TimeAxisView* tav = _editor->axis_view_from_route (*i);
1785                 if (tav) {
1786                         show.insert (tav);
1787                 }
1788         }
1789
1790         DisplaySuspender ds;
1791
1792         TreeModel::Children rows = _model->children ();
1793         for (TreeModel::Children::iterator i = rows.begin(); i != rows.end(); ++i) {
1794                 TimeAxisView* tv = (*i)[_columns.tv];
1795                 bool to_show = (show.find (tv) != show.end());
1796
1797                 tv->set_marked_for_display (to_show);
1798                 (*i)[_columns.visible] = to_show;
1799         }
1800
1801         /* force route order keys catch up with visibility changes
1802          */
1803
1804         sync_presentation_info_from_treeview ();
1805 }
1806
1807 int
1808 EditorRoutes::plugin_setup (boost::shared_ptr<Route> r, boost::shared_ptr<PluginInsert> pi, ARDOUR::Route::PluginSetupOptions flags)
1809 {
1810         PluginSetupDialog psd (r, pi, flags);
1811         return psd.run ();
1812 }