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/audioregion.h"
30 #include "ardour/audiosource.h"
31 #include "ardour/session.h"
33 #include "ardour_ui.h"
34 #include "global_signals.h"
35 #include "canvas-noevent-text.h"
36 #include "canvas-noevent-rect.h"
37 #include "streamview.h"
38 #include "region_view.h"
39 #include "automation_region_view.h"
40 #include "route_time_axis.h"
41 #include "simplerect.h"
42 #include "simpleline.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,
70 Gdk::Color const & basic_color,
72 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), false, automation,
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)
86 , _region_relative_time_converter(r->session().tempo_map(), r->position())
87 , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
89 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
92 RegionView::RegionView (const RegionView& other)
93 : sigc::trackable(other)
94 , TimeAxisViewItem (other)
96 , _region_relative_time_converter(other.region_relative_time_converter())
97 , _source_relative_time_converter(other.source_relative_time_converter())
99 /* derived concrete type will call init () */
101 _region = other._region;
102 current_visible_sync_position = other.current_visible_sync_position;
104 _pixel_width = other._pixel_width;
106 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
109 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
110 : sigc::trackable(other)
111 , TimeAxisViewItem (other)
113 , _region_relative_time_converter(other_region->session().tempo_map(), other_region->position())
114 , _source_relative_time_converter(other_region->session().tempo_map(), other_region->position() - other_region->start())
116 /* this is a pseudo-copy constructor used when dragging regions
117 around on the canvas.
120 /* derived concrete type will call init () */
122 _region = other_region;
123 current_visible_sync_position = other.current_visible_sync_position;
125 _pixel_width = other._pixel_width;
127 GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&RegionView::remove_ghost, this, _1), gui_context());
130 RegionView::RegionView (ArdourCanvas::Group* parent,
132 boost::shared_ptr<ARDOUR::Region> r,
134 Gdk::Color const & basic_color,
136 TimeAxisViewItem::Visibility visibility)
137 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
142 , current_visible_sync_position(0.0)
144 , _enable_display(false)
146 , in_destructor(false)
147 , wait_for_data(false)
149 , _region_relative_time_converter(r->session().tempo_map(), r->position())
150 , _source_relative_time_converter(r->session().tempo_map(), r->position() - r->start())
155 RegionView::init (Gdk::Color const & basic_color, bool wfd)
159 in_destructor = false;
166 compute_colors (basic_color);
168 if (name_highlight) {
169 name_highlight->set_data ("regionview", this);
170 name_highlight->signal_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->signal_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->signal_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();
188 name_pixbuf->set_data ("regionview", this);
189 name_pixbuf->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_pixbuf, this));
193 _enable_display = true;
196 set_height (trackview.current_height());
198 _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
200 group->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_event), group, this));
204 ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
206 /* XXX sync mark drag? */
209 RegionView::~RegionView ()
211 in_destructor = true;
213 for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
217 for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
221 drop_silent_frames ();
227 RegionView::set_silent_frames (const AudioIntervalResult& silences, double /*threshold*/)
229 framecnt_t shortest = max_framecnt;
231 /* remove old silent frames */
232 drop_silent_frames ();
234 if (silences.empty()) {
238 uint32_t const color = ARDOUR_UI::config()->canvasvar_Silence.get();
240 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
242 ArdourCanvas::SimpleRect* cr = new ArdourCanvas::NoEventSimpleRect (*group);
243 _silent_frames.push_back (cr);
245 /* coordinates for the rect are relative to the regionview origin */
247 cr->property_x1() = trackview.editor().frame_to_pixel (i->first - _region->start());
248 cr->property_x2() = trackview.editor().frame_to_pixel (i->second - _region->start());
249 cr->property_y1() = 1;
250 cr->property_y2() = _height - 2;
251 cr->property_outline_pixels() = 0;
252 cr->property_fill_color_rgba () = 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::NoEventText (*group);
276 _silence_text->property_font_desc() = get_font_for_style (N_("SilenceText"));
277 _silence_text->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_SilenceText.get();
278 _silence_text->property_anchor() = ANCHOR_NW;
280 /* both positions are relative to the region start offset in source */
282 _silence_text->property_x() = trackview.editor().frame_to_pixel (silences.front().first - _region->start()) + 10.0;
283 _silence_text->property_y() = 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->property_text() = text.c_str ();
327 RegionView::hide_silent_frames ()
329 for (list<ArdourCanvas::SimpleRect*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
332 _silence_text->hide();
336 RegionView::drop_silent_frames ()
338 for (list<ArdourCanvas::SimpleRect*>::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)) {
394 RegionView::region_locked ()
396 /* name will show locked status */
401 RegionView::region_resized (const PropertyChange& what_changed)
405 if (what_changed.contains (ARDOUR::Properties::position)) {
406 set_position (_region->position(), 0);
407 _region_relative_time_converter.set_origin_b (_region->position());
410 if (what_changed.contains (ARDOUR::Properties::start) || what_changed.contains (ARDOUR::Properties::position)) {
411 _source_relative_time_converter.set_origin_b (_region->position() - _region->start());
414 PropertyChange s_and_l;
415 s_and_l.add (ARDOUR::Properties::start);
416 s_and_l.add (ARDOUR::Properties::length);
418 if (what_changed.contains (s_and_l)) {
420 set_duration (_region->length(), 0);
422 unit_length = _region->length() / samples_per_unit;
424 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
426 (*i)->set_duration (unit_length);
433 RegionView::reset_width_dependent_items (double pixel_width)
435 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
436 _pixel_width = pixel_width;
440 RegionView::region_muted ()
447 RegionView::region_opacity ()
453 RegionView::raise_to_top ()
455 _region->raise_to_top ();
459 RegionView::lower_to_bottom ()
461 _region->lower_to_bottom ();
465 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
470 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
479 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
480 (*i)->group->move (delta, 0.0);
488 RegionView::set_samples_per_unit (gdouble spu)
490 TimeAxisViewItem::set_samples_per_unit (spu);
492 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
493 (*i)->set_samples_per_unit (spu);
494 (*i)->set_duration (_region->length() / samples_per_unit);
497 region_sync_changed ();
501 RegionView::set_duration (framecnt_t frames, void *src)
503 if (!TimeAxisViewItem::set_duration (frames, src)) {
507 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
508 (*i)->set_duration (_region->length() / samples_per_unit);
515 RegionView::set_colors ()
517 TimeAxisViewItem::set_colors ();
520 sync_mark->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
521 sync_line->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
526 RegionView::set_frame_color ()
528 if (_region->opaque()) {
534 TimeAxisViewItem::set_frame_color ();
538 RegionView::fake_set_opaque (bool yn)
550 RegionView::show_region_editor ()
553 editor = new RegionEditor (trackview.session(), region());
561 RegionView::hide_region_editor()
569 RegionView::make_name () const
573 // XXX nice to have some good icons for this
575 if (_region->locked()) {
577 str += _region->name();
579 } else if (_region->position_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 sync_mark->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
628 sync_line = new ArdourCanvas::Line (*group);
629 sync_line->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
630 sync_line->property_width_pixels() = 1;
633 /* this has to handle both a genuine change of position, a change of samples_per_unit,
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_unit;
662 points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
663 points.push_back (Gnome::Art::Point (offset + ((sync_mark_width-1)/2), 1));
664 points.push_back (Gnome::Art::Point (offset, sync_mark_width - 1));
665 points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
666 sync_mark->property_points().set_value (points);
670 points.push_back (Gnome::Art::Point (offset, 0));
671 points.push_back (Gnome::Art::Point (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
673 sync_line->property_points().set_value (points);
680 RegionView::move (double x_delta, double y_delta)
682 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
686 get_canvas_group()->move (x_delta, y_delta);
688 /* note: ghosts never leave their tracks so y_delta for them is always zero */
690 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
691 (*i)->group->move (x_delta, 0.0);
696 RegionView::remove_ghost_in (TimeAxisView& tv)
698 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
699 if (&(*i)->trackview == &tv) {
707 RegionView::remove_ghost (GhostRegion* ghost)
713 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
722 RegionView::get_fill_color ()
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_unit;
739 points.push_back (Gnome::Art::Point (offset, 0));
740 points.push_back (Gnome::Art::Point (offset, h - NAME_HIGHLIGHT_SIZE));
741 sync_line->property_points().set_value (points);
744 for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
745 (*i)->property_y2() = h + 1;
748 for (list<ArdourCanvas::SimpleRect*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
749 (*i)->property_y2() = h + 1;
754 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
755 * which uses them. */
757 RegionView::update_coverage_frames (LayerDisplay d)
759 /* remove old coverage frames */
760 for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
764 _coverage_frames.clear ();
767 /* don't do coverage frames unless we're in stacked mode */
771 boost::shared_ptr<Playlist> pl (_region->playlist ());
776 framepos_t const position = _region->first_frame ();
777 framepos_t t = position;
778 framepos_t const end = _region->last_frame ();
780 ArdourCanvas::SimpleRect* cr = 0;
783 /* the color that will be used to show parts of regions that will not be heard */
784 uint32_t non_playing_color = RGBA_TO_UINT (32, 32, 32, 192);
790 /* is this region is on top at time t? */
791 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
793 /* finish off any old rect, if required */
794 if (cr && me != new_me) {
795 cr->property_x2() = trackview.editor().frame_to_pixel (t - position);
798 /* start off any new rect, if required */
799 if (cr == 0 || me != new_me) {
800 cr = new ArdourCanvas::NoEventSimpleRect (*group);
801 _coverage_frames.push_back (cr);
802 cr->property_x1() = trackview.editor().frame_to_pixel (t - position);
803 cr->property_y1() = 1;
804 cr->property_y2() = _height + 1;
805 cr->property_outline_pixels() = 0;
807 cr->property_fill_color_rgba () = UINT_RGBA_CHANGE_A (non_playing_color, 0);
809 cr->property_fill_color_rgba () = non_playing_color;
813 t = pl->find_next_region_boundary (t, 1);
818 /* finish off the last rectangle */
819 cr->property_x2() = trackview.editor().frame_to_pixel (end - position);
822 if (frame_handle_start) {
823 frame_handle_start->raise_to_top ();
826 if (frame_handle_end) {
827 frame_handle_end->raise_to_top ();
830 if (name_highlight) {
831 name_highlight->raise_to_top ();
835 name_pixbuf->raise_to_top ();
840 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
842 if (_region->locked()) {
846 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
847 double const speed = rtv.track()->speed ();
849 framepos_t const pre_trim_first_frame = _region->first_frame();
851 _region->trim_front ((framepos_t) (new_bound * speed));
854 // Get the next region on the left of this region and shrink/expand it.
855 boost::shared_ptr<Playlist> playlist (_region->playlist());
856 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
858 bool regions_touching = false;
860 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
861 regions_touching = true;
864 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
865 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
866 region_left->trim_end (_region->first_frame() - 1);
870 region_changed (ARDOUR::bounds_change);
874 RegionView::trim_end (framepos_t new_bound, bool no_overlap)
876 if (_region->locked()) {
880 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
881 double const speed = rtv.track()->speed ();
883 framepos_t const pre_trim_last_frame = _region->last_frame();
885 _region->trim_end ((framepos_t) (new_bound * speed));
888 // Get the next region on the right of this region and shrink/expand it.
889 boost::shared_ptr<Playlist> playlist (_region->playlist());
890 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_frame, Start, 1);
892 bool regions_touching = false;
894 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
895 regions_touching = true;
898 // Only trim region on the right if the last frame has gone beyond the right region's first frame.
899 if (region_right != 0 && (region_right->first_frame() < _region->last_frame() || regions_touching)) {
900 region_right->trim_front (_region->last_frame() + 1);
903 region_changed (ARDOUR::bounds_change);
906 region_changed (PropertyChange (ARDOUR::Properties::length));
912 RegionView::thaw_after_trim ()
914 if (_region->locked()) {
918 _region->resume_property_changes ();
923 RegionView::trim_contents (framepos_t frame_delta, bool left_direction, bool swap_direction)
925 if (_region->locked()) {
929 framepos_t new_bound;
931 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
932 double const speed = rtv.track()->speed ();
934 if (left_direction) {
935 if (swap_direction) {
936 new_bound = (framepos_t) (_region->position() / speed) + frame_delta;
938 new_bound = (framepos_t) (_region->position() / speed) - frame_delta;
941 if (swap_direction) {
942 new_bound = (framepos_t) (_region->position() / speed) - frame_delta;
944 new_bound = (framepos_t) (_region->position() / speed) + frame_delta;
948 _region->trim_start ((framepos_t) (new_bound * speed));
949 region_changed (PropertyChange (ARDOUR::Properties::start));
952 /** Snap a frame offset within our region using the current snap settings.
953 * @param x Frame offset from this region's position.
954 * @return Snapped frame offset from this region's position.
957 RegionView::snap_frame_to_frame (frameoffset_t x) const
959 PublicEditor& editor = trackview.editor();
961 /* x is region relative, convert it to global absolute frames */
962 framepos_t const session_frame = x + _region->position();
964 /* try a snap in either direction */
965 framepos_t frame = session_frame;
966 editor.snap_to (frame, 0);
968 /* if we went off the beginning of the region, snap forwards */
969 if (frame < _region->position ()) {
970 frame = session_frame;
971 editor.snap_to (frame, 1);
974 /* back to region relative */
975 return frame - _region->position();