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/profile.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"
37 #include "canvas/colors.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)
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;
103 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
104 : sigc::trackable(other)
105 , TimeAxisViewItem (other)
108 /* this is a pseudo-copy constructor used when dragging regions
109 around on the canvas.
112 /* derived concrete type will call init () */
114 _region = other_region;
115 current_visible_sync_position = other.current_visible_sync_position;
117 _pixel_width = other._pixel_width;
120 RegionView::RegionView (ArdourCanvas::Container* parent,
122 boost::shared_ptr<ARDOUR::Region> r,
124 uint32_t basic_color,
126 TimeAxisViewItem::Visibility visibility)
127 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
132 , current_visible_sync_position(0.0)
134 , _enable_display(false)
136 , in_destructor(false)
137 , wait_for_data(false)
143 RegionView::init (bool wfd)
147 in_destructor = false;
154 if (name_highlight) {
155 name_highlight->set_data ("regionview", this);
156 name_highlight->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
159 if (frame_handle_start) {
160 frame_handle_start->set_data ("regionview", this);
161 frame_handle_start->set_data ("isleft", (void*) 1);
162 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
163 frame_handle_start->raise_to_top();
166 if (frame_handle_end) {
167 frame_handle_end->set_data ("regionview", this);
168 frame_handle_end->set_data ("isleft", (void*) 0);
169 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
170 frame_handle_end->raise_to_top();
174 name_text->set_data ("regionview", this);
175 name_text->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_text, this));
179 _enable_display = true;
182 /* derived class calls set_height () including RegionView::set_height() in ::init() */
183 //set_height (trackview.current_height());
185 _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
187 /* derived class calls set_colors () including RegionView::set_colors() in ::init() */
189 UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
191 /* XXX sync mark drag? */
194 RegionView::~RegionView ()
196 in_destructor = true;
198 for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
202 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
206 drop_silent_frames ();
212 RegionView::canvas_group_event (GdkEvent* event)
214 if (!in_destructor) {
215 return trackview.editor().canvas_region_view_event (event, group, this);
221 RegionView::set_silent_frames (const AudioIntervalResult& silences, double /*threshold*/)
223 framecnt_t shortest = max_framecnt;
225 /* remove old silent frames */
226 drop_silent_frames ();
228 if (silences.empty()) {
232 uint32_t const color = UIConfiguration::instance().color_mod ("silence", "silence");
234 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
236 ArdourCanvas::Rectangle* cr = new ArdourCanvas::Rectangle (group);
237 cr->set_ignore_events (true);
238 _silent_frames.push_back (cr);
240 /* coordinates for the rect are relative to the regionview origin */
242 cr->set_x0 (trackview.editor().sample_to_pixel (i->first - _region->start()));
243 cr->set_x1 (trackview.editor().sample_to_pixel (i->second - _region->start()));
245 cr->set_y1 (_height - 2);
246 cr->set_outline (false);
247 cr->set_fill_color (color);
249 shortest = min (shortest, i->second - i->first);
252 /* Find shortest audible segment */
253 framecnt_t shortest_audible = max_framecnt;
255 framecnt_t s = _region->start();
256 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
257 framecnt_t const dur = i->first - s;
259 shortest_audible = min (shortest_audible, dur);
265 framecnt_t const dur = _region->start() + _region->length() - 1 - s;
267 shortest_audible = min (shortest_audible, dur);
270 _silence_text = new ArdourCanvas::Text (group);
271 _silence_text->set_ignore_events (true);
272 _silence_text->set_font_description (get_font_for_style (N_("SilenceText")));
273 _silence_text->set_color (UIConfiguration::instance().color ("silence text"));
275 /* both positions are relative to the region start offset in source */
277 _silence_text->set_x_position (trackview.editor().sample_to_pixel (silences.front().first - _region->start()) + 10.0);
278 _silence_text->set_y_position (20.0);
280 double ms = (float) shortest/_region->session().frame_rate();
282 /* ms are now in seconds */
287 sunits = _("minutes");
289 } else if (ms < 1.0) {
296 string text = string_compose (ngettext ("%1 silent segment", "%1 silent segments", silences.size()), silences.size())
298 + string_compose (_("shortest = %1 %2"), ms, sunits);
300 if (shortest_audible != max_framepos) {
301 /* ms are now in seconds */
302 double ma = (float) shortest_audible / _region->session().frame_rate();
306 aunits = _("minutes");
308 } else if (ma < 1.0) {
315 text += string_compose (_("\n (shortest audible segment = %1 %2)"), ma, aunits);
318 _silence_text->set (text);
322 RegionView::hide_silent_frames ()
324 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
327 _silence_text->hide();
331 RegionView::drop_silent_frames ()
333 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
336 _silent_frames.clear ();
338 delete _silence_text;
343 RegionView::_lock_toggle (ArdourCanvas::Item*, GdkEvent* ev, void* arg)
346 case GDK_BUTTON_RELEASE:
347 static_cast<RegionView*>(arg)->lock_toggle ();
357 RegionView::lock_toggle ()
359 _region->set_locked (!_region->locked());
363 RegionView::region_changed (const PropertyChange& what_changed)
365 ENSURE_GUI_THREAD (*this, &RegionView::region_changed, what_changed);
367 if (what_changed.contains (ARDOUR::bounds_change)) {
368 region_resized (what_changed);
369 region_sync_changed ();
371 if (what_changed.contains (ARDOUR::Properties::muted)) {
374 if (what_changed.contains (ARDOUR::Properties::opaque)) {
377 if (what_changed.contains (ARDOUR::Properties::name)) {
380 if (what_changed.contains (ARDOUR::Properties::sync_position)) {
381 region_sync_changed ();
383 if (what_changed.contains (ARDOUR::Properties::locked)) {
389 RegionView::region_locked ()
391 /* name will show locked status */
396 RegionView::region_resized (const PropertyChange& what_changed)
400 if (what_changed.contains (ARDOUR::Properties::position)) {
401 set_position (_region->position(), 0);
404 PropertyChange s_and_l;
405 s_and_l.add (ARDOUR::Properties::start);
406 s_and_l.add (ARDOUR::Properties::length);
408 if (what_changed.contains (s_and_l)) {
410 set_duration (_region->length(), 0);
412 unit_length = _region->length() / samples_per_pixel;
414 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
416 (*i)->set_duration (unit_length);
423 RegionView::reset_width_dependent_items (double pixel_width)
425 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
426 _pixel_width = pixel_width;
430 RegionView::region_muted ()
437 RegionView::region_opacity ()
443 RegionView::raise_to_top ()
445 _region->raise_to_top ();
449 RegionView::lower_to_bottom ()
451 _region->lower_to_bottom ();
455 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
460 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
469 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
470 (*i)->group->move (ArdourCanvas::Duple (delta, 0.0));
478 RegionView::set_samples_per_pixel (double fpp)
480 TimeAxisViewItem::set_samples_per_pixel (fpp);
482 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
483 (*i)->set_samples_per_pixel (fpp);
484 (*i)->set_duration (_region->length() / fpp);
487 region_sync_changed ();
491 RegionView::set_duration (framecnt_t frames, void *src)
493 if (!TimeAxisViewItem::set_duration (frames, src)) {
497 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
498 (*i)->set_duration (_region->length() / samples_per_pixel);
505 RegionView::set_colors ()
507 TimeAxisViewItem::set_colors ();
508 set_sync_mark_color ();
512 RegionView::set_sync_mark_color ()
515 ArdourCanvas::Color c = UIConfiguration::instance().color ("sync mark");
516 sync_mark->set_fill_color (c);
517 sync_mark->set_outline_color (c);
518 sync_line->set_outline_color (c);
523 RegionView::get_fill_color () const
525 ArdourCanvas::Color f = TimeAxisViewItem::get_fill_color();
528 if (_region->opaque() && (!ARDOUR::Profile->get_mixbus() || (!_dragging && !_region->muted ()))) {
529 modname = "opaque region base";
531 modname = "transparent region base";
534 return HSV(f).mod (UIConfiguration::instance().modifier (modname)).color ();
538 RegionView::show_region_editor ()
541 editor = new RegionEditor (trackview.session(), region());
549 RegionView::hide_region_editor()
557 RegionView::make_name () const
561 // XXX nice to have some good icons for this
563 if (_region->locked()) {
565 str += _region->name();
567 } else if (_region->position_locked()) {
569 str += _region->name();
571 } else if (_region->video_locked()) {
573 str += _region->name();
576 str = _region->name();
579 if (_region->muted()) {
580 str = string ("!") + str;
587 RegionView::region_renamed ()
589 std::string str = make_name ();
591 set_item_name (str, this);
596 RegionView::region_sync_changed ()
599 framecnt_t sync_offset;
601 sync_offset = _region->sync_offset (sync_dir);
603 if (sync_offset == 0) {
604 /* no need for a sync mark */
614 /* points set below */
616 sync_mark = new ArdourCanvas::Polygon (group);
617 CANVAS_DEBUG_NAME (sync_mark, string_compose ("sync mark for %1", get_item_name()));
618 sync_line = new ArdourCanvas::Line (group);
619 CANVAS_DEBUG_NAME (sync_line, string_compose ("sync mark for %1", get_item_name()));
621 set_sync_mark_color ();
624 /* this has to handle both a genuine change of position, a change of samples_per_pixel
625 and a change in the bounds of the _region->
628 if (sync_offset == 0) {
630 /* no sync mark - its the start of the region */
637 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
639 /* no sync mark - its out of the bounds of the region */
650 //points = sync_mark->property_points().get_value();
652 double offset = sync_offset / samples_per_pixel;
653 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
654 points.push_back (ArdourCanvas::Duple (offset + ((sync_mark_width-1)/2), 1));
655 points.push_back (ArdourCanvas::Duple (offset, sync_mark_width - 1));
656 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
657 sync_mark->set (points);
660 sync_line->set (ArdourCanvas::Duple (offset, 0), ArdourCanvas::Duple (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
667 RegionView::move (double x_delta, double y_delta)
669 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
673 /* items will not prevent Item::move() moving
674 * them to a negative x-axis coordinate, which
675 * is legal, but we don't want that here.
678 ArdourCanvas::Item *item = get_canvas_group ();
680 if (item->position().x + x_delta < 0) {
681 x_delta = -item->position().x; /* move it to zero */
684 item->move (ArdourCanvas::Duple (x_delta, y_delta));
686 /* note: ghosts never leave their tracks so y_delta for them is always zero */
688 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
689 (*i)->group->move (ArdourCanvas::Duple (x_delta, 0.0));
694 RegionView::remove_ghost_in (TimeAxisView& tv)
696 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
697 if (&(*i)->trackview == &tv) {
705 RegionView::remove_ghost (GhostRegion* ghost)
711 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
720 RegionView::set_height (double h)
722 TimeAxisViewItem::set_height(h);
727 framecnt_t sync_offset;
728 sync_offset = _region->sync_offset (sync_dir);
729 double offset = sync_offset / samples_per_pixel;
732 ArdourCanvas::Duple (offset, 0),
733 ArdourCanvas::Duple (offset, h - NAME_HIGHLIGHT_SIZE)
737 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
738 (*i)->set_y1 (h + 1);
741 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
742 (*i)->set_y1 (h + 1);
747 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
748 * which uses them. */
750 RegionView::update_coverage_frames (LayerDisplay d)
752 /* remove old coverage frames */
753 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
757 _coverage_frames.clear ();
760 /* don't do coverage frames unless we're in stacked mode */
764 boost::shared_ptr<Playlist> pl (_region->playlist ());
769 framepos_t const position = _region->first_frame ();
770 framepos_t t = position;
771 framepos_t const end = _region->last_frame ();
773 ArdourCanvas::Rectangle* cr = 0;
776 /* the color that will be used to show parts of regions that will not be heard */
777 uint32_t const non_playing_color = UIConfiguration::instance().color_mod ("covered region", "covered region base");
784 /* is this region is on top at time t? */
785 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
786 /* finish off any old rect, if required */
787 if (cr && me != new_me) {
788 cr->set_x1 (trackview.editor().sample_to_pixel (t - position));
791 /* start off any new rect, if required */
792 if (cr == 0 || me != new_me) {
793 cr = new ArdourCanvas::Rectangle (group);
794 _coverage_frames.push_back (cr);
795 cr->set_x0 (trackview.editor().sample_to_pixel (t - position));
797 cr->set_y1 (_height + 1);
798 cr->set_outline (false);
799 cr->set_ignore_events (true);
801 cr->set_fill_color (UINT_RGBA_CHANGE_A (non_playing_color, 0));
803 cr->set_fill_color (non_playing_color);
806 t = pl->find_next_region_boundary (t, 1);
813 t = pl->find_next_region_boundary (t, 1);
816 /* finish off the last rectangle */
817 cr->set_x1 (trackview.editor().sample_to_pixel (end - position));
820 if (frame_handle_start) {
821 frame_handle_start->raise_to_top ();
824 if (frame_handle_end) {
825 frame_handle_end->raise_to_top ();
828 if (name_highlight) {
829 name_highlight->raise_to_top ();
833 name_text->raise_to_top ();
838 RegionView::trim_front (framepos_t new_bound, bool no_overlap, const int32_t sub_num)
840 if (_region->locked()) {
844 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
845 double const speed = rtv.track()->speed ();
847 framepos_t const pre_trim_first_frame = _region->first_frame();
849 const framepos_t speed_bound = (framepos_t) (new_bound * speed);
851 if (_region->position() == speed_bound) {
855 _region->trim_front (speed_bound, sub_num);
858 // Get the next region on the left of this region and shrink/expand it.
859 boost::shared_ptr<Playlist> playlist (_region->playlist());
860 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
862 bool regions_touching = false;
864 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
865 regions_touching = true;
868 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
869 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
870 region_left->trim_end (_region->first_frame() - 1);
874 region_changed (ARDOUR::bounds_change);
876 return (pre_trim_first_frame != _region->first_frame()); //return true if we actually changed something
880 RegionView::trim_end (framepos_t new_bound, bool no_overlap, const int32_t sub_num)
882 if (_region->locked()) {
886 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
887 double const speed = rtv.track()->speed ();
889 framepos_t const pre_trim_last_frame = _region->last_frame();
891 _region->trim_end ((framepos_t) (new_bound * speed), sub_num);
894 // Get the next region on the right of this region and shrink/expand it.
895 boost::shared_ptr<Playlist> playlist (_region->playlist());
896 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_frame, Start, 1);
898 bool regions_touching = false;
900 if (region_right != 0 && (pre_trim_last_frame == region_right->first_frame() - 1)) {
901 regions_touching = true;
904 // Only trim region on the right if the last frame has gone beyond the right region's first frame.
905 if (region_right != 0 && (region_right->first_frame() < _region->last_frame() || regions_touching)) {
906 region_right->trim_front (_region->last_frame() + 1, sub_num);
909 region_changed (ARDOUR::bounds_change);
912 region_changed (PropertyChange (ARDOUR::Properties::length));
915 return (pre_trim_last_frame != _region->last_frame()); //return true if we actually changed something
920 RegionView::thaw_after_trim ()
922 if (_region->locked()) {
926 _region->resume_property_changes ();
931 RegionView::move_contents (frameoffset_t distance)
933 if (_region->locked()) {
936 _region->move_start (distance);
937 region_changed (PropertyChange (ARDOUR::Properties::start));
940 /** Snap a frame offset within our region using the current snap settings.
941 * @param x Frame offset from this region's position.
942 * @param ensure_snap whether to ignore snap_mode (in the case of SnapOff) and magnetic snap.
943 * Used when inverting snap mode logic with key modifiers, or snap distance calculation.
944 * @return Snapped frame offset from this region's position.
947 RegionView::snap_frame_to_frame (frameoffset_t x, bool ensure_snap) const
949 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 MusicFrame frame (session_frame, 0);
955 editor.snap_to (frame, RoundNearest, false, ensure_snap);
957 /* if we went off the beginning of the region, snap forwards */
958 if (frame.frame < _region->position ()) {
959 frame.frame = session_frame;
960 editor.snap_to (frame, RoundUpAlways, false, ensure_snap);
963 /* back to region relative, keeping the relevant divisor */
964 return MusicFrame (frame.frame - _region->position(), frame.division);