Fix missing return statement in deleted region scenario.
[ardour.git] / gtk2_ardour / region_view.cc
1 /*
2     Copyright (C) 2001-2006 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 <cmath>
21 #include <cassert>
22 #include <algorithm>
23
24 #include <gtkmm.h>
25
26 #include <gtkmm2ext/gtk_ui.h>
27
28 #include "ardour/playlist.h"
29 #include "ardour/session.h"
30
31 #include "canvas/polygon.h"
32 #include "canvas/debug.h"
33 #include "canvas/pixbuf.h"
34 #include "canvas/text.h"
35 #include "canvas/line.h"
36 #include "canvas/utils.h"
37 #include "canvas/colors.h"
38
39 #include "ardour_ui.h"
40 #include "global_signals.h"
41 #include "streamview.h"
42 #include "region_view.h"
43 #include "automation_region_view.h"
44 #include "route_time_axis.h"
45 #include "public_editor.h"
46 #include "region_editor.h"
47 #include "ghostregion.h"
48 #include "route_time_axis.h"
49 #include "ui_config.h"
50 #include "utils.h"
51 #include "rgb_macros.h"
52 #include "gui_thread.h"
53
54 #include "i18n.h"
55
56 using namespace std;
57 using namespace ARDOUR;
58 using namespace ARDOUR_UI_UTILS;
59 using namespace PBD;
60 using namespace Editing;
61 using namespace Gtk;
62 using namespace ArdourCanvas;
63
64 static const int32_t sync_mark_width = 9;
65
66 PBD::Signal1<void,RegionView*> RegionView::RegionViewGoingAway;
67
68 RegionView::RegionView (ArdourCanvas::Container*              parent,
69                         TimeAxisView&                     tv,
70                         boost::shared_ptr<ARDOUR::Region> r,
71                         double                            spu,
72                         uint32_t                          basic_color,
73                         bool                              automation)
74         : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), false, automation,
75                             (automation ? TimeAxisViewItem::ShowFrame :
76                              TimeAxisViewItem::Visibility (TimeAxisViewItem::ShowNameText|
77                                                            TimeAxisViewItem::ShowNameHighlight| TimeAxisViewItem::ShowFrame)))
78         , _region (r)
79         , sync_mark(0)
80         , sync_line(0)
81         , editor(0)
82         , current_visible_sync_position(0.0)
83         , valid(false)
84         , _enable_display(false)
85         , _pixel_width(1.0)
86         , in_destructor(false)
87         , wait_for_data(false)
88         , _silence_text (0)
89         , _region_relative_time_converter(r->session().tempo_map(), r->position())
90         , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
91 {
92         GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
93 }
94
95 RegionView::RegionView (const RegionView& other)
96         : sigc::trackable(other)
97         , TimeAxisViewItem (other)
98         , _silence_text (0)
99         , _region_relative_time_converter(other.region_relative_time_converter())
100         , _source_relative_time_converter(other.source_relative_time_converter())
101 {
102         /* derived concrete type will call init () */
103
104         _region = other._region;
105         current_visible_sync_position = other.current_visible_sync_position;
106         valid = false;
107         _pixel_width = other._pixel_width;
108
109         GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
110 }
111
112 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
113         : sigc::trackable(other)
114         , TimeAxisViewItem (other)
115         , _silence_text (0)
116         , _region_relative_time_converter(other_region->session().tempo_map(), other_region->position())
117         , _source_relative_time_converter(other_region->session().tempo_map(), other_region->position() - other_region->start())
118 {
119         /* this is a pseudo-copy constructor used when dragging regions
120            around on the canvas.
121         */
122
123         /* derived concrete type will call init () */
124
125         _region = other_region;
126         current_visible_sync_position = other.current_visible_sync_position;
127         valid = false;
128         _pixel_width = other._pixel_width;
129
130         GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
131 }
132
133 RegionView::RegionView (ArdourCanvas::Container*         parent,
134                         TimeAxisView&                tv,
135                         boost::shared_ptr<ARDOUR::Region> r,
136                         double                       spu,
137                         uint32_t                     basic_color,
138                         bool                         recording,
139                         TimeAxisViewItem::Visibility visibility)
140         : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
141         , _region (r)
142         , sync_mark(0)
143         , sync_line(0)
144         , editor(0)
145         , current_visible_sync_position(0.0)
146         , valid(false)
147         , _enable_display(false)
148         , _pixel_width(1.0)
149         , in_destructor(false)
150         , wait_for_data(false)
151         , _silence_text (0)
152         , _region_relative_time_converter(r->session().tempo_map(), r->position())
153         , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
154 {
155 }
156
157 void
158 RegionView::init (bool wfd)
159 {
160         editor        = 0;
161         valid         = true;
162         in_destructor = false;
163         wait_for_data = wfd;
164         sync_mark     = 0;
165         sync_line     = 0;
166         sync_mark     = 0;
167         sync_line     = 0;
168
169         if (name_highlight) {
170                 name_highlight->set_data ("regionview", this);
171                 name_highlight->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
172         }
173         
174         if (frame_handle_start) {
175                 frame_handle_start->set_data ("regionview", this);
176                 frame_handle_start->set_data ("isleft", (void*) 1);
177                 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
178                 frame_handle_start->raise_to_top();
179         }
180         
181         if (frame_handle_end) {
182                 frame_handle_end->set_data ("regionview", this);
183                 frame_handle_end->set_data ("isleft", (void*) 0);
184                 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
185                 frame_handle_end->raise_to_top();
186         }
187
188         if (name_text) {
189                 name_text->set_data ("regionview", this);
190                 name_text->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_text, this));
191         }
192
193         if (wfd) {
194                 _enable_display = true;
195         }
196
197         set_height (trackview.current_height());
198
199         _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
200
201         set_colors ();
202
203         ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
204
205         /* XXX sync mark drag? */
206 }
207
208 RegionView::~RegionView ()
209 {
210         in_destructor = true;
211
212         for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
213                 delete *g;
214         }
215
216         for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
217                 delete *i;
218         }
219
220         drop_silent_frames ();
221
222         delete editor;
223 }
224
225 bool
226 RegionView::canvas_group_event (GdkEvent* event)
227 {
228         if (!in_destructor) {
229                 return trackview.editor().canvas_region_view_event (event, group, this);
230         }
231         return false;
232 }
233
234 void
235 RegionView::set_silent_frames (const AudioIntervalResult& silences, double /*threshold*/)
236 {
237         framecnt_t shortest = max_framecnt;
238
239         /* remove old silent frames */
240         drop_silent_frames ();
241
242         if (silences.empty()) {
243                 return;
244         }
245
246         uint32_t const color = ARDOUR_UI::config()->get_Silence();
247
248         for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
249
250                 ArdourCanvas::Rectangle* cr = new ArdourCanvas::TimeRectangle (group);
251                 cr->set_ignore_events (true);
252                 _silent_frames.push_back (cr);
253
254                 /* coordinates for the rect are relative to the regionview origin */
255
256                 cr->set_x0 (trackview.editor().sample_to_pixel (i->first - _region->start()));
257                 cr->set_x1 (trackview.editor().sample_to_pixel (i->second - _region->start()));
258                 cr->set_y0 (1);
259                 cr->set_y1 (_height - 2);
260                 cr->set_outline (false);
261                 cr->set_fill_color (color);
262
263                 shortest = min (shortest, i->second - i->first);
264         }
265
266         /* Find shortest audible segment */
267         framecnt_t shortest_audible = max_framecnt;
268
269         framecnt_t s = _region->start();
270         for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
271                 framecnt_t const dur = i->first - s;
272                 if (dur > 0) {
273                         shortest_audible = min (shortest_audible, dur);
274                 }
275
276                 s = i->second;
277         }
278
279         framecnt_t const dur = _region->start() + _region->length() - 1 - s;
280         if (dur > 0) {
281                 shortest_audible = min (shortest_audible, dur);
282         }
283
284         _silence_text = new ArdourCanvas::Text (group);
285         _silence_text->set_ignore_events (true);
286         _silence_text->set_font_description (get_font_for_style (N_("SilenceText")));
287         _silence_text->set_color (ARDOUR_UI::config()->get_SilenceText());
288
289         /* both positions are relative to the region start offset in source */
290
291         _silence_text->set_x_position (trackview.editor().sample_to_pixel (silences.front().first - _region->start()) + 10.0);
292         _silence_text->set_y_position (20.0);
293
294         double ms = (float) shortest/_region->session().frame_rate();
295
296         /* ms are now in seconds */
297
298         char const * sunits;
299
300         if (ms >= 60.0) {
301                 sunits = _("minutes");
302                 ms /= 60.0;
303         } else if (ms < 1.0) {
304                 sunits = _("msecs");
305                 ms *= 1000.0;
306         } else {
307                 sunits = _("secs");
308         }
309
310         string text = string_compose (ngettext ("%1 silent segment", "%1 silent segments", silences.size()), silences.size())
311                 + ", "
312                 + string_compose (_("shortest = %1 %2"), ms, sunits);
313
314         if (shortest_audible != max_framepos) {
315                 /* ms are now in seconds */
316                 double ma = (float) shortest_audible / _region->session().frame_rate();
317                 char const * aunits;
318
319                 if (ma >= 60.0) {
320                         aunits = _("minutes");
321                         ma /= 60.0;
322                 } else if (ma < 1.0) {
323                         aunits = _("msecs");
324                         ma *= 1000.0;
325                 } else {
326                         aunits = _("secs");
327                 }
328
329                 text += string_compose (_("\n  (shortest audible segment = %1 %2)"), ma, aunits);
330         }
331
332         _silence_text->set (text);
333 }
334
335 void
336 RegionView::hide_silent_frames ()
337 {
338         for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
339                 (*i)->hide ();
340         }
341         _silence_text->hide();
342 }
343
344 void
345 RegionView::drop_silent_frames ()
346 {
347         for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
348                 delete *i;
349         }
350         _silent_frames.clear ();
351
352         delete _silence_text;
353         _silence_text = 0;
354 }
355
356 gint
357 RegionView::_lock_toggle (ArdourCanvas::Item*, GdkEvent* ev, void* arg)
358 {
359         switch (ev->type) {
360         case GDK_BUTTON_RELEASE:
361                 static_cast<RegionView*>(arg)->lock_toggle ();
362                 return TRUE;
363                 break;
364         default:
365                 break;
366         }
367         return FALSE;
368 }
369
370 void
371 RegionView::lock_toggle ()
372 {
373         _region->set_locked (!_region->locked());
374 }
375
376 void
377 RegionView::region_changed (const PropertyChange& what_changed)
378 {
379         ENSURE_GUI_THREAD (*this, &RegionView::region_changed, what_changed);
380
381         if (what_changed.contains (ARDOUR::bounds_change)) {
382                 region_resized (what_changed);
383                 region_sync_changed ();
384         }
385         if (what_changed.contains (ARDOUR::Properties::muted)) {
386                 region_muted ();
387         }
388         if (what_changed.contains (ARDOUR::Properties::opaque)) {
389                 region_opacity ();
390         }
391         if (what_changed.contains (ARDOUR::Properties::name)) {
392                 region_renamed ();
393         }
394         if (what_changed.contains (ARDOUR::Properties::sync_position)) {
395                 region_sync_changed ();
396         }
397         if (what_changed.contains (ARDOUR::Properties::locked)) {
398                 region_locked ();
399         }
400         if (what_changed.contains (ARDOUR::Properties::locked)) {
401                 /* name will show locked status */
402                 region_renamed ();
403         }
404 }
405
406 void
407 RegionView::region_locked ()
408 {
409         /* name will show locked status */
410         region_renamed ();
411 }
412
413 void
414 RegionView::region_resized (const PropertyChange& what_changed)
415 {
416         double unit_length;
417
418         if (what_changed.contains (ARDOUR::Properties::position)) {
419                 set_position (_region->position(), 0);
420                 _region_relative_time_converter.set_origin_b (_region->position());
421         }
422
423         if (what_changed.contains (ARDOUR::Properties::start) || what_changed.contains (ARDOUR::Properties::position)) {
424                 _source_relative_time_converter.set_origin_b (_region->position() - _region->start());
425         }
426
427         PropertyChange s_and_l;
428         s_and_l.add (ARDOUR::Properties::start);
429         s_and_l.add (ARDOUR::Properties::length);
430
431         if (what_changed.contains (s_and_l)) {
432
433                 set_duration (_region->length(), 0);
434
435                 unit_length = _region->length() / samples_per_pixel;
436
437                 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
438
439                         (*i)->set_duration (unit_length);
440
441                 }
442         }
443 }
444
445 void
446 RegionView::reset_width_dependent_items (double pixel_width)
447 {
448         TimeAxisViewItem::reset_width_dependent_items (pixel_width);
449         _pixel_width = pixel_width;
450 }
451
452 void
453 RegionView::region_muted ()
454 {
455         set_frame_color ();
456         region_renamed ();
457 }
458
459 void
460 RegionView::region_opacity ()
461 {
462         set_frame_color ();
463 }
464
465 void
466 RegionView::raise_to_top ()
467 {
468         _region->raise_to_top ();
469 }
470
471 void
472 RegionView::lower_to_bottom ()
473 {
474         _region->lower_to_bottom ();
475 }
476
477 bool
478 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
479 {
480         double delta;
481         bool ret;
482
483         if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
484                 return false;
485         }
486
487         if (ignored) {
488                 *ignored = delta;
489         }
490
491         if (delta) {
492                 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
493                         (*i)->group->move (ArdourCanvas::Duple (delta, 0.0));
494                 }
495         }
496
497         return ret;
498 }
499
500 void
501 RegionView::set_samples_per_pixel (double fpp)
502 {
503         TimeAxisViewItem::set_samples_per_pixel (fpp);
504
505         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
506                 (*i)->set_samples_per_pixel (fpp);
507                 (*i)->set_duration (_region->length() / fpp);
508         }
509
510         region_sync_changed ();
511 }
512
513 bool
514 RegionView::set_duration (framecnt_t frames, void *src)
515 {
516         if (!TimeAxisViewItem::set_duration (frames, src)) {
517                 return false;
518         }
519
520         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
521                 (*i)->set_duration (_region->length() / samples_per_pixel);
522         }
523
524         return true;
525 }
526
527 uint32_t
528 RegionView::fill_opacity () const
529 {
530         if (!_region->opaque()) {
531                 return 60;
532         }
533         
534         uint32_t normal_tavi_opacity = TimeAxisViewItem::fill_opacity ();
535
536         return normal_tavi_opacity;
537 }
538
539 void
540 RegionView::set_colors ()
541 {
542         TimeAxisViewItem::set_colors ();
543
544         if (sync_mark) {
545                 /* XXX: make these colours themable */
546                 sync_mark->set_fill_color (ArdourCanvas::rgba_to_color (0, 1.0, 0, 1.0));
547                 sync_line->set_outline_color (ArdourCanvas::rgba_to_color (0, 1.0, 0, 1.0));
548         }
549 }
550
551 void
552 RegionView::set_frame_color ()
553 {
554         TimeAxisViewItem::set_frame_color ();
555 }
556
557 void
558 RegionView::show_region_editor ()
559 {
560         if (editor == 0) {
561                 editor = new RegionEditor (trackview.session(), region());
562         }
563
564         editor->present ();
565         editor->show_all();
566 }
567
568 void
569 RegionView::hide_region_editor()
570 {
571         if (editor) {
572                 editor->hide_all ();
573         }
574 }
575
576 std::string
577 RegionView::make_name () const
578 {
579         std::string str;
580
581         // XXX nice to have some good icons for this
582
583         if (_region->locked()) {
584                 str += '>';
585                 str += _region->name();
586                 str += '<';
587         } else if (_region->position_locked()) {
588                 str += '{';
589                 str += _region->name();
590                 str += '}';
591         } else if (_region->video_locked()) {
592                 str += '[';
593                 str += _region->name();
594                 str += ']';
595         } else {
596                 str = _region->name();
597         }
598
599         if (_region->muted()) {
600                 str = string ("!") + str;
601         }
602
603         return str;
604 }
605
606 void
607 RegionView::region_renamed ()
608 {
609         std::string str = make_name ();
610
611         set_item_name (str, this);
612         set_name_text (str);
613         reset_width_dependent_items (_pixel_width);
614 }
615
616 void
617 RegionView::region_sync_changed ()
618 {
619         int sync_dir;
620         framecnt_t sync_offset;
621
622         sync_offset = _region->sync_offset (sync_dir);
623
624         if (sync_offset == 0) {
625                 /* no need for a sync mark */
626                 if (sync_mark) {
627                         sync_mark->hide();
628                         sync_line->hide ();
629                 }
630                 return;
631         }
632
633         if (!sync_mark) {
634
635                 /* points set below */
636
637                 sync_mark = new ArdourCanvas::Polygon (group);
638                 CANVAS_DEBUG_NAME (sync_mark, string_compose ("sync mark for %1", get_item_name()));
639                 sync_mark->set_fill_color (ArdourCanvas::rgba_to_color (0, 1.0, 0, 1.0));    // FIXME make a themeable colour
640
641                 sync_line = new ArdourCanvas::Line (group);
642                 CANVAS_DEBUG_NAME (sync_line, string_compose ("sync mark for %1", get_item_name()));
643                 sync_line->set_outline_color (ArdourCanvas::rgba_to_color (0, 1.0, 0, 1.0)); // FIXME make a themeable colour
644         }
645
646         /* this has to handle both a genuine change of position, a change of samples_per_pixel
647            and a change in the bounds of the _region->
648          */
649
650         if (sync_offset == 0) {
651
652                 /* no sync mark - its the start of the region */
653
654                 sync_mark->hide();
655                 sync_line->hide ();
656
657         } else {
658
659                 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
660
661                         /* no sync mark - its out of the bounds of the region */
662
663                         sync_mark->hide();
664                         sync_line->hide ();
665
666                 } else {
667
668                         /* lets do it */
669
670                         Points points;
671
672                         //points = sync_mark->property_points().get_value();
673
674                         double offset = sync_offset / samples_per_pixel;
675                         points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
676                         points.push_back (ArdourCanvas::Duple (offset + ((sync_mark_width-1)/2), 1));
677                         points.push_back (ArdourCanvas::Duple (offset, sync_mark_width - 1));
678                         points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
679                         sync_mark->set (points);
680                         sync_mark->show ();
681
682                         sync_line->set (ArdourCanvas::Duple (offset, 0), ArdourCanvas::Duple (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
683                         sync_line->show ();
684                 }
685         }
686 }
687
688 void
689 RegionView::move (double x_delta, double y_delta)
690 {
691         if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
692                 return;
693         }
694
695         /* items will not prevent Item::move() moving
696          * them to a negative x-axis coordinate, which
697          * is legal, but we don't want that here.
698          */
699
700         ArdourCanvas::Item *item = get_canvas_group ();
701         
702         if (item->position().x + x_delta < 0) {
703                 x_delta = -item->position().x; /* move it to zero */
704         }
705
706         item->move (ArdourCanvas::Duple (x_delta, y_delta));
707
708         /* note: ghosts never leave their tracks so y_delta for them is always zero */
709
710         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
711                 (*i)->group->move (ArdourCanvas::Duple (x_delta, 0.0));
712         }
713 }
714
715 void
716 RegionView::remove_ghost_in (TimeAxisView& tv)
717 {
718         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
719                 if (&(*i)->trackview == &tv) {
720                         delete *i;
721                         break;
722                 }
723         }
724 }
725
726 void
727 RegionView::remove_ghost (GhostRegion* ghost)
728 {
729         if (in_destructor) {
730                 return;
731         }
732
733         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
734                 if (*i == ghost) {
735                         ghosts.erase (i);
736                         break;
737                 }
738         }
739 }
740
741 void
742 RegionView::set_height (double h)
743 {
744         TimeAxisViewItem::set_height(h);
745
746         if (sync_line) {
747                 Points points;
748                 int sync_dir;
749                 framecnt_t sync_offset;
750                 sync_offset = _region->sync_offset (sync_dir);
751                 double offset = sync_offset / samples_per_pixel;
752
753                 sync_line->set (
754                         ArdourCanvas::Duple (offset, 0),
755                         ArdourCanvas::Duple (offset, h - NAME_HIGHLIGHT_SIZE)
756                         );
757         }
758
759         for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
760                 (*i)->set_y1 (h + 1);
761         }
762
763         for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
764                 (*i)->set_y1 (h + 1);
765         }
766
767 }
768
769 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
770  *  which uses them. */
771 void
772 RegionView::update_coverage_frames (LayerDisplay d)
773 {
774         /* remove old coverage frames */
775         for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
776                 delete *i;
777         }
778
779         _coverage_frames.clear ();
780
781         if (d != Stacked) {
782                 /* don't do coverage frames unless we're in stacked mode */
783                 return;
784         }
785
786         boost::shared_ptr<Playlist> pl (_region->playlist ());
787         if (!pl) {
788                 return;
789         }
790
791         framepos_t const position = _region->first_frame ();
792         framepos_t t = position;
793         framepos_t const end = _region->last_frame ();
794
795         ArdourCanvas::Rectangle* cr = 0;
796         bool me = false;
797
798         /* the color that will be used to show parts of regions that will not be heard */
799         uint32_t const non_playing_color = ARDOUR_UI::config()->get_CoveredRegion ();
800
801         while (t < end) {
802
803                 t++;
804
805                 /* is this region is on top at time t? */
806                 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
807
808                 /* finish off any old rect, if required */
809                 if (cr && me != new_me) {
810                         cr->set_x1 (trackview.editor().sample_to_pixel (t - position));
811                 }
812
813                 /* start off any new rect, if required */
814                 if (cr == 0 || me != new_me) {
815                         cr = new ArdourCanvas::TimeRectangle (group);
816                         _coverage_frames.push_back (cr);
817                         cr->set_x0 (trackview.editor().sample_to_pixel (t - position));
818                         cr->set_y0 (1);
819                         cr->set_y1 (_height + 1);
820                         cr->set_outline (false);
821                         cr->set_ignore_events (true);
822                         if (new_me) {
823                                 cr->set_fill_color (UINT_RGBA_CHANGE_A (non_playing_color, 0));
824                         } else {
825                                 cr->set_fill_color (non_playing_color);
826                         }
827                 }
828
829                 t = pl->find_next_region_boundary (t, 1);
830                 me = new_me;
831         }
832
833         if (cr) {
834                 /* finish off the last rectangle */
835                 cr->set_x1 (trackview.editor().sample_to_pixel (end - position));
836         }
837
838         if (frame_handle_start) {
839                 frame_handle_start->raise_to_top ();
840         }
841
842         if (frame_handle_end) {
843                 frame_handle_end->raise_to_top ();
844         }
845
846         if (name_highlight) {
847                 name_highlight->raise_to_top ();
848         }
849
850         if (name_text) {
851                 name_text->raise_to_top ();
852         }
853 }
854
855 bool
856 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
857 {
858         if (_region->locked()) {
859                 return false;
860         }
861
862         RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
863         double const speed = rtv.track()->speed ();
864
865         framepos_t const pre_trim_first_frame = _region->first_frame();
866
867         _region->trim_front ((framepos_t) (new_bound * speed));
868
869         if (no_overlap) {
870                 // Get the next region on the left of this region and shrink/expand it.
871                 boost::shared_ptr<Playlist> playlist (_region->playlist());
872                 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
873
874                 bool regions_touching = false;
875
876                 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
877                         regions_touching = true;
878                 }
879
880                 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
881                 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
882                         region_left->trim_end (_region->first_frame() - 1);
883                 }
884         }
885
886         region_changed (ARDOUR::bounds_change);
887
888         return (pre_trim_first_frame != _region->first_frame());  //return true if we actually changed something
889 }
890
891 bool
892 RegionView::trim_end (framepos_t new_bound, bool no_overlap)
893 {
894         if (_region->locked()) {
895                 return false;
896         }
897
898         RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
899         double const speed = rtv.track()->speed ();
900
901         framepos_t const pre_trim_last_frame = _region->last_frame();
902
903         _region->trim_end ((framepos_t) (new_bound * speed));
904
905         if (no_overlap) {
906                 // Get the next region on the right of this region and shrink/expand it.
907                 boost::shared_ptr<Playlist> playlist (_region->playlist());
908                 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_frame, Start, 1);
909
910                 bool regions_touching = false;
911
912                 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
913                         regions_touching = true;
914                 }
915
916                 // Only trim region on the right if the last frame has gone beyond the right region's first frame.
917                 if (region_right != 0 && (region_right->first_frame() < _region->last_frame() || regions_touching)) {
918                         region_right->trim_front (_region->last_frame() + 1);
919                 }
920
921                 region_changed (ARDOUR::bounds_change);
922
923         } else {
924                 region_changed (PropertyChange (ARDOUR::Properties::length));
925         }
926
927         return (pre_trim_last_frame != _region->last_frame());  //return true if we actually changed something
928 }
929
930
931 void
932 RegionView::thaw_after_trim ()
933 {
934         if (_region->locked()) {
935                 return;
936         }
937
938         _region->resume_property_changes ();
939 }
940
941
942 void
943 RegionView::move_contents (frameoffset_t distance)
944 {
945         if (_region->locked()) {
946                 return;
947         }
948         _region->move_start (distance);
949         region_changed (PropertyChange (ARDOUR::Properties::start));
950 }
951
952 /** Snap a frame offset within our region using the current snap settings.
953  *  @param x Frame offset from this region's position.
954  *  @return Snapped frame offset from this region's position.
955  */
956 frameoffset_t
957 RegionView::snap_frame_to_frame (frameoffset_t x) const
958 {
959         PublicEditor& editor = trackview.editor();
960
961         /* x is region relative, convert it to global absolute frames */
962         framepos_t const session_frame = x + _region->position();
963
964         /* try a snap in either direction */
965         framepos_t frame = session_frame;
966         editor.snap_to (frame, 0);
967
968         /* if we went off the beginning of the region, snap forwards */
969         if (frame < _region->position ()) {
970                 frame = session_frame;
971                 editor.snap_to (frame, 1);
972         }
973
974         /* back to region relative */
975         return frame - _region->position();
976 }