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