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