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 "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;
56 using namespace ARDOUR_UI_UTILS;
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::Container* 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)
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)
96 /* derived concrete type will call init () */
98 _region = other._region;
99 current_visible_sync_position = other.current_visible_sync_position;
101 _pixel_width = other._pixel_width;
103 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
106 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
107 : sigc::trackable(other)
108 , TimeAxisViewItem (other)
111 /* this is a pseudo-copy constructor used when dragging regions
112 around on the canvas.
115 /* derived concrete type will call init () */
117 _region = other_region;
118 current_visible_sync_position = other.current_visible_sync_position;
120 _pixel_width = other._pixel_width;
122 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
125 RegionView::RegionView (ArdourCanvas::Container* parent,
127 boost::shared_ptr<ARDOUR::Region> r,
129 uint32_t basic_color,
131 TimeAxisViewItem::Visibility visibility)
132 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
137 , current_visible_sync_position(0.0)
139 , _enable_display(false)
141 , in_destructor(false)
142 , wait_for_data(false)
148 RegionView::init (bool wfd)
152 in_destructor = false;
159 if (name_highlight) {
160 name_highlight->set_data ("regionview", this);
161 name_highlight->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
164 if (frame_handle_start) {
165 frame_handle_start->set_data ("regionview", this);
166 frame_handle_start->set_data ("isleft", (void*) 1);
167 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
168 frame_handle_start->raise_to_top();
171 if (frame_handle_end) {
172 frame_handle_end->set_data ("regionview", this);
173 frame_handle_end->set_data ("isleft", (void*) 0);
174 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
175 frame_handle_end->raise_to_top();
179 name_text->set_data ("regionview", this);
180 name_text->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_text, this));
184 _enable_display = true;
187 set_height (trackview.current_height());
189 _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
193 UIConfiguration::ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
195 /* XXX sync mark drag? */
198 RegionView::~RegionView ()
200 in_destructor = true;
202 for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
206 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
210 drop_silent_frames ();
216 RegionView::canvas_group_event (GdkEvent* event)
218 if (!in_destructor) {
219 return trackview.editor().canvas_region_view_event (event, group, this);
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()->color_mod ("silence", "silence");
238 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
240 ArdourCanvas::Rectangle* cr = new ArdourCanvas::Rectangle (group);
241 cr->set_ignore_events (true);
242 _silent_frames.push_back (cr);
244 /* coordinates for the rect are relative to the regionview origin */
246 cr->set_x0 (trackview.editor().sample_to_pixel (i->first - _region->start()));
247 cr->set_x1 (trackview.editor().sample_to_pixel (i->second - _region->start()));
249 cr->set_y1 (_height - 2);
250 cr->set_outline (false);
251 cr->set_fill_color (color);
253 shortest = min (shortest, i->second - i->first);
256 /* Find shortest audible segment */
257 framecnt_t shortest_audible = max_framecnt;
259 framecnt_t s = _region->start();
260 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
261 framecnt_t const dur = i->first - s;
263 shortest_audible = min (shortest_audible, dur);
269 framecnt_t const dur = _region->start() + _region->length() - 1 - s;
271 shortest_audible = min (shortest_audible, dur);
274 _silence_text = new ArdourCanvas::Text (group);
275 _silence_text->set_ignore_events (true);
276 _silence_text->set_font_description (get_font_for_style (N_("SilenceText")));
277 _silence_text->set_color (ARDOUR_UI::config()->color ("silence text"));
279 /* both positions are relative to the region start offset in source */
281 _silence_text->set_x_position (trackview.editor().sample_to_pixel (silences.front().first - _region->start()) + 10.0);
282 _silence_text->set_y_position (20.0);
284 double ms = (float) shortest/_region->session().frame_rate();
286 /* ms are now in seconds */
291 sunits = _("minutes");
293 } else if (ms < 1.0) {
300 string text = string_compose (ngettext ("%1 silent segment", "%1 silent segments", silences.size()), silences.size())
302 + string_compose (_("shortest = %1 %2"), ms, sunits);
304 if (shortest_audible != max_framepos) {
305 /* ms are now in seconds */
306 double ma = (float) shortest_audible / _region->session().frame_rate();
310 aunits = _("minutes");
312 } else if (ma < 1.0) {
319 text += string_compose (_("\n (shortest audible segment = %1 %2)"), ma, aunits);
322 _silence_text->set (text);
326 RegionView::hide_silent_frames ()
328 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
331 _silence_text->hide();
335 RegionView::drop_silent_frames ()
337 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
340 _silent_frames.clear ();
342 delete _silence_text;
347 RegionView::_lock_toggle (ArdourCanvas::Item*, GdkEvent* ev, void* arg)
350 case GDK_BUTTON_RELEASE:
351 static_cast<RegionView*>(arg)->lock_toggle ();
361 RegionView::lock_toggle ()
363 _region->set_locked (!_region->locked());
367 RegionView::region_changed (const PropertyChange& what_changed)
369 ENSURE_GUI_THREAD (*this, &RegionView::region_changed, what_changed);
371 if (what_changed.contains (ARDOUR::bounds_change)) {
372 region_resized (what_changed);
373 region_sync_changed ();
375 if (what_changed.contains (ARDOUR::Properties::muted)) {
378 if (what_changed.contains (ARDOUR::Properties::opaque)) {
381 if (what_changed.contains (ARDOUR::Properties::name)) {
384 if (what_changed.contains (ARDOUR::Properties::sync_position)) {
385 region_sync_changed ();
387 if (what_changed.contains (ARDOUR::Properties::locked)) {
390 if (what_changed.contains (ARDOUR::Properties::locked)) {
391 /* name will show locked status */
397 RegionView::region_locked ()
399 /* name will show locked status */
404 RegionView::region_resized (const PropertyChange& what_changed)
408 if (what_changed.contains (ARDOUR::Properties::position)) {
409 set_position (_region->position(), 0);
412 PropertyChange s_and_l;
413 s_and_l.add (ARDOUR::Properties::start);
414 s_and_l.add (ARDOUR::Properties::length);
416 if (what_changed.contains (s_and_l)) {
418 set_duration (_region->length(), 0);
420 unit_length = _region->length() / samples_per_pixel;
422 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
424 (*i)->set_duration (unit_length);
431 RegionView::reset_width_dependent_items (double pixel_width)
433 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
434 _pixel_width = pixel_width;
438 RegionView::region_muted ()
445 RegionView::region_opacity ()
451 RegionView::raise_to_top ()
453 _region->raise_to_top ();
457 RegionView::lower_to_bottom ()
459 _region->lower_to_bottom ();
463 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
468 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
477 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
478 (*i)->group->move (ArdourCanvas::Duple (delta, 0.0));
486 RegionView::set_samples_per_pixel (double fpp)
488 TimeAxisViewItem::set_samples_per_pixel (fpp);
490 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
491 (*i)->set_samples_per_pixel (fpp);
492 (*i)->set_duration (_region->length() / fpp);
495 region_sync_changed ();
499 RegionView::set_duration (framecnt_t frames, void *src)
501 if (!TimeAxisViewItem::set_duration (frames, src)) {
505 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
506 (*i)->set_duration (_region->length() / samples_per_pixel);
513 RegionView::set_colors ()
515 TimeAxisViewItem::set_colors ();
516 set_sync_mark_color ();
520 RegionView::set_sync_mark_color ()
523 ArdourCanvas::Color c = ARDOUR_UI::config()->color ("sync mark");
524 sync_mark->set_fill_color (c);
525 sync_mark->set_outline_color (c);
526 sync_line->set_outline_color (c);
531 RegionView::get_fill_color () const
533 ArdourCanvas::Color f = TimeAxisViewItem::get_fill_color();
536 if (_region->opaque()) {
537 modname = "opaque region base";
539 modname = "transparent region base";
542 return HSV(f).mod (ARDOUR_UI::config()->modifier (modname)).color ();
546 RegionView::show_region_editor ()
549 editor = new RegionEditor (trackview.session(), region());
557 RegionView::hide_region_editor()
565 RegionView::make_name () const
569 // XXX nice to have some good icons for this
571 if (_region->locked()) {
573 str += _region->name();
575 } else if (_region->position_locked()) {
577 str += _region->name();
579 } else if (_region->video_locked()) {
581 str += _region->name();
584 str = _region->name();
587 if (_region->muted()) {
588 str = string ("!") + str;
595 RegionView::region_renamed ()
597 std::string str = make_name ();
599 set_item_name (str, this);
601 reset_width_dependent_items (_pixel_width);
605 RegionView::region_sync_changed ()
608 framecnt_t sync_offset;
610 sync_offset = _region->sync_offset (sync_dir);
612 if (sync_offset == 0) {
613 /* no need for a sync mark */
623 /* points set below */
625 sync_mark = new ArdourCanvas::Polygon (group);
626 CANVAS_DEBUG_NAME (sync_mark, string_compose ("sync mark for %1", get_item_name()));
627 sync_line = new ArdourCanvas::Line (group);
628 CANVAS_DEBUG_NAME (sync_line, string_compose ("sync mark for %1", get_item_name()));
630 set_sync_mark_color ();
633 /* this has to handle both a genuine change of position, a change of samples_per_pixel
634 and a change in the bounds of the _region->
637 if (sync_offset == 0) {
639 /* no sync mark - its the start of the region */
646 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
648 /* no sync mark - its out of the bounds of the region */
659 //points = sync_mark->property_points().get_value();
661 double offset = sync_offset / samples_per_pixel;
662 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
663 points.push_back (ArdourCanvas::Duple (offset + ((sync_mark_width-1)/2), 1));
664 points.push_back (ArdourCanvas::Duple (offset, sync_mark_width - 1));
665 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
666 sync_mark->set (points);
669 sync_line->set (ArdourCanvas::Duple (offset, 0), ArdourCanvas::Duple (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
676 RegionView::move (double x_delta, double y_delta)
678 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
682 /* items will not prevent Item::move() moving
683 * them to a negative x-axis coordinate, which
684 * is legal, but we don't want that here.
687 ArdourCanvas::Item *item = get_canvas_group ();
689 if (item->position().x + x_delta < 0) {
690 x_delta = -item->position().x; /* move it to zero */
693 item->move (ArdourCanvas::Duple (x_delta, y_delta));
695 /* note: ghosts never leave their tracks so y_delta for them is always zero */
697 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
698 (*i)->group->move (ArdourCanvas::Duple (x_delta, 0.0));
703 RegionView::remove_ghost_in (TimeAxisView& tv)
705 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
706 if (&(*i)->trackview == &tv) {
714 RegionView::remove_ghost (GhostRegion* ghost)
720 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
729 RegionView::set_height (double h)
731 TimeAxisViewItem::set_height(h);
736 framecnt_t sync_offset;
737 sync_offset = _region->sync_offset (sync_dir);
738 double offset = sync_offset / samples_per_pixel;
741 ArdourCanvas::Duple (offset, 0),
742 ArdourCanvas::Duple (offset, h - NAME_HIGHLIGHT_SIZE)
746 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
747 (*i)->set_y1 (h + 1);
750 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
751 (*i)->set_y1 (h + 1);
756 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
757 * which uses them. */
759 RegionView::update_coverage_frames (LayerDisplay d)
761 /* remove old coverage frames */
762 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
766 _coverage_frames.clear ();
769 /* don't do coverage frames unless we're in stacked mode */
773 boost::shared_ptr<Playlist> pl (_region->playlist ());
778 framepos_t const position = _region->first_frame ();
779 framepos_t t = position;
780 framepos_t const end = _region->last_frame ();
782 ArdourCanvas::Rectangle* cr = 0;
785 /* the color that will be used to show parts of regions that will not be heard */
786 uint32_t const non_playing_color = ARDOUR_UI::config()->color_mod ("covered region", "covered region base");
792 /* is this region is on top at time t? */
793 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
795 /* finish off any old rect, if required */
796 if (cr && me != new_me) {
797 cr->set_x1 (trackview.editor().sample_to_pixel (t - position));
800 /* start off any new rect, if required */
801 if (cr == 0 || me != new_me) {
802 cr = new ArdourCanvas::Rectangle (group);
803 _coverage_frames.push_back (cr);
804 cr->set_x0 (trackview.editor().sample_to_pixel (t - position));
806 cr->set_y1 (_height + 1);
807 cr->set_outline (false);
808 cr->set_ignore_events (true);
810 cr->set_fill_color (UINT_RGBA_CHANGE_A (non_playing_color, 0));
812 cr->set_fill_color (non_playing_color);
816 t = pl->find_next_region_boundary (t, 1);
821 /* finish off the last rectangle */
822 cr->set_x1 (trackview.editor().sample_to_pixel (end - position));
825 if (frame_handle_start) {
826 frame_handle_start->raise_to_top ();
829 if (frame_handle_end) {
830 frame_handle_end->raise_to_top ();
833 if (name_highlight) {
834 name_highlight->raise_to_top ();
838 name_text->raise_to_top ();
843 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
845 if (_region->locked()) {
849 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
850 double const speed = rtv.track()->speed ();
852 framepos_t const pre_trim_first_frame = _region->first_frame();
854 _region->trim_front ((framepos_t) (new_bound * speed));
857 // Get the next region on the left of this region and shrink/expand it.
858 boost::shared_ptr<Playlist> playlist (_region->playlist());
859 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
861 bool regions_touching = false;
863 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
864 regions_touching = true;
867 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
868 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
869 region_left->trim_end (_region->first_frame() - 1);
873 region_changed (ARDOUR::bounds_change);
875 return (pre_trim_first_frame != _region->first_frame()); //return true if we actually changed something
879 RegionView::trim_end (framepos_t new_bound, bool no_overlap)
881 if (_region->locked()) {
885 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
886 double const speed = rtv.track()->speed ();
888 framepos_t const pre_trim_last_frame = _region->last_frame();
890 _region->trim_end ((framepos_t) (new_bound * speed));
893 // Get the next region on the right of this region and shrink/expand it.
894 boost::shared_ptr<Playlist> playlist (_region->playlist());
895 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_frame, Start, 1);
897 bool regions_touching = false;
899 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
900 regions_touching = true;
903 // Only trim region on the right if the last frame has gone beyond the right region's first frame.
904 if (region_right != 0 && (region_right->first_frame() < _region->last_frame() || regions_touching)) {
905 region_right->trim_front (_region->last_frame() + 1);
908 region_changed (ARDOUR::bounds_change);
911 region_changed (PropertyChange (ARDOUR::Properties::length));
914 return (pre_trim_last_frame != _region->last_frame()); //return true if we actually changed something
919 RegionView::thaw_after_trim ()
921 if (_region->locked()) {
925 _region->resume_property_changes ();
930 RegionView::move_contents (frameoffset_t distance)
932 if (_region->locked()) {
935 _region->move_start (distance);
936 region_changed (PropertyChange (ARDOUR::Properties::start));
939 /** Snap a frame offset within our region using the current snap settings.
940 * @param x Frame offset from this region's position.
941 * @param ensure_snap whether to ignore snap_mode (in the case of SnapOff) and magnetic snap.
942 * Used when inverting snap mode logic with key modifiers, or snap distance calculation.
943 * @return Snapped frame offset from this region's position.
946 RegionView::snap_frame_to_frame (frameoffset_t x, bool ensure_snap) const
948 PublicEditor& editor = trackview.editor();
950 /* x is region relative, convert it to global absolute frames */
951 framepos_t const session_frame = x + _region->position();
953 /* try a snap in either direction */
954 framepos_t frame = session_frame;
955 editor.snap_to (frame, RoundNearest, false, ensure_snap);
957 /* if we went off the beginning of the region, snap forwards */
958 if (frame < _region->position ()) {
959 frame = session_frame;
960 editor.snap_to (frame, RoundUpAlways, false, ensure_snap);
963 /* back to region relative */
964 return frame - _region->position();