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"
37 #include "ardour_ui.h"
38 #include "global_signals.h"
39 #include "streamview.h"
40 #include "region_view.h"
41 #include "automation_region_view.h"
42 #include "route_time_axis.h"
43 #include "public_editor.h"
44 #include "region_editor.h"
45 #include "ghostregion.h"
46 #include "route_time_axis.h"
47 #include "ui_config.h"
49 #include "rgb_macros.h"
50 #include "gui_thread.h"
55 using namespace ARDOUR;
57 using namespace Editing;
59 using namespace ArdourCanvas;
61 static const int32_t sync_mark_width = 9;
63 PBD::Signal1<void,RegionView*> RegionView::RegionViewGoingAway;
65 RegionView::RegionView (ArdourCanvas::Group* parent,
67 boost::shared_ptr<ARDOUR::Region> r,
69 Gdk::Color const & basic_color,
71 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), false, automation,
72 TimeAxisViewItem::Visibility (TimeAxisViewItem::ShowNameText|
73 TimeAxisViewItem::ShowNameHighlight| TimeAxisViewItem::ShowFrame))
78 , current_visible_sync_position(0.0)
80 , _enable_display(false)
82 , in_destructor(false)
83 , wait_for_data(false)
85 , _region_relative_time_converter(r->session().tempo_map(), r->position())
86 , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
88 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
91 RegionView::RegionView (const RegionView& other)
92 : sigc::trackable(other)
93 , TimeAxisViewItem (other)
95 , _region_relative_time_converter(other.region_relative_time_converter())
96 , _source_relative_time_converter(other.source_relative_time_converter())
98 /* derived concrete type will call init () */
100 _region = other._region;
101 current_visible_sync_position = other.current_visible_sync_position;
103 _pixel_width = other._pixel_width;
105 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
108 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
109 : sigc::trackable(other)
110 , TimeAxisViewItem (other)
112 , _region_relative_time_converter(other_region->session().tempo_map(), other_region->position())
113 , _source_relative_time_converter(other_region->session().tempo_map(), other_region->position() - other_region->start())
115 /* this is a pseudo-copy constructor used when dragging regions
116 around on the canvas.
119 /* derived concrete type will call init () */
121 _region = other_region;
122 current_visible_sync_position = other.current_visible_sync_position;
124 _pixel_width = other._pixel_width;
126 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
129 RegionView::RegionView (ArdourCanvas::Group* parent,
131 boost::shared_ptr<ARDOUR::Region> r,
133 Gdk::Color const & basic_color,
135 TimeAxisViewItem::Visibility visibility)
136 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
141 , current_visible_sync_position(0.0)
143 , _enable_display(false)
145 , in_destructor(false)
146 , wait_for_data(false)
148 , _region_relative_time_converter(r->session().tempo_map(), r->position())
149 , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
154 RegionView::init (Gdk::Color const & basic_color, bool wfd)
158 in_destructor = false;
165 compute_colors (basic_color);
167 if (name_highlight) {
168 name_highlight->set_data ("regionview", this);
169 name_highlight->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
171 if (frame_handle_start) {
172 frame_handle_start->set_data ("regionview", this);
173 frame_handle_start->set_data ("isleft", (void*) 1);
174 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
175 frame_handle_start->raise_to_top();
178 if (frame_handle_end) {
179 frame_handle_end->set_data ("regionview", this);
180 frame_handle_end->set_data ("isleft", (void*) 0);
181 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
182 frame_handle_end->raise_to_top();
187 name_pixbuf->set_data ("regionview", this);
188 name_pixbuf->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_pixbuf, this));
192 _enable_display = true;
195 set_height (trackview.current_height());
197 _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
199 group->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_event), group, this));
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::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()->canvasvar_Silence.get();
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().frame_to_pixel (i->first - _region->start()));
248 cr->set_x1 (trackview.editor().frame_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()->canvasvar_SilenceText.get());
280 /* both positions are relative to the region start offset in source */
282 _silence_text->set_x_position (trackview.editor().frame_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 #ifdef WITH_VIDEOTIMELINE
392 if (what_changed.contains (ARDOUR::Properties::locked)) {
393 /* name will show locked status */
400 RegionView::region_locked ()
402 /* name will show locked status */
407 RegionView::region_resized (const PropertyChange& what_changed)
411 if (what_changed.contains (ARDOUR::Properties::position)) {
412 set_position (_region->position(), 0);
413 _region_relative_time_converter.set_origin_b (_region->position());
416 if (what_changed.contains (ARDOUR::Properties::start) || what_changed.contains (ARDOUR::Properties::position)) {
417 _source_relative_time_converter.set_origin_b (_region->position() - _region->start());
420 PropertyChange s_and_l;
421 s_and_l.add (ARDOUR::Properties::start);
422 s_and_l.add (ARDOUR::Properties::length);
424 if (what_changed.contains (s_and_l)) {
426 set_duration (_region->length(), 0);
428 unit_length = _region->length() / frames_per_pixel;
430 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
432 (*i)->set_duration (unit_length);
439 RegionView::reset_width_dependent_items (double pixel_width)
441 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
442 _pixel_width = pixel_width;
446 RegionView::region_muted ()
453 RegionView::region_opacity ()
459 RegionView::raise_to_top ()
461 _region->raise_to_top ();
465 RegionView::lower_to_bottom ()
467 _region->lower_to_bottom ();
471 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
476 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
485 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
486 (*i)->group->move (ArdourCanvas::Duple (delta, 0.0));
494 RegionView::set_frames_per_pixel (double fpp)
496 TimeAxisViewItem::set_frames_per_pixel (fpp);
498 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
499 (*i)->set_frames_per_pixel (fpp);
500 (*i)->set_duration (_region->length() / fpp);
503 region_sync_changed ();
507 RegionView::set_duration (framecnt_t frames, void *src)
509 if (!TimeAxisViewItem::set_duration (frames, src)) {
513 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
514 (*i)->set_duration (_region->length() / frames_per_pixel);
521 RegionView::set_colors ()
523 TimeAxisViewItem::set_colors ();
526 /* XXX: make these colours themable */
527 sync_mark->set_fill_color (RGBA_TO_UINT (0, 255, 0, 255));
528 sync_line->set_outline_color (RGBA_TO_UINT (0, 255, 0, 255));
533 RegionView::set_frame_color ()
535 if (_region->opaque()) {
541 TimeAxisViewItem::set_frame_color ();
545 RegionView::fake_set_opaque (bool yn)
557 RegionView::show_region_editor ()
560 editor = new RegionEditor (trackview.session(), region());
568 RegionView::hide_region_editor()
576 RegionView::make_name () const
580 // XXX nice to have some good icons for this
582 if (_region->locked()) {
584 str += _region->name();
586 } else if (_region->position_locked()) {
588 str += _region->name();
590 #ifdef WITH_VIDEOTIMELINE
591 } else if (_region->video_locked()) {
593 str += _region->name();
597 str = _region->name();
600 if (_region->muted()) {
601 str = string ("!") + str;
608 RegionView::region_renamed ()
610 std::string str = make_name ();
612 set_item_name (str, this);
614 reset_width_dependent_items (_pixel_width);
618 RegionView::region_sync_changed ()
621 framecnt_t sync_offset;
623 sync_offset = _region->sync_offset (sync_dir);
625 if (sync_offset == 0) {
626 /* no need for a sync mark */
636 /* points set below */
638 sync_mark = new ArdourCanvas::Polygon (group);
639 sync_mark->set_fill_color (RGBA_TO_UINT(0,255,0,255)); // FIXME make a themeable colour
641 sync_line = new ArdourCanvas::Line (group);
642 sync_line->set_outline_color (RGBA_TO_UINT(0,255,0,255)); // FIXME make a themeable colour
643 sync_line->set_outline_width (1);
646 /* this has to handle both a genuine change of position, a change of frames_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 / frames_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 get_canvas_group()->move (ArdourCanvas::Duple (x_delta, y_delta));
697 /* note: ghosts never leave their tracks so y_delta for them is always zero */
699 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
700 (*i)->group->move (ArdourCanvas::Duple (x_delta, 0.0));
705 RegionView::remove_ghost_in (TimeAxisView& tv)
707 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
708 if (&(*i)->trackview == &tv) {
716 RegionView::remove_ghost (GhostRegion* ghost)
722 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
731 RegionView::get_fill_color ()
737 RegionView::set_height (double h)
739 TimeAxisViewItem::set_height(h);
744 framecnt_t sync_offset;
745 sync_offset = _region->sync_offset (sync_dir);
746 double offset = sync_offset / frames_per_pixel;
749 ArdourCanvas::Duple (offset, 0),
750 ArdourCanvas::Duple (offset, h - NAME_HIGHLIGHT_SIZE)
754 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
755 (*i)->set_y1 (h + 1);
758 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
759 (*i)->set_y1 (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::Rectangle*>::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::Rectangle* 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->set_x1 (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::Rectangle (group);
811 _coverage_frames.push_back (cr);
812 cr->set_x0 (trackview.editor().frame_to_pixel (t - position));
814 cr->set_y1 (_height + 1);
815 cr->set_outline (false);
816 cr->set_ignore_events (true);
818 cr->set_fill_color (UINT_RGBA_CHANGE_A (non_playing_color, 0));
820 cr->set_fill_color (non_playing_color);
824 t = pl->find_next_region_boundary (t, 1);
829 /* finish off the last rectangle */
830 cr->set_x1 (trackview.editor().frame_to_pixel (end - position));
833 if (frame_handle_start) {
834 frame_handle_start->raise_to_top ();
837 if (frame_handle_end) {
838 frame_handle_end->raise_to_top ();
841 if (name_highlight) {
842 name_highlight->raise_to_top ();
846 name_pixbuf->raise_to_top ();
851 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
853 if (_region->locked()) {
857 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
858 double const speed = rtv.track()->speed ();
860 framepos_t const pre_trim_first_frame = _region->first_frame();
862 _region->trim_front ((framepos_t) (new_bound * speed));
865 // Get the next region on the left of this region and shrink/expand it.
866 boost::shared_ptr<Playlist> playlist (_region->playlist());
867 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
869 bool regions_touching = false;
871 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
872 regions_touching = true;
875 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
876 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
877 region_left->trim_end (_region->first_frame() - 1);
881 region_changed (ARDOUR::bounds_change);
883 return (pre_trim_first_frame != _region->first_frame()); //return true if we actually changed something
887 RegionView::trim_end (framepos_t new_bound, bool no_overlap)
889 if (_region->locked()) {
893 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
894 double const speed = rtv.track()->speed ();
896 framepos_t const pre_trim_last_frame = _region->last_frame();
898 _region->trim_end ((framepos_t) (new_bound * speed));
901 // Get the next region on the right of this region and shrink/expand it.
902 boost::shared_ptr<Playlist> playlist (_region->playlist());
903 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_frame, Start, 1);
905 bool regions_touching = false;
907 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
908 regions_touching = true;
911 // Only trim region on the right if the last frame has gone beyond the right region's first frame.
912 if (region_right != 0 && (region_right->first_frame() < _region->last_frame() || regions_touching)) {
913 region_right->trim_front (_region->last_frame() + 1);
916 region_changed (ARDOUR::bounds_change);
919 region_changed (PropertyChange (ARDOUR::Properties::length));
922 return (pre_trim_last_frame != _region->last_frame()); //return true if we actually changed something
927 RegionView::thaw_after_trim ()
929 if (_region->locked()) {
933 _region->resume_property_changes ();
938 RegionView::trim_contents (framepos_t frame_delta, bool left_direction, bool swap_direction)
940 if (_region->locked()) {
944 framepos_t new_bound;
946 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
947 double const speed = rtv.track()->speed ();
949 if (left_direction) {
950 if (swap_direction) {
951 new_bound = (framepos_t) (_region->position() / speed) + frame_delta;
953 new_bound = (framepos_t) (_region->position() / speed) - frame_delta;
956 if (swap_direction) {
957 new_bound = (framepos_t) (_region->position() / speed) - frame_delta;
959 new_bound = (framepos_t) (_region->position() / speed) + frame_delta;
963 _region->trim_start ((framepos_t) (new_bound * speed));
964 region_changed (PropertyChange (ARDOUR::Properties::start));
967 /** Snap a frame offset within our region using the current snap settings.
968 * @param x Frame offset from this region's position.
969 * @return Snapped frame offset from this region's position.
972 RegionView::snap_frame_to_frame (frameoffset_t x) const
974 PublicEditor& editor = trackview.editor();
976 /* x is region relative, convert it to global absolute frames */
977 framepos_t const session_frame = x + _region->position();
979 /* try a snap in either direction */
980 framepos_t frame = session_frame;
981 editor.snap_to (frame, 0);
983 /* if we went off the beginning of the region, snap forwards */
984 if (frame < _region->position ()) {
985 frame = session_frame;
986 editor.snap_to (frame, 1);
989 /* back to region relative */
990 return frame - _region->position();