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 "streamview.h"
39 #include "region_view.h"
40 #include "automation_region_view.h"
41 #include "route_time_axis.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;
55 using namespace ARDOUR_UI_UTILS;
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::Container* parent,
67 boost::shared_ptr<ARDOUR::Region> r,
71 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), false, automation,
72 (automation ? TimeAxisViewItem::ShowFrame :
73 TimeAxisViewItem::Visibility (TimeAxisViewItem::ShowNameText|
74 TimeAxisViewItem::ShowNameHighlight| TimeAxisViewItem::ShowFrame)))
79 , current_visible_sync_position(0.0)
81 , _enable_display(false)
83 , in_destructor(false)
84 , wait_for_data(false)
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)
95 /* derived concrete type will call init () */
97 _region = other._region;
98 current_visible_sync_position = other.current_visible_sync_position;
100 _pixel_width = other._pixel_width;
102 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
105 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
106 : sigc::trackable(other)
107 , TimeAxisViewItem (other)
110 /* this is a pseudo-copy constructor used when dragging regions
111 around on the canvas.
114 /* derived concrete type will call init () */
116 _region = other_region;
117 current_visible_sync_position = other.current_visible_sync_position;
119 _pixel_width = other._pixel_width;
121 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
124 RegionView::RegionView (ArdourCanvas::Container* parent,
126 boost::shared_ptr<ARDOUR::Region> r,
128 uint32_t basic_color,
130 TimeAxisViewItem::Visibility visibility)
131 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
136 , current_visible_sync_position(0.0)
138 , _enable_display(false)
140 , in_destructor(false)
141 , wait_for_data(false)
147 RegionView::init (bool wfd)
151 in_destructor = false;
158 if (name_highlight) {
159 name_highlight->set_data ("regionview", this);
160 name_highlight->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
163 if (frame_handle_start) {
164 frame_handle_start->set_data ("regionview", this);
165 frame_handle_start->set_data ("isleft", (void*) 1);
166 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
167 frame_handle_start->raise_to_top();
170 if (frame_handle_end) {
171 frame_handle_end->set_data ("regionview", this);
172 frame_handle_end->set_data ("isleft", (void*) 0);
173 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
174 frame_handle_end->raise_to_top();
178 name_text->set_data ("regionview", this);
179 name_text->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_text, this));
183 _enable_display = true;
186 set_height (trackview.current_height());
188 _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
192 UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
194 /* XXX sync mark drag? */
197 RegionView::~RegionView ()
199 in_destructor = true;
201 for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
205 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
209 drop_silent_frames ();
215 RegionView::canvas_group_event (GdkEvent* event)
217 if (!in_destructor) {
218 return trackview.editor().canvas_region_view_event (event, group, this);
224 RegionView::set_silent_frames (const AudioIntervalResult& silences, double /*threshold*/)
226 framecnt_t shortest = max_framecnt;
228 /* remove old silent frames */
229 drop_silent_frames ();
231 if (silences.empty()) {
235 uint32_t const color = UIConfiguration::instance().color_mod ("silence", "silence");
237 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
239 ArdourCanvas::Rectangle* cr = new ArdourCanvas::Rectangle (group);
240 cr->set_ignore_events (true);
241 _silent_frames.push_back (cr);
243 /* coordinates for the rect are relative to the regionview origin */
245 cr->set_x0 (trackview.editor().sample_to_pixel (i->first - _region->start()));
246 cr->set_x1 (trackview.editor().sample_to_pixel (i->second - _region->start()));
248 cr->set_y1 (_height - 2);
249 cr->set_outline (false);
250 cr->set_fill_color (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::Text (group);
274 _silence_text->set_ignore_events (true);
275 _silence_text->set_font_description (get_font_for_style (N_("SilenceText")));
276 _silence_text->set_color (UIConfiguration::instance().color ("silence text"));
278 /* both positions are relative to the region start offset in source */
280 _silence_text->set_x_position (trackview.editor().sample_to_pixel (silences.front().first - _region->start()) + 10.0);
281 _silence_text->set_y_position (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->set (text);
325 RegionView::hide_silent_frames ()
327 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
330 _silence_text->hide();
334 RegionView::drop_silent_frames ()
336 for (list<ArdourCanvas::Rectangle*>::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 if (what_changed.contains (ARDOUR::Properties::locked)) {
390 /* name will show locked status */
396 RegionView::region_locked ()
398 /* name will show locked status */
403 RegionView::region_resized (const PropertyChange& what_changed)
407 if (what_changed.contains (ARDOUR::Properties::position)) {
408 set_position (_region->position(), 0);
411 PropertyChange s_and_l;
412 s_and_l.add (ARDOUR::Properties::start);
413 s_and_l.add (ARDOUR::Properties::length);
415 if (what_changed.contains (s_and_l)) {
417 set_duration (_region->length(), 0);
419 unit_length = _region->length() / samples_per_pixel;
421 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
423 (*i)->set_duration (unit_length);
430 RegionView::reset_width_dependent_items (double pixel_width)
432 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
433 _pixel_width = pixel_width;
437 RegionView::region_muted ()
444 RegionView::region_opacity ()
450 RegionView::raise_to_top ()
452 _region->raise_to_top ();
456 RegionView::lower_to_bottom ()
458 _region->lower_to_bottom ();
462 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
467 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
476 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
477 (*i)->group->move (ArdourCanvas::Duple (delta, 0.0));
485 RegionView::set_samples_per_pixel (double fpp)
487 TimeAxisViewItem::set_samples_per_pixel (fpp);
489 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
490 (*i)->set_samples_per_pixel (fpp);
491 (*i)->set_duration (_region->length() / fpp);
494 region_sync_changed ();
498 RegionView::set_duration (framecnt_t frames, void *src)
500 if (!TimeAxisViewItem::set_duration (frames, src)) {
504 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
505 (*i)->set_duration (_region->length() / samples_per_pixel);
512 RegionView::set_colors ()
514 TimeAxisViewItem::set_colors ();
515 set_sync_mark_color ();
519 RegionView::set_sync_mark_color ()
522 ArdourCanvas::Color c = UIConfiguration::instance().color ("sync mark");
523 sync_mark->set_fill_color (c);
524 sync_mark->set_outline_color (c);
525 sync_line->set_outline_color (c);
530 RegionView::get_fill_color () const
532 ArdourCanvas::Color f = TimeAxisViewItem::get_fill_color();
535 if (_region->opaque()) {
536 modname = "opaque region base";
538 modname = "transparent region base";
541 return HSV(f).mod (UIConfiguration::instance().modifier (modname)).color ();
545 RegionView::show_region_editor ()
548 editor = new RegionEditor (trackview.session(), region());
556 RegionView::hide_region_editor()
564 RegionView::make_name () const
568 // XXX nice to have some good icons for this
570 if (_region->locked()) {
572 str += _region->name();
574 } else if (_region->position_locked()) {
576 str += _region->name();
578 } else if (_region->video_locked()) {
580 str += _region->name();
583 str = _region->name();
586 if (_region->muted()) {
587 str = string ("!") + str;
594 RegionView::region_renamed ()
596 std::string str = make_name ();
598 set_item_name (str, this);
600 reset_width_dependent_items (_pixel_width);
604 RegionView::region_sync_changed ()
607 framecnt_t sync_offset;
609 sync_offset = _region->sync_offset (sync_dir);
611 if (sync_offset == 0) {
612 /* no need for a sync mark */
622 /* points set below */
624 sync_mark = new ArdourCanvas::Polygon (group);
625 CANVAS_DEBUG_NAME (sync_mark, string_compose ("sync mark for %1", get_item_name()));
626 sync_line = new ArdourCanvas::Line (group);
627 CANVAS_DEBUG_NAME (sync_line, string_compose ("sync mark for %1", get_item_name()));
629 set_sync_mark_color ();
632 /* this has to handle both a genuine change of position, a change of samples_per_pixel
633 and a change in the bounds of the _region->
636 if (sync_offset == 0) {
638 /* no sync mark - its the start of the region */
645 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
647 /* no sync mark - its out of the bounds of the region */
658 //points = sync_mark->property_points().get_value();
660 double offset = sync_offset / samples_per_pixel;
661 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
662 points.push_back (ArdourCanvas::Duple (offset + ((sync_mark_width-1)/2), 1));
663 points.push_back (ArdourCanvas::Duple (offset, sync_mark_width - 1));
664 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
665 sync_mark->set (points);
668 sync_line->set (ArdourCanvas::Duple (offset, 0), ArdourCanvas::Duple (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
675 RegionView::move (double x_delta, double y_delta)
677 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
681 /* items will not prevent Item::move() moving
682 * them to a negative x-axis coordinate, which
683 * is legal, but we don't want that here.
686 ArdourCanvas::Item *item = get_canvas_group ();
688 if (item->position().x + x_delta < 0) {
689 x_delta = -item->position().x; /* move it to zero */
692 item->move (ArdourCanvas::Duple (x_delta, y_delta));
694 /* note: ghosts never leave their tracks so y_delta for them is always zero */
696 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
697 (*i)->group->move (ArdourCanvas::Duple (x_delta, 0.0));
702 RegionView::remove_ghost_in (TimeAxisView& tv)
704 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
705 if (&(*i)->trackview == &tv) {
713 RegionView::remove_ghost (GhostRegion* ghost)
719 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
728 RegionView::set_height (double h)
730 TimeAxisViewItem::set_height(h);
735 framecnt_t sync_offset;
736 sync_offset = _region->sync_offset (sync_dir);
737 double offset = sync_offset / samples_per_pixel;
740 ArdourCanvas::Duple (offset, 0),
741 ArdourCanvas::Duple (offset, h - NAME_HIGHLIGHT_SIZE)
745 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
746 (*i)->set_y1 (h + 1);
749 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
750 (*i)->set_y1 (h + 1);
755 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
756 * which uses them. */
758 RegionView::update_coverage_frames (LayerDisplay d)
760 /* remove old coverage frames */
761 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
765 _coverage_frames.clear ();
768 /* don't do coverage frames unless we're in stacked mode */
772 boost::shared_ptr<Playlist> pl (_region->playlist ());
777 framepos_t const position = _region->first_frame ();
778 framepos_t t = position;
779 framepos_t const end = _region->last_frame ();
781 ArdourCanvas::Rectangle* cr = 0;
784 /* the color that will be used to show parts of regions that will not be heard */
785 uint32_t const non_playing_color = UIConfiguration::instance().color_mod ("covered region", "covered region base");
791 /* is this region is on top at time t? */
792 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
794 /* finish off any old rect, if required */
795 if (cr && me != new_me) {
796 cr->set_x1 (trackview.editor().sample_to_pixel (t - position));
799 /* start off any new rect, if required */
800 if (cr == 0 || me != new_me) {
801 cr = new ArdourCanvas::Rectangle (group);
802 _coverage_frames.push_back (cr);
803 cr->set_x0 (trackview.editor().sample_to_pixel (t - position));
805 cr->set_y1 (_height + 1);
806 cr->set_outline (false);
807 cr->set_ignore_events (true);
809 cr->set_fill_color (UINT_RGBA_CHANGE_A (non_playing_color, 0));
811 cr->set_fill_color (non_playing_color);
815 t = pl->find_next_region_boundary (t, 1);
820 /* finish off the last rectangle */
821 cr->set_x1 (trackview.editor().sample_to_pixel (end - position));
824 if (frame_handle_start) {
825 frame_handle_start->raise_to_top ();
828 if (frame_handle_end) {
829 frame_handle_end->raise_to_top ();
832 if (name_highlight) {
833 name_highlight->raise_to_top ();
837 name_text->raise_to_top ();
842 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
844 if (_region->locked()) {
848 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
849 double const speed = rtv.track()->speed ();
851 framepos_t const pre_trim_first_frame = _region->first_frame();
853 _region->trim_front ((framepos_t) (new_bound * speed));
856 // Get the next region on the left of this region and shrink/expand it.
857 boost::shared_ptr<Playlist> playlist (_region->playlist());
858 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
860 bool regions_touching = false;
862 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
863 regions_touching = true;
866 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
867 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
868 region_left->trim_end (_region->first_frame() - 1);
872 region_changed (ARDOUR::bounds_change);
874 return (pre_trim_first_frame != _region->first_frame()); //return true if we actually changed something
878 RegionView::trim_end (framepos_t new_bound, bool no_overlap)
880 if (_region->locked()) {
884 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
885 double const speed = rtv.track()->speed ();
887 framepos_t const pre_trim_last_frame = _region->last_frame();
889 _region->trim_end ((framepos_t) (new_bound * speed));
892 // Get the next region on the right of this region and shrink/expand it.
893 boost::shared_ptr<Playlist> playlist (_region->playlist());
894 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_frame, Start, 1);
896 bool regions_touching = false;
898 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
899 regions_touching = true;
902 // Only trim region on the right if the last frame has gone beyond the right region's first frame.
903 if (region_right != 0 && (region_right->first_frame() < _region->last_frame() || regions_touching)) {
904 region_right->trim_front (_region->last_frame() + 1);
907 region_changed (ARDOUR::bounds_change);
910 region_changed (PropertyChange (ARDOUR::Properties::length));
913 return (pre_trim_last_frame != _region->last_frame()); //return true if we actually changed something
918 RegionView::thaw_after_trim ()
920 if (_region->locked()) {
924 _region->resume_property_changes ();
929 RegionView::move_contents (frameoffset_t distance)
931 if (_region->locked()) {
934 _region->move_start (distance);
935 region_changed (PropertyChange (ARDOUR::Properties::start));
938 /** Snap a frame offset within our region using the current snap settings.
939 * @param x Frame offset from this region's position.
940 * @param ensure_snap whether to ignore snap_mode (in the case of SnapOff) and magnetic snap.
941 * Used when inverting snap mode logic with key modifiers, or snap distance calculation.
942 * @return Snapped frame offset from this region's position.
945 RegionView::snap_frame_to_frame (frameoffset_t x, bool ensure_snap) const
947 PublicEditor& editor = trackview.editor();
949 /* x is region relative, convert it to global absolute frames */
950 framepos_t const session_frame = x + _region->position();
952 /* try a snap in either direction */
953 framepos_t frame = session_frame;
954 editor.snap_to (frame, RoundNearest, false, ensure_snap);
956 /* if we went off the beginning of the region, snap forwards */
957 if (frame < _region->position ()) {
958 frame = session_frame;
959 editor.snap_to (frame, RoundUpAlways, false, ensure_snap);
962 /* back to region relative */
963 return frame - _region->position();