2 Copyright (C) 2001-2006 Paul Davis
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.
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.
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.
25 #include <gtkmm2ext/gtk_ui.h>
27 #include "ardour/playlist.h"
28 #include "ardour/session.h"
30 #include "canvas/polygon.h"
31 #include "canvas/debug.h"
32 #include "canvas/pixbuf.h"
33 #include "canvas/text.h"
34 #include "canvas/line.h"
35 #include "canvas/utils.h"
36 #include "canvas/colors.h"
38 #include "ardour_ui.h"
39 #include "global_signals.h"
40 #include "streamview.h"
41 #include "region_view.h"
42 #include "automation_region_view.h"
43 #include "route_time_axis.h"
44 #include "public_editor.h"
45 #include "region_editor.h"
46 #include "ghostregion.h"
47 #include "route_time_axis.h"
48 #include "ui_config.h"
50 #include "rgb_macros.h"
51 #include "gui_thread.h"
56 using namespace ARDOUR;
57 using namespace ARDOUR_UI_UTILS;
59 using namespace Editing;
61 using namespace ArdourCanvas;
63 static const int32_t sync_mark_width = 9;
65 PBD::Signal1<void,RegionView*> RegionView::RegionViewGoingAway;
67 RegionView::RegionView (ArdourCanvas::Container* parent,
69 boost::shared_ptr<ARDOUR::Region> r,
73 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), false, automation,
74 (automation ? TimeAxisViewItem::ShowFrame :
75 TimeAxisViewItem::Visibility (TimeAxisViewItem::ShowNameText|
76 TimeAxisViewItem::ShowNameHighlight| TimeAxisViewItem::ShowFrame)))
81 , current_visible_sync_position(0.0)
83 , _enable_display(false)
85 , in_destructor(false)
86 , wait_for_data(false)
89 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
92 RegionView::RegionView (const RegionView& other)
93 : sigc::trackable(other)
94 , TimeAxisViewItem (other)
97 /* derived concrete type will call init () */
99 _region = other._region;
100 current_visible_sync_position = other.current_visible_sync_position;
102 _pixel_width = other._pixel_width;
104 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
107 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
108 : sigc::trackable(other)
109 , TimeAxisViewItem (other)
112 /* this is a pseudo-copy constructor used when dragging regions
113 around on the canvas.
116 /* derived concrete type will call init () */
118 _region = other_region;
119 current_visible_sync_position = other.current_visible_sync_position;
121 _pixel_width = other._pixel_width;
123 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
126 RegionView::RegionView (ArdourCanvas::Container* parent,
128 boost::shared_ptr<ARDOUR::Region> r,
130 uint32_t basic_color,
132 TimeAxisViewItem::Visibility visibility)
133 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
138 , current_visible_sync_position(0.0)
140 , _enable_display(false)
142 , in_destructor(false)
143 , wait_for_data(false)
149 RegionView::init (bool wfd)
153 in_destructor = false;
160 if (name_highlight) {
161 name_highlight->set_data ("regionview", this);
162 name_highlight->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
165 if (frame_handle_start) {
166 frame_handle_start->set_data ("regionview", this);
167 frame_handle_start->set_data ("isleft", (void*) 1);
168 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
169 frame_handle_start->raise_to_top();
172 if (frame_handle_end) {
173 frame_handle_end->set_data ("regionview", this);
174 frame_handle_end->set_data ("isleft", (void*) 0);
175 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
176 frame_handle_end->raise_to_top();
180 name_text->set_data ("regionview", this);
181 name_text->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_text, this));
185 _enable_display = true;
188 set_height (trackview.current_height());
190 _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
194 ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
196 /* XXX sync mark drag? */
199 RegionView::~RegionView ()
201 in_destructor = true;
203 for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
207 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
211 drop_silent_frames ();
217 RegionView::canvas_group_event (GdkEvent* event)
219 if (!in_destructor) {
220 return trackview.editor().canvas_region_view_event (event, group, this);
226 RegionView::set_silent_frames (const AudioIntervalResult& silences, double /*threshold*/)
228 framecnt_t shortest = max_framecnt;
230 /* remove old silent frames */
231 drop_silent_frames ();
233 if (silences.empty()) {
237 uint32_t const color = ARDOUR_UI::config()->color_mod ("silence", "silence");
239 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
241 ArdourCanvas::Rectangle* cr = new ArdourCanvas::Rectangle (group);
242 cr->set_ignore_events (true);
243 _silent_frames.push_back (cr);
245 /* coordinates for the rect are relative to the regionview origin */
247 cr->set_x0 (trackview.editor().sample_to_pixel (i->first - _region->start()));
248 cr->set_x1 (trackview.editor().sample_to_pixel (i->second - _region->start()));
250 cr->set_y1 (_height - 2);
251 cr->set_outline (false);
252 cr->set_fill_color (color);
254 shortest = min (shortest, i->second - i->first);
257 /* Find shortest audible segment */
258 framecnt_t shortest_audible = max_framecnt;
260 framecnt_t s = _region->start();
261 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
262 framecnt_t const dur = i->first - s;
264 shortest_audible = min (shortest_audible, dur);
270 framecnt_t const dur = _region->start() + _region->length() - 1 - s;
272 shortest_audible = min (shortest_audible, dur);
275 _silence_text = new ArdourCanvas::Text (group);
276 _silence_text->set_ignore_events (true);
277 _silence_text->set_font_description (get_font_for_style (N_("SilenceText")));
278 _silence_text->set_color (ARDOUR_UI::config()->color ("silence text"));
280 /* both positions are relative to the region start offset in source */
282 _silence_text->set_x_position (trackview.editor().sample_to_pixel (silences.front().first - _region->start()) + 10.0);
283 _silence_text->set_y_position (20.0);
285 double ms = (float) shortest/_region->session().frame_rate();
287 /* ms are now in seconds */
292 sunits = _("minutes");
294 } else if (ms < 1.0) {
301 string text = string_compose (ngettext ("%1 silent segment", "%1 silent segments", silences.size()), silences.size())
303 + string_compose (_("shortest = %1 %2"), ms, sunits);
305 if (shortest_audible != max_framepos) {
306 /* ms are now in seconds */
307 double ma = (float) shortest_audible / _region->session().frame_rate();
311 aunits = _("minutes");
313 } else if (ma < 1.0) {
320 text += string_compose (_("\n (shortest audible segment = %1 %2)"), ma, aunits);
323 _silence_text->set (text);
327 RegionView::hide_silent_frames ()
329 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
332 _silence_text->hide();
336 RegionView::drop_silent_frames ()
338 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
341 _silent_frames.clear ();
343 delete _silence_text;
348 RegionView::_lock_toggle (ArdourCanvas::Item*, GdkEvent* ev, void* arg)
351 case GDK_BUTTON_RELEASE:
352 static_cast<RegionView*>(arg)->lock_toggle ();
362 RegionView::lock_toggle ()
364 _region->set_locked (!_region->locked());
368 RegionView::region_changed (const PropertyChange& what_changed)
370 ENSURE_GUI_THREAD (*this, &RegionView::region_changed, what_changed);
372 if (what_changed.contains (ARDOUR::bounds_change)) {
373 region_resized (what_changed);
374 region_sync_changed ();
376 if (what_changed.contains (ARDOUR::Properties::muted)) {
379 if (what_changed.contains (ARDOUR::Properties::opaque)) {
382 if (what_changed.contains (ARDOUR::Properties::name)) {
385 if (what_changed.contains (ARDOUR::Properties::sync_position)) {
386 region_sync_changed ();
388 if (what_changed.contains (ARDOUR::Properties::locked)) {
391 if (what_changed.contains (ARDOUR::Properties::locked)) {
392 /* name will show locked status */
398 RegionView::region_locked ()
400 /* name will show locked status */
405 RegionView::region_resized (const PropertyChange& what_changed)
409 if (what_changed.contains (ARDOUR::Properties::position)) {
410 set_position (_region->position(), 0);
413 PropertyChange s_and_l;
414 s_and_l.add (ARDOUR::Properties::start);
415 s_and_l.add (ARDOUR::Properties::length);
417 if (what_changed.contains (s_and_l)) {
419 set_duration (_region->length(), 0);
421 unit_length = _region->length() / samples_per_pixel;
423 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
425 (*i)->set_duration (unit_length);
432 RegionView::reset_width_dependent_items (double pixel_width)
434 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
435 _pixel_width = pixel_width;
439 RegionView::region_muted ()
446 RegionView::region_opacity ()
452 RegionView::raise_to_top ()
454 _region->raise_to_top ();
458 RegionView::lower_to_bottom ()
460 _region->lower_to_bottom ();
464 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
469 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
478 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
479 (*i)->group->move (ArdourCanvas::Duple (delta, 0.0));
487 RegionView::set_samples_per_pixel (double fpp)
489 TimeAxisViewItem::set_samples_per_pixel (fpp);
491 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
492 (*i)->set_samples_per_pixel (fpp);
493 (*i)->set_duration (_region->length() / fpp);
496 region_sync_changed ();
500 RegionView::set_duration (framecnt_t frames, void *src)
502 if (!TimeAxisViewItem::set_duration (frames, src)) {
506 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
507 (*i)->set_duration (_region->length() / samples_per_pixel);
514 RegionView::set_colors ()
516 TimeAxisViewItem::set_colors ();
517 set_sync_mark_color ();
521 RegionView::set_sync_mark_color ()
524 ArdourCanvas::Color c = ARDOUR_UI::config()->color ("sync mark");
525 sync_mark->set_fill_color (c);
526 sync_mark->set_outline_color (c);
527 sync_line->set_outline_color (c);
532 RegionView::get_fill_color () const
534 ArdourCanvas::Color f = TimeAxisViewItem::get_fill_color();
537 if (_region->opaque()) {
538 modname = "opaque region base";
540 modname = "transparent region base";
543 return HSV(f).mod (ARDOUR_UI::config()->modifier (modname)).color ();
547 RegionView::show_region_editor ()
550 editor = new RegionEditor (trackview.session(), region());
558 RegionView::hide_region_editor()
566 RegionView::make_name () const
570 // XXX nice to have some good icons for this
572 if (_region->locked()) {
574 str += _region->name();
576 } else if (_region->position_locked()) {
578 str += _region->name();
580 } else if (_region->video_locked()) {
582 str += _region->name();
585 str = _region->name();
588 if (_region->muted()) {
589 str = string ("!") + str;
596 RegionView::region_renamed ()
598 std::string str = make_name ();
600 set_item_name (str, this);
602 reset_width_dependent_items (_pixel_width);
606 RegionView::region_sync_changed ()
609 framecnt_t sync_offset;
611 sync_offset = _region->sync_offset (sync_dir);
613 if (sync_offset == 0) {
614 /* no need for a sync mark */
624 /* points set below */
626 sync_mark = new ArdourCanvas::Polygon (group);
627 CANVAS_DEBUG_NAME (sync_mark, string_compose ("sync mark for %1", get_item_name()));
628 sync_line = new ArdourCanvas::Line (group);
629 CANVAS_DEBUG_NAME (sync_line, string_compose ("sync mark for %1", get_item_name()));
631 set_sync_mark_color ();
634 /* this has to handle both a genuine change of position, a change of samples_per_pixel
635 and a change in the bounds of the _region->
638 if (sync_offset == 0) {
640 /* no sync mark - its the start of the region */
647 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
649 /* no sync mark - its out of the bounds of the region */
660 //points = sync_mark->property_points().get_value();
662 double offset = sync_offset / samples_per_pixel;
663 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
664 points.push_back (ArdourCanvas::Duple (offset + ((sync_mark_width-1)/2), 1));
665 points.push_back (ArdourCanvas::Duple (offset, sync_mark_width - 1));
666 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
667 sync_mark->set (points);
670 sync_line->set (ArdourCanvas::Duple (offset, 0), ArdourCanvas::Duple (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
677 RegionView::move (double x_delta, double y_delta)
679 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
683 /* items will not prevent Item::move() moving
684 * them to a negative x-axis coordinate, which
685 * is legal, but we don't want that here.
688 ArdourCanvas::Item *item = get_canvas_group ();
690 if (item->position().x + x_delta < 0) {
691 x_delta = -item->position().x; /* move it to zero */
694 item->move (ArdourCanvas::Duple (x_delta, y_delta));
696 /* note: ghosts never leave their tracks so y_delta for them is always zero */
698 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
699 (*i)->group->move (ArdourCanvas::Duple (x_delta, 0.0));
704 RegionView::remove_ghost_in (TimeAxisView& tv)
706 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
707 if (&(*i)->trackview == &tv) {
715 RegionView::remove_ghost (GhostRegion* ghost)
721 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
730 RegionView::set_height (double h)
732 TimeAxisViewItem::set_height(h);
737 framecnt_t sync_offset;
738 sync_offset = _region->sync_offset (sync_dir);
739 double offset = sync_offset / samples_per_pixel;
742 ArdourCanvas::Duple (offset, 0),
743 ArdourCanvas::Duple (offset, h - NAME_HIGHLIGHT_SIZE)
747 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
748 (*i)->set_y1 (h + 1);
751 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
752 (*i)->set_y1 (h + 1);
757 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
758 * which uses them. */
760 RegionView::update_coverage_frames (LayerDisplay d)
762 /* remove old coverage frames */
763 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
767 _coverage_frames.clear ();
770 /* don't do coverage frames unless we're in stacked mode */
774 boost::shared_ptr<Playlist> pl (_region->playlist ());
779 framepos_t const position = _region->first_frame ();
780 framepos_t t = position;
781 framepos_t const end = _region->last_frame ();
783 ArdourCanvas::Rectangle* cr = 0;
786 /* the color that will be used to show parts of regions that will not be heard */
787 uint32_t const non_playing_color = ARDOUR_UI::config()->color_mod ("covered region", "covered region base");
793 /* is this region is on top at time t? */
794 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
796 /* finish off any old rect, if required */
797 if (cr && me != new_me) {
798 cr->set_x1 (trackview.editor().sample_to_pixel (t - position));
801 /* start off any new rect, if required */
802 if (cr == 0 || me != new_me) {
803 cr = new ArdourCanvas::Rectangle (group);
804 _coverage_frames.push_back (cr);
805 cr->set_x0 (trackview.editor().sample_to_pixel (t - position));
807 cr->set_y1 (_height + 1);
808 cr->set_outline (false);
809 cr->set_ignore_events (true);
811 cr->set_fill_color (UINT_RGBA_CHANGE_A (non_playing_color, 0));
813 cr->set_fill_color (non_playing_color);
817 t = pl->find_next_region_boundary (t, 1);
822 /* finish off the last rectangle */
823 cr->set_x1 (trackview.editor().sample_to_pixel (end - position));
826 if (frame_handle_start) {
827 frame_handle_start->raise_to_top ();
830 if (frame_handle_end) {
831 frame_handle_end->raise_to_top ();
834 if (name_highlight) {
835 name_highlight->raise_to_top ();
839 name_text->raise_to_top ();
844 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
846 if (_region->locked()) {
850 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
851 double const speed = rtv.track()->speed ();
853 framepos_t const pre_trim_first_frame = _region->first_frame();
855 _region->trim_front ((framepos_t) (new_bound * speed));
858 // Get the next region on the left of this region and shrink/expand it.
859 boost::shared_ptr<Playlist> playlist (_region->playlist());
860 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
862 bool regions_touching = false;
864 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
865 regions_touching = true;
868 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
869 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
870 region_left->trim_end (_region->first_frame() - 1);
874 region_changed (ARDOUR::bounds_change);
876 return (pre_trim_first_frame != _region->first_frame()); //return true if we actually changed something
880 RegionView::trim_end (framepos_t new_bound, bool no_overlap)
882 if (_region->locked()) {
886 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
887 double const speed = rtv.track()->speed ();
889 framepos_t const pre_trim_last_frame = _region->last_frame();
891 _region->trim_end ((framepos_t) (new_bound * speed));
894 // Get the next region on the right of this region and shrink/expand it.
895 boost::shared_ptr<Playlist> playlist (_region->playlist());
896 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_frame, Start, 1);
898 bool regions_touching = false;
900 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
901 regions_touching = true;
904 // Only trim region on the right if the last frame has gone beyond the right region's first frame.
905 if (region_right != 0 && (region_right->first_frame() < _region->last_frame() || regions_touching)) {
906 region_right->trim_front (_region->last_frame() + 1);
909 region_changed (ARDOUR::bounds_change);
912 region_changed (PropertyChange (ARDOUR::Properties::length));
915 return (pre_trim_last_frame != _region->last_frame()); //return true if we actually changed something
920 RegionView::thaw_after_trim ()
922 if (_region->locked()) {
926 _region->resume_property_changes ();
931 RegionView::move_contents (frameoffset_t distance)
933 if (_region->locked()) {
936 _region->move_start (distance);
937 region_changed (PropertyChange (ARDOUR::Properties::start));
940 /** Snap a frame offset within our region using the current snap settings.
941 * @param x Frame offset from this region's position.
942 * @param ensure_snap whether to ignore snap_mode (in the case of SnapOff) and magnetic snap.
943 * Used when inverting snap mode logic with key modifiers, or snap distance calculation.
944 * @return Snapped frame offset from this region's position.
947 RegionView::snap_frame_to_frame (frameoffset_t x, bool ensure_snap) const
949 PublicEditor& editor = trackview.editor();
951 /* x is region relative, convert it to global absolute frames */
952 framepos_t const session_frame = x + _region->position();
954 /* try a snap in either direction */
955 framepos_t frame = session_frame;
956 editor.snap_to (frame, RoundNearest, false, ensure_snap);
958 /* if we went off the beginning of the region, snap forwards */
959 if (frame < _region->position ()) {
960 frame = session_frame;
961 editor.snap_to (frame, RoundUpAlways, false, ensure_snap);
964 /* back to region relative */
965 return frame - _region->position();