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 "streamview.h"
37 #include "region_view.h"
38 #include "automation_region_view.h"
39 #include "route_time_axis.h"
40 #include "simplerect.h"
41 #include "simpleline.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), ui_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), ui_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), ui_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->signal_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->signal_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->signal_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->signal_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), ui_bind (&RegionView::region_changed, this, _1), gui_context());
199 group->signal_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::SimpleRect*>::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::SimpleRect* cr = new ArdourCanvas::SimpleRect (*group);
242 _silent_frames.push_back (cr);
244 /* coordinates for the rect are relative to the regionview origin */
246 cr->property_x1() = trackview.editor().frame_to_pixel (i->first - _region->start());
247 cr->property_x2() = trackview.editor().frame_to_pixel (i->second - _region->start());
248 cr->property_y1() = 1;
249 cr->property_y2() = _height - 2;
250 cr->property_outline_pixels() = 0;
251 cr->property_fill_color_rgba () = 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::NoEventText (*group);
275 _silence_text->property_font_desc() = get_font_for_style (N_("SilenceText"));
276 _silence_text->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_SilenceText.get();
277 _silence_text->property_anchor() = ANCHOR_NW;
279 /* both positions are relative to the region start offset in source */
281 _silence_text->property_x() = trackview.editor().frame_to_pixel (silences.front().first - _region->start()) + 10.0;
282 _silence_text->property_y() = 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->property_text() = text.c_str ();
326 RegionView::hide_silent_frames ()
328 for (list<ArdourCanvas::SimpleRect*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
331 _silence_text->hide();
335 RegionView::drop_silent_frames ()
337 for (list<ArdourCanvas::SimpleRect*>::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)) {
393 RegionView::region_locked ()
395 /* name will show locked status */
400 RegionView::region_resized (const PropertyChange& what_changed)
404 if (what_changed.contains (ARDOUR::Properties::position)) {
405 set_position (_region->position(), 0);
406 _region_relative_time_converter.set_origin_b (_region->position());
409 if (what_changed.contains (ARDOUR::Properties::start) || what_changed.contains (ARDOUR::Properties::position)) {
410 _source_relative_time_converter.set_origin_b (_region->position() - _region->start());
413 PropertyChange s_and_l;
414 s_and_l.add (ARDOUR::Properties::start);
415 s_and_l.add (ARDOUR::Properties::length);
417 if (what_changed.contains (s_and_l)) {
419 set_duration (_region->length(), 0);
421 unit_length = _region->length() / samples_per_unit;
423 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
425 (*i)->set_duration (unit_length);
432 RegionView::reset_width_dependent_items (double pixel_width)
434 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
435 _pixel_width = pixel_width;
439 RegionView::region_muted ()
446 RegionView::region_opacity ()
452 RegionView::raise_to_top ()
454 _region->raise_to_top ();
458 RegionView::lower_to_bottom ()
460 _region->lower_to_bottom ();
464 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
469 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
478 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
479 (*i)->group->move (delta, 0.0);
487 RegionView::set_samples_per_unit (gdouble spu)
489 TimeAxisViewItem::set_samples_per_unit (spu);
491 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
492 (*i)->set_samples_per_unit (spu);
493 (*i)->set_duration (_region->length() / samples_per_unit);
496 region_sync_changed ();
500 RegionView::set_duration (framecnt_t frames, void *src)
502 if (!TimeAxisViewItem::set_duration (frames, src)) {
506 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
507 (*i)->set_duration (_region->length() / samples_per_unit);
514 RegionView::set_colors ()
516 TimeAxisViewItem::set_colors ();
519 sync_mark->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
520 sync_line->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
525 RegionView::set_frame_color ()
527 if (_region->opaque()) {
533 TimeAxisViewItem::set_frame_color ();
537 RegionView::fake_set_opaque (bool yn)
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();
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 sync_mark->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
627 sync_line = new ArdourCanvas::Line (*group);
628 sync_line->property_fill_color_rgba() = RGBA_TO_UINT(0,255,0,255); // fill_color; // FIXME make a themeable colour
629 sync_line->property_width_pixels() = 1;
632 /* this has to handle both a genuine change of position, a change of samples_per_unit,
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_unit;
661 points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
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));
664 points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
665 sync_mark->property_points().set_value (points);
669 points.push_back (Gnome::Art::Point (offset, 0));
670 points.push_back (Gnome::Art::Point (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
672 sync_line->property_points().set_value (points);
679 RegionView::move (double x_delta, double y_delta)
681 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
685 get_canvas_group()->move (x_delta, y_delta);
687 /* note: ghosts never leave their tracks so y_delta for them is always zero */
689 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
690 (*i)->group->move (x_delta, 0.0);
695 RegionView::remove_ghost_in (TimeAxisView& tv)
697 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
698 if (&(*i)->trackview == &tv) {
706 RegionView::remove_ghost (GhostRegion* ghost)
712 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
721 RegionView::get_fill_color ()
727 RegionView::set_height (double h)
729 TimeAxisViewItem::set_height(h);
734 framecnt_t sync_offset;
735 sync_offset = _region->sync_offset (sync_dir);
736 double offset = sync_offset / samples_per_unit;
738 points.push_back (Gnome::Art::Point (offset, 0));
739 points.push_back (Gnome::Art::Point (offset, h - NAME_HIGHLIGHT_SIZE));
740 sync_line->property_points().set_value (points);
743 for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
744 (*i)->property_y2() = h + 1;
747 for (list<ArdourCanvas::SimpleRect*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
748 (*i)->property_y2() = h + 1;
753 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
754 * which uses them. */
756 RegionView::update_coverage_frames (LayerDisplay d)
758 /* remove old coverage frames */
759 for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
763 _coverage_frames.clear ();
766 /* don't do coverage frames unless we're in stacked mode */
770 boost::shared_ptr<Playlist> pl (_region->playlist ());
775 framepos_t const position = _region->first_frame ();
776 framepos_t t = position;
777 framepos_t const end = _region->last_frame ();
779 ArdourCanvas::SimpleRect* cr = 0;
782 /* the color that will be used to show parts of regions that will not be heard */
783 uint32_t non_playing_color = RGBA_TO_UINT (32, 32, 32, 192);
789 /* is this region is on top at time t? */
790 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
792 /* finish off any old rect, if required */
793 if (cr && me != new_me) {
794 cr->property_x2() = trackview.editor().frame_to_pixel (t - position);
797 /* start off any new rect, if required */
798 if (cr == 0 || me != new_me) {
799 cr = new ArdourCanvas::SimpleRect (*group);
800 _coverage_frames.push_back (cr);
801 cr->property_x1() = trackview.editor().frame_to_pixel (t - position);
802 cr->property_y1() = 1;
803 cr->property_y2() = _height + 1;
804 cr->property_outline_pixels() = 0;
806 cr->property_fill_color_rgba () = UINT_RGBA_CHANGE_A (non_playing_color, 0);
808 cr->property_fill_color_rgba () = non_playing_color;
812 t = pl->find_next_region_boundary (t, 1);
817 /* finish off the last rectangle */
818 cr->property_x2() = trackview.editor().frame_to_pixel (end - position);
821 if (frame_handle_start) {
822 frame_handle_start->raise_to_top ();
825 if (frame_handle_end) {
826 frame_handle_end->raise_to_top ();
829 if (name_highlight) {
830 name_highlight->raise_to_top ();
834 name_pixbuf->raise_to_top ();
839 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
841 if (_region->locked()) {
845 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
846 double const speed = rtv.track()->speed ();
848 framepos_t const pre_trim_first_frame = _region->first_frame();
850 _region->trim_front ((framepos_t) (new_bound * speed));
853 // Get the next region on the left of this region and shrink/expand it.
854 boost::shared_ptr<Playlist> playlist (_region->playlist());
855 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
857 bool regions_touching = false;
859 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
860 regions_touching = true;
863 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
864 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
865 region_left->trim_end (_region->first_frame() - 1);
869 region_changed (ARDOUR::bounds_change);
873 RegionView::trim_end (framepos_t new_bound, bool no_overlap)
875 if (_region->locked()) {
879 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
880 double const speed = rtv.track()->speed ();
882 framepos_t const pre_trim_last_frame = _region->last_frame();
884 _region->trim_end ((framepos_t) (new_bound * speed));
887 // Get the next region on the right of this region and shrink/expand it.
888 boost::shared_ptr<Playlist> playlist (_region->playlist());
889 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_frame, Start, 1);
891 bool regions_touching = false;
893 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
894 regions_touching = true;
897 // Only trim region on the right if the last frame has gone beyond the right region's first frame.
898 if (region_right != 0 && (region_right->first_frame() < _region->last_frame() || regions_touching)) {
899 region_right->trim_front (_region->last_frame() + 1);
902 region_changed (ARDOUR::bounds_change);
905 region_changed (PropertyChange (ARDOUR::Properties::length));
911 RegionView::thaw_after_trim ()
913 if (_region->locked()) {
917 _region->resume_property_changes ();
922 RegionView::trim_contents (framepos_t frame_delta, bool left_direction, bool swap_direction)
924 if (_region->locked()) {
928 framepos_t new_bound;
930 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
931 double const speed = rtv.track()->speed ();
933 if (left_direction) {
934 if (swap_direction) {
935 new_bound = (framepos_t) (_region->position() / speed) + frame_delta;
937 new_bound = (framepos_t) (_region->position() / speed) - frame_delta;
940 if (swap_direction) {
941 new_bound = (framepos_t) (_region->position() / speed) - frame_delta;
943 new_bound = (framepos_t) (_region->position() / speed) + frame_delta;
947 _region->trim_start ((framepos_t) (new_bound * speed));
948 region_changed (PropertyChange (ARDOUR::Properties::start));
951 /** Snap a frame offset within our region using the current snap settings.
952 * @param x Frame offset from this region's position.
953 * @return Snapped frame offset from this region's position.
956 RegionView::snap_frame_to_frame (frameoffset_t x) const
958 PublicEditor& editor = trackview.editor();
960 /* x is region relative, convert it to global absolute frames */
961 framepos_t const session_frame = x + _region->position();
963 /* try a snap in either direction */
964 framepos_t frame = session_frame;
965 editor.snap_to (frame, 0);
967 /* if we went off the beginning of the region, snap forwards */
968 if (frame < _region->position ()) {
969 frame = session_frame;
970 editor.snap_to (frame, 1);
973 /* back to region relative */
974 return frame - _region->position();