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)
89 RegionView::RegionView (const RegionView& other)
90 : sigc::trackable(other)
91 , TimeAxisViewItem (other)
94 /* derived concrete type will call init () */
96 _region = other._region;
97 current_visible_sync_position = other.current_visible_sync_position;
99 _pixel_width = other._pixel_width;
102 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
103 : sigc::trackable(other)
104 , TimeAxisViewItem (other)
107 /* this is a pseudo-copy constructor used when dragging regions
108 around on the canvas.
111 /* derived concrete type will call init () */
113 _region = other_region;
114 current_visible_sync_position = other.current_visible_sync_position;
116 _pixel_width = other._pixel_width;
119 RegionView::RegionView (ArdourCanvas::Container* parent,
121 boost::shared_ptr<ARDOUR::Region> r,
123 uint32_t basic_color,
125 TimeAxisViewItem::Visibility visibility)
126 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
131 , current_visible_sync_position(0.0)
133 , _enable_display(false)
135 , in_destructor(false)
136 , wait_for_data(false)
142 RegionView::init (bool wfd)
146 in_destructor = false;
153 if (name_highlight) {
154 name_highlight->set_data ("regionview", this);
155 name_highlight->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
158 if (frame_handle_start) {
159 frame_handle_start->set_data ("regionview", this);
160 frame_handle_start->set_data ("isleft", (void*) 1);
161 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
162 frame_handle_start->raise_to_top();
165 if (frame_handle_end) {
166 frame_handle_end->set_data ("regionview", this);
167 frame_handle_end->set_data ("isleft", (void*) 0);
168 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
169 frame_handle_end->raise_to_top();
173 name_text->set_data ("regionview", this);
174 name_text->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_text, this));
178 _enable_display = true;
181 set_height (trackview.current_height());
183 _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
187 UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
189 /* XXX sync mark drag? */
192 RegionView::~RegionView ()
194 in_destructor = true;
196 for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
200 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
204 drop_silent_frames ();
210 RegionView::canvas_group_event (GdkEvent* event)
212 if (!in_destructor) {
213 return trackview.editor().canvas_region_view_event (event, group, this);
219 RegionView::set_silent_frames (const AudioIntervalResult& silences, double /*threshold*/)
221 framecnt_t shortest = max_framecnt;
223 /* remove old silent frames */
224 drop_silent_frames ();
226 if (silences.empty()) {
230 uint32_t const color = UIConfiguration::instance().color_mod ("silence", "silence");
232 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
234 ArdourCanvas::Rectangle* cr = new ArdourCanvas::Rectangle (group);
235 cr->set_ignore_events (true);
236 _silent_frames.push_back (cr);
238 /* coordinates for the rect are relative to the regionview origin */
240 cr->set_x0 (trackview.editor().sample_to_pixel (i->first - _region->start()));
241 cr->set_x1 (trackview.editor().sample_to_pixel (i->second - _region->start()));
243 cr->set_y1 (_height - 2);
244 cr->set_outline (false);
245 cr->set_fill_color (color);
247 shortest = min (shortest, i->second - i->first);
250 /* Find shortest audible segment */
251 framecnt_t shortest_audible = max_framecnt;
253 framecnt_t s = _region->start();
254 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
255 framecnt_t const dur = i->first - s;
257 shortest_audible = min (shortest_audible, dur);
263 framecnt_t const dur = _region->start() + _region->length() - 1 - s;
265 shortest_audible = min (shortest_audible, dur);
268 _silence_text = new ArdourCanvas::Text (group);
269 _silence_text->set_ignore_events (true);
270 _silence_text->set_font_description (get_font_for_style (N_("SilenceText")));
271 _silence_text->set_color (UIConfiguration::instance().color ("silence text"));
273 /* both positions are relative to the region start offset in source */
275 _silence_text->set_x_position (trackview.editor().sample_to_pixel (silences.front().first - _region->start()) + 10.0);
276 _silence_text->set_y_position (20.0);
278 double ms = (float) shortest/_region->session().frame_rate();
280 /* ms are now in seconds */
285 sunits = _("minutes");
287 } else if (ms < 1.0) {
294 string text = string_compose (ngettext ("%1 silent segment", "%1 silent segments", silences.size()), silences.size())
296 + string_compose (_("shortest = %1 %2"), ms, sunits);
298 if (shortest_audible != max_framepos) {
299 /* ms are now in seconds */
300 double ma = (float) shortest_audible / _region->session().frame_rate();
304 aunits = _("minutes");
306 } else if (ma < 1.0) {
313 text += string_compose (_("\n (shortest audible segment = %1 %2)"), ma, aunits);
316 _silence_text->set (text);
320 RegionView::hide_silent_frames ()
322 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
325 _silence_text->hide();
329 RegionView::drop_silent_frames ()
331 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
334 _silent_frames.clear ();
336 delete _silence_text;
341 RegionView::_lock_toggle (ArdourCanvas::Item*, GdkEvent* ev, void* arg)
344 case GDK_BUTTON_RELEASE:
345 static_cast<RegionView*>(arg)->lock_toggle ();
355 RegionView::lock_toggle ()
357 _region->set_locked (!_region->locked());
361 RegionView::region_changed (const PropertyChange& what_changed)
363 ENSURE_GUI_THREAD (*this, &RegionView::region_changed, what_changed);
365 if (what_changed.contains (ARDOUR::bounds_change)) {
366 region_resized (what_changed);
367 region_sync_changed ();
369 if (what_changed.contains (ARDOUR::Properties::muted)) {
372 if (what_changed.contains (ARDOUR::Properties::opaque)) {
375 if (what_changed.contains (ARDOUR::Properties::name)) {
378 if (what_changed.contains (ARDOUR::Properties::sync_position)) {
379 region_sync_changed ();
381 if (what_changed.contains (ARDOUR::Properties::locked)) {
384 if (what_changed.contains (ARDOUR::Properties::locked)) {
385 /* name will show locked status */
391 RegionView::region_locked ()
393 /* name will show locked status */
398 RegionView::region_resized (const PropertyChange& what_changed)
402 if (what_changed.contains (ARDOUR::Properties::position)) {
403 set_position (_region->position(), 0);
406 PropertyChange s_and_l;
407 s_and_l.add (ARDOUR::Properties::start);
408 s_and_l.add (ARDOUR::Properties::length);
410 if (what_changed.contains (s_and_l)) {
412 set_duration (_region->length(), 0);
414 unit_length = _region->length() / samples_per_pixel;
416 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
418 (*i)->set_duration (unit_length);
425 RegionView::reset_width_dependent_items (double pixel_width)
427 TimeAxisViewItem::reset_width_dependent_items (pixel_width);
428 _pixel_width = pixel_width;
432 RegionView::region_muted ()
439 RegionView::region_opacity ()
445 RegionView::raise_to_top ()
447 _region->raise_to_top ();
451 RegionView::lower_to_bottom ()
453 _region->lower_to_bottom ();
457 RegionView::set_position (framepos_t pos, void* /*src*/, double* ignored)
462 if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
471 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
472 (*i)->group->move (ArdourCanvas::Duple (delta, 0.0));
480 RegionView::set_samples_per_pixel (double fpp)
482 TimeAxisViewItem::set_samples_per_pixel (fpp);
484 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
485 (*i)->set_samples_per_pixel (fpp);
486 (*i)->set_duration (_region->length() / fpp);
489 region_sync_changed ();
493 RegionView::set_duration (framecnt_t frames, void *src)
495 if (!TimeAxisViewItem::set_duration (frames, src)) {
499 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
500 (*i)->set_duration (_region->length() / samples_per_pixel);
507 RegionView::set_colors ()
509 TimeAxisViewItem::set_colors ();
510 set_sync_mark_color ();
514 RegionView::set_sync_mark_color ()
517 ArdourCanvas::Color c = UIConfiguration::instance().color ("sync mark");
518 sync_mark->set_fill_color (c);
519 sync_mark->set_outline_color (c);
520 sync_line->set_outline_color (c);
525 RegionView::get_fill_color () const
527 ArdourCanvas::Color f = TimeAxisViewItem::get_fill_color();
530 if (_region->opaque()) {
531 modname = "opaque region base";
533 modname = "transparent region base";
536 return HSV(f).mod (UIConfiguration::instance().modifier (modname)).color ();
540 RegionView::show_region_editor ()
543 editor = new RegionEditor (trackview.session(), region());
551 RegionView::hide_region_editor()
559 RegionView::make_name () const
563 // XXX nice to have some good icons for this
565 if (_region->locked()) {
567 str += _region->name();
569 } else if (_region->position_locked()) {
571 str += _region->name();
573 } else if (_region->video_locked()) {
575 str += _region->name();
578 str = _region->name();
581 if (_region->muted()) {
582 str = string ("!") + str;
589 RegionView::region_renamed ()
591 std::string str = make_name ();
593 set_item_name (str, this);
595 reset_width_dependent_items (_pixel_width);
599 RegionView::region_sync_changed ()
602 framecnt_t sync_offset;
604 sync_offset = _region->sync_offset (sync_dir);
606 if (sync_offset == 0) {
607 /* no need for a sync mark */
617 /* points set below */
619 sync_mark = new ArdourCanvas::Polygon (group);
620 CANVAS_DEBUG_NAME (sync_mark, string_compose ("sync mark for %1", get_item_name()));
621 sync_line = new ArdourCanvas::Line (group);
622 CANVAS_DEBUG_NAME (sync_line, string_compose ("sync mark for %1", get_item_name()));
624 set_sync_mark_color ();
627 /* this has to handle both a genuine change of position, a change of samples_per_pixel
628 and a change in the bounds of the _region->
631 if (sync_offset == 0) {
633 /* no sync mark - its the start of the region */
640 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
642 /* no sync mark - its out of the bounds of the region */
653 //points = sync_mark->property_points().get_value();
655 double offset = sync_offset / samples_per_pixel;
656 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
657 points.push_back (ArdourCanvas::Duple (offset + ((sync_mark_width-1)/2), 1));
658 points.push_back (ArdourCanvas::Duple (offset, sync_mark_width - 1));
659 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
660 sync_mark->set (points);
663 sync_line->set (ArdourCanvas::Duple (offset, 0), ArdourCanvas::Duple (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
670 RegionView::move (double x_delta, double y_delta)
672 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
676 /* items will not prevent Item::move() moving
677 * them to a negative x-axis coordinate, which
678 * is legal, but we don't want that here.
681 ArdourCanvas::Item *item = get_canvas_group ();
683 if (item->position().x + x_delta < 0) {
684 x_delta = -item->position().x; /* move it to zero */
687 item->move (ArdourCanvas::Duple (x_delta, y_delta));
689 /* note: ghosts never leave their tracks so y_delta for them is always zero */
691 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
692 (*i)->group->move (ArdourCanvas::Duple (x_delta, 0.0));
697 RegionView::remove_ghost_in (TimeAxisView& tv)
699 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
700 if (&(*i)->trackview == &tv) {
708 RegionView::remove_ghost (GhostRegion* ghost)
714 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
723 RegionView::set_height (double h)
725 TimeAxisViewItem::set_height(h);
730 framecnt_t sync_offset;
731 sync_offset = _region->sync_offset (sync_dir);
732 double offset = sync_offset / samples_per_pixel;
735 ArdourCanvas::Duple (offset, 0),
736 ArdourCanvas::Duple (offset, h - NAME_HIGHLIGHT_SIZE)
740 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
741 (*i)->set_y1 (h + 1);
744 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
745 (*i)->set_y1 (h + 1);
750 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
751 * which uses them. */
753 RegionView::update_coverage_frames (LayerDisplay d)
755 /* remove old coverage frames */
756 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
760 _coverage_frames.clear ();
763 /* don't do coverage frames unless we're in stacked mode */
767 boost::shared_ptr<Playlist> pl (_region->playlist ());
772 framepos_t const position = _region->first_frame ();
773 framepos_t t = position;
774 framepos_t const end = _region->last_frame ();
776 ArdourCanvas::Rectangle* cr = 0;
779 /* the color that will be used to show parts of regions that will not be heard */
780 uint32_t const non_playing_color = UIConfiguration::instance().color_mod ("covered region", "covered region base");
786 /* is this region is on top at time t? */
787 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
789 /* finish off any old rect, if required */
790 if (cr && me != new_me) {
791 cr->set_x1 (trackview.editor().sample_to_pixel (t - position));
794 /* start off any new rect, if required */
795 if (cr == 0 || me != new_me) {
796 cr = new ArdourCanvas::Rectangle (group);
797 _coverage_frames.push_back (cr);
798 cr->set_x0 (trackview.editor().sample_to_pixel (t - position));
800 cr->set_y1 (_height + 1);
801 cr->set_outline (false);
802 cr->set_ignore_events (true);
804 cr->set_fill_color (UINT_RGBA_CHANGE_A (non_playing_color, 0));
806 cr->set_fill_color (non_playing_color);
810 t = pl->find_next_region_boundary (t, 1);
815 /* finish off the last rectangle */
816 cr->set_x1 (trackview.editor().sample_to_pixel (end - position));
819 if (frame_handle_start) {
820 frame_handle_start->raise_to_top ();
823 if (frame_handle_end) {
824 frame_handle_end->raise_to_top ();
827 if (name_highlight) {
828 name_highlight->raise_to_top ();
832 name_text->raise_to_top ();
837 RegionView::trim_front (framepos_t new_bound, bool no_overlap)
839 if (_region->locked()) {
843 RouteTimeAxisView& rtv = dynamic_cast<RouteTimeAxisView&> (trackview);
844 double const speed = rtv.track()->speed ();
846 framepos_t const pre_trim_first_frame = _region->first_frame();
848 _region->trim_front ((framepos_t) (new_bound * speed));
851 // Get the next region on the left of this region and shrink/expand it.
852 boost::shared_ptr<Playlist> playlist (_region->playlist());
853 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_frame, End, 0);
855 bool regions_touching = false;
857 if (region_left != 0 && (pre_trim_first_frame == region_left->last_frame() + 1)) {
858 regions_touching = true;
861 // Only trim region on the left if the first frame has gone beyond the left region's last frame.
862 if (region_left != 0 && (region_left->last_frame() > _region->first_frame() || regions_touching)) {
863 region_left->trim_end (_region->first_frame() - 1);
867 region_changed (ARDOUR::bounds_change);
869 return (pre_trim_first_frame != _region->first_frame()); //return true if we actually changed something
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));
908 return (pre_trim_last_frame != _region->last_frame()); //return true if we actually changed something
913 RegionView::thaw_after_trim ()
915 if (_region->locked()) {
919 _region->resume_property_changes ();
924 RegionView::move_contents (frameoffset_t distance)
926 if (_region->locked()) {
929 _region->move_start (distance);
930 region_changed (PropertyChange (ARDOUR::Properties::start));
933 /** Snap a frame offset within our region using the current snap settings.
934 * @param x Frame offset from this region's position.
935 * @param ensure_snap whether to ignore snap_mode (in the case of SnapOff) and magnetic snap.
936 * Used when inverting snap mode logic with key modifiers, or snap distance calculation.
937 * @return Snapped frame offset from this region's position.
940 RegionView::snap_frame_to_frame (frameoffset_t x, bool ensure_snap) const
942 PublicEditor& editor = trackview.editor();
944 /* x is region relative, convert it to global absolute frames */
945 framepos_t const session_frame = x + _region->position();
947 /* try a snap in either direction */
948 framepos_t frame = session_frame;
949 editor.snap_to (frame, RoundNearest, false, ensure_snap);
951 /* if we went off the beginning of the region, snap forwards */
952 if (frame < _region->position ()) {
953 frame = session_frame;
954 editor.snap_to (frame, RoundUpAlways, false, ensure_snap);
957 /* back to region relative */
958 return frame - _region->position();