gtk2_ardour/editor_regions.cc

   1 /*
   2     Copyright (C) 2000-2005 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 <cmath>
  22 #include <algorithm>
  23 #include <string>
  24 #include <sstream>
  25
  26 #include "pbd/basename.h"
  27 #include "pbd/enumwriter.h"
  28
  29 #include "ardour/audioregion.h"
  30 #include "ardour/audiofilesource.h"
  31 #include "ardour/silentfilesource.h"
  32 #include "ardour/region_factory.h"
  33 #include "ardour/session.h"
  34 #include "ardour/profile.h"
  35
  36 #include "gtkmm2ext/choice.h"
  37 #include "gtkmm2ext/treeutils.h"
  38
  39 #include "audio_clock.h"
  40 #include "editor.h"
  41 #include "editing.h"
  42 #include "keyboard.h"
  43 #include "ardour_ui.h"
  44 #include "gui_thread.h"
  45 #include "actions.h"
  46 #include "region_view.h"
  47 #include "utils.h"
  48 #include "editor_regions.h"
  49 #include "editor_drag.h"
  50 #include "main_clock.h"
  51 #include "ui_config.h"
  52
  53 #include "i18n.h"
  54
  55 using namespace std;
  56 using namespace ARDOUR;
  57 using namespace ARDOUR_UI_UTILS;
  58 using namespace PBD;
  59 using namespace Gtk;
  60 using namespace Glib;
  61 using namespace Editing;
  62 using Gtkmm2ext::Keyboard;
  63
  64 struct ColumnInfo {
  65     int         index;
  66     const char* label;
  67     const char* tooltip;
  68 };
  69
  70 EditorRegions::EditorRegions (Editor* e)
  71         : EditorComponent (e)
  72         , old_focus (0)
  73         , name_editable (0)
  74         , _menu (0)
  75         , _show_automatic_regions (true)
  76         , ignore_region_list_selection_change (false)
  77         , ignore_selected_region_change (false)
  78         , _no_redisplay (false)
  79         , _sort_type ((Editing::RegionListSortType) 0)
  80         , expanded (false)
  81 {
  82         _display.set_size_request (100, -1);
  83         _display.set_rules_hint (true);
  84         _display.set_name ("EditGroupList");
  85
  86         /* Try to prevent single mouse presses from initiating edits.
  87            This relies on a hack in gtktreeview.c:gtk_treeview_button_press()
  88         */
  89         _display.set_data ("mouse-edits-require-mod1", (gpointer) 0x1);
  90
  91         _model = TreeStore::create (_columns);
  92         _model->set_sort_func (0, sigc::mem_fun (*this, &EditorRegions::sorter));
  93         _model->set_sort_column (0, SORT_ASCENDING);
  94
  95         _display.set_model (_model);
  96
  97         _display.append_column ("", _columns.name);
  98         _display.append_column ("", _columns.position);
  99         _display.append_column ("", _columns.end);
 100         _display.append_column ("", _columns.length);
 101         _display.append_column ("", _columns.sync);
 102         _display.append_column ("", _columns.fadein);
 103         _display.append_column ("", _columns.fadeout);
 104         _display.append_column ("", _columns.locked);
 105         _display.append_column ("", _columns.glued);
 106         _display.append_column ("", _columns.muted);
 107         _display.append_column ("", _columns.opaque);
 108
 109         TreeViewColumn* col;
 110         Gtk::Label* l;
 111
 112         ColumnInfo ci[] = {
 113                 { 0,   _("Region"),    _("Region name, with number of channels in []'s") },
 114                 { 1,   _("Position"),  _("Position of start of region") },
 115                 { 2,   _("End"),       _("Position of end of region") },
 116                 { 3,   _("Length"),    _("Length of the region") },
 117                 { 4,   _("Sync"),      _("Position of region sync point, relative to start of the region") },
 118                 { 5,   _("Fade In"),   _("Length of region fade-in (units: secondary clock), () if disabled") },
 119                 { 6,   _("Fade Out"),  _("Length of region fade-out (units: secondary clock), () if disabled") },
 120                 { 7,  S_("Lock|L"),    _("Region position locked?") },
 121                 { 8,  S_("Gain|G"),    _("Region position glued to Bars|Beats time?") },
 122                 { 9,  S_("Mute|M"),    _("Region muted?") },
 123                 { 10, S_("Opaque|O"),  _("Region opaque (blocks regions below it from being heard)?") },
 124                 { -1, 0, 0 }
 125         };
 126
 127         for (int i = 0; ci[i].index >= 0; ++i) {
 128                 col = _display.get_column (ci[i].index);
 129                 l = manage (new Label (ci[i].label));
 130                 ARDOUR_UI::instance()->set_tip (*l, ci[i].tooltip);
 131                 col->set_widget (*l);
 132                 l->show ();
 133
 134                 if (ci[i].index > 6) {
 135                         col->set_expand (false);
 136                         col->set_alignment (ALIGN_CENTER);
 137                 }
 138         }
 139
 140         _display.set_headers_visible (true);
 141         _display.set_rules_hint ();
 142
 143         /* show path as the row tooltip */
 144         _display.set_tooltip_column (14); /* path */
 145
 146         CellRendererText* region_name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
 147         region_name_cell->property_editable() = true;
 148         region_name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRegions::name_edit));
 149         region_name_cell->signal_editing_started().connect (sigc::mem_fun (*this, &EditorRegions::name_editing_started));
 150
 151         _display.get_selection()->set_select_function (sigc::mem_fun (*this, &EditorRegions::selection_filter));
 152
 153         TreeViewColumn* tv_col = _display.get_column(0);
 154         CellRendererText* renderer = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
 155         tv_col->add_attribute(renderer->property_text(), _columns.name);
 156         tv_col->add_attribute(renderer->property_foreground_gdk(), _columns.color_);
 157         tv_col->set_expand (true);
 158
 159         CellRendererToggle* locked_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (7));
 160         locked_cell->property_activatable() = true;
 161         locked_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::locked_changed));
 162
 163         TreeViewColumn* locked_col = _display.get_column (7);
 164         locked_col->add_attribute (locked_cell->property_visible(), _columns.property_toggles_visible);
 165
 166         CellRendererToggle* glued_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (8));
 167         glued_cell->property_activatable() = true;
 168         glued_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::glued_changed));
 169
 170         TreeViewColumn* glued_col = _display.get_column (8);
 171         glued_col->add_attribute (glued_cell->property_visible(), _columns.property_toggles_visible);
 172
 173         CellRendererToggle* muted_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (9));
 174         muted_cell->property_activatable() = true;
 175         muted_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::muted_changed));
 176
 177         TreeViewColumn* muted_col = _display.get_column (9);
 178         muted_col->add_attribute (muted_cell->property_visible(), _columns.property_toggles_visible);
 179
 180         CellRendererToggle* opaque_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (10));
 181         opaque_cell->property_activatable() = true;
 182         opaque_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::opaque_changed));
 183
 184         TreeViewColumn* opaque_col = _display.get_column (10);
 185         opaque_col->add_attribute (opaque_cell->property_visible(), _columns.property_toggles_visible);
 186
 187         _display.get_selection()->set_mode (SELECTION_MULTIPLE);
 188         _display.add_object_drag (_columns.region.index(), "regions");
 189
 190         /* setup DnD handling */
 191
 192         list<TargetEntry> region_list_target_table;
 193
 194         region_list_target_table.push_back (TargetEntry ("text/plain"));
 195         region_list_target_table.push_back (TargetEntry ("text/uri-list"));
 196         region_list_target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
 197
 198         _display.add_drop_targets (region_list_target_table);
 199         _display.signal_drag_data_received().connect (sigc::mem_fun(*this, &EditorRegions::drag_data_received));
 200
 201         _scroller.add (_display);
 202         _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
 203
 204         _display.signal_button_press_event().connect (sigc::mem_fun(*this, &EditorRegions::button_press), false);
 205         _change_connection = _display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &EditorRegions::selection_changed));
 206
 207         _scroller.signal_key_press_event().connect (sigc::mem_fun(*this, &EditorRegions::key_press), false);
 208         _scroller.signal_focus_in_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_in), false);
 209         _scroller.signal_focus_out_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_out));
 210
 211         _display.signal_enter_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::enter_notify), false);
 212         _display.signal_leave_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::leave_notify), false);
 213
 214         // _display.signal_popup_menu().connect (sigc::bind (sigc::mem_fun (*this, &Editor::show__display_context_menu), 1, 0));
 215
 216         //ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &Editor::redisplay_regions));
 217         ARDOUR_UI::instance()->secondary_clock->mode_changed.connect (sigc::mem_fun(*this, &EditorRegions::update_all_rows));
 218         ARDOUR::Region::RegionPropertyChanged.connect (region_property_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::region_changed, this, _1, _2), gui_context());
 219         ARDOUR::RegionFactory::CheckNewRegion.connect (check_new_region_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::add_region, this, _1), gui_context());
 220
 221         e->EditorFreeze.connect (editor_freeze_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::freeze_tree_model, this), gui_context());
 222         e->EditorThaw.connect (editor_thaw_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::thaw_tree_model, this), gui_context());
 223 }
 224
 225 bool
 226 EditorRegions::focus_in (GdkEventFocus*)
 227 {
 228         Window* win = dynamic_cast<Window*> (_scroller.get_toplevel ());
 229
 230         if (win) {
 231                 old_focus = win->get_focus ();
 232         } else {
 233                 old_focus = 0;
 234         }
 235
 236         name_editable = 0;
 237
 238         /* try to do nothing on focus in (doesn't work, hence selection_count nonsense) */
 239         return true;
 240 }
 241
 242 bool
 243 EditorRegions::focus_out (GdkEventFocus*)
 244 {
 245         if (old_focus) {
 246                 old_focus->grab_focus ();
 247                 old_focus = 0;
 248         }
 249
 250         name_editable = 0;
 251
 252         return false;
 253 }
 254
 255 bool
 256 EditorRegions::enter_notify (GdkEventCrossing*)
 257 {
 258         if (name_editable) {
 259                 return true;
 260         }
 261
 262         /* arm counter so that ::selection_filter() will deny selecting anything for the
 263            next two attempts to change selection status.
 264         */
 265         _scroller.grab_focus ();
 266         Keyboard::magic_widget_grab_focus ();
 267         return false;
 268 }
 269
 270 bool
 271 EditorRegions::leave_notify (GdkEventCrossing*)
 272 {
 273         if (old_focus) {
 274                 old_focus->grab_focus ();
 275                 old_focus = 0;
 276         }
 277
 278         Keyboard::magic_widget_drop_focus ();
 279         return false;
 280 }
 281
 282 void
 283 EditorRegions::set_session (ARDOUR::Session* s)
 284 {
 285         SessionHandlePtr::set_session (s);
 286         redisplay ();
 287 }
 288
 289 void
 290 EditorRegions::add_region (boost::shared_ptr<Region> region)
 291 {
 292         if (!region || !_session) {
 293                 return;
 294         }
 295
 296         string str;
 297         TreeModel::Row row;
 298         Gdk::Color c;
 299         bool missing_source = boost::dynamic_pointer_cast<SilentFileSource>(region->source()) != NULL;
 300
 301         if (!_show_automatic_regions && region->automatic()) {
 302                 return;
 303         }
 304
 305         if (region->hidden()) {
 306
 307                 TreeModel::iterator iter = _model->get_iter ("0");
 308                 TreeModel::Row parent;
 309
 310                 if (!iter) {
 311                         parent = *(_model->append());
 312                         parent[_columns.name] = _("Hidden");
 313                         boost::shared_ptr<Region> proxy = parent[_columns.region];
 314                         proxy.reset ();
 315                 } else {
 316                         string s = (*iter)[_columns.name];
 317                         if (s != _("Hidden")) {
 318                                 parent = *(_model->insert(iter));
 319                                 parent[_columns.name] = _("Hidden");
 320                                 boost::shared_ptr<Region> proxy = parent[_columns.region];
 321                                 proxy.reset ();
 322                         } else {
 323                                 parent = *iter;
 324                         }
 325                 }
 326
 327                 row = *(_model->append (parent.children()));
 328
 329         } else if (region->whole_file()) {
 330
 331                 TreeModel::iterator i;
 332                 TreeModel::Children rows = _model->children();
 333
 334                 for (i = rows.begin(); i != rows.end(); ++i) {
 335                         boost::shared_ptr<Region> rr = (*i)[_columns.region];
 336
 337                         if (rr && region->region_list_equivalent (rr)) {
 338                                 return;
 339                         }
 340                 }
 341
 342                 row = *(_model->append());
 343
 344                 if (missing_source) {
 345                         // c.set_rgb(65535,0,0);     // FIXME: error color from style
 346                         set_color_from_rgba (c, UIConfiguration::instance().color ("region list missing source"));
 347
 348                 } else if (region->automatic()){
 349                         // c.set_rgb(0,65535,0);     // FIXME: error color from style
 350                         set_color_from_rgba (c, UIConfiguration::instance().color ("region list automatic"));
 351
 352                 } else {
 353                         set_color_from_rgba (c, UIConfiguration::instance().color ("region list whole file"));
 354                 }
 355
 356                 row[_columns.color_] = c;
 357
 358                 if (region->source()->name()[0] == '/') { // external file
 359
 360                         if (region->whole_file()) {
 361
 362                                 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(region->source());
 363                                 str = ".../";
 364
 365                                 if (afs) {
 366                                         str = region_name_from_path (afs->path(), region->n_channels() > 1);
 367                                 } else {
 368                                         str += region->source()->name();
 369                                 }
 370
 371                         } else {
 372                                 str = region->name();
 373                         }
 374
 375                 } else {
 376                         str = region->name();
 377                 }
 378
 379                 if (region->n_channels() > 1) {
 380                         std::stringstream foo;
 381                         foo << region->n_channels ();
 382                         str += " [";
 383                         str += foo.str();
 384                         str += "]";
 385                 }
 386
 387                 row[_columns.name] = str;
 388                 row[_columns.region] = region;
 389                 row[_columns.property_toggles_visible] = false;
 390
 391                 if (missing_source) {
 392                         row[_columns.path] = _("(MISSING) ") + region->source()->name();
 393
 394                 } else {
 395                         boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource>(region->source());
 396                         if (fs) {
 397                                 row[_columns.path] = fs->path();
 398                         } else {
 399                                 row[_columns.path] = region->source()->name();
 400                         }
 401                 }
 402
 403                 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
 404                 parent_regions_sources_map.insert(pair<string, Gtk::TreeModel::RowReference>(region->source_string(), TreeRowReference(_model, TreePath (row))) );
 405
 406                 return;
 407
 408         } else {
 409                 // find parent node, add as new child
 410                 TreeModel::iterator i;
 411
 412                 boost::unordered_map<string, Gtk::TreeModel::RowReference>::iterator it;
 413
 414                 it = parent_regions_sources_map.find (region->source_string());
 415
 416                 if (it != parent_regions_sources_map.end()){
 417
 418                         TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
 419
 420                         TreeModel::iterator ii;
 421                         TreeModel::Children subrows = (*j).children();
 422
 423                         /* XXXX: should we be accounting for all regions? */
 424                         /*
 425                         for (ii = subrows.begin(); ii != subrows.end(); ++ii) {
 426                                 boost::shared_ptr<Region> rr = (*ii)[_columns.region];
 427
 428                                 if (region->region_list_equivalent (rr)) {
 429                                         return;
 430                                 }
 431                         }
 432                         */
 433
 434                         row = *(_model->insert (subrows.end()));
 435
 436                 } else {
 437                         row = *(_model->append());
 438                 }
 439
 440                 row[_columns.property_toggles_visible] = true;
 441         }
 442
 443         row[_columns.region] = region;
 444
 445         region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
 446
 447         populate_row(region, (*row));
 448 }
 449
 450 void
 451 EditorRegions::remove_unused_regions ()
 452 {
 453         vector<string> choices;
 454         string prompt;
 455
 456         if (!_session) {
 457                 return;
 458         }
 459
 460         prompt  = _("Do you really want to remove unused regions?"
 461                     "\n(This is destructive and cannot be undone)");
 462
 463         choices.push_back (_("No, do nothing."));
 464         choices.push_back (_("Yes, remove."));
 465
 466         Gtkmm2ext::Choice prompter (_("Remove unused regions"), prompt, choices);
 467
 468         if (prompter.run () == 1) {
 469                 _no_redisplay = true;
 470                 _session->cleanup_regions ();
 471                 _no_redisplay = false;
 472                 redisplay ();
 473         }
 474 }
 475
 476 void
 477 EditorRegions::region_changed (boost::shared_ptr<Region> r, const PropertyChange& what_changed)
 478 {
 479         PropertyChange our_interests;
 480
 481         our_interests.add (ARDOUR::Properties::name);
 482         our_interests.add (ARDOUR::Properties::position);
 483         our_interests.add (ARDOUR::Properties::length);
 484         our_interests.add (ARDOUR::Properties::start);
 485         our_interests.add (ARDOUR::Properties::locked);
 486         our_interests.add (ARDOUR::Properties::position_lock_style);
 487         our_interests.add (ARDOUR::Properties::muted);
 488         our_interests.add (ARDOUR::Properties::opaque);
 489         our_interests.add (ARDOUR::Properties::fade_in);
 490         our_interests.add (ARDOUR::Properties::fade_out);
 491         our_interests.add (ARDOUR::Properties::fade_in_active);
 492         our_interests.add (ARDOUR::Properties::fade_out_active);
 493
 494         if (what_changed.contains (our_interests)) {
 495
 496                 if (last_row != 0) {
 497
 498                         TreeModel::iterator j = _model->get_iter (last_row.get_path());
 499                         boost::shared_ptr<Region> c = (*j)[_columns.region];
 500
 501                         if (c == r) {
 502                                 populate_row (r, (*j));
 503
 504                                 if (what_changed.contains (ARDOUR::Properties::hidden)) {
 505                                         redisplay ();
 506                                 }
 507
 508                                 return;
 509                         }
 510                 }
 511
 512                 RegionRowMap::iterator it;
 513
 514                 it = region_row_map.find (r);
 515
 516                 if (it != region_row_map.end()){
 517
 518                         TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
 519                         boost::shared_ptr<Region> c = (*j)[_columns.region];
 520
 521                         if (c == r) {
 522                                 populate_row (r, (*j));
 523
 524                                 if (what_changed.contains (ARDOUR::Properties::hidden)) {
 525                                         redisplay ();
 526                                 }
 527
 528                                 return;
 529                         }
 530                 }
 531         }
 532
 533         if (what_changed.contains (ARDOUR::Properties::hidden)) {
 534                 redisplay ();
 535         }
 536 }
 537
 538 void
 539 EditorRegions::selection_changed ()
 540 {
 541         if (ignore_region_list_selection_change) {
 542                 return;
 543         }
 544
 545         _editor->_region_selection_change_updates_region_list = false;
 546
 547         if (_display.get_selection()->count_selected_rows() > 0) {
 548
 549                 TreeIter iter;
 550                 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
 551
 552                 _editor->get_selection().clear_regions ();
 553
 554                 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
 555
 556                         if ((iter = _model->get_iter (*i))) {
 557
 558                                 boost::shared_ptr<Region> region = (*iter)[_columns.region];
 559
 560                                 // they could have clicked on a row that is just a placeholder, like "Hidden"
 561                                 // although that is not allowed by our selection filter. check it anyway
 562                                 // since we need a region ptr.
 563
 564                                 if (region) {
 565
 566                                         _change_connection.block (true);
 567                                         _editor->set_selected_regionview_from_region_list (region, Selection::Add);
 568                                         _change_connection.block (false);
 569                                 }
 570                         }
 571
 572                 }
 573         } else {
 574                 _editor->get_selection().clear_regions ();
 575         }
 576
 577         _editor->_region_selection_change_updates_region_list = true;
 578 }
 579
 580 void
 581 EditorRegions::set_selected (RegionSelection& regions)
 582 {
 583         for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
 584
 585                 boost::shared_ptr<Region> r ((*i)->region());
 586
 587                 RegionRowMap::iterator it;
 588
 589                 it = region_row_map.find (r);
 590
 591                 if (it != region_row_map.end()){
 592                         TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
 593                         _display.get_selection()->select(*j);
 594                 }
 595         }
 596 }
 597
 598 void
 599 EditorRegions::redisplay ()
 600 {
 601         if (_no_redisplay || !_session) {
 602                 return;
 603         }
 604
 605         bool tree_expanded = false;
 606
 607         /* If the list was expanded prior to rebuilding, expand it again afterwards */
 608         if (toggle_full_action()->get_active()) {
 609                 tree_expanded = true;
 610         }
 611
 612         _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
 613         _model->clear ();
 614         _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
 615
 616
 617         region_row_map.clear();
 618         parent_regions_sources_map.clear();
 619
 620         /* now add everything we have, via a temporary list used to help with sorting */
 621
 622         const RegionFactory::RegionMap& regions (RegionFactory::regions());
 623
 624         for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
 625
 626                 if ( i->second->whole_file()) {
 627                         /* add automatic regions first so that children can find their parents as we add them */
 628                         add_region (i->second);
 629                         continue;
 630                 }
 631
 632                 tmp_region_list.push_front (i->second);
 633         }
 634
 635         for (list<boost::shared_ptr<Region> >::iterator r = tmp_region_list.begin(); r != tmp_region_list.end(); ++r) {
 636                 add_region (*r);
 637         }
 638
 639         _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
 640         _display.set_model (_model);
 641
 642         tmp_region_list.clear();
 643
 644         if (tree_expanded) {
 645                 _display.expand_all();
 646         }
 647 }
 648
 649 void
 650 EditorRegions::update_row (boost::shared_ptr<Region> region)
 651 {
 652         if (!region || !_session) {
 653                 return;
 654         }
 655
 656         RegionRowMap::iterator it;
 657
 658         it = region_row_map.find (region);
 659
 660         if (it != region_row_map.end()){
 661
 662                 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
 663                 populate_row(region, (*j));
 664         }
 665 }
 666
 667 void
 668 EditorRegions::update_all_rows ()
 669 {
 670         if (!_session) {
 671                 return;
 672         }
 673
 674         RegionRowMap::iterator i;
 675
 676         for (i = region_row_map.begin(); i != region_row_map.end(); ++i) {
 677
 678                 TreeModel::iterator j = _model->get_iter ((*i).second.get_path());
 679
 680                 boost::shared_ptr<Region> region = (*j)[_columns.region];
 681
 682                 if (!region->automatic()) {
 683                         populate_row(region, (*j));
 684                 }
 685         }
 686 }
 687
 688 void
 689 EditorRegions::format_position (framepos_t pos, char* buf, size_t bufsize, bool onoff)
 690 {
 691         Timecode::BBT_Time bbt;
 692         Timecode::Time timecode;
 693
 694         if (pos < 0) {
 695                 error << string_compose (_("EditorRegions::format_position: negative timecode position: %1"), pos) << endmsg;
 696                 snprintf (buf, bufsize, "invalid");
 697                 return;
 698         }
 699
 700         switch (ARDOUR_UI::instance()->secondary_clock->mode ()) {
 701         case AudioClock::BBT:
 702                 _session->tempo_map().bbt_time (pos, bbt);
 703                 if (onoff) {
 704                         snprintf (buf, bufsize, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
 705                 } else {
 706                         snprintf (buf, bufsize, "(%03d|%02d|%04d)" , bbt.bars, bbt.beats, bbt.ticks);
 707                 }
 708                 break;
 709
 710         case AudioClock::MinSec:
 711                 framepos_t left;
 712                 int hrs;
 713                 int mins;
 714                 float secs;
 715
 716                 left = pos;
 717                 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
 718                 left -= (framecnt_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
 719                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
 720                 left -= (framecnt_t) floor (mins * _session->frame_rate() * 60.0f);
 721                 secs = left / (float) _session->frame_rate();
 722                 if (onoff) {
 723                         snprintf (buf, bufsize, "%02d:%02d:%06.3f", hrs, mins, secs);
 724                 } else {
 725                         snprintf (buf, bufsize, "(%02d:%02d:%06.3f)", hrs, mins, secs);
 726                 }
 727                 break;
 728
 729         case AudioClock::Frames:
 730                 if (onoff) {
 731                         snprintf (buf, bufsize, "%" PRId64, pos);
 732                 } else {
 733                         snprintf (buf, bufsize, "(%" PRId64 ")", pos);
 734                 }
 735                 break;
 736
 737         case AudioClock::Timecode:
 738         default:
 739                 _session->timecode_time (pos, timecode);
 740                 if (onoff) {
 741                         snprintf (buf, bufsize, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
 742                 } else {
 743                         snprintf (buf, bufsize, "(%02d:%02d:%02d:%02d)", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
 744                 }
 745                 break;
 746         }
 747 }
 748
 749 void
 750 EditorRegions::populate_row (boost::shared_ptr<Region> region, TreeModel::Row const &row)
 751 {
 752         boost::shared_ptr<AudioRegion> audioregion = boost::dynamic_pointer_cast<AudioRegion>(region);
 753         //uint32_t used = _session->playlists->region_use_count (region);
 754         /* Presently a region is only used once so let's save on the sequential scan to determine use count */
 755         uint32_t used = 1;
 756
 757         populate_row_position (region, row, used);
 758         populate_row_end (region, row, used);
 759         populate_row_sync (region, row, used);
 760         populate_row_fade_in (region, row, used, audioregion);
 761         populate_row_fade_out (region, row, used, audioregion);
 762         populate_row_locked (region, row, used);
 763         populate_row_glued (region, row, used);
 764         populate_row_muted (region, row, used);
 765         populate_row_opaque (region, row, used);
 766         populate_row_length (region, row);
 767         populate_row_source (region, row);
 768         populate_row_name (region, row);
 769         populate_row_used (region, row, used);
 770 }
 771
 772 #if 0
 773         if (audioRegion && fades_in_seconds) {
 774
 775                 framepos_t left;
 776                 int mins;
 777                 int millisecs;
 778
 779                 left = audioRegion->fade_in()->back()->when;
 780                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
 781                 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
 782                 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
 783
 784                 if (audioRegion->fade_in()->back()->when >= _session->frame_rate()) {
 785                         sprintf (fadein_str, "%01dM %01dmS", mins, millisecs);
 786                 } else {
 787                         sprintf (fadein_str, "%01dmS", millisecs);
 788                 }
 789
 790                 left = audioRegion->fade_out()->back()->when;
 791                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
 792                 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
 793                 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
 794
 795                 if (audioRegion->fade_out()->back()->when >= _session->frame_rate()) {
 796                         sprintf (fadeout_str, "%01dM %01dmS", mins, millisecs);
 797                 } else {
 798                         sprintf (fadeout_str, "%01dmS", millisecs);
 799                 }
 800         }
 801 #endif
 802
 803 void
 804 EditorRegions::populate_row_used (boost::shared_ptr<Region>, TreeModel::Row const& row, uint32_t used)
 805 {
 806         char buf[8];
 807         snprintf (buf, sizeof (buf), "%4d" , used);
 808         row[_columns.used] = buf;
 809 }
 810
 811 void
 812 EditorRegions::populate_row_length (boost::shared_ptr<Region> region, TreeModel::Row const &row)
 813 {
 814         char buf[16];
 815         format_position (region->length(), buf, sizeof (buf));
 816         row[_columns.length] = buf;
 817 }
 818
 819 void
 820 EditorRegions::populate_row_end (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
 821 {
 822         if (region->whole_file()) {
 823                 row[_columns.end] = "";
 824         } else if (used > 1) {
 825                 row[_columns.end] = _("Mult.");
 826         } else if (region->last_frame() >= region->first_frame()) {
 827                 char buf[16];
 828                 format_position (region->last_frame(), buf, sizeof (buf));
 829                 row[_columns.end] = buf;
 830         } else {
 831                 row[_columns.end] = "empty";
 832         }
 833 }
 834
 835 void
 836 EditorRegions::populate_row_position (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
 837 {
 838         if (region->whole_file()) {
 839                 row[_columns.position] = "";
 840         } else if (used > 1) {
 841                 row[_columns.position] = _("Mult.");
 842         } else {
 843                 char buf[16];
 844                 format_position (region->position(), buf, sizeof (buf));
 845                 row[_columns.position] = buf;
 846         }
 847 }
 848
 849 void
 850 EditorRegions::populate_row_sync (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
 851 {
 852         if (region->whole_file()) {
 853                 row[_columns.sync] = "";
 854         } else if (used > 1) {
 855                 row[_columns.sync] = _("Mult."); /* translators: a short phrase for "multiple" as in "many" */
 856         } else {
 857                 if (region->sync_position() == region->position()) {
 858                         row[_columns.sync] = _("Start");
 859                 } else if (region->sync_position() == (region->last_frame())) {
 860                         row[_columns.sync] = _("End");
 861                 } else {
 862                         char buf[16];
 863                         format_position (region->sync_position(), buf, sizeof (buf));
 864                         row[_columns.sync] = buf;
 865                 }
 866         }
 867 }
 868
 869 void
 870 EditorRegions::populate_row_fade_in (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
 871 {
 872         if (!audioregion || region->whole_file()) {
 873                 row[_columns.fadein] = "";
 874         } else {
 875                 if (used > 1) {
 876                         row[_columns.fadein] = _("Multiple");
 877                 } else {
 878                         char buf[32];
 879                         format_position (audioregion->fade_in()->back()->when, buf, sizeof (buf), audioregion->fade_in_active());
 880                         row[_columns.fadein] = buf;
 881                 }
 882         }
 883 }
 884
 885 void
 886 EditorRegions::populate_row_fade_out (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
 887 {
 888         if (!audioregion || region->whole_file()) {
 889                 row[_columns.fadeout] = "";
 890         } else {
 891                 if (used > 1) {
 892                         row[_columns.fadeout] = _("Multiple");
 893                 } else {
 894                         char buf[32];
 895                         format_position (audioregion->fade_out()->back()->when, buf, sizeof (buf), audioregion->fade_out_active());
 896                         row[_columns.fadeout] = buf;
 897                 }
 898         }
 899 }
 900
 901 void
 902 EditorRegions::populate_row_locked (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
 903 {
 904         if (region->whole_file()) {
 905                 row[_columns.locked] = false;
 906         } else if (used > 1) {
 907                 row[_columns.locked] = false;
 908         } else {
 909                 row[_columns.locked] = region->locked();
 910         }
 911 }
 912
 913 void
 914 EditorRegions::populate_row_glued (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
 915 {
 916         if (region->whole_file() || used > 1) {
 917                 row[_columns.glued] = false;
 918         } else {
 919                 if (region->position_lock_style() == MusicTime) {
 920                         row[_columns.glued] = true;
 921                 } else {
 922                         row[_columns.glued] = false;
 923                 }
 924         }
 925 }
 926
 927 void
 928 EditorRegions::populate_row_muted (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
 929 {
 930         if (region->whole_file() || used > 1) {
 931                 row[_columns.muted] = false;
 932         } else {
 933                 row[_columns.muted] = region->muted();
 934         }
 935 }
 936
 937 void
 938 EditorRegions::populate_row_opaque (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
 939 {
 940         if (region->whole_file() || used > 1) {
 941                 row[_columns.opaque] = false;
 942         } else {
 943                 row[_columns.opaque] = region->opaque();
 944         }
 945 }
 946
 947 void
 948 EditorRegions::populate_row_name (boost::shared_ptr<Region> region, TreeModel::Row const &row)
 949 {
 950         if (region->n_channels() > 1) {
 951                 row[_columns.name] = string_compose("%1  [%2]", region->name(), region->n_channels());
 952         } else {
 953                 row[_columns.name] = region->name();
 954         }
 955 }
 956
 957 void
 958 EditorRegions::populate_row_source (boost::shared_ptr<Region> region, TreeModel::Row const &row)
 959 {
 960         if (boost::dynamic_pointer_cast<SilentFileSource>(region->source())) {
 961                 row[_columns.path] = _("MISSING ") + region->source()->name();
 962         } else {
 963                 row[_columns.path] = region->source()->name();
 964         }
 965 }
 966
 967 void
 968 EditorRegions::toggle_show_auto_regions ()
 969 {
 970         _show_automatic_regions = toggle_show_auto_regions_action()->get_active();
 971         redisplay ();
 972 }
 973
 974 void
 975 EditorRegions::toggle_full ()
 976 {
 977         set_full (toggle_full_action()->get_active ());
 978 }
 979
 980 void
 981 EditorRegions::set_full (bool f)
 982 {
 983         if (f) {
 984                 _display.expand_all ();
 985                 expanded = true;
 986         } else {
 987                 _display.collapse_all ();
 988                 expanded = false;
 989         }
 990 }
 991
 992 void
 993 EditorRegions::show_context_menu (int button, int time)
 994 {
 995         if (_menu == 0) {
 996                 _menu = dynamic_cast<Menu*> (ActionManager::get_widget ("/RegionListMenu"));
 997         }
 998
 999         if (_display.get_selection()->count_selected_rows() > 0) {
1000                 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, true);
1001         } else {
1002                 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, false);
1003         }
1004
1005         /* Enable the "Show" option if any selected regions are hidden, and vice versa for "Hide" */
1006
1007         bool have_shown = false;
1008         bool have_hidden = false;
1009
1010         TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
1011         for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
1012                 TreeIter t = _model->get_iter (*i);
1013                 boost::shared_ptr<Region> r = (*t)[_columns.region];
1014                 if (r) {
1015                         if (r->hidden ()) {
1016                                 have_hidden = true;
1017                         } else {
1018                                 have_shown = true;
1019                         }
1020                 }
1021         }
1022
1023         hide_action()->set_sensitive (have_shown);
1024         show_action()->set_sensitive (have_hidden);
1025
1026         _menu->popup (button, time);
1027 }
1028
1029 bool
1030 EditorRegions::key_press (GdkEventKey* ev)
1031 {
1032         TreeViewColumn *col;
1033
1034         switch (ev->keyval) {
1035         case GDK_Tab:
1036         case GDK_ISO_Left_Tab:
1037
1038                 if (name_editable) {
1039                         name_editable->editing_done ();
1040                         name_editable = 0;
1041                 }
1042
1043                 col = _display.get_column (0); // select&focus on name column
1044
1045                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
1046                         treeview_select_previous (_display, _model, col);
1047                 } else {
1048                         treeview_select_next (_display, _model, col);
1049                 }
1050
1051                 return true;
1052                 break;
1053
1054         default:
1055                 break;
1056         }
1057
1058         return false;
1059 }
1060
1061 bool
1062 EditorRegions::button_press (GdkEventButton *ev)
1063 {
1064         boost::shared_ptr<Region> region;
1065         TreeIter iter;
1066         TreeModel::Path path;
1067         TreeViewColumn* column;
1068         int cellx;
1069         int celly;
1070
1071         if (_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1072                 if ((iter = _model->get_iter (path))) {
1073                         region = (*iter)[_columns.region];
1074                 }
1075         }
1076
1077         if (Keyboard::is_context_menu_event (ev)) {
1078                 show_context_menu (ev->button, ev->time);
1079                 return false;
1080         }
1081
1082         if (region != 0 && Keyboard::is_button2_event (ev)) {
1083                 // start/stop audition
1084                 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1085                         _editor->consider_auditioning (region);
1086                 }
1087                 return true;
1088         }
1089
1090         return false;
1091 }
1092
1093 int
1094 EditorRegions::sorter (TreeModel::iterator a, TreeModel::iterator b)
1095 {
1096         int cmp = 0;
1097
1098         boost::shared_ptr<Region> r1 = (*a)[_columns.region];
1099         boost::shared_ptr<Region> r2 = (*b)[_columns.region];
1100
1101         /* handle rows without regions, like "Hidden" */
1102
1103         if (r1 == 0) {
1104                 return -1;
1105         }
1106
1107         if (r2 == 0) {
1108                 return 1;
1109         }
1110
1111         boost::shared_ptr<AudioRegion> region1 = boost::dynamic_pointer_cast<AudioRegion> (r1);
1112         boost::shared_ptr<AudioRegion> region2 = boost::dynamic_pointer_cast<AudioRegion> (r2);
1113
1114         if (region1 == 0 || region2 == 0) {
1115                 std::string s1;
1116                 std::string s2;
1117                 switch (_sort_type) {
1118                 case ByName:
1119                         s1 = (*a)[_columns.name];
1120                         s2 = (*b)[_columns.name];
1121                         return (s1.compare (s2));
1122                 default:
1123                         return 0;
1124                 }
1125         }
1126
1127         switch (_sort_type) {
1128         case ByName:
1129                 cmp = region1->name().compare(region2->name());
1130                 break;
1131
1132         case ByLength:
1133                 cmp = region1->length() - region2->length();
1134                 break;
1135
1136         case ByPosition:
1137                 cmp = region1->position() - region2->position();
1138                 break;
1139
1140         case ByTimestamp:
1141                 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1142                 break;
1143
1144         case ByStartInFile:
1145                 cmp = region1->start() - region2->start();
1146                 break;
1147
1148         case ByEndInFile:
1149                 // cerr << "Compare " << (region1->start() + region1->length()) << " and " << (region2->start() + region2->length()) << endl;
1150                 cmp = (region1->start() + region1->length()) - (region2->start() + region2->length());
1151                 break;
1152
1153         case BySourceFileName:
1154                 cmp = region1->source()->name().compare(region2->source()->name());
1155                 break;
1156
1157         case BySourceFileLength:
1158                 cmp = region1->source_length(0) - region2->source_length(0);
1159                 break;
1160
1161         case BySourceFileCreationDate:
1162                 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1163                 break;
1164
1165         case BySourceFileFS:
1166                 if (region1->source()->name() == region2->source()->name()) {
1167                         cmp = region1->name().compare(region2->name());
1168                 } else {
1169                         cmp = region1->source()->name().compare(region2->source()->name());
1170                 }
1171                 break;
1172         }
1173
1174         // cerr << "Comparison on " << enum_2_string (_sort_type) << " gives " << cmp << endl;
1175
1176         if (cmp < 0) {
1177                 return -1;
1178         } else if (cmp > 0) {
1179                 return 1;
1180         } else {
1181                 return 0;
1182         }
1183 }
1184
1185 void
1186 EditorRegions::reset_sort_type (RegionListSortType type, bool force)
1187 {
1188         if (type != _sort_type || force) {
1189                 _sort_type = type;
1190                 _model->set_sort_func (0, (sigc::mem_fun (*this, &EditorRegions::sorter)));
1191         }
1192 }
1193
1194 void
1195 EditorRegions::reset_sort_direction (bool up)
1196 {
1197         _model->set_sort_column (0, up ? SORT_ASCENDING : SORT_DESCENDING);
1198 }
1199
1200 void
1201 EditorRegions::selection_mapover (sigc::slot<void,boost::shared_ptr<Region> > sl)
1202 {
1203         Glib::RefPtr<TreeSelection> selection = _display.get_selection();
1204         TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1205         TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1206
1207         if (selection->count_selected_rows() == 0 || _session == 0) {
1208                 return;
1209         }
1210
1211         for (; i != rows.end(); ++i) {
1212                 TreeIter iter;
1213
1214                 if ((iter = _model->get_iter (*i))) {
1215
1216                         /* some rows don't have a region associated with them, but can still be
1217                            selected (XXX maybe prevent them from being selected)
1218                         */
1219
1220                         boost::shared_ptr<Region> r = (*iter)[_columns.region];
1221
1222                         if (r) {
1223                                 sl (r);
1224                         }
1225                 }
1226         }
1227 }
1228
1229
1230 void
1231 EditorRegions::drag_data_received (const RefPtr<Gdk::DragContext>& context,
1232                                    int x, int y,
1233                                    const SelectionData& data,
1234                                    guint info, guint time)
1235 {
1236         vector<string> paths;
1237
1238         if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1239                 /* something is being dragged over the region list */
1240                 _editor->_drags->abort ();
1241                 _display.on_drag_data_received (context, x, y, data, info, time);
1242                 return;
1243         }
1244
1245         if (_editor->convert_drop_to_paths (paths, context, x, y, data, info, time) == 0) {
1246                 framepos_t pos = 0;
1247                 bool copy = ((context->get_actions() & (Gdk::ACTION_COPY | Gdk::ACTION_LINK | Gdk::ACTION_MOVE)) == Gdk::ACTION_COPY);
1248
1249                 if (Profile->get_sae() || UIConfiguration::instance().get_only_copy_imported_files() || copy) {
1250                         _editor->do_import (paths, Editing::ImportDistinctFiles, Editing::ImportAsRegion, SrcBest, pos);
1251                 } else {
1252                         _editor->do_embed (paths, Editing::ImportDistinctFiles, ImportAsRegion, pos);
1253                 }
1254                 context->drag_finish (true, false, time);
1255         }
1256 }
1257
1258 bool
1259 EditorRegions::selection_filter (const RefPtr<TreeModel>& model, const TreeModel::Path& path, bool already_selected)
1260 {
1261         /* not possible to select rows that do not represent regions, like "Hidden" */
1262
1263         if (already_selected) {
1264                 /* deselecting anything is OK with us */
1265                 return true;
1266         }
1267
1268         TreeModel::iterator iter = model->get_iter (path);
1269
1270         if (iter) {
1271                 boost::shared_ptr<Region> r =(*iter)[_columns.region];
1272                 if (!r) {
1273                         return false;
1274                 }
1275         }
1276
1277         return true;
1278 }
1279
1280 void
1281 EditorRegions::name_editing_started (CellEditable* ce, const Glib::ustring&)
1282 {
1283         name_editable = ce;
1284
1285         /* give it a special name */
1286
1287         Gtk::Entry *e = dynamic_cast<Gtk::Entry*> (ce);
1288
1289         if (e) {
1290                 e->set_name (X_("RegionNameEditorEntry"));
1291         }
1292 }
1293
1294 void
1295 EditorRegions::name_edit (const std::string& path, const std::string& new_text)
1296 {
1297         name_editable = 0;
1298
1299         boost::shared_ptr<Region> region;
1300         TreeIter iter;
1301
1302         if ((iter = _model->get_iter (path))) {
1303                 region = (*iter)[_columns.region];
1304                 (*iter)[_columns.name] = new_text;
1305         }
1306
1307         /* now mapover everything */
1308
1309         if (region) {
1310                 vector<RegionView*> equivalents;
1311                 _editor->get_regions_corresponding_to (region, equivalents, false);
1312
1313                 for (vector<RegionView*>::iterator i = equivalents.begin(); i != equivalents.end(); ++i) {
1314                         if (new_text != (*i)->region()->name()) {
1315                                 (*i)->region()->set_name (new_text);
1316                         }
1317                 }
1318         }
1319
1320 }
1321
1322 /** @return Region that has been dragged out of the list, or 0 */
1323 boost::shared_ptr<Region>
1324 EditorRegions::get_dragged_region ()
1325 {
1326         list<boost::shared_ptr<Region> > regions;
1327         TreeView* source;
1328         _display.get_object_drag_data (regions, &source);
1329
1330         if (regions.empty()) {
1331                 return boost::shared_ptr<Region> ();
1332         }
1333
1334         assert (regions.size() == 1);
1335         return regions.front ();
1336 }
1337
1338 void
1339 EditorRegions::clear ()
1340 {
1341         _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1342         _model->clear ();
1343         _display.set_model (_model);
1344
1345         /* Clean up the maps */
1346         region_row_map.clear();
1347         parent_regions_sources_map.clear();
1348 }
1349
1350 boost::shared_ptr<Region>
1351 EditorRegions::get_single_selection ()
1352 {
1353         Glib::RefPtr<TreeSelection> selected = _display.get_selection();
1354
1355         if (selected->count_selected_rows() != 1) {
1356                 return boost::shared_ptr<Region> ();
1357         }
1358
1359         TreeView::Selection::ListHandle_Path rows = selected->get_selected_rows ();
1360
1361         /* only one row selected, so rows.begin() is it */
1362
1363         TreeIter iter = _model->get_iter (*rows.begin());
1364
1365         if (!iter) {
1366                 return boost::shared_ptr<Region> ();
1367         }
1368
1369         return (*iter)[_columns.region];
1370 }
1371
1372 void
1373 EditorRegions::freeze_tree_model (){
1374
1375         _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
1376         _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
1377
1378 }
1379
1380 void
1381 EditorRegions::thaw_tree_model (){
1382
1383         _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
1384         _display.set_model (_model);
1385
1386         if (toggle_full_action()->get_active()) {
1387                 _display.expand_all();
1388         }
1389 }
1390
1391 void
1392 EditorRegions::locked_changed (std::string const & path)
1393 {
1394         TreeIter i = _model->get_iter (path);
1395         if (i) {
1396                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1397                 if (region) {
1398                         region->set_locked (!(*i)[_columns.locked]);
1399                 }
1400         }
1401 }
1402
1403 void
1404 EditorRegions::glued_changed (std::string const & path)
1405 {
1406         TreeIter i = _model->get_iter (path);
1407         if (i) {
1408                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1409                 if (region) {
1410                         /* `glued' means MusicTime, and we're toggling here */
1411                         region->set_position_lock_style ((*i)[_columns.glued] ? AudioTime : MusicTime);
1412                 }
1413         }
1414
1415 }
1416
1417 void
1418 EditorRegions::muted_changed (std::string const & path)
1419 {
1420         TreeIter i = _model->get_iter (path);
1421         if (i) {
1422                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1423                 if (region) {
1424                         region->set_muted (!(*i)[_columns.muted]);
1425                 }
1426         }
1427
1428 }
1429
1430 void
1431 EditorRegions::opaque_changed (std::string const & path)
1432 {
1433         TreeIter i = _model->get_iter (path);
1434         if (i) {
1435                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1436                 if (region) {
1437                         region->set_opaque (!(*i)[_columns.opaque]);
1438                 }
1439         }
1440
1441 }
1442
1443 XMLNode &
1444 EditorRegions::get_state () const
1445 {
1446         XMLNode* node = new XMLNode (X_("RegionList"));
1447
1448         node->add_property (X_("sort-type"), enum_2_string (_sort_type));
1449
1450         RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1451         bool const ascending = RefPtr<RadioAction>::cast_dynamic(act)->get_active ();
1452         node->add_property (X_("sort-ascending"), ascending ? "yes" : "no");
1453         node->add_property (X_("show-all"), toggle_full_action()->get_active() ? "yes" : "no");
1454         node->add_property (X_("show-automatic-regions"), _show_automatic_regions ? "yes" : "no");
1455
1456         return *node;
1457 }
1458
1459 void
1460 EditorRegions::set_state (const XMLNode & node)
1461 {
1462         bool changed = false;
1463
1464         if (node.name() != X_("RegionList")) {
1465                 return;
1466         }
1467
1468         XMLProperty const * p = node.property (X_("sort-type"));
1469
1470         if (p) {
1471                 Editing::RegionListSortType const t = static_cast<Editing::RegionListSortType> (string_2_enum (p->value(), _sort_type));
1472
1473                 if (_sort_type != t) {
1474                         changed = true;
1475                 }
1476
1477                 reset_sort_type (t, true);
1478                 RefPtr<RadioAction> ract = sort_type_action (t);
1479                 ract->set_active ();
1480         }
1481
1482         p = node.property (X_("sort-ascending"));
1483
1484         if (p) {
1485                 bool const yn = string_is_affirmative (p->value ());
1486                 SortType old_sort_type;
1487                 int old_sort_column;
1488
1489                 _model->get_sort_column_id (old_sort_column, old_sort_type);
1490
1491                 if (old_sort_type != (yn ? SORT_ASCENDING : SORT_DESCENDING)) {
1492                         changed = true;
1493                 }
1494
1495                 reset_sort_direction (yn);
1496                 RefPtr<Action> act;
1497
1498                 if (yn) {
1499                         act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1500                 } else {
1501                         act = ActionManager::get_action (X_("RegionList"), X_("SortDescending"));
1502                 }
1503
1504                 RefPtr<RadioAction>::cast_dynamic(act)->set_active ();
1505         }
1506
1507         p = node.property (X_("show-all"));
1508         if (p) {
1509                 bool const yn = string_is_affirmative (p->value ());
1510
1511                 if (expanded != yn) {
1512                         changed = true;
1513                 }
1514
1515                 set_full (yn);
1516                 toggle_full_action()->set_active (yn);
1517         }
1518
1519         p = node.property (X_("show-automatic-regions"));
1520         if (p) {
1521                 bool const yn = string_is_affirmative (p->value ());
1522
1523                 if (yn != _show_automatic_regions) {
1524                         _show_automatic_regions = yn;
1525                         toggle_show_auto_regions_action()->set_active (yn);
1526                         changed = true;
1527                 }
1528         }
1529
1530         if (changed) {
1531                 redisplay ();
1532         }
1533 }
1534
1535 RefPtr<RadioAction>
1536 EditorRegions::sort_type_action (Editing::RegionListSortType t) const
1537 {
1538         const char* action = 0;
1539
1540         switch (t) {
1541         case Editing::ByName:
1542                 action = X_("SortByRegionName");
1543                 break;
1544         case Editing::ByLength:
1545                 action = X_("SortByRegionLength");
1546                 break;
1547         case Editing::ByPosition:
1548                 action = X_("SortByRegionPosition");
1549                 break;
1550         case Editing::ByTimestamp:
1551                 action = X_("SortByRegionTimestamp");
1552                 break;
1553         case Editing::ByStartInFile:
1554                 action = X_("SortByRegionStartinFile");
1555                 break;
1556         case Editing::ByEndInFile:
1557                 action = X_("SortByRegionEndinFile");
1558                 break;
1559         case Editing::BySourceFileName:
1560                 action = X_("SortBySourceFileName");
1561                 break;
1562         case Editing::BySourceFileLength:
1563                 action = X_("SortBySourceFileLength");
1564                 break;
1565         case Editing::BySourceFileCreationDate:
1566                 action = X_("SortBySourceFileCreationDate");
1567                 break;
1568         case Editing::BySourceFileFS:
1569                 action = X_("SortBySourceFilesystem");
1570                 break;
1571         default:
1572                 fatal << string_compose (_("programming error: %1: %2"), "EditorRegions: impossible sort type", (int) t) << endmsg;
1573                 abort(); /*NOTREACHED*/
1574         }
1575
1576         RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), action);
1577         assert (act);
1578
1579         return RefPtr<RadioAction>::cast_dynamic (act);
1580 }
1581
1582 RefPtr<Action>
1583 EditorRegions::hide_action () const
1584 {
1585         return ActionManager::get_action (X_("RegionList"), X_("rlHide"));
1586
1587 }
1588
1589 RefPtr<Action>
1590 EditorRegions::show_action () const
1591 {
1592         return ActionManager::get_action (X_("RegionList"), X_("rlShow"));
1593 }
1594
1595 RefPtr<Action>
1596 EditorRegions::remove_unused_regions_action () const
1597 {
1598         return ActionManager::get_action (X_("RegionList"), X_("removeUnusedRegions"));
1599 }
1600
1601 RefPtr<ToggleAction>
1602 EditorRegions::toggle_full_action () const
1603 {
1604         Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAll"));
1605         assert (act);
1606         return Glib::RefPtr<ToggleAction>::cast_dynamic (act);
1607 }
1608
1609 RefPtr<ToggleAction>
1610 EditorRegions::toggle_show_auto_regions_action () const
1611 {
1612         Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAuto"));
1613         assert (act);
1614         return Glib::RefPtr<ToggleAction>::cast_dynamic (act);
1615 }