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