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.
26 #include <gtkmm2ext/gtk_ui.h>
28 #include "ardour/playlist.h"
29 #include "ardour/session.h"
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"
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"
51 #include "rgb_macros.h"
52 #include "gui_thread.h"
57 using namespace ARDOUR;
58 using namespace ARDOUR_UI_UTILS;
60 using namespace Editing;
62 using namespace ArdourCanvas;
64 static const int32_t sync_mark_width = 9;
66 PBD::Signal1<void,RegionView*> RegionView::RegionViewGoingAway;
68 RegionView::RegionView (ArdourCanvas::Container* parent,
70 boost::shared_ptr<ARDOUR::Region> r,
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)))
82 , current_visible_sync_position(0.0)
84 , _enable_display(false)
86 , in_destructor(false)
87 , wait_for_data(false)
89 , _region_relative_time_converter(r->session().tempo_map(), r->position())
90 , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
92 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
95 RegionView::RegionView (const RegionView& other)
96 : sigc::trackable(other)
97 , TimeAxisViewItem (other)
99 , _region_relative_time_converter(other.region_relative_time_converter())
100 , _source_relative_time_converter(other.source_relative_time_converter())
102 /* derived concrete type will call init () */
104 _region = other._region;
105 current_visible_sync_position = other.current_visible_sync_position;
107 _pixel_width = other._pixel_width;
109 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
112 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
113 : sigc::trackable(other)
114 , TimeAxisViewItem (other)
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())
119 /* this is a pseudo-copy constructor used when dragging regions
120 around on the canvas.
123 /* derived concrete type will call init () */
125 _region = other_region;
126 current_visible_sync_position = other.current_visible_sync_position;
128 _pixel_width = other._pixel_width;
130 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
133 RegionView::RegionView (ArdourCanvas::Container* parent,
135 boost::shared_ptr<ARDOUR::Region> r,
137 uint32_t basic_color,
139 TimeAxisViewItem::Visibility visibility)
140 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
145 , current_visible_sync_position(0.0)
147 , _enable_display(false)
149 , in_destructor(false)
150 , wait_for_data(false)
152 , _region_relative_time_converter(r->session().tempo_map(), r->position())
153 , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
158 RegionView::init (bool wfd)
162 in_destructor = false;
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));
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();
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();
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));
194 _enable_display = true;
197 set_height (trackview.current_height());
199 _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
203 ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
205 /* XXX sync mark drag? */
208 RegionView::~RegionView ()
210 in_destructor = true;
212 for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
216 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
220 drop_silent_frames ();
226 RegionView::canvas_group_event (GdkEvent* event)
228 if (!in_destructor) {
229 return trackview.editor().canvas_region_view_event (event, group, this);
235 RegionView::set_silent_frames (const AudioIntervalResult& silences, double /*threshold*/)
237 framecnt_t shortest = max_framecnt;
239 /* remove old silent frames */
240 drop_silent_frames ();
242 if (silences.empty()) {
246 uint32_t const color = ARDOUR_UI::config()->get_Silence();
248 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
250 ArdourCanvas::Rectangle* cr = new ArdourCanvas::TimeRectangle (group);
251 cr->set_ignore_events (true);
252 _silent_frames.push_back (cr);
254 /* coordinates for the rect are relative to the regionview origin */
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()));
259 cr->set_y1 (_height - 2);
260 cr->set_outline (false);
261 cr->set_fill_color (color);
263 shortest = min (shortest, i->second - i->first);
266 /* Find shortest audible segment */
267 framecnt_t shortest_audible = max_framecnt;
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;
273 shortest_audible = min (shortest_audible, dur);
279 framecnt_t const dur = _region->start() + _region->length() - 1 - s;
281 shortest_audible = min (shortest_audible, dur);
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());
289 /* both positions are relative to the region start offset in source */
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);
294 double ms = (float) shortest/_region->session().frame_rate();
296 /* ms are now in seconds */
301 sunits = _("minutes");
303 } else if (ms < 1.0) {
310 string text = string_compose (ngettext ("%1 silent segment", "%1 silent segments", silences.size()), silences.size())
312 + string_compose (_("shortest = %1 %2"), ms, sunits);
314 if (shortest_audible != max_framepos) {
315 /* ms are now in seconds */
316 double ma = (float) shortest_audible / _region->session().frame_rate();
320 aunits = _("minutes");
322 } else if (ma < 1.0) {
329 text += string_compose (_("\n (shortest audible segment = %1 %2)"), ma, aunits);
332 _silence_text->set (text);
336 RegionView::hide_silent_frames ()
338 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
341 _silence_text->hide();
345 RegionView::drop_silent_frames ()
347 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
350 _silent_frames.clear ();
352 delete _silence_text;
357 RegionView::_lock_toggle (ArdourCanvas::Item*, GdkEvent* ev, void* arg)
360 case GDK_BUTTON_RELEASE:
361 static_cast<RegionView*>(arg)->lock_toggle ();
371 RegionView::lock_toggle ()
373 _region->set_locked (!_region->locked());
377 RegionView::region_changed (const PropertyChange& what_changed)
379 ENSURE_GUI_THREAD (*this, &RegionView::region_changed, what_changed);
381 if (what_changed.contains (ARDOUR::bounds_change)) {
382 region_resized (what_changed);
383 region_sync_changed ();
385 if (what_changed.contains (ARDOUR::Properties::muted)) {
388 if (what_changed.contains (ARDOUR::Properties::opaque)) {
391 if (what_changed.contains (ARDOUR::Properties::name)) {
394 if (what_changed.contains (ARDOUR::Properties::sync_position)) {
395 region_sync_changed ();
397 if (what_changed.contains (ARDOUR::Properties::locked)) {
400 if (what_changed.contains (ARDOUR::Properties::locked)) {
401 /* name will show locked status */
407 RegionView::region_locked ()
409 /* name will show locked status */
414 RegionView::region_resized (const PropertyChange& what_changed)
418 if (what_changed.contains (ARDOUR::Properties::position)) {
419 set_position (_region->position(), 0);
420 _region_relative_time_converter.set_origin_b (_region->position());
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());
427 PropertyChange s_and_l;
428 s_and_l.add (ARDOUR::Properties::start);
429 s_and_l.add (ARDOUR::Properties::length);
431 if (what_changed.contains (s_and_l)) {
433 set_duration (_region->length(), 0);
435 unit_length = _region->length() / samples_per_pixel;
437 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
439 (*i)->set_duration (unit_length);
446 RegionView::reset_width_dependent_items (double pixel_width)
448 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
449 _pixel_width = pixel_width;
453 RegionView::region_muted ()
460 RegionView::region_opacity ()
466 RegionView::raise_to_top ()
468 _region->raise_to_top ();
472 RegionView::lower_to_bottom ()
474 _region->lower_to_bottom ();
478 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
483 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
492 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
493 (*i)->group->move (ArdourCanvas::Duple (delta, 0.0));
501 RegionView::set_samples_per_pixel (double fpp)
503 TimeAxisViewItem::set_samples_per_pixel (fpp);
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);
510 region_sync_changed ();
514 RegionView::set_duration (framecnt_t frames, void *src)
516 if (!TimeAxisViewItem::set_duration (frames, src)) {
520 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
521 (*i)->set_duration (_region->length() / samples_per_pixel);
528 RegionView::fill_opacity () const
530 if (!_region->opaque()) {
534 uint32_t normal_tavi_opacity = TimeAxisViewItem::fill_opacity ();
536 return normal_tavi_opacity;
540 RegionView::set_colors ()
542 TimeAxisViewItem::set_colors ();
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));
552 RegionView::set_frame_color ()
554 TimeAxisViewItem::set_frame_color ();
558 RegionView::show_region_editor ()
561 editor = new RegionEditor (trackview.session(), region());
569 RegionView::hide_region_editor()
577 RegionView::make_name () const
581 // XXX nice to have some good icons for this
583 if (_region->locked()) {
585 str += _region->name();
587 } else if (_region->position_locked()) {
589 str += _region->name();
591 } else if (_region->video_locked()) {
593 str += _region->name();
596 str = _region->name();
599 if (_region->muted()) {
600 str = string ("!") + str;
607 RegionView::region_renamed ()
609 std::string str = make_name ();
611 set_item_name (str, this);
613 reset_width_dependent_items (_pixel_width);
617 RegionView::region_sync_changed ()
620 framecnt_t sync_offset;
622 sync_offset = _region->sync_offset (sync_dir);
624 if (sync_offset == 0) {
625 /* no need for a sync mark */
635 /* points set below */
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
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
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->
650 if (sync_offset == 0) {
652 /* no sync mark - its the start of the region */
659 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
661 /* no sync mark - its out of the bounds of the region */
672 //points = sync_mark->property_points().get_value();
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);
682 sync_line->set (ArdourCanvas::Duple (offset, 0), ArdourCanvas::Duple (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
689 RegionView::move (double x_delta, double y_delta)
691 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
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.
700 ArdourCanvas::Item *item = get_canvas_group ();
702 if (item->position().x + x_delta < 0) {
703 x_delta = -item->position().x; /* move it to zero */
706 item->move (ArdourCanvas::Duple (x_delta, y_delta));
708 /* note: ghosts never leave their tracks so y_delta for them is always zero */
710 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
711 (*i)->group->move (ArdourCanvas::Duple (x_delta, 0.0));
716 RegionView::remove_ghost_in (TimeAxisView& tv)
718 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
719 if (&(*i)->trackview == &tv) {
727 RegionView::remove_ghost (GhostRegion* ghost)
733 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
742 RegionView::set_height (double h)
744 TimeAxisViewItem::set_height(h);
749 framecnt_t sync_offset;
750 sync_offset = _region->sync_offset (sync_dir);
751 double offset = sync_offset / samples_per_pixel;
754 ArdourCanvas::Duple (offset, 0),
755 ArdourCanvas::Duple (offset, h - NAME_HIGHLIGHT_SIZE)
759 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
760 (*i)->set_y1 (h + 1);
763 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
764 (*i)->set_y1 (h + 1);
769 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
770 * which uses them. */
772 RegionView::update_coverage_frames (LayerDisplay d)
774 /* remove old coverage frames */
775 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
779 _coverage_frames.clear ();
782 /* don't do coverage frames unless we're in stacked mode */
786 boost::shared_ptr<Playlist> pl (_region->playlist ());
791 framepos_t const position = _region->first_frame ();
792 framepos_t t = position;
793 framepos_t const end = _region->last_frame ();
795 ArdourCanvas::Rectangle* cr = 0;
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 ();
805 /* is this region is on top at time t? */
806 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
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));
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));
819 cr->set_y1 (_height + 1);
820 cr->set_outline (false);
821 cr->set_ignore_events (true);
823 cr->set_fill_color (UINT_RGBA_CHANGE_A (non_playing_color, 0));
825 cr->set_fill_color (non_playing_color);
829 t = pl->find_next_region_boundary (t, 1);
834 /* finish off the last rectangle */
835 cr->set_x1 (trackview.editor().sample_to_pixel (end - position));
838 if (frame_handle_start) {
839 frame_handle_start->raise_to_top ();
842 if (frame_handle_end) {
843 frame_handle_end->raise_to_top ();
846 if (name_highlight) {
847 name_highlight->raise_to_top ();
851 name_text->raise_to_top ();
856 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
858 if (_region->locked()) {
862 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
863 double const speed = rtv.track()->speed ();
865 framepos_t const pre_trim_first_frame = _region->first_frame();
867 _region->trim_front ((framepos_t) (new_bound * speed));
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);
874 bool regions_touching = false;
876 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
877 regions_touching = true;
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);
886 region_changed (ARDOUR::bounds_change);
888 return (pre_trim_first_frame != _region->first_frame()); //return true if we actually changed something
892 RegionView::trim_end (framepos_t new_bound, bool no_overlap)
894 if (_region->locked()) {
898 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
899 double const speed = rtv.track()->speed ();
901 framepos_t const pre_trim_last_frame = _region->last_frame();
903 _region->trim_end ((framepos_t) (new_bound * speed));
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);
910 bool regions_touching = false;
912 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
913 regions_touching = true;
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);
921 region_changed (ARDOUR::bounds_change);
924 region_changed (PropertyChange (ARDOUR::Properties::length));
927 return (pre_trim_last_frame != _region->last_frame()); //return true if we actually changed something
932 RegionView::thaw_after_trim ()
934 if (_region->locked()) {
938 _region->resume_property_changes ();
943 RegionView::move_contents (frameoffset_t distance)
945 if (_region->locked()) {
948 _region->move_start (distance);
949 region_changed (PropertyChange (ARDOUR::Properties::start));
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.
957 RegionView::snap_frame_to_frame (frameoffset_t x) const
959 PublicEditor& editor = trackview.editor();
961 /* x is region relative, convert it to global absolute frames */
962 framepos_t const session_frame = x + _region->position();
964 /* try a snap in either direction */
965 framepos_t frame = session_frame;
966 editor.snap_to (frame, RoundNearest);
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, RoundUpAlways);
974 /* back to region relative */
975 return frame - _region->position();