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"
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;
58 using namespace Editing;
60 using namespace ArdourCanvas;
62 static const int32_t sync_mark_width = 9;
64 PBD::Signal1<void,RegionView*> RegionView::RegionViewGoingAway;
66 RegionView::RegionView (ArdourCanvas::Group* parent,
68 boost::shared_ptr<ARDOUR::Region> r,
72 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), false, automation,
73 (automation ? TimeAxisViewItem::ShowFrame :
74 TimeAxisViewItem::Visibility (TimeAxisViewItem::ShowNameText|
75 TimeAxisViewItem::ShowNameHighlight| TimeAxisViewItem::ShowFrame)))
80 , current_visible_sync_position(0.0)
82 , _enable_display(false)
84 , in_destructor(false)
85 , wait_for_data(false)
87 , _region_relative_time_converter(r->session().tempo_map(), r->position())
88 , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
90 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
93 RegionView::RegionView (const RegionView& other)
94 : sigc::trackable(other)
95 , TimeAxisViewItem (other)
97 , _region_relative_time_converter(other.region_relative_time_converter())
98 , _source_relative_time_converter(other.source_relative_time_converter())
100 /* derived concrete type will call init () */
102 _region = other._region;
103 current_visible_sync_position = other.current_visible_sync_position;
105 _pixel_width = other._pixel_width;
107 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
110 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
111 : sigc::trackable(other)
112 , TimeAxisViewItem (other)
114 , _region_relative_time_converter(other_region->session().tempo_map(), other_region->position())
115 , _source_relative_time_converter(other_region->session().tempo_map(), other_region->position() - other_region->start())
117 /* this is a pseudo-copy constructor used when dragging regions
118 around on the canvas.
121 /* derived concrete type will call init () */
123 _region = other_region;
124 current_visible_sync_position = other.current_visible_sync_position;
126 _pixel_width = other._pixel_width;
128 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
131 RegionView::RegionView (ArdourCanvas::Group* parent,
133 boost::shared_ptr<ARDOUR::Region> r,
135 uint32_t basic_color,
137 TimeAxisViewItem::Visibility visibility)
138 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
143 , current_visible_sync_position(0.0)
145 , _enable_display(false)
147 , in_destructor(false)
148 , wait_for_data(false)
150 , _region_relative_time_converter(r->session().tempo_map(), r->position())
151 , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
156 RegionView::init (bool wfd)
160 in_destructor = false;
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));
172 if (frame_handle_start) {
173 frame_handle_start->set_data ("regionview", this);
174 frame_handle_start->set_data ("isleft", (void*) 1);
175 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
176 frame_handle_start->raise_to_top();
179 if (frame_handle_end) {
180 frame_handle_end->set_data ("regionview", this);
181 frame_handle_end->set_data ("isleft", (void*) 0);
182 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
183 frame_handle_end->raise_to_top();
187 name_text->set_data ("regionview", this);
188 name_text->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_text, 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());
201 ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
203 /* XXX sync mark drag? */
206 RegionView::~RegionView ()
208 in_destructor = true;
210 for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
214 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
218 drop_silent_frames ();
224 RegionView::canvas_group_event (GdkEvent* event)
226 return trackview.editor().canvas_region_view_event (event, group, this);
230 RegionView::set_silent_frames (const AudioIntervalResult& silences, double /*threshold*/)
232 framecnt_t shortest = max_framecnt;
234 /* remove old silent frames */
235 drop_silent_frames ();
237 if (silences.empty()) {
241 uint32_t const color = ARDOUR_UI::config()->get_canvasvar_Silence();
243 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
245 ArdourCanvas::Rectangle* cr = new ArdourCanvas::Rectangle (group);
246 cr->set_ignore_events (true);
247 _silent_frames.push_back (cr);
249 /* coordinates for the rect are relative to the regionview origin */
251 cr->set_x0 (trackview.editor().sample_to_pixel (i->first - _region->start()));
252 cr->set_x1 (trackview.editor().sample_to_pixel (i->second - _region->start()));
254 cr->set_y1 (_height - 2);
255 cr->set_outline (false);
256 cr->set_fill_color (color);
258 shortest = min (shortest, i->second - i->first);
261 /* Find shortest audible segment */
262 framecnt_t shortest_audible = max_framecnt;
264 framecnt_t s = _region->start();
265 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
266 framecnt_t const dur = i->first - s;
268 shortest_audible = min (shortest_audible, dur);
274 framecnt_t const dur = _region->start() + _region->length() - 1 - s;
276 shortest_audible = min (shortest_audible, dur);
279 _silence_text = new ArdourCanvas::Text (group);
280 _silence_text->set_ignore_events (true);
281 _silence_text->set_font_description (get_font_for_style (N_("SilenceText")));
282 _silence_text->set_color (ARDOUR_UI::config()->get_canvasvar_SilenceText());
284 /* both positions are relative to the region start offset in source */
286 _silence_text->set_x_position (trackview.editor().sample_to_pixel (silences.front().first - _region->start()) + 10.0);
287 _silence_text->set_y_position (20.0);
289 double ms = (float) shortest/_region->session().frame_rate();
291 /* ms are now in seconds */
296 sunits = _("minutes");
298 } else if (ms < 1.0) {
305 string text = string_compose (ngettext ("%1 silent segment", "%1 silent segments", silences.size()), silences.size())
307 + string_compose (_("shortest = %1 %2"), ms, sunits);
309 if (shortest_audible != max_framepos) {
310 /* ms are now in seconds */
311 double ma = (float) shortest_audible / _region->session().frame_rate();
315 aunits = _("minutes");
317 } else if (ma < 1.0) {
324 text += string_compose (_("\n (shortest audible segment = %1 %2)"), ma, aunits);
327 _silence_text->set (text);
331 RegionView::hide_silent_frames ()
333 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
336 _silence_text->hide();
340 RegionView::drop_silent_frames ()
342 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
345 _silent_frames.clear ();
347 delete _silence_text;
352 RegionView::_lock_toggle (ArdourCanvas::Item*, GdkEvent* ev, void* arg)
355 case GDK_BUTTON_RELEASE:
356 static_cast<RegionView*>(arg)->lock_toggle ();
366 RegionView::lock_toggle ()
368 _region->set_locked (!_region->locked());
372 RegionView::region_changed (const PropertyChange& what_changed)
374 ENSURE_GUI_THREAD (*this, &RegionView::region_changed, what_changed);
376 if (what_changed.contains (ARDOUR::bounds_change)) {
377 region_resized (what_changed);
378 region_sync_changed ();
380 if (what_changed.contains (ARDOUR::Properties::muted)) {
383 if (what_changed.contains (ARDOUR::Properties::opaque)) {
386 if (what_changed.contains (ARDOUR::Properties::name)) {
389 if (what_changed.contains (ARDOUR::Properties::sync_position)) {
390 region_sync_changed ();
392 if (what_changed.contains (ARDOUR::Properties::locked)) {
395 if (what_changed.contains (ARDOUR::Properties::locked)) {
396 /* name will show locked status */
402 RegionView::region_locked ()
404 /* name will show locked status */
409 RegionView::region_resized (const PropertyChange& what_changed)
413 if (what_changed.contains (ARDOUR::Properties::position)) {
414 set_position (_region->position(), 0);
415 _region_relative_time_converter.set_origin_b (_region->position());
418 if (what_changed.contains (ARDOUR::Properties::start) || what_changed.contains (ARDOUR::Properties::position)) {
419 _source_relative_time_converter.set_origin_b (_region->position() - _region->start());
422 PropertyChange s_and_l;
423 s_and_l.add (ARDOUR::Properties::start);
424 s_and_l.add (ARDOUR::Properties::length);
426 if (what_changed.contains (s_and_l)) {
428 set_duration (_region->length(), 0);
430 unit_length = _region->length() / samples_per_pixel;
432 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
434 (*i)->set_duration (unit_length);
441 RegionView::reset_width_dependent_items (double pixel_width)
443 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
444 _pixel_width = pixel_width;
448 RegionView::region_muted ()
455 RegionView::region_opacity ()
461 RegionView::raise_to_top ()
463 _region->raise_to_top ();
467 RegionView::lower_to_bottom ()
469 _region->lower_to_bottom ();
473 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
478 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
487 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
488 (*i)->group->move (ArdourCanvas::Duple (delta, 0.0));
496 RegionView::set_samples_per_pixel (double fpp)
498 TimeAxisViewItem::set_samples_per_pixel (fpp);
500 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
501 (*i)->set_samples_per_pixel (fpp);
502 (*i)->set_duration (_region->length() / fpp);
505 region_sync_changed ();
509 RegionView::set_duration (framecnt_t frames, void *src)
511 if (!TimeAxisViewItem::set_duration (frames, src)) {
515 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
516 (*i)->set_duration (_region->length() / samples_per_pixel);
523 RegionView::set_colors ()
525 TimeAxisViewItem::set_colors ();
528 /* XXX: make these colours themable */
529 sync_mark->set_fill_color (ArdourCanvas::rgba_to_color (0, 1.0, 0, 1.0));
530 sync_line->set_outline_color (ArdourCanvas::rgba_to_color (0, 1.0, 0, 1.0));
535 RegionView::set_frame_color ()
541 if (!_region->opaque()) {
545 TimeAxisViewItem::set_frame_color ();
549 RegionView::show_region_editor ()
552 editor = new RegionEditor (trackview.session(), region());
560 RegionView::hide_region_editor()
568 RegionView::make_name () const
572 // XXX nice to have some good icons for this
574 if (_region->locked()) {
576 str += _region->name();
578 } else if (_region->position_locked()) {
580 str += _region->name();
582 } else if (_region->video_locked()) {
584 str += _region->name();
587 str = _region->name();
590 if (_region->muted()) {
591 str = string ("!") + str;
598 RegionView::region_renamed ()
600 std::string str = make_name ();
602 set_item_name (str, this);
604 reset_width_dependent_items (_pixel_width);
608 RegionView::region_sync_changed ()
611 framecnt_t sync_offset;
613 sync_offset = _region->sync_offset (sync_dir);
615 if (sync_offset == 0) {
616 /* no need for a sync mark */
626 /* points set below */
628 sync_mark = new ArdourCanvas::Polygon (group);
629 CANVAS_DEBUG_NAME (sync_mark, string_compose ("sync mark for %1", get_item_name()));
630 sync_mark->set_fill_color (ArdourCanvas::rgba_to_color (0, 1.0, 0, 1.0)); // FIXME make a themeable colour
632 sync_line = new ArdourCanvas::Line (group);
633 CANVAS_DEBUG_NAME (sync_line, string_compose ("sync mark for %1", get_item_name()));
634 sync_line->set_outline_color (ArdourCanvas::rgba_to_color (0, 1.0, 0, 1.0)); // FIXME make a themeable colour
637 /* this has to handle both a genuine change of position, a change of samples_per_pixel
638 and a change in the bounds of the _region->
641 if (sync_offset == 0) {
643 /* no sync mark - its the start of the region */
650 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
652 /* no sync mark - its out of the bounds of the region */
663 //points = sync_mark->property_points().get_value();
665 double offset = sync_offset / samples_per_pixel;
666 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
667 points.push_back (ArdourCanvas::Duple (offset + ((sync_mark_width-1)/2), 1));
668 points.push_back (ArdourCanvas::Duple (offset, sync_mark_width - 1));
669 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
670 sync_mark->set (points);
673 sync_line->set (ArdourCanvas::Duple (offset, 0), ArdourCanvas::Duple (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
680 RegionView::move (double x_delta, double y_delta)
682 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
686 /* items will not prevent Item::move() moving
687 * them to a negative x-axis coordinate, which
688 * is legal, but we don't want that here.
691 ArdourCanvas::Item *item = get_canvas_group ();
693 if (item->position().x + x_delta < 0) {
694 x_delta = -item->position().x; /* move it to zero */
697 item->move (ArdourCanvas::Duple (x_delta, y_delta));
699 /* note: ghosts never leave their tracks so y_delta for them is always zero */
701 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
702 (*i)->group->move (ArdourCanvas::Duple (x_delta, 0.0));
707 RegionView::remove_ghost_in (TimeAxisView& tv)
709 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
710 if (&(*i)->trackview == &tv) {
718 RegionView::remove_ghost (GhostRegion* ghost)
724 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
733 RegionView::set_height (double h)
735 TimeAxisViewItem::set_height(h);
740 framecnt_t sync_offset;
741 sync_offset = _region->sync_offset (sync_dir);
742 double offset = sync_offset / samples_per_pixel;
745 ArdourCanvas::Duple (offset, 0),
746 ArdourCanvas::Duple (offset, h - NAME_HIGHLIGHT_SIZE)
750 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
751 (*i)->set_y1 (h + 1);
754 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
755 (*i)->set_y1 (h + 1);
760 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
761 * which uses them. */
763 RegionView::update_coverage_frames (LayerDisplay d)
765 /* remove old coverage frames */
766 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
770 _coverage_frames.clear ();
773 /* don't do coverage frames unless we're in stacked mode */
777 boost::shared_ptr<Playlist> pl (_region->playlist ());
782 framepos_t const position = _region->first_frame ();
783 framepos_t t = position;
784 framepos_t const end = _region->last_frame ();
786 ArdourCanvas::Rectangle* cr = 0;
789 /* the color that will be used to show parts of regions that will not be heard */
790 uint32_t const non_playing_color = ARDOUR_UI::config()->get_canvasvar_CoveredRegion ();
796 /* is this region is on top at time t? */
797 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
799 /* finish off any old rect, if required */
800 if (cr && me != new_me) {
801 cr->set_x1 (trackview.editor().sample_to_pixel (t - position));
804 /* start off any new rect, if required */
805 if (cr == 0 || me != new_me) {
806 cr = new ArdourCanvas::Rectangle (group);
807 _coverage_frames.push_back (cr);
808 cr->set_x0 (trackview.editor().sample_to_pixel (t - position));
810 cr->set_y1 (_height + 1);
811 cr->set_outline (false);
812 cr->set_ignore_events (true);
814 cr->set_fill_color (UINT_RGBA_CHANGE_A (non_playing_color, 0));
816 cr->set_fill_color (non_playing_color);
820 t = pl->find_next_region_boundary (t, 1);
825 /* finish off the last rectangle */
826 cr->set_x1 (trackview.editor().sample_to_pixel (end - position));
829 if (frame_handle_start) {
830 frame_handle_start->raise_to_top ();
833 if (frame_handle_end) {
834 frame_handle_end->raise_to_top ();
837 if (name_highlight) {
838 name_highlight->raise_to_top ();
842 name_text->raise_to_top ();
847 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
849 if (_region->locked()) {
853 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
854 double const speed = rtv.track()->speed ();
856 framepos_t const pre_trim_first_frame = _region->first_frame();
858 _region->trim_front ((framepos_t) (new_bound * speed));
861 // Get the next region on the left of this region and shrink/expand it.
862 boost::shared_ptr<Playlist> playlist (_region->playlist());
863 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
865 bool regions_touching = false;
867 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
868 regions_touching = true;
871 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
872 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
873 region_left->trim_end (_region->first_frame() - 1);
877 region_changed (ARDOUR::bounds_change);
879 return (pre_trim_first_frame != _region->first_frame()); //return true if we actually changed something
883 RegionView::trim_end (framepos_t new_bound, bool no_overlap)
885 if (_region->locked()) {
889 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
890 double const speed = rtv.track()->speed ();
892 framepos_t const pre_trim_last_frame = _region->last_frame();
894 _region->trim_end ((framepos_t) (new_bound * speed));
897 // Get the next region on the right of this region and shrink/expand it.
898 boost::shared_ptr<Playlist> playlist (_region->playlist());
899 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_frame, Start, 1);
901 bool regions_touching = false;
903 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
904 regions_touching = true;
907 // Only trim region on the right if the last frame has gone beyond the right region's first frame.
908 if (region_right != 0 && (region_right->first_frame() < _region->last_frame() || regions_touching)) {
909 region_right->trim_front (_region->last_frame() + 1);
912 region_changed (ARDOUR::bounds_change);
915 region_changed (PropertyChange (ARDOUR::Properties::length));
918 return (pre_trim_last_frame != _region->last_frame()); //return true if we actually changed something
923 RegionView::thaw_after_trim ()
925 if (_region->locked()) {
929 _region->resume_property_changes ();
934 RegionView::move_contents (frameoffset_t distance)
936 if (_region->locked()) {
939 _region->move_start (distance);
940 region_changed (PropertyChange (ARDOUR::Properties::start));
943 /** Snap a frame offset within our region using the current snap settings.
944 * @param x Frame offset from this region's position.
945 * @return Snapped frame offset from this region's position.
948 RegionView::snap_frame_to_frame (frameoffset_t x) const
950 PublicEditor& editor = trackview.editor();
952 /* x is region relative, convert it to global absolute frames */
953 framepos_t const session_frame = x + _region->position();
955 /* try a snap in either direction */
956 framepos_t frame = session_frame;
957 editor.snap_to (frame, 0);
959 /* if we went off the beginning of the region, snap forwards */
960 if (frame < _region->position ()) {
961 frame = session_frame;
962 editor.snap_to (frame, 1);
965 /* back to region relative */
966 return frame - _region->position();