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