Vkeybd: use ArdourWidgets for all GUI elements
[ardour.git] / gtk2_ardour / editor_regions.cc
1 /*
2  * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
3  * Copyright (C) 2009-2012 David Robillard <d@drobilla.net>
4  * Copyright (C) 2009-2018 Paul Davis <paul@linuxaudiosystems.com>
5  * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
6  * Copyright (C) 2015-2016 Tim Mayberry <mojofunk@gmail.com>
7  * Copyright (C) 2016 Nick Mainsbridge <mainsbridge@gmail.com>
8  * Copyright (C) 2018-2019 Ben Loftis <ben@harrisonconsoles.com>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License along
21  * with this program; if not, write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  */
24
25 #include <algorithm>
26 #include <cmath>
27 #include <cstdlib>
28 #include <sstream>
29 #include <string>
30
31 #include "pbd/basename.h"
32 #include "pbd/enumwriter.h"
33
34 #include "ardour/audiofilesource.h"
35 #include "ardour/audioregion.h"
36 #include "ardour/profile.h"
37 #include "ardour/region_factory.h"
38 #include "ardour/session.h"
39 #include "ardour/session_playlist.h"
40 #include "ardour/silentfilesource.h"
41
42 #include "gtkmm2ext/treeutils.h"
43 #include "gtkmm2ext/utils.h"
44
45 #include "widgets/choice.h"
46 #include "widgets/tooltips.h"
47
48 #include "actions.h"
49 #include "ardour_ui.h"
50 #include "audio_clock.h"
51 #include "editing.h"
52 #include "editing_convert.h"
53 #include "editor.h"
54 #include "editor_drag.h"
55 #include "editor_regions.h"
56 #include "gui_thread.h"
57 #include "keyboard.h"
58 #include "main_clock.h"
59 #include "region_view.h"
60 #include "ui_config.h"
61 #include "utils.h"
62
63 #include "pbd/i18n.h"
64
65 using namespace std;
66 using namespace ARDOUR;
67 using namespace ArdourWidgets;
68 using namespace ARDOUR_UI_UTILS;
69 using namespace PBD;
70 using namespace Gtk;
71 using namespace Glib;
72 using namespace Editing;
73 using Gtkmm2ext::Keyboard;
74
75 struct ColumnInfo {
76         int                index;
77         int                sort_idx;
78         Gtk::AlignmentEnum al;
79         const char*        label;
80         const char*        tooltip;
81 };
82
83 //#define SHOW_REGION_EXTRAS
84
85 EditorRegions::EditorRegions (Editor* e)
86         : EditorComponent (e)
87         , old_focus (0)
88         , name_editable (0)
89         , tags_editable (0)
90         , _menu (0)
91         , _no_redisplay (false)
92 {
93         _display.set_size_request (100, -1);
94         _display.set_rules_hint (true);
95         _display.set_name ("RegionList");
96         _display.set_fixed_height_mode (true);
97         _display.set_reorderable (false);
98
99         /* Try to prevent single mouse presses from initiating edits.
100          * This relies on a hack in gtktreeview.c:gtk_treeview_button_press() */
101         _display.set_data ("mouse-edits-require-mod1", (gpointer)0x1);
102
103         _model = TreeStore::create (_columns);
104         _model->set_sort_column (0, SORT_ASCENDING);
105
106         /* column widths */
107         int bbt_width, date_width, check_width, height;
108
109         Glib::RefPtr<Pango::Layout> layout = _display.create_pango_layout (X_ ("000|000|000"));
110         Gtkmm2ext::get_pixel_size (layout, bbt_width, height);
111
112         Glib::RefPtr<Pango::Layout> layout2 = _display.create_pango_layout (X_ ("2099-10-10 10:10:30"));
113         Gtkmm2ext::get_pixel_size (layout2, date_width, height);
114
115         check_width = 20;
116
117         TreeViewColumn* col_name = manage (new TreeViewColumn ("", _columns.name));
118         col_name->set_fixed_width (120);
119         col_name->set_sizing (TREE_VIEW_COLUMN_FIXED);
120         TreeViewColumn* col_tags = manage (new TreeViewColumn ("", _columns.tags));
121         col_tags->set_fixed_width (date_width);
122         col_tags->set_sizing (TREE_VIEW_COLUMN_FIXED);
123         TreeViewColumn* col_start = manage (new TreeViewColumn ("", _columns.start));
124         col_start->set_fixed_width (bbt_width);
125         col_start->set_sizing (TREE_VIEW_COLUMN_FIXED);
126         TreeViewColumn* col_end = manage (new TreeViewColumn ("", _columns.end));
127         col_end->set_fixed_width (bbt_width);
128         col_end->set_sizing (TREE_VIEW_COLUMN_FIXED);
129         TreeViewColumn* col_length = manage (new TreeViewColumn ("", _columns.length));
130         col_length->set_fixed_width (bbt_width);
131         col_length->set_sizing (TREE_VIEW_COLUMN_FIXED);
132         TreeViewColumn* col_sync = manage (new TreeViewColumn ("", _columns.sync));
133         col_sync->set_fixed_width (bbt_width);
134         col_sync->set_sizing (TREE_VIEW_COLUMN_FIXED);
135         TreeViewColumn* col_fadein = manage (new TreeViewColumn ("", _columns.fadein));
136         col_fadein->set_fixed_width (bbt_width);
137         col_fadein->set_sizing (TREE_VIEW_COLUMN_FIXED);
138         TreeViewColumn* col_fadeout = manage (new TreeViewColumn ("", _columns.fadeout));
139         col_fadeout->set_fixed_width (bbt_width);
140         col_fadeout->set_sizing (TREE_VIEW_COLUMN_FIXED);
141         TreeViewColumn* col_locked = manage (new TreeViewColumn ("", _columns.locked));
142         col_locked->set_fixed_width (check_width);
143         col_locked->set_sizing (TREE_VIEW_COLUMN_FIXED);
144         TreeViewColumn* col_glued = manage (new TreeViewColumn ("", _columns.glued));
145         col_glued->set_fixed_width (check_width);
146         col_glued->set_sizing (TREE_VIEW_COLUMN_FIXED);
147         TreeViewColumn* col_muted = manage (new TreeViewColumn ("", _columns.muted));
148         col_muted->set_fixed_width (check_width);
149         col_muted->set_sizing (TREE_VIEW_COLUMN_FIXED);
150         TreeViewColumn* col_opaque = manage (new TreeViewColumn ("", _columns.opaque));
151         col_opaque->set_fixed_width (check_width);
152         col_opaque->set_sizing (TREE_VIEW_COLUMN_FIXED);
153
154         _display.append_column (*col_name);
155         _display.append_column (*col_tags);
156         _display.append_column (*col_start);
157         _display.append_column (*col_length);
158         _display.append_column (*col_locked);
159         _display.append_column (*col_glued);
160         _display.append_column (*col_muted);
161         _display.append_column (*col_opaque);
162
163 #ifdef SHOW_REGION_EXTRAS
164         _display.append_column (*col_end);
165         _display.append_column (*col_sync);
166         _display.append_column (*col_fadein);
167         _display.append_column (*col_fadeout);
168 #endif
169
170         TreeViewColumn* col;
171         Gtk::Label*     l;
172
173         /* clang-format off */
174         ColumnInfo ci[] = {
175                 { 0,  0,  ALIGN_LEFT,    _("Region"),    _("Region name, with number of channels in []'s") },
176                 { 1,  1,  ALIGN_LEFT,    _("Tags"),      _("Tags") },
177                 { 2, 15,  ALIGN_RIGHT,   _("Start"),     _("Position of start of region") },
178                 { 3,  3,  ALIGN_RIGHT,   _("Length"),    _("Length of the region") },
179                 { 4, -1,  ALIGN_CENTER, S_("Lock|L"),    _("Region position locked?") },
180                 { 5, -1,  ALIGN_CENTER, S_("Glued|G"),   _("Region position glued to Bars|Beats time?") },
181                 { 6, -1,  ALIGN_CENTER, S_("Mute|M"),    _("Region muted?") },
182                 { 7, -1,  ALIGN_CENTER, S_("Opaque|O"),  _("Region opaque (blocks regions below it from being heard)?") },
183 #ifdef SHOW_REGION_EXTRAS
184                 { 8,  4,  ALIGN_RIGHT,  _("End"),       _("Position of end of region") },
185                 { 9, -1,  ALIGN_RIGHT,  _("Sync"),      _("Position of region sync point, relative to start of the region") },
186                 { 10,-1,  ALIGN_RIGHT,  _("Fade In"),   _("Length of region fade-in (units: secondary clock), () if disabled") },
187                 { 11,-1,  ALIGN_RIGHT,  _("Fade Out"),  _("Length of region fade-out (units: secondary clock), () if disabled") },
188 #endif
189                 { -1,-1,  ALIGN_CENTER, 0, 0 }
190         };
191         /* clang-format on */
192
193         for (int i = 0; ci[i].index >= 0; ++i) {
194                 col = _display.get_column (ci[i].index);
195
196                 /* add the label */
197                 l = manage (new Label (ci[i].label));
198                 l->set_alignment (ci[i].al);
199                 set_tooltip (*l, ci[i].tooltip);
200                 col->set_widget (*l);
201                 l->show ();
202
203                 col->set_sort_column (ci[i].sort_idx);
204
205                 col->set_expand (false);
206
207                 /* this sets the alignment of the column header... */
208                 col->set_alignment (ci[i].al);
209
210                 /* ...and this sets the alignment for the data cells */
211                 CellRendererText* renderer = dynamic_cast<CellRendererText*> (_display.get_column_cell_renderer (i));
212                 if (renderer) {
213                         renderer->property_xalign () = (ci[i].al == ALIGN_RIGHT ? 1.0 : (ci[i].al == ALIGN_LEFT ? 0.0 : 0.5));
214                 }
215         }
216
217         _display.set_model (_model);
218
219         _display.set_headers_visible (true);
220         _display.set_rules_hint ();
221
222         if (UIConfiguration::instance ().get_use_tooltips ()) {
223                 /* show path as the row tooltip */
224                 _display.set_tooltip_column (12); /* path */
225         }
226         _display.get_selection ()->set_select_function (sigc::mem_fun (*this, &EditorRegions::selection_filter));
227
228         /* Name cell: make editable */
229         CellRendererText* region_name_cell     = dynamic_cast<CellRendererText*> (_display.get_column_cell_renderer (0));
230         region_name_cell->property_editable () = true;
231         region_name_cell->signal_edited ().connect (sigc::mem_fun (*this, &EditorRegions::name_edit));
232         region_name_cell->signal_editing_started ().connect (sigc::mem_fun (*this, &EditorRegions::name_editing_started));
233
234         /* Region Name: color turns red if source is missing. */
235         TreeViewColumn*   tv_col   = _display.get_column (0);
236         CellRendererText* renderer = dynamic_cast<CellRendererText*> (_display.get_column_cell_renderer (0));
237         tv_col->add_attribute (renderer->property_text (), _columns.name);
238         tv_col->add_attribute (renderer->property_foreground_gdk (), _columns.color_);
239         tv_col->set_expand (true);
240
241         /* Tags cell: make editable */
242         CellRendererText* region_tags_cell     = dynamic_cast<CellRendererText*> (_display.get_column_cell_renderer (1));
243         region_tags_cell->property_editable () = true;
244         region_tags_cell->signal_edited ().connect (sigc::mem_fun (*this, &EditorRegions::tag_edit));
245         region_tags_cell->signal_editing_started ().connect (sigc::mem_fun (*this, &EditorRegions::tag_editing_started));
246
247         /* checkbox cells */
248         int check_start_col = 4;
249
250         CellRendererToggle* locked_cell      = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (check_start_col++));
251         locked_cell->property_activatable () = true;
252         locked_cell->signal_toggled ().connect (sigc::mem_fun (*this, &EditorRegions::locked_changed));
253
254         CellRendererToggle* glued_cell      = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (check_start_col++));
255         glued_cell->property_activatable () = true;
256         glued_cell->signal_toggled ().connect (sigc::mem_fun (*this, &EditorRegions::glued_changed));
257
258         CellRendererToggle* muted_cell      = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (check_start_col++));
259         muted_cell->property_activatable () = true;
260         muted_cell->signal_toggled ().connect (sigc::mem_fun (*this, &EditorRegions::muted_changed));
261
262         CellRendererToggle* opaque_cell      = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (check_start_col));
263         opaque_cell->property_activatable () = true;
264         opaque_cell->signal_toggled ().connect (sigc::mem_fun (*this, &EditorRegions::opaque_changed));
265
266         _display.get_selection ()->set_mode (SELECTION_MULTIPLE);
267         _display.add_object_drag (_columns.region.index (), "regions");
268         _display.set_drag_column (_columns.name.index ());
269
270         /* setup DnD handling */
271
272         list<TargetEntry> region_list_target_table;
273
274         region_list_target_table.push_back (TargetEntry ("text/uri-list"));
275         region_list_target_table.push_back (TargetEntry ("text/plain"));
276         region_list_target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
277
278         _display.add_drop_targets (region_list_target_table);
279         _display.signal_drag_data_received ().connect (sigc::mem_fun (*this, &EditorRegions::drag_data_received));
280
281         _scroller.add (_display);
282         _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
283
284         _display.signal_button_press_event ().connect (sigc::mem_fun (*this, &EditorRegions::button_press), false);
285         _change_connection = _display.get_selection ()->signal_changed ().connect (sigc::mem_fun (*this, &EditorRegions::selection_changed));
286
287         _scroller.signal_key_press_event ().connect (sigc::mem_fun (*this, &EditorRegions::key_press), false);
288         _scroller.signal_focus_in_event ().connect (sigc::mem_fun (*this, &EditorRegions::focus_in), false);
289         _scroller.signal_focus_out_event ().connect (sigc::mem_fun (*this, &EditorRegions::focus_out));
290
291         _display.signal_enter_notify_event ().connect (sigc::mem_fun (*this, &EditorRegions::enter_notify), false);
292         _display.signal_leave_notify_event ().connect (sigc::mem_fun (*this, &EditorRegions::leave_notify), false);
293
294         ARDOUR_UI::instance ()->primary_clock->mode_changed.connect (sigc::mem_fun (*this, &EditorRegions::clock_format_changed));
295
296         e->EditorFreeze.connect (editor_freeze_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::freeze_tree_model, this), gui_context ());
297         e->EditorThaw.connect (editor_thaw_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::thaw_tree_model, this), gui_context ());
298 }
299
300 bool
301 EditorRegions::focus_in (GdkEventFocus*)
302 {
303         Window* win = dynamic_cast<Window*> (_scroller.get_toplevel ());
304
305         if (win) {
306                 old_focus = win->get_focus ();
307         } else {
308                 old_focus = 0;
309         }
310
311         name_editable = 0;
312         tags_editable = 0;
313
314         /* try to do nothing on focus in (doesn't work, hence selection_count nonsense) */
315         return true;
316 }
317
318 bool
319 EditorRegions::focus_out (GdkEventFocus*)
320 {
321         if (old_focus) {
322                 old_focus->grab_focus ();
323                 old_focus = 0;
324         }
325
326         name_editable = 0;
327         tags_editable = 0;
328
329         return false;
330 }
331
332 bool
333 EditorRegions::enter_notify (GdkEventCrossing*)
334 {
335         if (name_editable || tags_editable) {
336                 return true;
337         }
338
339         Keyboard::magic_widget_grab_focus ();
340         return false;
341 }
342
343 bool
344 EditorRegions::leave_notify (GdkEventCrossing*)
345 {
346         if (old_focus) {
347                 old_focus->grab_focus ();
348                 old_focus = 0;
349         }
350
351         Keyboard::magic_widget_drop_focus ();
352         return false;
353 }
354
355 void
356 EditorRegions::set_session (ARDOUR::Session* s)
357 {
358         SessionHandlePtr::set_session (s);
359
360         ARDOUR::Region::RegionPropertyChanged.connect (region_property_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::region_changed, this, _1, _2), gui_context ());
361         ARDOUR::RegionFactory::CheckNewRegion.connect (check_new_region_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::add_region, this, _1), gui_context ());
362
363         redisplay ();
364 }
365
366 void
367 EditorRegions::add_region (boost::shared_ptr<Region> region)
368 {
369         if (!region || !_session) {
370                 return;
371         }
372
373         /* whole-file regions are shown in the Source List */
374         if (region->whole_file ()) {
375                 return;
376         }
377
378         PropertyChange pc;
379         region_changed (region, pc);
380 }
381
382 void
383 EditorRegions::destroy_region (boost::shared_ptr<ARDOUR::Region> region)
384 {
385         //UNTESTED
386         //At the time of writing, the only way to remove regions is "cleanup"
387         //by definition, "cleanup" only removes regions that aren't on the timeline
388         //so this would be a no-op anyway
389         //perhaps someday we will allow users to manually destroy regions.
390         RegionRowMap::iterator map_it = region_row_map.find (region);
391         if (map_it != region_row_map.end ()) {
392                 region_row_map.erase (map_it);
393                 _model->erase (map_it->second);
394         }
395 }
396
397 void
398 EditorRegions::remove_unused_regions ()
399 {
400         vector<string> choices;
401         string         prompt;
402
403         if (!_session) {
404                 return;
405         }
406
407         prompt = _ ("Do you really want to remove unused regions?"
408                     "\n(This is destructive and cannot be undone)");
409
410         choices.push_back (_ ("No, do nothing."));
411         choices.push_back (_ ("Yes, remove."));
412
413         ArdourWidgets::Choice prompter (_ ("Remove unused regions"), prompt, choices);
414
415         if (prompter.run () == 1) {
416                 _no_redisplay = true;
417                 _session->cleanup_regions ();
418                 _no_redisplay = false;
419                 redisplay ();
420         }
421 }
422
423 void
424 EditorRegions::region_changed (boost::shared_ptr<Region> r, const PropertyChange& what_changed)
425 {
426         RegionRowMap::iterator map_it = region_row_map.find (r);
427
428         boost::shared_ptr<ARDOUR::Playlist> pl = r->playlist ();
429         if (!(pl && _session && _session->playlist_is_active (pl))) {
430                 /* this region is not on an active playlist
431                  * maybe it got deleted, or whatever */
432                 if (map_it != region_row_map.end ()) {
433                         region_row_map.erase (map_it);
434                         _model->erase (map_it->second);
435                 }
436                 return;
437         }
438
439         if (map_it != region_row_map.end ()) {
440                 /* found the region, update its row properties */
441                 TreeModel::Row row = *(map_it->second);
442                 populate_row (r, row, what_changed);
443
444         } else {
445                 /* new region, add it to the list */
446                 TreeModel::iterator iter = _model->append ();
447                 TreeModel::Row      row  = *iter;
448                 region_row_map.insert (pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::iterator> (r, iter));
449
450                 /* set the properties that don't change */
451                 row[_columns.region] = r;
452
453                 /* now populate the properties that might change... */
454                 populate_row (r, row, PropertyChange ());
455         }
456 }
457
458 void
459 EditorRegions::selection_changed ()
460 {
461         _editor->_region_selection_change_updates_region_list = false;
462
463         if (_display.get_selection ()->count_selected_rows () > 0) {
464                 TreeIter                             iter;
465                 TreeView::Selection::ListHandle_Path rows = _display.get_selection ()->get_selected_rows ();
466
467                 _editor->get_selection ().clear_regions ();
468
469                 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin (); i != rows.end (); ++i) {
470                         if ((iter = _model->get_iter (*i))) {
471                                 boost::shared_ptr<Region> region = (*iter)[_columns.region];
472
473                                 // they could have clicked on a row that is just a placeholder, like "Hidden"
474                                 // although that is not allowed by our selection filter. check it anyway
475                                 // since we need a region ptr.
476
477                                 if (region) {
478                                         _change_connection.block (true);
479                                         _editor->set_selected_regionview_from_region_list (region, Selection::Add);
480                                         _change_connection.block (false);
481                                 }
482                         }
483                 }
484         } else {
485                 _editor->get_selection ().clear_regions ();
486         }
487
488         _editor->_region_selection_change_updates_region_list = true;
489 }
490
491 void
492 EditorRegions::set_selected (RegionSelection& regions)
493 {
494         for (RegionSelection::iterator i = regions.begin (); i != regions.end (); ++i) {
495                 boost::shared_ptr<Region> r ((*i)->region ());
496
497                 RegionRowMap::iterator it;
498
499                 it = region_row_map.find (r);
500
501                 if (it != region_row_map.end ()) {
502                         TreeModel::iterator j = it->second;
503                         _display.get_selection ()->select (*j);
504                 }
505         }
506 }
507
508 void
509 EditorRegions::redisplay ()
510 {
511         if (_no_redisplay || !_session) {
512                 return;
513         }
514
515         _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
516         _model->clear ();
517         _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
518
519         region_row_map.clear ();
520
521         RegionFactory::foreach_region (sigc::mem_fun (*this, &EditorRegions::add_region));
522
523         _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
524         _display.set_model (_model);
525 }
526
527 void
528 EditorRegions::update_row (boost::shared_ptr<Region> region)
529 {
530         if (!region || !_session) {
531                 return;
532         }
533
534         RegionRowMap::iterator it;
535
536         it = region_row_map.find (region);
537
538         if (it != region_row_map.end ()) {
539                 PropertyChange      c;
540                 TreeModel::iterator j = it->second;
541                 populate_row (region, (*j), c);
542         }
543 }
544
545 void
546 EditorRegions::clock_format_changed ()
547 {
548         if (!_session) {
549                 return;
550         }
551
552         PropertyChange change;
553         change.add (ARDOUR::Properties::start);
554         change.add (ARDOUR::Properties::length);
555         change.add (ARDOUR::Properties::position);
556         change.add (ARDOUR::Properties::sync_position);
557         change.add (ARDOUR::Properties::fade_in);
558         change.add (ARDOUR::Properties::fade_out);
559
560         RegionRowMap::iterator i;
561
562         for (i = region_row_map.begin (); i != region_row_map.end (); ++i) {
563                 TreeModel::iterator j = i->second;
564
565                 boost::shared_ptr<Region> region = (*j)[_columns.region];
566
567                 populate_row (region, (*j), change);
568         }
569 }
570
571 void
572 EditorRegions::format_position (samplepos_t pos, char* buf, size_t bufsize, bool onoff)
573 {
574         Timecode::BBT_Time bbt;
575         Timecode::Time     timecode;
576
577         if (pos < 0) {
578                 error << string_compose (_ ("EditorRegions::format_position: negative timecode position: %1"), pos) << endmsg;
579                 snprintf (buf, bufsize, "invalid");
580                 return;
581         }
582
583         switch (ARDOUR_UI::instance ()->primary_clock->mode ()) {
584                 case AudioClock::BBT:
585                         bbt = _session->tempo_map ().bbt_at_sample (pos);
586                         if (onoff) {
587                                 snprintf (buf, bufsize, "%03d|%02d|%04d", bbt.bars, bbt.beats, bbt.ticks);
588                         } else {
589                                 snprintf (buf, bufsize, "(%03d|%02d|%04d)", bbt.bars, bbt.beats, bbt.ticks);
590                         }
591                         break;
592
593                 case AudioClock::MinSec:
594                         samplepos_t left;
595                         int         hrs;
596                         int         mins;
597                         float       secs;
598
599                         left = pos;
600                         hrs  = (int)floor (left / (_session->sample_rate () * 60.0f * 60.0f));
601                         left -= (samplecnt_t)floor (hrs * _session->sample_rate () * 60.0f * 60.0f);
602                         mins = (int)floor (left / (_session->sample_rate () * 60.0f));
603                         left -= (samplecnt_t)floor (mins * _session->sample_rate () * 60.0f);
604                         secs = left / (float)_session->sample_rate ();
605                         if (onoff) {
606                                 snprintf (buf, bufsize, "%02d:%02d:%06.3f", hrs, mins, secs);
607                         } else {
608                                 snprintf (buf, bufsize, "(%02d:%02d:%06.3f)", hrs, mins, secs);
609                         }
610                         break;
611
612                 case AudioClock::Seconds:
613                         if (onoff) {
614                                 snprintf (buf, bufsize, "%.1f", pos / (float)_session->sample_rate ());
615                         } else {
616                                 snprintf (buf, bufsize, "(%.1f)", pos / (float)_session->sample_rate ());
617                         }
618                         break;
619
620                 case AudioClock::Samples:
621                         if (onoff) {
622                                 snprintf (buf, bufsize, "%" PRId64, pos);
623                         } else {
624                                 snprintf (buf, bufsize, "(%" PRId64 ")", pos);
625                         }
626                         break;
627
628                 case AudioClock::Timecode:
629                 default:
630                         _session->timecode_time (pos, timecode);
631                         if (onoff) {
632                                 snprintf (buf, bufsize, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
633                         } else {
634                                 snprintf (buf, bufsize, "(%02d:%02d:%02d:%02d)", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
635                         }
636                         break;
637         }
638 }
639
640 void
641 EditorRegions::populate_row (boost::shared_ptr<Region> region, TreeModel::Row const& row, PBD::PropertyChange const& what_changed)
642 {
643         /* the grid is most interested in the regions that are *visible* in the editor.
644          * this is a convenient place to flag changes to the grid cache, on a visible region */
645         PropertyChange grid_interests;
646         grid_interests.add (ARDOUR::Properties::position);
647         grid_interests.add (ARDOUR::Properties::length);
648         grid_interests.add (ARDOUR::Properties::sync_position);
649         if (what_changed.contains (grid_interests)) {
650                 _editor->mark_region_boundary_cache_dirty ();
651         }
652
653         {
654                 Gdk::Color c;
655                 bool       missing_source = boost::dynamic_pointer_cast<SilentFileSource> (region->source ()) != NULL;
656                 if (missing_source) {
657                         set_color_from_rgba (c, UIConfiguration::instance ().color ("region list missing source"));
658                 } else {
659                         set_color_from_rgba (c, UIConfiguration::instance ().color ("region list whole file"));
660                 }
661                 row[_columns.color_] = c;
662         }
663
664         boost::shared_ptr<AudioRegion> audioregion = boost::dynamic_pointer_cast<AudioRegion> (region);
665
666         PropertyChange c;
667         const bool     all = what_changed == c;
668
669         if (all || what_changed.contains (Properties::position)) {
670                 populate_row_position (region, row);
671         }
672         if (all || what_changed.contains (Properties::start) || what_changed.contains (Properties::sync_position)) {
673                 populate_row_sync (region, row);
674         }
675         if (all || what_changed.contains (Properties::fade_in)) {
676                 populate_row_fade_in (region, row, audioregion);
677         }
678         if (all || what_changed.contains (Properties::fade_out)) {
679                 populate_row_fade_out (region, row, audioregion);
680         }
681         if (all || what_changed.contains (Properties::locked)) {
682                 populate_row_locked (region, row);
683         }
684         if (all || what_changed.contains (Properties::position_lock_style)) {
685                 populate_row_glued (region, row);
686         }
687         if (all || what_changed.contains (Properties::muted)) {
688                 populate_row_muted (region, row);
689         }
690         if (all || what_changed.contains (Properties::opaque)) {
691                 populate_row_opaque (region, row);
692         }
693         if (all || what_changed.contains (Properties::length)) {
694                 populate_row_end (region, row);
695                 populate_row_length (region, row);
696         }
697         if (all) {
698                 populate_row_source (region, row);
699         }
700         if (all || what_changed.contains (Properties::name) || what_changed.contains (Properties::tags)) {
701                 populate_row_name (region, row);
702         }
703 }
704
705 #if 0
706         if (audioRegion && fades_in_seconds) {
707
708                 samplepos_t left;
709                 int mins;
710                 int millisecs;
711
712                 left = audioRegion->fade_in()->back()->when;
713                 mins = (int) floor (left / (_session->sample_rate() * 60.0f));
714                 left -= (samplepos_t) floor (mins * _session->sample_rate() * 60.0f);
715                 millisecs = (int) floor ((left * 1000.0f) / _session->sample_rate());
716
717                 if (audioRegion->fade_in()->back()->when >= _session->sample_rate()) {
718                         sprintf (fadein_str, "%01dM %01dmS", mins, millisecs);
719                 } else {
720                         sprintf (fadein_str, "%01dmS", millisecs);
721                 }
722
723                 left = audioRegion->fade_out()->back()->when;
724                 mins = (int) floor (left / (_session->sample_rate() * 60.0f));
725                 left -= (samplepos_t) floor (mins * _session->sample_rate() * 60.0f);
726                 millisecs = (int) floor ((left * 1000.0f) / _session->sample_rate());
727
728                 if (audioRegion->fade_out()->back()->when >= _session->sample_rate()) {
729                         sprintf (fadeout_str, "%01dM %01dmS", mins, millisecs);
730                 } else {
731                         sprintf (fadeout_str, "%01dmS", millisecs);
732                 }
733         }
734 #endif
735
736 void
737 EditorRegions::populate_row_length (boost::shared_ptr<Region> region, TreeModel::Row const& row)
738 {
739         char buf[16];
740
741         if (ARDOUR_UI::instance ()->primary_clock->mode () == AudioClock::BBT) {
742                 TempoMap&          map (_session->tempo_map ());
743                 Timecode::BBT_Time bbt = map.bbt_at_beat (map.beat_at_sample (region->last_sample ()) - map.beat_at_sample (region->first_sample ()));
744                 snprintf (buf, sizeof (buf), "%03d|%02d|%04d", bbt.bars, bbt.beats, bbt.ticks);
745         } else {
746                 format_position (region->length (), buf, sizeof (buf));
747         }
748
749         row[_columns.length] = buf;
750 }
751
752 void
753 EditorRegions::populate_row_end (boost::shared_ptr<Region> region, TreeModel::Row const& row)
754 {
755 #ifndef SHOW_REGION_EXTRAS
756         return;
757 #endif
758
759         if (region->last_sample () >= region->first_sample ()) {
760                 char buf[16];
761                 format_position (region->last_sample (), buf, sizeof (buf));
762                 row[_columns.end] = buf;
763         } else {
764                 row[_columns.end] = "empty";
765         }
766 }
767
768 void
769 EditorRegions::populate_row_position (boost::shared_ptr<Region> region, TreeModel::Row const& row)
770 {
771         row[_columns.position] = region->position ();
772
773         char buf[16];
774         format_position (region->position (), buf, sizeof (buf));
775         row[_columns.start] = buf;
776 }
777
778 void
779 EditorRegions::populate_row_sync (boost::shared_ptr<Region> region, TreeModel::Row const& row)
780 {
781 #ifndef SHOW_REGION_EXTRAS
782         return;
783 #endif
784         if (region->sync_position () == region->position ()) {
785                 row[_columns.sync] = _ ("Start");
786         } else if (region->sync_position () == (region->last_sample ())) {
787                 row[_columns.sync] = _ ("End");
788         } else {
789                 char buf[16];
790                 format_position (region->sync_position (), buf, sizeof (buf));
791                 row[_columns.sync] = buf;
792         }
793 }
794
795 void
796 EditorRegions::populate_row_fade_in (boost::shared_ptr<Region> region, TreeModel::Row const& row, boost::shared_ptr<AudioRegion> audioregion)
797 {
798 #ifndef SHOW_REGION_EXTRAS
799         return;
800 #endif
801         if (!audioregion) {
802                 row[_columns.fadein] = "";
803         } else {
804                 char buf[32];
805                 format_position (audioregion->fade_in ()->back ()->when, buf, sizeof (buf), audioregion->fade_in_active ());
806                 row[_columns.fadein] = buf;
807         }
808 }
809
810 void
811 EditorRegions::populate_row_fade_out (boost::shared_ptr<Region> region, TreeModel::Row const& row, boost::shared_ptr<AudioRegion> audioregion)
812 {
813 #ifndef SHOW_REGION_EXTRAS
814         return;
815 #endif
816         if (!audioregion) {
817                 row[_columns.fadeout] = "";
818         } else {
819                 char buf[32];
820                 format_position (audioregion->fade_out ()->back ()->when, buf, sizeof (buf), audioregion->fade_out_active ());
821                 row[_columns.fadeout] = buf;
822         }
823 }
824
825 void
826 EditorRegions::populate_row_locked (boost::shared_ptr<Region> region, TreeModel::Row const& row)
827 {
828         row[_columns.locked] = region->locked ();
829 }
830
831 void
832 EditorRegions::populate_row_glued (boost::shared_ptr<Region> region, TreeModel::Row const& row)
833 {
834         if (region->position_lock_style () == MusicTime) {
835                 row[_columns.glued] = true;
836         } else {
837                 row[_columns.glued] = false;
838         }
839 }
840
841 void
842 EditorRegions::populate_row_muted (boost::shared_ptr<Region> region, TreeModel::Row const& row)
843 {
844         row[_columns.muted] = region->muted ();
845 }
846
847 void
848 EditorRegions::populate_row_opaque (boost::shared_ptr<Region> region, TreeModel::Row const& row)
849 {
850         row[_columns.opaque] = region->opaque ();
851 }
852
853 void
854 EditorRegions::populate_row_name (boost::shared_ptr<Region> region, TreeModel::Row const& row)
855 {
856         if (region->n_channels () > 1) {
857                 row[_columns.name] = string_compose ("%1  [%2]", Gtkmm2ext::markup_escape_text (region->name ()), region->n_channels ());
858         } else {
859                 row[_columns.name] = Gtkmm2ext::markup_escape_text (region->name ());
860         }
861
862         row[_columns.tags] = region->tags ();
863 }
864
865 void
866 EditorRegions::populate_row_source (boost::shared_ptr<Region> region, TreeModel::Row const& row)
867 {
868         if (boost::dynamic_pointer_cast<SilentFileSource> (region->source ())) {
869                 row[_columns.path] = _ ("MISSING ") + Gtkmm2ext::markup_escape_text (region->source ()->name ());
870         } else {
871                 row[_columns.path] = Gtkmm2ext::markup_escape_text (region->source ()->name ());
872         }
873 }
874
875 void
876 EditorRegions::show_context_menu (int button, int time)
877 {
878         using namespace Gtk::Menu_Helpers;
879         Gtk::Menu* menu = dynamic_cast<Menu*> (ActionManager::get_widget (X_ ("/PopupRegionMenu")));
880         menu->popup (button, time);
881 }
882
883 bool
884 EditorRegions::key_press (GdkEventKey* ev)
885 {
886         TreeViewColumn* col;
887
888         switch (ev->keyval) {
889                 case GDK_Tab:
890                 case GDK_ISO_Left_Tab:
891
892                         if (name_editable) {
893                                 name_editable->editing_done ();
894                                 name_editable = 0;
895                         }
896
897                         if (tags_editable) {
898                                 tags_editable->editing_done ();
899                                 tags_editable = 0;
900                         }
901
902                         col = _display.get_column (0); // select&focus on name column
903
904                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
905                                 treeview_select_previous (_display, _model, col);
906                         } else {
907                                 treeview_select_next (_display, _model, col);
908                         }
909
910                         return true;
911                         break;
912
913                 default:
914                         break;
915         }
916
917         return false;
918 }
919
920 bool
921 EditorRegions::button_press (GdkEventButton* ev)
922 {
923         boost::shared_ptr<Region> region;
924         TreeIter                  iter;
925         TreeModel::Path           path;
926         TreeViewColumn*           column;
927         int                       cellx;
928         int                       celly;
929
930         if (_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
931                 if ((iter = _model->get_iter (path))) {
932                         region = (*iter)[_columns.region];
933                 }
934         }
935
936         if (Keyboard::is_context_menu_event (ev)) {
937                 show_context_menu (ev->button, ev->time);
938                 return true;
939         }
940
941         if (region != 0 && Keyboard::is_button2_event (ev)) {
942                 /* start/stop audition */
943                 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
944                         _editor->consider_auditioning (region);
945                 }
946                 return true;
947         }
948
949         return false;
950 }
951
952 void
953 EditorRegions::selection_mapover (sigc::slot<void, boost::shared_ptr<Region> > sl)
954 {
955         Glib::RefPtr<TreeSelection>                    selection = _display.get_selection ();
956         TreeView::Selection::ListHandle_Path           rows      = selection->get_selected_rows ();
957         TreeView::Selection::ListHandle_Path::iterator i         = rows.begin ();
958
959         if (selection->count_selected_rows () == 0 || _session == 0) {
960                 return;
961         }
962
963         for (; i != rows.end (); ++i) {
964                 TreeIter iter;
965
966                 if ((iter = _model->get_iter (*i))) {
967                         /* some rows don't have a region associated with them, but can still be
968                            selected (XXX maybe prevent them from being selected)
969                         */
970
971                         boost::shared_ptr<Region> r = (*iter)[_columns.region];
972
973                         if (r) {
974                                 sl (r);
975                         }
976                 }
977         }
978 }
979
980 void
981 EditorRegions::drag_data_received (const RefPtr<Gdk::DragContext>& context,
982                                    int x, int y,
983                                    const SelectionData& data,
984                                    guint info, guint time)
985 {
986         vector<string> paths;
987
988         if (data.get_target () == "GTK_TREE_MODEL_ROW") {
989                 /* something is being dragged over the region list */
990                 _editor->_drags->abort ();
991                 _display.on_drag_data_received (context, x, y, data, info, time);
992                 return;
993         }
994
995         if (_editor->convert_drop_to_paths (paths, context, x, y, data, info, time) == 0) {
996                 samplepos_t pos  = 0;
997                 bool        copy = ((context->get_actions () & (Gdk::ACTION_COPY | Gdk::ACTION_LINK | Gdk::ACTION_MOVE)) == Gdk::ACTION_COPY);
998
999                 if (UIConfiguration::instance ().get_only_copy_imported_files () || copy) {
1000                         _editor->do_import (paths, Editing::ImportDistinctFiles, Editing::ImportAsRegion,
1001                                             SrcBest, SMFTrackName, SMFTempoIgnore, pos);
1002                 } else {
1003                         _editor->do_embed (paths, Editing::ImportDistinctFiles, ImportAsRegion, pos);
1004                 }
1005                 context->drag_finish (true, false, time);
1006         }
1007 }
1008
1009 bool
1010 EditorRegions::selection_filter (const RefPtr<TreeModel>& model, const TreeModel::Path& path, bool already_selected)
1011 {
1012         if (already_selected) {
1013                 /* deselecting path, if it is selected, is OK */
1014                 return true;
1015         }
1016
1017         /* not possible to select rows that do not represent regions, like "Hidden" */
1018         TreeModel::iterator iter = model->get_iter (path);
1019         if (iter) {
1020                 boost::shared_ptr<Region> r = (*iter)[_columns.region];
1021                 if (!r) {
1022                         return false;
1023                 }
1024         }
1025
1026         return true;
1027 }
1028
1029 void
1030 EditorRegions::name_editing_started (CellEditable* ce, const Glib::ustring& path)
1031 {
1032         name_editable = ce;
1033
1034         /* give it a special name */
1035
1036         Gtk::Entry* e = dynamic_cast<Gtk::Entry*> (ce);
1037
1038         if (e) {
1039                 e->set_name (X_ ("RegionNameEditorEntry"));
1040
1041                 TreeIter iter;
1042                 if ((iter = _model->get_iter (path))) {
1043                         boost::shared_ptr<Region> region = (*iter)[_columns.region];
1044
1045                         if (region) {
1046                                 e->set_text (region->name ());
1047                         }
1048                 }
1049         }
1050 }
1051
1052 void
1053 EditorRegions::name_edit (const std::string& path, const std::string& new_text)
1054 {
1055         name_editable = 0;
1056
1057         boost::shared_ptr<Region> region;
1058         TreeIter                  row_iter;
1059
1060         if ((row_iter = _model->get_iter (path))) {
1061                 region                     = (*row_iter)[_columns.region];
1062                 (*row_iter)[_columns.name] = new_text;
1063         }
1064
1065         if (region) {
1066                 region->set_name (new_text);
1067
1068                 populate_row_name (region, (*row_iter));
1069         }
1070 }
1071
1072 void
1073 EditorRegions::tag_editing_started (CellEditable* ce, const Glib::ustring& path)
1074 {
1075         tags_editable = ce;
1076
1077         /* give it a special name */
1078
1079         Gtk::Entry* e = dynamic_cast<Gtk::Entry*> (ce);
1080
1081         if (e) {
1082                 e->set_name (X_ ("RegionTagEditorEntry"));
1083
1084                 TreeIter iter;
1085                 if ((iter = _model->get_iter (path))) {
1086                         boost::shared_ptr<Region> region = (*iter)[_columns.region];
1087
1088                         if (region) {
1089                                 e->set_text (region->tags ());
1090                         }
1091                 }
1092         }
1093 }
1094
1095 void
1096 EditorRegions::tag_edit (const std::string& path, const std::string& new_text)
1097 {
1098         tags_editable = 0;
1099
1100         boost::shared_ptr<Region> region;
1101         TreeIter                  row_iter;
1102
1103         if ((row_iter = _model->get_iter (path))) {
1104                 region                     = (*row_iter)[_columns.region];
1105                 (*row_iter)[_columns.tags] = new_text;
1106         }
1107
1108         if (region) {
1109                 region->set_tags (new_text);
1110
1111                 populate_row_name (region, (*row_iter));
1112         }
1113 }
1114
1115 /** @return Region that has been dragged out of the list, or 0 */
1116 boost::shared_ptr<Region>
1117 EditorRegions::get_dragged_region ()
1118 {
1119         list<boost::shared_ptr<Region> > regions;
1120         TreeView*                        source;
1121         _display.get_object_drag_data (regions, &source);
1122
1123         if (regions.empty ()) {
1124                 return boost::shared_ptr<Region> ();
1125         }
1126
1127         assert (regions.size () == 1);
1128         return regions.front ();
1129 }
1130
1131 void
1132 EditorRegions::clear ()
1133 {
1134         _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1135         _model->clear ();
1136         _display.set_model (_model);
1137
1138         /* Clean up the maps */
1139         region_row_map.clear ();
1140 }
1141
1142 boost::shared_ptr<Region>
1143 EditorRegions::get_single_selection ()
1144 {
1145         Glib::RefPtr<TreeSelection> selected = _display.get_selection ();
1146
1147         if (selected->count_selected_rows () != 1) {
1148                 return boost::shared_ptr<Region> ();
1149         }
1150
1151         TreeView::Selection::ListHandle_Path rows = selected->get_selected_rows ();
1152
1153         /* only one row selected, so rows.begin() is it */
1154
1155         TreeIter iter = _model->get_iter (*rows.begin ());
1156
1157         if (!iter) {
1158                 return boost::shared_ptr<Region> ();
1159         }
1160
1161         return (*iter)[_columns.region];
1162 }
1163
1164 void
1165 EditorRegions::freeze_tree_model ()
1166 {
1167         _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1168         _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
1169 }
1170
1171 void
1172 EditorRegions::thaw_tree_model ()
1173 {
1174         _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
1175         _display.set_model (_model);
1176 }
1177
1178 void
1179 EditorRegions::locked_changed (std::string const& path)
1180 {
1181         TreeIter i = _model->get_iter (path);
1182         if (i) {
1183                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1184                 if (region) {
1185                         region->set_locked (!(*i)[_columns.locked]);
1186                 }
1187         }
1188 }
1189
1190 void
1191 EditorRegions::glued_changed (std::string const& path)
1192 {
1193         TreeIter i = _model->get_iter (path);
1194         if (i) {
1195                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1196                 if (region) {
1197                         /* `glued' means MusicTime, and we're toggling here */
1198                         region->set_position_lock_style ((*i)[_columns.glued] ? AudioTime : MusicTime);
1199                 }
1200         }
1201 }
1202
1203 void
1204 EditorRegions::muted_changed (std::string const& path)
1205 {
1206         TreeIter i = _model->get_iter (path);
1207         if (i) {
1208                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1209                 if (region) {
1210                         region->set_muted (!(*i)[_columns.muted]);
1211                 }
1212         }
1213 }
1214
1215 void
1216 EditorRegions::opaque_changed (std::string const& path)
1217 {
1218         TreeIter i = _model->get_iter (path);
1219         if (i) {
1220                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1221                 if (region) {
1222                         region->set_opaque (!(*i)[_columns.opaque]);
1223                 }
1224         }
1225 }
1226
1227 XMLNode&
1228 EditorRegions::get_state () const
1229 {
1230         XMLNode* node = new XMLNode (X_ ("RegionList"));
1231
1232         //TODO:  save sort state?
1233         //      node->set_property (X_("sort-col"), _sort_type);
1234         //      node->set_property (X_("sort-asc"), _sort_type);
1235
1236         return *node;
1237 }
1238
1239 void
1240 EditorRegions::set_state (const XMLNode& node)
1241 {
1242         bool changed = false;
1243
1244         if (node.name () != X_ ("RegionList")) {
1245                 return;
1246         }
1247
1248         if (changed) {
1249                 redisplay ();
1250         }
1251 }
1252
1253 RefPtr<Action>
1254 EditorRegions::remove_unused_regions_action () const
1255 {
1256         return ActionManager::get_action (X_ ("RegionList"), X_ ("removeUnusedRegions"));
1257 }