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 "ardour_ui.h"
32 #include "global_signals.h"
33 #include "canvas-noevent-text.h"
34 #include "canvas-noevent-rect.h"
35 #include "streamview.h"
36 #include "region_view.h"
37 #include "automation_region_view.h"
38 #include "route_time_axis.h"
39 #include "simplerect.h"
40 #include "simpleline.h"
42 #include "public_editor.h"
43 #include "region_editor.h"
44 #include "ghostregion.h"
45 #include "route_time_axis.h"
46 #include "ui_config.h"
48 #include "rgb_macros.h"
49 #include "gui_thread.h"
54 using namespace ARDOUR;
56 using namespace Editing;
58 using namespace ArdourCanvas;
60 static const int32_t sync_mark_width = 9;
62 PBD::Signal1<void,RegionView*> RegionView::RegionViewGoingAway;
64 RegionView::RegionView (ArdourCanvas::Group* parent,
66 boost::shared_ptr<ARDOUR::Region> r,
68 Gdk::Color const & basic_color,
70 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), false, automation,
71 TimeAxisViewItem::Visibility (TimeAxisViewItem::ShowNameText|
72 TimeAxisViewItem::ShowNameHighlight| TimeAxisViewItem::ShowFrame))
77 , current_visible_sync_position(0.0)
79 , _enable_display(false)
81 , in_destructor(false)
82 , wait_for_data(false)
84 , _region_relative_time_converter(r->session().tempo_map(), r->position())
85 , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
87 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
90 RegionView::RegionView (const RegionView& other)
91 : sigc::trackable(other)
92 , TimeAxisViewItem (other)
94 , _region_relative_time_converter(other.region_relative_time_converter())
95 , _source_relative_time_converter(other.source_relative_time_converter())
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)
111 , _region_relative_time_converter(other_region->session().tempo_map(), other_region->position())
112 , _source_relative_time_converter(other_region->session().tempo_map(), other_region->position() - other_region->start())
114 /* this is a pseudo-copy constructor used when dragging regions
115 around on the canvas.
118 /* derived concrete type will call init () */
120 _region = other_region;
121 current_visible_sync_position = other.current_visible_sync_position;
123 _pixel_width = other._pixel_width;
125 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
128 RegionView::RegionView (ArdourCanvas::Group* parent,
130 boost::shared_ptr<ARDOUR::Region> r,
132 Gdk::Color const & basic_color,
134 TimeAxisViewItem::Visibility visibility)
135 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
140 , current_visible_sync_position(0.0)
142 , _enable_display(false)
144 , in_destructor(false)
145 , wait_for_data(false)
147 , _region_relative_time_converter(r->session().tempo_map(), r->position())
148 , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
153 RegionView::init (Gdk::Color const & basic_color, bool wfd)
157 in_destructor = false;
164 compute_colors (basic_color);
166 if (name_highlight) {
167 name_highlight->set_data ("regionview", this);
168 name_highlight->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
170 if (frame_handle_start) {
171 frame_handle_start->set_data ("regionview", this);
172 frame_handle_start->set_data ("isleft", (void*) 1);
173 frame_handle_start->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
174 frame_handle_start->raise_to_top();
177 if (frame_handle_end) {
178 frame_handle_end->set_data ("regionview", this);
179 frame_handle_end->set_data ("isleft", (void*) 0);
180 frame_handle_end->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
181 frame_handle_end->raise_to_top();
186 name_pixbuf->set_data ("regionview", this);
187 name_pixbuf->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_pixbuf, this));
191 _enable_display = true;
194 set_height (trackview.current_height());
196 _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
198 group->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_event), group, this));
202 ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
204 /* XXX sync mark drag? */
207 RegionView::~RegionView ()
209 in_destructor = true;
211 for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
215 for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
219 drop_silent_frames ();
225 RegionView::set_silent_frames (const AudioIntervalResult& silences, double /*threshold*/)
227 framecnt_t shortest = max_framecnt;
229 /* remove old silent frames */
230 drop_silent_frames ();
232 if (silences.empty()) {
236 uint32_t const color = ARDOUR_UI::config()->canvasvar_Silence.get();
238 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
240 ArdourCanvas::SimpleRect* cr = new ArdourCanvas::NoEventSimpleRect (*group);
241 _silent_frames.push_back (cr);
243 /* coordinates for the rect are relative to the regionview origin */
245 cr->property_x1() = trackview.editor().frame_to_pixel (i->first - _region->start());
246 cr->property_x2() = trackview.editor().frame_to_pixel (i->second - _region->start());
247 cr->property_y1() = 1;
248 cr->property_y2() = _height - 2;
249 cr->property_outline_pixels() = 0;
250 cr->property_fill_color_rgba () = color;
252 shortest = min (shortest, i->second - i->first);
255 /* Find shortest audible segment */
256 framecnt_t shortest_audible = max_framecnt;
258 framecnt_t s = _region->start();
259 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
260 framecnt_t const dur = i->first - s;
262 shortest_audible = min (shortest_audible, dur);
268 framecnt_t const dur = _region->start() + _region->length() - 1 - s;
270 shortest_audible = min (shortest_audible, dur);
273 _silence_text = new ArdourCanvas::NoEventText (*group);
274 _silence_text->property_font_desc() = get_font_for_style (N_("SilenceText"));
275 _silence_text->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_SilenceText.get();
276 _silence_text->property_anchor() = ANCHOR_NW;
278 /* both positions are relative to the region start offset in source */
280 _silence_text->property_x() = trackview.editor().frame_to_pixel (silences.front().first - _region->start()) + 10.0;
281 _silence_text->property_y() = 20.0;
283 double ms = (float) shortest/_region->session().frame_rate();
285 /* ms are now in seconds */
290 sunits = _("minutes");
292 } else if (ms < 1.0) {
299 string text = string_compose (ngettext ("%1 silent segment", "%1 silent segments", silences.size()), silences.size())
301 + string_compose (_("shortest = %1 %2"), ms, sunits);
303 if (shortest_audible != max_framepos) {
304 /* ms are now in seconds */
305 double ma = (float) shortest_audible / _region->session().frame_rate();
309 aunits = _("minutes");
311 } else if (ma < 1.0) {
318 text += string_compose (_("\n (shortest audible segment = %1 %2)"), ma, aunits);
321 _silence_text->property_text() = text.c_str ();
325 RegionView::hide_silent_frames ()
327 for (list<ArdourCanvas::SimpleRect*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
330 _silence_text->hide();
334 RegionView::drop_silent_frames ()
336 for (list<ArdourCanvas::SimpleRect*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
339 _silent_frames.clear ();
341 delete _silence_text;
346 RegionView::_lock_toggle (ArdourCanvas::Item*, GdkEvent* ev, void* arg)
349 case GDK_BUTTON_RELEASE:
350 static_cast<RegionView*>(arg)->lock_toggle ();
360 RegionView::lock_toggle ()
362 _region->set_locked (!_region->locked());
366 RegionView::region_changed (const PropertyChange& what_changed)
368 ENSURE_GUI_THREAD (*this, &RegionView::region_changed, what_changed);
370 if (what_changed.contains (ARDOUR::bounds_change)) {
371 region_resized (what_changed);
372 region_sync_changed ();
374 if (what_changed.contains (ARDOUR::Properties::muted)) {
377 if (what_changed.contains (ARDOUR::Properties::opaque)) {
380 if (what_changed.contains (ARDOUR::Properties::name)) {
383 if (what_changed.contains (ARDOUR::Properties::sync_position)) {
384 region_sync_changed ();
386 if (what_changed.contains (ARDOUR::Properties::locked)) {
389 #ifdef WITH_VIDEOTIMELINE
390 if (what_changed.contains (ARDOUR::Properties::locked)) {
391 /* 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);
411 _region_relative_time_converter.set_origin_b (_region->position());
414 if (what_changed.contains (ARDOUR::Properties::start) || what_changed.contains (ARDOUR::Properties::position)) {
415 _source_relative_time_converter.set_origin_b (_region->position() - _region->start());
418 PropertyChange s_and_l;
419 s_and_l.add (ARDOUR::Properties::start);
420 s_and_l.add (ARDOUR::Properties::length);
422 if (what_changed.contains (s_and_l)) {
424 set_duration (_region->length(), 0);
426 unit_length = _region->length() / samples_per_unit;
428 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
430 (*i)->set_duration (unit_length);
437 RegionView::reset_width_dependent_items (double pixel_width)
439 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
440 _pixel_width = pixel_width;
444 RegionView::region_muted ()
451 RegionView::region_opacity ()
457 RegionView::raise_to_top ()
459 _region->raise_to_top ();
463 RegionView::lower_to_bottom ()
465 _region->lower_to_bottom ();
469 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
474 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
483 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
484 (*i)->group->move (delta, 0.0);
492 RegionView::set_samples_per_unit (gdouble spu)
494 TimeAxisViewItem::set_samples_per_unit (spu);
496 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
497 (*i)->set_samples_per_unit (spu);
498 (*i)->set_duration (_region->length() / samples_per_unit);
501 region_sync_changed ();
505 RegionView::set_duration (framecnt_t frames, void *src)
507 if (!TimeAxisViewItem::set_duration (frames, src)) {
511 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
512 (*i)->set_duration (_region->length() / samples_per_unit);
519 RegionView::set_colors ()
521 TimeAxisViewItem::set_colors ();
524 sync_mark->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
525 sync_line->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
530 RegionView::set_frame_color ()
532 if (_region->opaque()) {
538 TimeAxisViewItem::set_frame_color ();
542 RegionView::fake_set_opaque (bool yn)
554 RegionView::show_region_editor ()
557 editor = new RegionEditor (trackview.session(), region());
565 RegionView::hide_region_editor()
573 RegionView::make_name () const
577 // XXX nice to have some good icons for this
579 if (_region->locked()) {
581 str += _region->name();
583 } else if (_region->position_locked()) {
585 str += _region->name();
587 #ifdef WITH_VIDEOTIMELINE
588 } else if (_region->video_locked()) {
590 str += _region->name();
594 str = _region->name();
597 if (_region->muted()) {
598 str = string ("!") + str;
605 RegionView::region_renamed ()
607 std::string str = make_name ();
609 set_item_name (str, this);
611 reset_width_dependent_items (_pixel_width);
615 RegionView::region_sync_changed ()
618 framecnt_t sync_offset;
620 sync_offset = _region->sync_offset (sync_dir);
622 if (sync_offset == 0) {
623 /* no need for a sync mark */
633 /* points set below */
635 sync_mark = new ArdourCanvas::Polygon (*group);
636 sync_mark->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
638 sync_line = new ArdourCanvas::Line (*group);
639 sync_line->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
640 sync_line->property_width_pixels() = 1;
643 /* this has to handle both a genuine change of position, a change of samples_per_unit,
644 and a change in the bounds of the _region->
647 if (sync_offset == 0) {
649 /* no sync mark - its the start of the region */
656 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
658 /* no sync mark - its out of the bounds of the region */
669 //points = sync_mark->property_points().get_value();
671 double offset = sync_offset / samples_per_unit;
672 points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
673 points.push_back (Gnome::Art::Point (offset + ((sync_mark_width-1)/2), 1));
674 points.push_back (Gnome::Art::Point (offset, sync_mark_width - 1));
675 points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
676 sync_mark->property_points().set_value (points);
680 points.push_back (Gnome::Art::Point (offset, 0));
681 points.push_back (Gnome::Art::Point (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
683 sync_line->property_points().set_value (points);
690 RegionView::move (double x_delta, double y_delta)
692 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
696 get_canvas_group()->move (x_delta, y_delta);
698 /* note: ghosts never leave their tracks so y_delta for them is always zero */
700 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
701 (*i)->group->move (x_delta, 0.0);
706 RegionView::remove_ghost_in (TimeAxisView& tv)
708 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
709 if (&(*i)->trackview == &tv) {
717 RegionView::remove_ghost (GhostRegion* ghost)
723 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
732 RegionView::get_fill_color ()
738 RegionView::set_height (double h)
740 TimeAxisViewItem::set_height(h);
745 framecnt_t sync_offset;
746 sync_offset = _region->sync_offset (sync_dir);
747 double offset = sync_offset / samples_per_unit;
749 points.push_back (Gnome::Art::Point (offset, 0));
750 points.push_back (Gnome::Art::Point (offset, h - NAME_HIGHLIGHT_SIZE));
751 sync_line->property_points().set_value (points);
754 for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
755 (*i)->property_y2() = h + 1;
758 for (list<ArdourCanvas::SimpleRect*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
759 (*i)->property_y2() = h + 1;
764 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
765 * which uses them. */
767 RegionView::update_coverage_frames (LayerDisplay d)
769 /* remove old coverage frames */
770 for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
774 _coverage_frames.clear ();
777 /* don't do coverage frames unless we're in stacked mode */
781 boost::shared_ptr<Playlist> pl (_region->playlist ());
786 framepos_t const position = _region->first_frame ();
787 framepos_t t = position;
788 framepos_t const end = _region->last_frame ();
790 ArdourCanvas::SimpleRect* cr = 0;
793 /* the color that will be used to show parts of regions that will not be heard */
794 uint32_t const non_playing_color = ARDOUR_UI::config()->canvasvar_CoveredRegion.get ();
800 /* is this region is on top at time t? */
801 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
803 /* finish off any old rect, if required */
804 if (cr && me != new_me) {
805 cr->property_x2() = trackview.editor().frame_to_pixel (t - position);
808 /* start off any new rect, if required */
809 if (cr == 0 || me != new_me) {
810 cr = new ArdourCanvas::NoEventSimpleRect (*group);
811 _coverage_frames.push_back (cr);
812 cr->property_x1() = trackview.editor().frame_to_pixel (t - position);
813 cr->property_y1() = 1;
814 cr->property_y2() = _height + 1;
815 cr->property_outline_pixels() = 0;
817 cr->property_fill_color_rgba () = UINT_RGBA_CHANGE_A (non_playing_color, 0);
819 cr->property_fill_color_rgba () = non_playing_color;
823 t = pl->find_next_region_boundary (t, 1);
828 /* finish off the last rectangle */
829 cr->property_x2() = trackview.editor().frame_to_pixel (end - position);
832 if (frame_handle_start) {
833 frame_handle_start->raise_to_top ();
836 if (frame_handle_end) {
837 frame_handle_end->raise_to_top ();
840 if (name_highlight) {
841 name_highlight->raise_to_top ();
845 name_pixbuf->raise_to_top ();
850 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
852 if (_region->locked()) {
856 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
857 double const speed = rtv.track()->speed ();
859 framepos_t const pre_trim_first_frame = _region->first_frame();
861 _region->trim_front ((framepos_t) (new_bound * speed));
864 // Get the next region on the left of this region and shrink/expand it.
865 boost::shared_ptr<Playlist> playlist (_region->playlist());
866 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
868 bool regions_touching = false;
870 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
871 regions_touching = true;
874 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
875 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
876 region_left->trim_end (_region->first_frame() - 1);
880 region_changed (ARDOUR::bounds_change);
882 return (pre_trim_first_frame != _region->first_frame()); //return true if we actually changed something
886 RegionView::trim_end (framepos_t new_bound, bool no_overlap)
888 if (_region->locked()) {
892 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
893 double const speed = rtv.track()->speed ();
895 framepos_t const pre_trim_last_frame = _region->last_frame();
897 _region->trim_end ((framepos_t) (new_bound * speed));
900 // Get the next region on the right of this region and shrink/expand it.
901 boost::shared_ptr<Playlist> playlist (_region->playlist());
902 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_frame, Start, 1);
904 bool regions_touching = false;
906 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
907 regions_touching = true;
910 // Only trim region on the right if the last frame has gone beyond the right region's first frame.
911 if (region_right != 0 && (region_right->first_frame() < _region->last_frame() || regions_touching)) {
912 region_right->trim_front (_region->last_frame() + 1);
915 region_changed (ARDOUR::bounds_change);
918 region_changed (PropertyChange (ARDOUR::Properties::length));
921 return (pre_trim_last_frame != _region->last_frame()); //return true if we actually changed something
926 RegionView::thaw_after_trim ()
928 if (_region->locked()) {
932 _region->resume_property_changes ();
937 RegionView::trim_contents (framepos_t frame_delta, bool left_direction, bool swap_direction)
939 if (_region->locked()) {
943 framepos_t new_bound;
945 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
946 double const speed = rtv.track()->speed ();
948 if (left_direction) {
949 if (swap_direction) {
950 new_bound = (framepos_t) (_region->position() / speed) + frame_delta;
952 new_bound = (framepos_t) (_region->position() / speed) - frame_delta;
955 if (swap_direction) {
956 new_bound = (framepos_t) (_region->position() / speed) - frame_delta;
958 new_bound = (framepos_t) (_region->position() / speed) + frame_delta;
962 _region->trim_start ((framepos_t) (new_bound * speed));
963 region_changed (PropertyChange (ARDOUR::Properties::start));
966 /** Snap a frame offset within our region using the current snap settings.
967 * @param x Frame offset from this region's position.
968 * @return Snapped frame offset from this region's position.
971 RegionView::snap_frame_to_frame (frameoffset_t x) const
973 PublicEditor& editor = trackview.editor();
975 /* x is region relative, convert it to global absolute frames */
976 framepos_t const session_frame = x + _region->position();
978 /* try a snap in either direction */
979 framepos_t frame = session_frame;
980 editor.snap_to (frame, 0);
982 /* if we went off the beginning of the region, snap forwards */
983 if (frame < _region->position ()) {
984 frame = session_frame;
985 editor.snap_to (frame, 1);
988 /* back to region relative */
989 return frame - _region->position();