Preserve region list selection state even if a region is selected which is not shown...
[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/region_factory.h"
32 #include "ardour/session.h"
33 #include "ardour/silentfilesource.h"
34 #include "ardour/profile.h"
35
36 #include "editor.h"
37 #include "editing.h"
38 #include "keyboard.h"
39 #include "ardour_ui.h"
40 #include "gui_thread.h"
41 #include "actions.h"
42 #include "region_view.h"
43 #include "utils.h"
44 #include "editor_regions.h"
45 #include "editor_drag.h"
46
47 #include "i18n.h"
48
49 using namespace std;
50 using namespace ARDOUR;
51 using namespace PBD;
52 using namespace Gtk;
53 using namespace Glib;
54 using namespace Editing;
55 using Gtkmm2ext::Keyboard;
56
57 EditorRegions::EditorRegions (Editor* e)
58         : EditorComponent (e)
59         , _menu (0)
60         , _show_automatic_regions (true)
61         , _sort_type ((Editing::RegionListSortType) 0)
62         , _no_redisplay (false) 
63         , ignore_region_list_selection_change (false)
64         , ignore_selected_region_change (false)
65 {
66         _display.set_size_request (100, -1);
67         _display.set_name ("RegionListDisplay");
68         /* Try to prevent single mouse presses from initiating edits.
69            This relies on a hack in gtktreeview.c:gtk_treeview_button_press()
70         */
71         _display.set_data ("mouse-edits-require-mod1", (gpointer) 0x1);
72
73         _model = TreeStore::create (_columns);
74         _model->set_sort_func (0, sigc::mem_fun (*this, &EditorRegions::sorter));
75         _model->set_sort_column (0, SORT_ASCENDING);
76
77         _display.set_model (_model);
78         _display.append_column (_("Regions"), _columns.name);
79         _display.append_column (_("Start"), _columns.start);
80         _display.append_column (_("End"), _columns.end);
81         _display.append_column (_("Length"), _columns.length);
82         _display.append_column (_("Sync"), _columns.sync);
83         _display.append_column (_("Fade In"), _columns.fadein);
84         _display.append_column (_("Fade Out"), _columns.fadeout);
85         _display.append_column (_("L"), _columns.locked);
86         _display.append_column (_("G"), _columns.glued);
87         _display.append_column (_("M"), _columns.muted);
88         _display.append_column (_("O"), _columns.opaque);
89         _display.append_column (_("Used"), _columns.used);
90         _display.append_column (_("Path"), _columns.path);
91         _display.set_headers_visible (true);
92         //_display.set_grid_lines (TREE_VIEW_GRID_LINES_BOTH);
93
94         CellRendererText* region_name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
95         region_name_cell->property_editable() = true;
96         region_name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRegions::name_edit));
97
98         _display.get_selection()->set_select_function (sigc::mem_fun (*this, &EditorRegions::selection_filter));
99
100         TreeViewColumn* tv_col = _display.get_column(0);
101         CellRendererText* renderer = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
102         tv_col->add_attribute(renderer->property_text(), _columns.name);
103         tv_col->add_attribute(renderer->property_foreground_gdk(), _columns.color_);
104
105         CellRendererToggle* locked_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (7));
106         locked_cell->property_activatable() = true;
107         locked_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::locked_changed));
108         TreeViewColumn* locked_col = _display.get_column (7);
109         locked_col->add_attribute (locked_cell->property_visible(), _columns.property_toggles_visible);
110
111         CellRendererToggle* glued_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (8));
112         glued_cell->property_activatable() = true;
113         glued_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::glued_changed));
114         TreeViewColumn* glued_col = _display.get_column (8);
115         glued_col->add_attribute (glued_cell->property_visible(), _columns.property_toggles_visible);
116
117         CellRendererToggle* muted_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (9));
118         muted_cell->property_activatable() = true;
119         muted_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::muted_changed));
120         TreeViewColumn* muted_col = _display.get_column (9);
121         muted_col->add_attribute (muted_cell->property_visible(), _columns.property_toggles_visible);
122
123         CellRendererToggle* opaque_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (10));
124         opaque_cell->property_activatable() = true;
125         opaque_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::opaque_changed));
126         TreeViewColumn* opaque_col = _display.get_column (10);
127         opaque_col->add_attribute (opaque_cell->property_visible(), _columns.property_toggles_visible);
128         
129         _display.get_selection()->set_mode (SELECTION_MULTIPLE);
130         _display.add_object_drag (_columns.region.index(), "regions");
131
132         /* setup DnD handling */
133
134         list<TargetEntry> region_list_target_table;
135
136         region_list_target_table.push_back (TargetEntry ("text/plain"));
137         region_list_target_table.push_back (TargetEntry ("text/uri-list"));
138         region_list_target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
139
140         _display.add_drop_targets (region_list_target_table);
141         _display.signal_drag_data_received().connect (sigc::mem_fun(*this, &EditorRegions::drag_data_received));
142
143         _scroller.add (_display);
144         _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
145
146         _display.signal_key_press_event().connect (sigc::mem_fun(*this, &EditorRegions::key_press));
147         _display.signal_button_press_event().connect (sigc::mem_fun(*this, &EditorRegions::button_press), false);
148         _change_connection = _display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &EditorRegions::selection_changed));
149         // _display.signal_popup_menu().connect (sigc::bind (sigc::mem_fun (*this, &Editor::show__display_context_menu), 1, 0));
150
151         //ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &Editor::redisplay_regions));
152         ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &EditorRegions::update_all_rows));
153         ARDOUR::Region::RegionPropertyChanged.connect (region_property_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::region_changed, this, _1, _2), gui_context());
154         ARDOUR::RegionFactory::CheckNewRegion.connect (check_new_region_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::add_region, this, _1), gui_context());
155 }
156
157 void
158 EditorRegions::set_session (ARDOUR::Session* s)
159 {
160         SessionHandlePtr::set_session (s);
161         redisplay ();
162 }
163
164 void
165 EditorRegions::add_regions (vector<boost::shared_ptr<Region> >& regions)
166 {
167         for (vector<boost::shared_ptr<Region> >::iterator x = regions.begin(); x != regions.end(); ++x) {
168                 add_region (*x);
169         }
170 }
171
172 void
173 EditorRegions::add_region (boost::shared_ptr<Region> region)
174 {
175         if (!region || !_session) {
176                 return;
177         }
178
179         string str;
180         TreeModel::Row row;
181         Gdk::Color c;
182         bool missing_source = boost::dynamic_pointer_cast<SilentFileSource>(region->source());
183
184         if (!_show_automatic_regions && region->automatic()) {
185                 return;
186         }
187
188         if (region->hidden()) {
189                 TreeModel::iterator iter = _model->get_iter ("0");
190                 TreeModel::Row parent;
191                 TreeModel::Row child;
192
193                 if (!iter) {
194                         parent = *(_model->append());
195                         parent[_columns.name] = _("Hidden");
196                         boost::shared_ptr<Region> proxy = parent[_columns.region];
197                         proxy.reset ();
198                 } else {
199                         string s = (*iter)[_columns.name];
200                         if (s != _("Hidden")) {
201                                 parent = *(_model->insert(iter));
202                                 parent[_columns.name] = _("Hidden");
203                                 boost::shared_ptr<Region> proxy = parent[_columns.region];
204                                 proxy.reset ();
205                         } else {
206                                 parent = *iter;
207                         }
208                 }
209
210                 row = *(_model->append (parent.children()));
211
212         } else if (region->whole_file()) {
213
214                 TreeModel::iterator i;
215                 TreeModel::Children rows = _model->children();
216
217                 for (i = rows.begin(); i != rows.end(); ++i) {
218                         boost::shared_ptr<Region> rr = (*i)[_columns.region];
219
220                         if (rr && region->region_list_equivalent (rr)) {
221                                 return;
222                         }
223                 }
224
225                 row = *(_model->append());
226
227                 if (missing_source) {
228                         c.set_rgb(65535,0,0);     // FIXME: error color from style
229
230                 } else if (region->automatic()){
231                         c.set_rgb(0,65535,0);     // FIXME: error color from style
232
233                 } else {
234                         set_color(c, rgba_from_style ("RegionListWholeFile", 0xff, 0, 0, 0, "fg", Gtk::STATE_NORMAL, false ));
235
236                 }
237
238                 row[_columns.color_] = c;
239
240                 if (region->source()->name()[0] == '/') { // external file
241
242                         if (region->whole_file()) {
243
244                                 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(region->source());
245                                 str = ".../";
246
247                                 if (afs) {
248                                         str = region_name_from_path (afs->path(), region->n_channels() > 1);
249                                 } else {
250                                         str += region->source()->name();
251                                 }
252
253                         } else {
254                                 str = region->name();
255                         }
256
257                 } else {
258                         str = region->name();
259                 }
260
261                 if (region->n_channels() > 1) {
262                         std::stringstream foo;
263                         foo << region->n_channels ();
264                         str += " [";
265                         str += foo.str();
266                         str += "]";
267                 }
268
269                 row[_columns.name] = str;
270                 row[_columns.region] = region;
271                 row[_columns.property_toggles_visible] = false;
272
273                 if (missing_source) {
274                         row[_columns.path] = _("(MISSING) ") + region->source()->name();
275
276                 } else {
277                         row[_columns.path] = region->source()->name();
278
279                 }
280
281                 if (region->automatic()) {
282                         return;
283                 }
284
285         } else {
286
287                 /* find parent node, add as new child */
288
289                 TreeModel::iterator i;
290                 TreeModel::Children rows = _model->children();
291                 bool found_parent = false;
292
293                 for (i = rows.begin(); i != rows.end(); ++i) {
294                         boost::shared_ptr<Region> rr = (*i)[_columns.region];
295                         boost::shared_ptr<AudioRegion> r = boost::dynamic_pointer_cast<AudioRegion>(rr);
296
297                         if (r && r->whole_file()) {
298
299                                 if (region->source_equivalent (r)) {
300                                         row = *(_model->append ((*i).children()));
301                                         found_parent = true;
302                                         break;
303                                 }
304                         }
305
306                         TreeModel::iterator ii;
307                         TreeModel::Children subrows = (*i).children();
308
309                         for (ii = subrows.begin(); ii != subrows.end(); ++ii) {
310                                 boost::shared_ptr<Region> rrr = (*ii)[_columns.region];
311
312                                 if (region->region_list_equivalent (rrr)) {
313                                         return;
314
315                                 }
316                         }
317                 }
318
319                 if (!found_parent) {
320                         row = *(_model->append());
321                 }
322
323                 row[_columns.property_toggles_visible] = true;
324         }
325
326         row[_columns.region] = region;
327
328         populate_row(region, (*row));
329 }
330
331 void
332 EditorRegions::region_changed (boost::shared_ptr<Region> r, const PropertyChange& what_changed)
333 {
334         if (what_changed.contains (ARDOUR::Properties::name) ||
335             what_changed.contains (ARDOUR::Properties::start) ||
336             what_changed.contains (ARDOUR::Properties::position) ||
337             what_changed.contains (ARDOUR::Properties::length) ||
338             what_changed.contains (ARDOUR::Properties::locked) ||
339             what_changed.contains (ARDOUR::Properties::position_lock_style) ||
340             what_changed.contains (ARDOUR::Properties::muted) ||
341             what_changed.contains (ARDOUR::Properties::opaque) ||
342             what_changed.contains (ARDOUR::Properties::fade_in) ||
343             what_changed.contains (ARDOUR::Properties::fade_out)) {
344
345                 /* find the region in our model and update its row */
346                 TreeModel::Children rows = _model->children ();
347                 TreeModel::iterator i = rows.begin ();
348                 while (i != rows.end ()) {
349                         TreeModel::Children children = (*i)->children ();
350                         TreeModel::iterator j = children.begin ();
351                         while (j != children.end()) {
352                                 boost::shared_ptr<Region> c = (*j)[_columns.region];
353                                 if (c == r) {
354                                         break;
355                                 }
356                                 ++j;
357                         }
358
359                         if (j != children.end()) {
360                                 populate_row (r, *j);
361                         }
362
363                         ++i;
364                 }
365
366         }
367
368         if (what_changed.contains (ARDOUR::Properties::hidden)) {
369                 redisplay ();
370         }
371 }
372
373 void
374 EditorRegions::selection_changed ()
375 {
376         if (ignore_region_list_selection_change) {
377                 return;
378         }
379
380         /* We may have selected a region which is not displayed in the Editor.  If this happens, the
381            result will be no selected regions in the editor's Selection.  Without the following line,
382            this `no-selection' will be mapped back to our list, meaning that the selection will
383            appear not to take.
384         */
385         _editor->_block_region_list_update_if_empty = true;
386
387         if (_display.get_selection()->count_selected_rows() > 0) {
388
389                 TreeIter iter;
390                 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
391
392                 _editor->get_selection().clear_regions ();
393
394                 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
395
396                         if (iter = _model->get_iter (*i)) { 
397                                 boost::shared_ptr<Region> region = (*iter)[_columns.region];
398
399                                 // they could have clicked on a row that is just a placeholder, like "Hidden"
400
401                                 if (region) {
402
403                                         if (region->automatic()) {
404
405                                                 _display.get_selection()->unselect(*i);
406
407                                         } else {
408                                                 _change_connection.block (true);
409                                                 _editor->set_selected_regionview_from_region_list (region, Selection::Add);
410
411                                                 _change_connection.block (false);
412                                         }
413                                 }
414                         }
415                 }
416         } else {
417                 _editor->get_selection().clear_regions ();
418         }
419
420         _editor->_block_region_list_update_if_empty = false;
421 }
422
423 void
424 EditorRegions::set_selected (RegionSelection& regions)
425 {
426         for (RegionSelection::iterator iter = regions.begin(); iter != regions.end(); ++iter) {
427
428                 TreeModel::iterator i;
429                 TreeModel::Children rows = _model->children();
430                 boost::shared_ptr<Region> r ((*iter)->region());
431
432                 for (i = rows.begin(); i != rows.end(); ++i) {
433
434                         boost::shared_ptr<Region> compared_region = (*i)[_columns.region];
435
436                         if (r == compared_region) {
437                                 _display.get_selection()->select(*i);
438                                 break;
439                         }
440
441                         if (!(*i).children().empty()) {
442                                 if (set_selected_in_subrow(r, (*i), 2)) {
443                                         break;
444                                 }
445                         }
446                 }
447         }
448 }
449
450 bool
451 EditorRegions::set_selected_in_subrow (boost::shared_ptr<Region> region, TreeModel::Row const &parent_row, int level)
452 {
453         TreeModel::iterator i;
454         TreeModel::Children subrows = (*parent_row).children();
455
456         for (i = subrows.begin(); i != subrows.end(); ++i) {
457
458                 boost::shared_ptr<Region> compared_region = (*i)[_columns.region];
459
460                 if (region == compared_region) {
461                         _display.get_selection()->select(*i);
462                         return true;
463                 }
464
465                 if (!(*i).children().empty()) {
466                         if (set_selected_in_subrow (region, (*i), level + 1)) {
467                                 return true;
468                         }
469                 }
470         }
471         return false;
472 }
473
474 void
475 EditorRegions::insert_into_tmp_regionlist(boost::shared_ptr<Region> region)
476 {
477         /* keep all whole files at the beginning */
478
479         if (region->whole_file()) {
480                 tmp_region_list.push_front (region);
481         } else {
482                 tmp_region_list.push_back (region);
483         }
484 }
485
486 void
487 EditorRegions::redisplay ()
488 {
489         if (_no_redisplay || !_session) {
490                 return;
491         }
492
493         bool tree_expanded = false;
494
495         if (_toggle_full_action && _toggle_full_action->get_active()) {   //If the list was expanded prior to rebuilding,
496                 tree_expanded = true;                                                                                                                           //expand it again afterwards
497         }
498
499         _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
500         _model->clear ();
501
502         /* now add everything we have, via a temporary list used to help with
503                 sorting.
504         */
505
506         tmp_region_list.clear();
507
508         const RegionFactory::RegionMap& regions (RegionFactory::regions());
509         for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
510                 insert_into_tmp_regionlist (i->second);
511         }
512
513         for (list<boost::shared_ptr<Region> >::iterator r = tmp_region_list.begin(); r != tmp_region_list.end(); ++r) {
514                 add_region (*r);
515         }
516         tmp_region_list.clear();
517
518         _display.set_model (_model);
519
520         if (tree_expanded) {
521                 _display.expand_all();
522         }
523 }
524
525 void
526 EditorRegions::update_row (boost::shared_ptr<Region> region)
527 {
528         if (!region || !_session) {
529                 return;
530         }
531
532         TreeModel::iterator i;
533         TreeModel::Children rows = _model->children();
534         
535         return;
536
537         for (i = rows.begin(); i != rows.end(); ++i) {
538
539 //              cerr << "Level 1: Compare " << region->name() << " with parent " << (*i)[_columns.name] << "\n";
540
541                 boost::shared_ptr<Region> compared_region = (*i)[_columns.region];
542
543                 if (region == compared_region) {
544 //                      cerr << "Matched\n";
545                         populate_row(region, (*i));
546                         return;
547                 }
548
549                 if (!(*i).children().empty()) {
550                         if (update_subrows(region, (*i), 2)) {
551                                 return;
552                         }
553                 }
554         }
555
556 //      cerr << "Returning - No match\n";
557 }
558
559 bool
560 EditorRegions::update_subrows (boost::shared_ptr<Region> region, TreeModel::Row const &parent_row, int level)
561 {
562         TreeModel::iterator i;
563         TreeModel::Children subrows = (*parent_row).children();
564
565         for (i = subrows.begin(); i != subrows.end(); ++i) {
566
567 //              cerr << "Level " << level << ": Compare " << region->name() << " with child " << (*i)[_columns.name] << "\n";
568
569                 boost::shared_ptr<Region> compared_region = (*i)[_columns.region];
570
571                 if (region == compared_region) {
572                         populate_row(region, (*i));
573 //                      cerr << "Matched\n";
574                         return true;
575                 }
576
577                 if (!(*i).children().empty()) {
578                         if (update_subrows (region, (*i), level + 1)) {
579                                 return true;
580                         }
581                 }
582         }
583
584         return false;
585 }
586
587 void
588 EditorRegions::update_all_rows ()
589 {
590         if (!_session) {
591                 return;
592         }
593         
594         TreeModel::iterator i;
595         TreeModel::Children rows = _model->children();
596
597         for (i = rows.begin(); i != rows.end(); ++i) {
598
599                 boost::shared_ptr<Region> region = (*i)[_columns.region];
600
601                 if (!region->automatic()) {
602                         populate_row(region, (*i));
603                 }
604
605                 if (!(*i).children().empty()) {
606                         update_all_subrows ((*i), 2);
607                 }
608         }
609 }
610
611 void
612 EditorRegions::update_all_subrows (TreeModel::Row const &parent_row, int level)
613 {
614         TreeModel::iterator i;
615         TreeModel::Children subrows = (*parent_row).children();
616
617         for (i = subrows.begin(); i != subrows.end(); ++i) {
618
619                 boost::shared_ptr<Region> region = (*i)[_columns.region];
620
621                 if (!region->automatic()) {
622                         populate_row(region, (*i));
623                 }
624
625                 if (!(*i).children().empty()) {
626                         update_all_subrows ((*i), level + 1);
627                 }
628         }
629 }
630
631 void
632 EditorRegions::populate_row (boost::shared_ptr<Region> region, TreeModel::Row const &row)
633 {
634         char start_str[16];
635         char end_str[16];
636         char length_str[16];
637         char sync_str[16];
638         char fadein_str[16];
639         char fadeout_str[16];
640         char used_str[8];
641         int used;
642         BBT_Time bbt;
643         Timecode::Time timecode;
644
645         bool missing_source = boost::dynamic_pointer_cast<SilentFileSource>(region->source());
646
647         boost::shared_ptr<AudioRegion> audioRegion = boost::dynamic_pointer_cast<AudioRegion>(region);
648
649         bool fades_in_seconds = false;
650
651         start_str[0] = '\0';
652         end_str[0] = '\0';
653         length_str[0] = '\0';
654         sync_str[0] = '\0';
655         fadein_str[0] = '\0';
656         fadeout_str[0] = '\0';
657         used_str[0] = '\0';
658
659         used = _editor->get_regionview_count_from_region_list (region);
660         sprintf (used_str, "%4d" , used);
661
662         switch (ARDOUR_UI::instance()->secondary_clock.mode ()) {
663         case AudioClock::Timecode:
664         case AudioClock::Off:                                                                                           /* If the secondary clock is off, default to Timecode */
665                 _session->timecode_time (region->position(), timecode);
666                 sprintf (start_str, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
667                 _session->timecode_time (region->position() + region->length() - 1, timecode);
668                 sprintf (end_str, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
669                 _session->timecode_time (region->length(), timecode);
670                 sprintf (length_str, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
671                 _session->timecode_time (region->sync_position(), timecode);
672                 sprintf (sync_str, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
673
674                 if (audioRegion && !fades_in_seconds) {
675                         _session->timecode_time (audioRegion->fade_in()->back()->when, timecode);
676                         sprintf (fadein_str, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
677                         _session->timecode_time (audioRegion->fade_out()->back()->when, timecode);
678                         sprintf (fadeout_str, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
679                 }
680
681                 break;
682
683         case AudioClock::BBT:
684                 _session->tempo_map().bbt_time (region->position(), bbt);
685                 sprintf (start_str, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
686                 _session->tempo_map().bbt_time (region->position() + region->length() - 1, bbt);
687                 sprintf (end_str, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
688                 _session->tempo_map().bbt_time (region->length(), bbt);
689                 sprintf (length_str, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
690                 _session->tempo_map().bbt_time (region->sync_position(), bbt);
691                 sprintf (sync_str, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
692
693                 if (audioRegion && !fades_in_seconds) {
694                         _session->tempo_map().bbt_time (audioRegion->fade_in()->back()->when, bbt);
695                         sprintf (fadein_str, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
696                         _session->tempo_map().bbt_time (audioRegion->fade_out()->back()->when, bbt);
697                         sprintf (fadeout_str, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
698                 }
699                 break;
700
701         case AudioClock::MinSec:
702                 nframes_t left;
703                 int hrs;
704                 int mins;
705                 float secs;
706
707                 left = region->position();
708                 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
709                 left -= (nframes_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
710                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
711                 left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
712                 secs = left / (float) _session->frame_rate();
713                 sprintf (start_str, "%02d:%02d:%06.3f", hrs, mins, secs);
714
715                 left = region->position() + region->length() - 1;
716                 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
717                 left -= (nframes_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
718                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
719                 left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
720                 secs = left / (float) _session->frame_rate();
721                 sprintf (end_str, "%02d:%02d:%06.3f", hrs, mins, secs);
722
723                 left = region->length();
724                 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
725                 left -= (nframes_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
726                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
727                 left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
728                 secs = left / (float) _session->frame_rate();
729                 sprintf (length_str, "%02d:%02d:%06.3f", hrs, mins, secs);
730
731                 left = region->sync_position();
732                 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
733                 left -= (nframes_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
734                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
735                 left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
736                 secs = left / (float) _session->frame_rate();
737                 sprintf (sync_str, "%02d:%02d:%06.3f", hrs, mins, secs);
738
739                 if (audioRegion && !fades_in_seconds) {
740                         left = audioRegion->fade_in()->back()->when;
741                         hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
742                         left -= (nframes_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
743                         mins = (int) floor (left / (_session->frame_rate() * 60.0f));
744                         left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
745                         secs = left / (float) _session->frame_rate();
746                         sprintf (fadein_str, "%02d:%02d:%06.3f", hrs, mins, secs);
747
748                         left = audioRegion->fade_out()->back()->when;
749                         hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
750                         left -= (nframes_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
751                         mins = (int) floor (left / (_session->frame_rate() * 60.0f));
752                         left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
753                         secs = left / (float) _session->frame_rate();
754                         sprintf (fadeout_str, "%02d:%02d:%06.3f", hrs, mins, secs);
755                 }
756
757                 break;
758
759         case AudioClock::Frames:
760                 snprintf (start_str, sizeof (start_str), "%" PRId64, region->position());
761                 snprintf (end_str, sizeof (end_str), "%" PRId64, (region->last_frame()));
762                 snprintf (length_str, sizeof (length_str), "%" PRId64, region->length());
763                 snprintf (sync_str, sizeof (sync_str), "%" PRId64, region->sync_position());
764
765                 if (audioRegion && !fades_in_seconds) {
766                         snprintf (fadein_str, sizeof (fadein_str), "%u", uint (audioRegion->fade_in()->back()->when));
767                         snprintf (fadeout_str, sizeof (fadeout_str), "%u", uint (audioRegion->fade_out()->back()->when));
768                 }
769
770                 break;
771
772         default:
773                 break;
774         }
775
776         if (audioRegion && fades_in_seconds) {
777
778                 nframes_t left;
779                 int mins;
780                 int millisecs;
781
782                 left = audioRegion->fade_in()->back()->when;
783                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
784                 left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
785                 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
786
787                 if (audioRegion->fade_in()->back()->when >= _session->frame_rate()) {
788                         sprintf (fadein_str, "%01dM %01dmS", mins, millisecs);
789                 } else {
790                         sprintf (fadein_str, "%01dmS", millisecs);
791                 }
792
793                 left = audioRegion->fade_out()->back()->when;
794                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
795                 left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
796                 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
797
798                 if (audioRegion->fade_out()->back()->when >= _session->frame_rate()) {
799                         sprintf (fadeout_str, "%01dM %01dmS", mins, millisecs);
800                 } else {
801                         sprintf (fadeout_str, "%01dmS", millisecs);
802                 }
803         }
804
805         if (used > 1) {
806                 row[_columns.start] = _("Multiple");
807                 row[_columns.end] = _("Multiple");
808                 row[_columns.sync] = _("Multiple");
809                 row[_columns.fadein] = _("Multiple");
810                 row[_columns.fadeout] = _("Multiple");
811                 row[_columns.locked] = false;
812                 row[_columns.glued] = false;
813                 row[_columns.muted] = false;
814                 row[_columns.opaque] = false;
815         } else {
816                 row[_columns.start] = start_str;
817                 row[_columns.end] = end_str;
818
819                 if (region->sync_position() == region->position()) {
820                         row[_columns.sync] = _("Start");
821                 } else if (region->sync_position() == (region->position() + region->length() - 1)) {
822                         row[_columns.sync] = _("End");
823                 } else {
824                         row[_columns.sync] = sync_str;
825                 }
826
827                 if (audioRegion) {
828                         if (audioRegion->fade_in_active()) {
829                                 row[_columns.fadein] = string_compose("%1%2%3", " ", fadein_str, " ");
830                         } else {
831                                 row[_columns.fadein] = string_compose("%1%2%3", "(", fadein_str, ")");
832                         }
833                 } else {
834                         row[_columns.fadein] = "";
835                 }
836
837                 if (audioRegion) {
838                         if (audioRegion->fade_out_active()) {
839                                 row[_columns.fadeout] = string_compose("%1%2%3", " ", fadeout_str, " ");
840                         } else {
841                                 row[_columns.fadeout] = string_compose("%1%2%3", "(", fadeout_str, ")");
842                         }
843                 } else {
844                         row[_columns.fadeout] = "";
845                 }
846
847                 row[_columns.locked] = region->locked();
848
849                 if (region->position_lock_style() == MusicTime) {
850                         row[_columns.glued] = true;
851                 } else {
852                         row[_columns.glued] = false;
853                 }
854
855                 row[_columns.muted] = region->muted();
856                 row[_columns.opaque] = region->opaque();
857         }
858
859         row[_columns.length] = length_str;
860         row[_columns.used] = used_str;
861
862         if (missing_source) {
863                 row[_columns.path] = _("MISSING ") + region->source()->name();
864         } else {
865                 row[_columns.path] = region->source()->name();
866         }
867
868         if (region->n_channels() > 1) {
869                 row[_columns.name] = string_compose("%1  [%2]", region->name(), region->n_channels());
870         } else {
871                 row[_columns.name] = region->name();
872         }
873 }
874
875 void
876 EditorRegions::build_menu ()
877 {
878         _menu = dynamic_cast<Menu*>(ActionManager::get_widget ("/RegionListMenu"));
879
880         /* now grab specific menu items that we need */
881
882         Glib::RefPtr<Action> act;
883
884         _hide_action = ActionManager::get_action (X_("RegionList"), X_("rlHide"));
885         _show_action = ActionManager::get_action (X_("RegionList"), X_("rlShow"));
886
887         act = ActionManager::get_action (X_("RegionList"), X_("rlShowAll"));
888         if (act) {
889                 _toggle_full_action = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
890         }
891
892         act = ActionManager::get_action (X_("RegionList"), X_("rlShowAuto"));
893         if (act) {
894                 _toggle_show_auto_regions_action = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
895         }
896 }
897
898 void
899 EditorRegions::toggle_show_auto_regions ()
900 {
901         _show_automatic_regions = _toggle_show_auto_regions_action->get_active();
902         redisplay ();
903 }
904
905 void
906 EditorRegions::toggle_full ()
907 {
908         if (_toggle_full_action->get_active()) {
909                 _display.expand_all ();
910         } else {
911                 _display.collapse_all ();
912         }
913 }
914
915 void
916 EditorRegions::show_context_menu (int button, int time)
917 {
918         if (_menu == 0) {
919                 build_menu ();
920         }
921
922         if (_display.get_selection()->count_selected_rows() > 0) {
923                 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, true);
924         } else {
925                 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, false);
926         }
927
928         /* Enable the "Show" option if any selected regions are hidden, and vice versa for "Hide" */
929
930         bool have_shown = false;
931         bool have_hidden = false;
932         
933         TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
934         for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
935                 TreeIter t = _model->get_iter (*i);
936                 boost::shared_ptr<Region> r = (*t)[_columns.region];
937                 if (r) {
938                         if (r->hidden ()) {
939                                 have_hidden = true;
940                         } else {
941                                 have_shown = true;
942                         }
943                 }
944         }
945
946         _hide_action->set_sensitive (have_shown);
947         _show_action->set_sensitive (have_hidden);
948
949         _menu->popup (button, time);
950 }
951
952 bool
953 EditorRegions::key_press (GdkEventKey* /*ev*/)
954 {
955         return false;
956 }
957
958
959 bool
960 EditorRegions::button_press (GdkEventButton *ev)
961 {
962         boost::shared_ptr<Region> region;
963         TreeIter iter;
964         TreeModel::Path path;
965         TreeViewColumn* column;
966         int cellx;
967         int celly;
968
969         if (_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
970                 if ((iter = _model->get_iter (path))) {
971                         region = (*iter)[_columns.region];
972                 }
973         }
974
975         if (Keyboard::is_context_menu_event (ev)) {
976                 show_context_menu (ev->button, ev->time);
977                 return false;
978         }
979
980         if (region != 0 && Keyboard::is_button2_event (ev)) {
981                 // start/stop audition
982                 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
983                         _editor->consider_auditioning (region);
984                 }
985                 return true;
986         }
987
988         return false;
989 }
990
991 int
992 EditorRegions::sorter (TreeModel::iterator a, TreeModel::iterator b)
993 {
994         int cmp = 0;
995
996         boost::shared_ptr<Region> r1 = (*a)[_columns.region];
997         boost::shared_ptr<Region> r2 = (*b)[_columns.region];
998
999         /* handle rows without regions, like "Hidden" */
1000
1001         if (r1 == 0) {
1002                 return -1;
1003         }
1004
1005         if (r2 == 0) {
1006                 return 1;
1007         }
1008
1009         boost::shared_ptr<AudioRegion> region1 = boost::dynamic_pointer_cast<AudioRegion> (r1);
1010         boost::shared_ptr<AudioRegion> region2 = boost::dynamic_pointer_cast<AudioRegion> (r2);
1011
1012         if (region1 == 0 || region2 == 0) {
1013                 std::string s1;
1014                 std::string s2;
1015                 switch (_sort_type) {
1016                 case ByName:
1017                         s1 = (*a)[_columns.name];
1018                         s2 = (*b)[_columns.name];
1019                         return (s1.compare (s2));
1020                 default:
1021                         return 0;
1022                 }
1023         }
1024
1025         switch (_sort_type) {
1026         case ByName:
1027                 cmp = strcasecmp (region1->name().c_str(), region2->name().c_str());
1028                 break;
1029
1030         case ByLength:
1031                 cmp = region1->length() - region2->length();
1032                 break;
1033
1034         case ByPosition:
1035                 cmp = region1->position() - region2->position();
1036                 break;
1037
1038         case ByTimestamp:
1039                 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1040                 break;
1041
1042         case ByStartInFile:
1043                 cmp = region1->start() - region2->start();
1044                 break;
1045
1046         case ByEndInFile:
1047                 // cerr << "Compare " << (region1->start() + region1->length()) << " and " << (region2->start() + region2->length()) << endl;
1048                 cmp = (region1->start() + region1->length()) - (region2->start() + region2->length());
1049                 break;
1050
1051         case BySourceFileName:
1052                 cmp = strcasecmp (region1->source()->name().c_str(), region2->source()->name().c_str());
1053                 break;
1054
1055         case BySourceFileLength:
1056                 cmp = region1->source_length(0) - region2->source_length(0);
1057                 break;
1058
1059         case BySourceFileCreationDate:
1060                 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1061                 break;
1062
1063         case BySourceFileFS:
1064                 if (region1->source()->name() == region2->source()->name()) {
1065                         cmp = strcasecmp (region1->name().c_str(),  region2->name().c_str());
1066                 } else {
1067                         cmp = strcasecmp (region1->source()->name().c_str(),  region2->source()->name().c_str());
1068                 }
1069                 break;
1070         }
1071
1072         // cerr << "Comparison on " << enum_2_string (_sort_type) << " gives " << cmp << endl;
1073
1074         if (cmp < 0) {
1075                 return -1;
1076         } else if (cmp > 0) {
1077                 return 1;
1078         } else {
1079                 return 0;
1080         }
1081 }
1082
1083 void
1084 EditorRegions::reset_sort_type (RegionListSortType type, bool force)
1085 {
1086         if (type != _sort_type || force) {
1087                 _sort_type = type;
1088                 _model->set_sort_func (0, (sigc::mem_fun (*this, &EditorRegions::sorter)));
1089         }
1090 }
1091
1092 void
1093 EditorRegions::reset_sort_direction (bool up)
1094 {
1095         _model->set_sort_column (0, up ? SORT_ASCENDING : SORT_DESCENDING);
1096 }
1097
1098 void
1099 EditorRegions::selection_mapover (sigc::slot<void,boost::shared_ptr<Region> > sl)
1100 {
1101         Glib::RefPtr<TreeSelection> selection = _display.get_selection();
1102         TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1103         TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1104
1105         if (selection->count_selected_rows() == 0 || _session == 0) {
1106                 return;
1107         }
1108
1109         for (; i != rows.end(); ++i) {
1110                 TreeIter iter;
1111
1112                 if ((iter = _model->get_iter (*i))) {
1113
1114                         /* some rows don't have a region associated with them, but can still be
1115                            selected (XXX maybe prevent them from being selected)
1116                         */
1117
1118                         boost::shared_ptr<Region> r = (*iter)[_columns.region];
1119
1120                         if (r) {
1121                                 sl (r);
1122                         }
1123                 }
1124         }
1125 }
1126
1127
1128 void
1129 EditorRegions::drag_data_received (const RefPtr<Gdk::DragContext>& context,
1130                                    int x, int y,
1131                                    const SelectionData& data,
1132                                    guint info, guint time)
1133 {
1134         vector<string> paths;
1135
1136         if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1137                 /* something is being dragged over the region list */
1138                 _editor->_drags->abort ();
1139                 _display.on_drag_data_received (context, x, y, data, info, time);
1140                 return;
1141         }
1142
1143         if (_editor->convert_drop_to_paths (paths, context, x, y, data, info, time) == 0) {
1144                 framepos_t pos = 0;
1145                 if (Profile->get_sae() || Config->get_only_copy_imported_files()) {
1146                         _editor->do_import (paths, Editing::ImportDistinctFiles, Editing::ImportAsRegion, SrcBest, pos);
1147                 } else {
1148                         _editor->do_embed (paths, Editing::ImportDistinctFiles, ImportAsRegion, pos);
1149                 }
1150                 context->drag_finish (true, false, time);
1151         }
1152 }
1153
1154 bool
1155 EditorRegions::selection_filter (const RefPtr<TreeModel>& model, const TreeModel::Path& path, bool /*yn*/)
1156 {
1157         /* not possible to select rows that do not represent regions, like "Hidden" */
1158
1159         TreeModel::iterator iter = model->get_iter (path);
1160
1161         if (iter) {
1162                 boost::shared_ptr<Region> r =(*iter)[_columns.region];
1163                 if (!r) {
1164                         return false;
1165                 }
1166         }
1167
1168         return true;
1169 }
1170
1171 void
1172 EditorRegions::name_edit (const std::string& path, const std::string& new_text)
1173 {
1174         boost::shared_ptr<Region> region;
1175         TreeIter iter;
1176
1177         if ((iter = _model->get_iter (path))) {
1178                 region = (*iter)[_columns.region];
1179                 (*iter)[_columns.name] = new_text;
1180         }
1181
1182         /* now mapover everything */
1183
1184         if (region) {
1185                 vector<RegionView*> equivalents;
1186                 _editor->get_regions_corresponding_to (region, equivalents);
1187
1188                 for (vector<RegionView*>::iterator i = equivalents.begin(); i != equivalents.end(); ++i) {
1189                         if (new_text != (*i)->region()->name()) {
1190                                 (*i)->region()->set_name (new_text);
1191                         }
1192                 }
1193         }
1194
1195 }
1196
1197 /** @return Region that has been dragged out of the list, or 0 */
1198 boost::shared_ptr<Region>
1199 EditorRegions::get_dragged_region ()
1200 {
1201         list<boost::shared_ptr<Region> > regions;
1202         TreeView* source;
1203         _display.get_object_drag_data (regions, &source);
1204
1205         if (regions.empty()) {
1206                 return boost::shared_ptr<Region> ();
1207         }
1208         
1209         assert (regions.size() == 1);
1210         return regions.front ();
1211 }
1212
1213 void
1214 EditorRegions::clear ()
1215 {
1216         _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1217         _model->clear ();
1218         _display.set_model (_model);
1219 }
1220
1221 boost::shared_ptr<Region>
1222 EditorRegions::get_single_selection ()
1223 {
1224         Glib::RefPtr<TreeSelection> selected = _display.get_selection();
1225
1226         if (selected->count_selected_rows() != 1) {
1227                 return boost::shared_ptr<Region> ();
1228         }
1229
1230         TreeView::Selection::ListHandle_Path rows = selected->get_selected_rows ();
1231
1232         /* only one row selected, so rows.begin() is it */
1233
1234         TreeIter iter = _model->get_iter (*rows.begin());
1235
1236         if (!iter) {
1237                 return boost::shared_ptr<Region> ();
1238         }
1239
1240         return (*iter)[_columns.region];
1241 }
1242
1243 void
1244 EditorRegions::locked_changed (std::string const & path)
1245 {
1246         TreeIter i = _model->get_iter (path);
1247         if (i) {
1248                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1249                 if (region) {
1250                         region->set_locked (!(*i)[_columns.locked]);
1251                 }
1252         }
1253 }
1254
1255 void
1256 EditorRegions::glued_changed (std::string const & path)
1257 {
1258         TreeIter i = _model->get_iter (path);
1259         if (i) {
1260                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1261                 if (region) {
1262                         /* `glued' means MusicTime, and we're toggling here */
1263                         region->set_position_lock_style ((*i)[_columns.glued] ? AudioTime : MusicTime);
1264                 }
1265         }
1266
1267 }
1268
1269 void
1270 EditorRegions::muted_changed (std::string const & path)
1271 {
1272         TreeIter i = _model->get_iter (path);
1273         if (i) {
1274                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1275                 if (region) {
1276                         region->set_muted (!(*i)[_columns.muted]);
1277                 }
1278         }
1279
1280 }
1281
1282 void
1283 EditorRegions::opaque_changed (std::string const & path)
1284 {
1285         TreeIter i = _model->get_iter (path);
1286         if (i) {
1287                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1288                 if (region) {
1289                         region->set_opaque (!(*i)[_columns.opaque]);
1290                 }
1291         }
1292
1293 }