2 * Copyright (C) 2006-2014 David Robillard <d@drobilla.net>
3 * Copyright (C) 2007-2012 Carl Hetherington <carl@carlh.net>
4 * Copyright (C) 2007-2019 Paul Davis <paul@linuxaudiosystems.com>
5 * Copyright (C) 2007 Doug McLain <doug@nostar.net>
6 * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
7 * Copyright (C) 2015-2017 Nick Mainsbridge <mainsbridge@gmail.com>
8 * Copyright (C) 2015 Tim Mayberry <mojofunk@gmail.com>
9 * Copyright (C) 2018 Ben Loftis <ben@harrisonconsoles.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
31 #include <gtkmm2ext/gtk_ui.h>
33 #include "ardour/playlist.h"
34 #include "ardour/profile.h"
35 #include "ardour/session.h"
37 #include "gtkmm2ext/colors.h"
39 #include "canvas/polygon.h"
40 #include "canvas/debug.h"
41 #include "canvas/pixbuf.h"
42 #include "canvas/text.h"
43 #include "canvas/line.h"
45 #include "streamview.h"
46 #include "region_view.h"
47 #include "automation_region_view.h"
48 #include "route_time_axis.h"
49 #include "public_editor.h"
50 #include "region_editor.h"
51 #include "ghostregion.h"
52 #include "route_time_axis.h"
53 #include "ui_config.h"
55 #include "rgb_macros.h"
56 #include "gui_thread.h"
61 using namespace ARDOUR;
62 using namespace ARDOUR_UI_UTILS;
64 using namespace Editing;
66 using namespace ArdourCanvas;
68 static const int32_t sync_mark_width = 9;
70 PBD::Signal1<void,RegionView*> RegionView::RegionViewGoingAway;
72 RegionView::RegionView (ArdourCanvas::Container* parent,
74 boost::shared_ptr<ARDOUR::Region> r,
78 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), false, automation,
79 (automation ? TimeAxisViewItem::ShowFrame :
80 TimeAxisViewItem::Visibility ((UIConfiguration::instance().get_show_region_name() ? TimeAxisViewItem::ShowNameText : 0) |
81 TimeAxisViewItem::ShowNameHighlight| TimeAxisViewItem::ShowFrame)))
86 , current_visible_sync_position(0.0)
88 , _enable_display(false)
90 , in_destructor(false)
91 , wait_for_data(false)
96 RegionView::RegionView (const RegionView& other)
97 : sigc::trackable(other)
98 , TimeAxisViewItem (other)
101 /* derived concrete type will call init () */
103 _region = other._region;
104 current_visible_sync_position = other.current_visible_sync_position;
106 _pixel_width = other._pixel_width;
109 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
110 : sigc::trackable(other)
111 , TimeAxisViewItem (other)
114 /* this is a pseudo-copy constructor used when dragging regions
115 around on the canvas.
118 /* derived concrete type will call init () */
120 _region = other_region;
121 current_visible_sync_position = other.current_visible_sync_position;
123 _pixel_width = other._pixel_width;
126 RegionView::RegionView (ArdourCanvas::Container* parent,
128 boost::shared_ptr<ARDOUR::Region> r,
130 uint32_t basic_color,
132 TimeAxisViewItem::Visibility visibility)
133 : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, false, visibility)
138 , current_visible_sync_position(0.0)
140 , _enable_display(false)
142 , in_destructor(false)
143 , wait_for_data(false)
149 RegionView::init (bool wfd)
153 in_destructor = false;
160 if (name_highlight) {
161 name_highlight->set_data ("regionview", this);
162 name_highlight->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
165 if (frame_handle_start) {
166 frame_handle_start->set_data ("regionview", this);
167 frame_handle_start->set_data ("isleft", (void*) 1);
168 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
169 frame_handle_start->raise_to_top();
172 if (frame_handle_end) {
173 frame_handle_end->set_data ("regionview", this);
174 frame_handle_end->set_data ("isleft", (void*) 0);
175 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
176 frame_handle_end->raise_to_top();
180 name_text->set_data ("regionview", this);
181 name_text->Event.connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_text, this));
185 _enable_display = true;
188 /* derived class calls set_height () including RegionView::set_height() in ::init() */
189 //set_height (trackview.current_height());
191 _region->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RegionView::region_changed, this, _1), gui_context());
193 /* derived class calls set_colors () including RegionView::set_colors() in ::init() */
195 UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
197 /* XXX sync mark drag? */
200 RegionView::~RegionView ()
202 in_destructor = true;
204 for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
208 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frame.begin (); i != _coverage_frame.end (); ++i) {
212 drop_silent_frames ();
218 RegionView::canvas_group_event (GdkEvent* event)
220 if (!in_destructor) {
221 return trackview.editor().canvas_region_view_event (event, group, this);
227 RegionView::set_silent_frames (const AudioIntervalResult& silences, double /*threshold*/)
229 samplecnt_t shortest = max_samplecnt;
231 /* remove old silent frames */
232 drop_silent_frames ();
234 if (silences.empty()) {
238 uint32_t const color = UIConfiguration::instance().color_mod ("silence", "silence");
240 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
242 ArdourCanvas::Rectangle* cr = new ArdourCanvas::Rectangle (group);
243 cr->set_ignore_events (true);
244 _silent_frames.push_back (cr);
246 /* coordinates for the rect are relative to the regionview origin */
248 cr->set_x0 (trackview.editor().sample_to_pixel (i->first - _region->start()));
249 cr->set_x1 (trackview.editor().sample_to_pixel (i->second - _region->start()));
251 cr->set_y1 (_height - 2);
252 cr->set_outline (false);
253 cr->set_fill_color (color);
255 shortest = min (shortest, i->second - i->first);
258 /* Find shortest audible segment */
259 samplecnt_t shortest_audible = max_samplecnt;
261 samplecnt_t s = _region->start();
262 for (AudioIntervalResult::const_iterator i = silences.begin(); i != silences.end(); ++i) {
263 samplecnt_t const dur = i->first - s;
265 shortest_audible = min (shortest_audible, dur);
271 samplecnt_t const dur = _region->start() + _region->length() - 1 - s;
273 shortest_audible = min (shortest_audible, dur);
276 _silence_text = new ArdourCanvas::Text (group);
277 _silence_text->set_ignore_events (true);
278 _silence_text->set_font_description (get_font_for_style (N_("SilenceText")));
279 _silence_text->set_color (UIConfiguration::instance().color ("silence text"));
281 /* both positions are relative to the region start offset in source */
283 _silence_text->set_x_position (trackview.editor().sample_to_pixel (silences.front().first - _region->start()) + 10.0);
284 _silence_text->set_y_position (20.0);
286 double ms = (float) shortest/_region->session().sample_rate();
288 /* ms are now in seconds */
293 sunits = _("minutes");
295 } else if (ms < 1.0) {
302 string text = string_compose (ngettext ("%1 silent segment", "%1 silent segments", silences.size()), silences.size())
304 + string_compose (_("shortest = %1 %2"), ms, sunits);
306 if (shortest_audible != max_samplepos) {
307 /* ms are now in seconds */
308 double ma = (float) shortest_audible / _region->session().sample_rate();
312 aunits = _("minutes");
314 } else if (ma < 1.0) {
321 text += string_compose (_("\n (shortest audible segment = %1 %2)"), ma, aunits);
324 _silence_text->set (text);
328 RegionView::hide_silent_frames ()
330 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
333 _silence_text->hide();
337 RegionView::drop_silent_frames ()
339 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin (); i != _silent_frames.end (); ++i) {
342 _silent_frames.clear ();
344 delete _silence_text;
349 RegionView::_lock_toggle (ArdourCanvas::Item*, GdkEvent* ev, void* arg)
352 case GDK_BUTTON_RELEASE:
353 static_cast<RegionView*>(arg)->lock_toggle ();
363 RegionView::lock_toggle ()
365 _region->set_locked (!_region->locked());
369 RegionView::region_changed (const PropertyChange& what_changed)
371 ENSURE_GUI_THREAD (*this, &RegionView::region_changed, what_changed);
373 if (what_changed.contains (ARDOUR::bounds_change)) {
374 region_resized (what_changed);
375 region_sync_changed ();
377 if (what_changed.contains (ARDOUR::Properties::muted)) {
380 if (what_changed.contains (ARDOUR::Properties::opaque)) {
383 if (what_changed.contains (ARDOUR::Properties::name)) {
386 if (what_changed.contains (ARDOUR::Properties::position_lock_style)) {
389 if (what_changed.contains (ARDOUR::Properties::sync_position)) {
390 region_sync_changed ();
392 if (what_changed.contains (ARDOUR::Properties::locked)) {
398 RegionView::region_locked ()
400 /* name will show locked status */
405 RegionView::region_resized (const PropertyChange& what_changed)
409 if (what_changed.contains (ARDOUR::Properties::position)) {
410 set_position (_region->position(), 0);
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_pixel;
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 (samplepos_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 (ArdourCanvas::Duple (delta, 0.0));
487 RegionView::set_samples_per_pixel (double fpp)
489 TimeAxisViewItem::set_samples_per_pixel (fpp);
491 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
492 (*i)->set_samples_per_pixel (fpp);
493 (*i)->set_duration (_region->length() / fpp);
496 region_sync_changed ();
500 RegionView::set_duration (samplecnt_t samples, void *src)
502 if (!TimeAxisViewItem::set_duration (samples, src)) {
506 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
507 (*i)->set_duration (_region->length() / samples_per_pixel);
514 RegionView::set_colors ()
516 TimeAxisViewItem::set_colors ();
517 set_sync_mark_color ();
521 RegionView::set_sync_mark_color ()
524 Gtkmm2ext::Color c = UIConfiguration::instance().color ("sync mark");
525 sync_mark->set_fill_color (c);
526 sync_mark->set_outline_color (c);
527 sync_line->set_outline_color (c);
532 RegionView::get_fill_color () const
534 Gtkmm2ext::Color f = TimeAxisViewItem::get_fill_color();
537 if (_region->opaque() && ( !_dragging && !_region->muted () )) {
538 modname = "opaque region base";
540 modname = "transparent region base";
543 return Gtkmm2ext::HSV(f).mod (UIConfiguration::instance().modifier (modname)).color ();
547 RegionView::show_region_editor ()
550 editor = new RegionEditor (trackview.session(), region());
558 RegionView::hide_region_editor()
566 RegionView::make_name () const
570 // XXX nice to have some good icons for this
571 if (_region->position_lock_style() == MusicTime) {
572 str += "\u266B"; // BEAMED EIGHTH NOTES
575 if (_region->locked()) {
576 str += "\u2629"; // CROSS OF JERUSALEM
577 str += _region->name();
578 } else if (_region->position_locked()) {
579 str += "\u21B9"; // LEFTWARDS ARROW TO BAR OVER RIGHTWARDS ARROW TO BAR
580 str += _region->name();
581 } else if (_region->video_locked()) {
583 str += _region->name();
586 str += _region->name();
589 if (_region->muted()) {
590 str = string ("!") + str;
597 RegionView::region_renamed ()
599 std::string str = make_name ();
601 set_item_name (str, this);
606 RegionView::region_sync_changed ()
609 samplecnt_t sync_offset;
611 sync_offset = _region->sync_offset (sync_dir);
613 if (sync_offset == 0) {
614 /* no need for a sync mark */
624 /* points set below */
626 sync_mark = new ArdourCanvas::Polygon (group);
627 CANVAS_DEBUG_NAME (sync_mark, string_compose ("sync mark for %1", get_item_name()));
628 sync_line = new ArdourCanvas::Line (group);
629 CANVAS_DEBUG_NAME (sync_line, string_compose ("sync mark for %1", get_item_name()));
631 set_sync_mark_color ();
634 /* this has to handle both a genuine change of position, a change of samples_per_pixel
635 and a change in the bounds of the _region->
638 if (sync_offset == 0) {
640 /* no sync mark - its the start of the region */
647 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
649 /* no sync mark - its out of the bounds of the region */
660 //points = sync_mark->property_points().get_value();
662 double offset = sync_offset / samples_per_pixel;
663 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
664 points.push_back (ArdourCanvas::Duple (offset + ((sync_mark_width-1)/2), 1));
665 points.push_back (ArdourCanvas::Duple (offset, sync_mark_width - 1));
666 points.push_back (ArdourCanvas::Duple (offset - ((sync_mark_width-1)/2), 1));
667 sync_mark->set (points);
670 sync_line->set (ArdourCanvas::Duple (offset, 0), ArdourCanvas::Duple (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
677 RegionView::move (double x_delta, double y_delta)
679 if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
683 /* items will not prevent Item::move() moving
684 * them to a negative x-axis coordinate, which
685 * is legal, but we don't want that here.
688 ArdourCanvas::Item *item = get_canvas_group ();
690 if (item->position().x + x_delta < 0) {
691 x_delta = -item->position().x; /* move it to zero */
694 item->move (ArdourCanvas::Duple (x_delta, y_delta));
696 /* note: ghosts never leave their tracks so y_delta for them is always zero */
698 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
699 (*i)->group->move (ArdourCanvas::Duple (x_delta, 0.0));
704 RegionView::remove_ghost_in (TimeAxisView& tv)
706 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
707 if (&(*i)->trackview == &tv) {
715 RegionView::remove_ghost (GhostRegion* ghost)
721 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
730 RegionView::set_height (double h)
732 TimeAxisViewItem::set_height(h);
737 samplecnt_t sync_offset;
738 sync_offset = _region->sync_offset (sync_dir);
739 double offset = sync_offset / samples_per_pixel;
742 ArdourCanvas::Duple (offset, 0),
743 ArdourCanvas::Duple (offset, h - NAME_HIGHLIGHT_SIZE)
747 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frame.begin(); i != _coverage_frame.end(); ++i) {
748 (*i)->set_y1 (h + 1);
751 for (list<ArdourCanvas::Rectangle*>::iterator i = _silent_frames.begin(); i != _silent_frames.end(); ++i) {
752 (*i)->set_y1 (h + 1);
757 /** Remove old coverage frame and make new ones, if we're in a LayerDisplay mode
758 * which uses them. */
760 RegionView::update_coverage_frame (LayerDisplay d)
762 /* remove old coverage frame */
763 for (list<ArdourCanvas::Rectangle*>::iterator i = _coverage_frame.begin (); i != _coverage_frame.end (); ++i) {
767 _coverage_frame.clear ();
770 /* don't do coverage frame unless we're in stacked mode */
774 boost::shared_ptr<Playlist> pl (_region->playlist ());
779 samplepos_t const position = _region->first_sample ();
780 samplepos_t t = position;
781 samplepos_t const end = _region->last_sample ();
783 ArdourCanvas::Rectangle* cr = 0;
786 /* the color that will be used to show parts of regions that will not be heard */
787 uint32_t const non_playing_color = UIConfiguration::instance().color_mod ("covered region", "covered region base");
794 /* is this region is on top at time t? */
795 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
796 /* finish off any old rect, if required */
797 if (cr && me != new_me) {
798 cr->set_x1 (trackview.editor().sample_to_pixel (t - position));
801 /* start off any new rect, if required */
802 if (cr == 0 || me != new_me) {
803 cr = new ArdourCanvas::Rectangle (group);
804 _coverage_frame.push_back (cr);
805 cr->set_x0 (trackview.editor().sample_to_pixel (t - position));
807 cr->set_y1 (_height + 1);
808 cr->set_outline (false);
809 cr->set_ignore_events (true);
811 cr->set_fill_color (UINT_RGBA_CHANGE_A (non_playing_color, 0));
813 cr->set_fill_color (non_playing_color);
816 t = pl->find_next_region_boundary (t, 1);
823 t = pl->find_next_region_boundary (t, 1);
826 /* finish off the last rectangle */
827 cr->set_x1 (trackview.editor().sample_to_pixel (end - position));
830 if (frame_handle_start) {
831 frame_handle_start->raise_to_top ();
834 if (frame_handle_end) {
835 frame_handle_end->raise_to_top ();
838 if (name_highlight) {
839 name_highlight->raise_to_top ();
843 name_text->raise_to_top ();
848 RegionView::trim_front (samplepos_t new_bound, bool no_overlap, const int32_t sub_num)
850 if (_region->locked()) {
854 samplepos_t const pre_trim_first_sample = _region->first_sample();
856 if (_region->position() == new_bound) {
860 _region->trim_front (new_bound, sub_num);
863 /* Get the next region on the left of this region and shrink/expand it. */
864 boost::shared_ptr<Playlist> playlist (_region->playlist());
865 boost::shared_ptr<Region> region_left = playlist->find_next_region (pre_trim_first_sample, End, 0);
867 bool regions_touching = false;
869 if (region_left != 0 && (pre_trim_first_sample == region_left->last_sample() + 1)) {
870 regions_touching = true;
873 /* Only trim region on the left if the first sample has gone beyond the left region's last sample. */
874 if (region_left != 0 && (region_left->last_sample() > _region->first_sample() || regions_touching)) {
875 region_left->trim_end (_region->first_sample() - 1);
879 region_changed (ARDOUR::bounds_change);
881 return (pre_trim_first_sample != _region->first_sample()); // return true if we actually changed something
885 RegionView::trim_end (samplepos_t new_bound, bool no_overlap, const int32_t sub_num)
887 if (_region->locked()) {
891 samplepos_t const pre_trim_last_sample = _region->last_sample();
893 _region->trim_end (new_bound, sub_num);
896 /* Get the next region on the right of this region and shrink/expand it. */
897 boost::shared_ptr<Playlist> playlist (_region->playlist());
898 boost::shared_ptr<Region> region_right = playlist->find_next_region (pre_trim_last_sample, Start, 1);
900 bool regions_touching = false;
902 if (region_right != 0 && (pre_trim_last_sample == region_right->first_sample() - 1)) {
903 regions_touching = true;
906 /* Only trim region on the right if the last sample has gone beyond the right region's first sample. */
907 if (region_right != 0 && (region_right->first_sample() < _region->last_sample() || regions_touching)) {
908 region_right->trim_front (_region->last_sample() + 1, sub_num);
911 region_changed (ARDOUR::bounds_change);
914 region_changed (PropertyChange (ARDOUR::Properties::length));
917 return (pre_trim_last_sample != _region->last_sample()); // return true if we actually changed something
922 RegionView::thaw_after_trim ()
924 if (_region->locked()) {
928 _region->resume_property_changes ();
933 RegionView::move_contents (sampleoffset_t distance)
935 if (_region->locked()) {
938 _region->move_start (distance);
939 region_changed (PropertyChange (ARDOUR::Properties::start));
942 /** Snap a sample offset within our region using the current snap settings.
943 * @param x Frame offset from this region's position.
944 * @param ensure_snap whether to ignore snap_mode (in the case of SnapOff) and magnetic snap.
945 * Used when inverting snap mode logic with key modifiers, or snap distance calculation.
946 * @return Snapped sample offset from this region's position.
949 RegionView::snap_sample_to_sample (sampleoffset_t x, bool ensure_snap) const
951 PublicEditor& editor = trackview.editor();
952 /* x is region relative, convert it to global absolute samples */
953 samplepos_t const session_sample = x + _region->position();
955 /* try a snap in either direction */
956 MusicSample sample (session_sample, 0);
957 editor.snap_to (sample, RoundNearest, SnapToAny_Visual, ensure_snap);
959 /* if we went off the beginning of the region, snap forwards */
960 if (sample.sample < _region->position ()) {
961 sample.sample = session_sample;
962 editor.snap_to (sample, RoundUpAlways, SnapToAny_Visual, ensure_snap);
965 /* back to region relative, keeping the relevant divisor */
966 return MusicSample (sample.sample - _region->position(), sample.division);
970 RegionView::update_visibility ()
972 /* currently only the name visibility can be changed dynamically */
974 if (UIConfiguration::instance().get_show_region_name()) {
975 visibility = Visibility (visibility | ShowNameText);
977 visibility = Visibility (visibility & ~ShowNameText);