2 Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "content_panel.h"
22 #include "film_editor.h"
23 #include "film_viewer.h"
25 #include "timeline_atmos_content_view.h"
26 #include "timeline_audio_content_view.h"
27 #include "timeline_labels_view.h"
28 #include "timeline_reels_view.h"
29 #include "timeline_text_content_view.h"
30 #include "timeline_time_axis_view.h"
31 #include "timeline_video_content_view.h"
33 #include "lib/atmos_mxf_content.h"
34 #include "lib/audio_content.h"
36 #include "lib/image_content.h"
37 #include "lib/playlist.h"
38 #include "lib/text_content.h"
39 #include "lib/timer.h"
40 #include "lib/video_content.h"
41 #include <dcp/warnings.h>
42 LIBDCP_DISABLE_WARNINGS
43 #include <wx/graphics.h>
44 LIBDCP_ENABLE_WARNINGS
50 using std::dynamic_pointer_cast;
52 using std::make_shared;
55 using std::shared_ptr;
58 using boost::optional;
59 using namespace dcpomatic;
60 #if BOOST_VERSION >= 106100
61 using namespace boost::placeholders;
65 /* 3 hours in 640 pixels */
66 double const Timeline::_minimum_pixels_per_second = 640.0 / (60 * 60 * 3);
67 int const Timeline::_minimum_pixels_per_track = 16;
70 Timeline::Timeline (wxWindow* parent, ContentPanel* cp, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
71 : wxPanel (parent, wxID_ANY)
72 , _labels_canvas (new wxScrolledCanvas (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE))
73 , _main_canvas (new wxScrolledCanvas (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE))
77 , _time_axis_view (new TimelineTimeAxisView (*this, 64))
78 , _reels_view (new TimelineReelsView (*this, 32))
79 , _labels_view (new TimelineLabelsView (*this))
82 , _down_view_position (0)
84 , _menu (this, viewer)
89 , _pixels_per_track (48)
90 , _first_resize (true)
94 _labels_canvas->SetDoubleBuffered (true);
95 _main_canvas->SetDoubleBuffered (true);
98 auto sizer = new wxBoxSizer (wxHORIZONTAL);
99 sizer->Add (_labels_canvas, 0, wxEXPAND);
100 _labels_canvas->SetMinSize (wxSize (_labels_view->bbox().width, -1));
101 sizer->Add (_main_canvas, 1, wxEXPAND);
104 _labels_canvas->Bind (wxEVT_PAINT, boost::bind (&Timeline::paint_labels, this));
105 _main_canvas->Bind (wxEVT_PAINT, boost::bind (&Timeline::paint_main, this));
106 _main_canvas->Bind (wxEVT_LEFT_DOWN, boost::bind (&Timeline::left_down, this, _1));
107 _main_canvas->Bind (wxEVT_LEFT_UP, boost::bind (&Timeline::left_up, this, _1));
108 _main_canvas->Bind (wxEVT_RIGHT_DOWN, boost::bind (&Timeline::right_down, this, _1));
109 _main_canvas->Bind (wxEVT_MOTION, boost::bind (&Timeline::mouse_moved, this, _1));
110 _main_canvas->Bind (wxEVT_SIZE, boost::bind (&Timeline::resized, this));
111 _main_canvas->Bind (wxEVT_SCROLLWIN_TOP, boost::bind (&Timeline::scrolled, this, _1));
112 _main_canvas->Bind (wxEVT_SCROLLWIN_BOTTOM, boost::bind (&Timeline::scrolled, this, _1));
113 _main_canvas->Bind (wxEVT_SCROLLWIN_LINEUP, boost::bind (&Timeline::scrolled, this, _1));
114 _main_canvas->Bind (wxEVT_SCROLLWIN_LINEDOWN, boost::bind (&Timeline::scrolled, this, _1));
115 _main_canvas->Bind (wxEVT_SCROLLWIN_PAGEUP, boost::bind (&Timeline::scrolled, this, _1));
116 _main_canvas->Bind (wxEVT_SCROLLWIN_PAGEDOWN, boost::bind (&Timeline::scrolled, this, _1));
117 _main_canvas->Bind (wxEVT_SCROLLWIN_THUMBTRACK, boost::bind (&Timeline::scrolled, this, _1));
119 film_change (ChangeType::DONE, Film::Property::CONTENT);
121 SetMinSize (wxSize (640, 4 * pixels_per_track() + 96));
123 _film_changed_connection = film->Change.connect (bind (&Timeline::film_change, this, _1, _2));
124 _film_content_change_connection = film->ContentChange.connect (bind (&Timeline::film_content_change, this, _1, _3, _4));
126 Bind (wxEVT_TIMER, boost::bind(&Timeline::update_playhead, this));
127 _timer.Start (200, wxTIMER_CONTINUOUS);
130 _labels_canvas->ShowScrollbars (wxSHOW_SB_NEVER, wxSHOW_SB_NEVER);
135 Timeline::update_playhead ()
142 Timeline::set_pixels_per_second (double pps)
144 _pixels_per_second = max (_minimum_pixels_per_second, pps);
149 Timeline::paint_labels ()
151 wxPaintDC dc (_labels_canvas);
153 auto gc = wxGraphicsContext::Create (dc);
159 _labels_canvas->GetViewStart (&vsx, &vsy);
160 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate + tracks_y_offset());
162 _labels_view->paint (gc, {});
169 Timeline::paint_main ()
171 wxPaintDC dc (_main_canvas);
172 _main_canvas->DoPrepareDC (dc);
174 auto gc = wxGraphicsContext::Create (dc);
180 _main_canvas->GetViewStart (&vsx, &vsy);
181 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate);
183 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
185 for (auto i: _views) {
187 auto ic = dynamic_pointer_cast<TimelineContentView> (i);
189 /* Find areas of overlap with other content views, so that we can plot them */
190 list<dcpomatic::Rect<int>> overlaps;
191 for (auto j: _views) {
192 auto jc = dynamic_pointer_cast<TimelineContentView> (j);
193 /* No overlap with non-content views, views on different tracks, audio views or non-active views */
194 if (!ic || !jc || i == j || ic->track() != jc->track() || ic->track().get_value_or(2) >= 2 || !ic->active() || !jc->active()) {
198 auto r = j->bbox().intersection(i->bbox());
200 overlaps.push_back (r.get ());
204 i->paint (gc, overlaps);
208 /* Translate back as _down_point and _zoom_point do not take scroll into account */
209 gc->Translate (vsx * _x_scroll_rate, vsy * _y_scroll_rate);
210 gc->SetPen (*wxBLACK_PEN);
211 gc->SetBrush (*wxTRANSPARENT_BRUSH);
213 min (_down_point.x, _zoom_point->x),
214 min (_down_point.y, _zoom_point->y),
215 abs (_down_point.x - _zoom_point->x),
216 abs (_down_point.y - _zoom_point->y)
222 auto vp = _viewer.lock ();
223 DCPOMATIC_ASSERT (vp);
225 gc->SetPen (*wxRED_PEN);
226 auto path = gc->CreatePath ();
227 double const ph = vp->position().seconds() * pixels_per_second().get_value_or(0);
228 path.MoveToPoint (ph, 0);
229 path.AddLineToPoint (ph, pixels_per_track() * _tracks + 32);
230 gc->StrokePath (path);
237 Timeline::film_change (ChangeType type, Film::Property p)
239 if (type != ChangeType::DONE) {
243 if (p == Film::Property::CONTENT || p == Film::Property::REEL_TYPE || p == Film::Property::REEL_LENGTH) {
246 } else if (p == Film::Property::CONTENT_ORDER) {
253 Timeline::recreate_views ()
255 auto film = _film.lock ();
261 _views.push_back (_time_axis_view);
262 _views.push_back (_reels_view);
264 for (auto i: film->content ()) {
266 _views.push_back (make_shared<TimelineVideoContentView>(*this, i));
269 if (i->audio && !i->audio->mapping().mapped_output_channels().empty ()) {
270 _views.push_back (make_shared<TimelineAudioContentView>(*this, i));
273 for (auto j: i->text) {
274 _views.push_back (make_shared<TimelineTextContentView>(*this, i, j));
278 _views.push_back (make_shared<TimelineAtmosContentView>(*this, i));
289 Timeline::film_content_change (ChangeType type, int property, bool frequent)
291 if (type != ChangeType::DONE) {
297 if (property == AudioContentProperty::STREAMS || property == VideoContentProperty::FRAME_TYPE) {
299 } else if (property == ContentProperty::POSITION || property == ContentProperty::LENGTH) {
300 _reels_view->force_redraw ();
301 } else if (!frequent) {
310 place (shared_ptr<const Film> film, TimelineViewList& views, int& tracks)
312 int const base = tracks;
314 for (auto i: views) {
315 if (!dynamic_pointer_cast<T>(i)) {
319 auto cv = dynamic_pointer_cast<TimelineContentView> (i);
323 auto content = cv->content();
324 DCPTimePeriod const content_period (content->position(), content->end(film));
327 auto j = views.begin();
328 while (j != views.end()) {
329 auto test = dynamic_pointer_cast<T> (*j);
335 auto test_content = test->content();
337 test->track() && test->track().get() == t &&
338 content_period.overlap(DCPTimePeriod(test_content->position(), test_content->end(film)))) {
339 /* we have an overlap on track `t' */
347 if (j == views.end ()) {
348 /* no overlap on `t' */
354 tracks = max (tracks, t + 1);
357 return tracks - base;
361 /** Compare the mapped output channels of two TimelineViews, so we can into
362 * order of first mapped DCP channel.
364 struct AudioMappingComparator {
365 bool operator()(shared_ptr<TimelineView> a, shared_ptr<TimelineView> b) {
367 auto cva = dynamic_pointer_cast<TimelineAudioContentView>(a);
369 auto oc = cva->content()->audio->mapping().mapped_output_channels();
370 la = *min_element(boost::begin(oc), boost::end(oc));
373 auto cvb = dynamic_pointer_cast<TimelineAudioContentView>(b);
375 auto oc = cvb->content()->audio->mapping().mapped_output_channels();
376 lb = *min_element(boost::begin(oc), boost::end(oc));
384 Timeline::assign_tracks ()
399 auto film = _film.lock ();
400 DCPOMATIC_ASSERT (film);
404 for (auto i: _views) {
405 auto c = dynamic_pointer_cast<TimelineContentView>(i);
411 int const video_tracks = place<TimelineVideoContentView> (film, _views, _tracks);
412 int const text_tracks = place<TimelineTextContentView> (film, _views, _tracks);
416 bool have_atmos = false;
417 for (auto i: _views) {
418 auto cv = dynamic_pointer_cast<TimelineAtmosContentView>(i);
420 cv->set_track (_tracks);
429 /* Audio. We're sorting the views so that we get the audio views in order of increasing
434 sort(views.begin(), views.end(), AudioMappingComparator());
435 int const audio_tracks = place<TimelineAudioContentView> (film, views, _tracks);
437 _labels_view->set_video_tracks (video_tracks);
438 _labels_view->set_audio_tracks (audio_tracks);
439 _labels_view->set_text_tracks (text_tracks);
440 _labels_view->set_atmos (have_atmos);
442 _time_axis_view->set_y (tracks());
443 _reels_view->set_y (8);
448 Timeline::tracks () const
455 Timeline::setup_scrollbars ()
457 auto film = _film.lock ();
458 if (!film || !_pixels_per_second) {
462 int const h = tracks() * pixels_per_track() + tracks_y_offset() + _time_axis_view->bbox().height;
464 _labels_canvas->SetVirtualSize (_labels_view->bbox().width, h);
465 _labels_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
466 _main_canvas->SetVirtualSize (*_pixels_per_second * film->length().seconds(), h);
467 _main_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
471 shared_ptr<TimelineView>
472 Timeline::event_to_view (wxMouseEvent& ev)
474 /* Search backwards through views so that we find the uppermost one first */
475 auto i = _views.rbegin();
478 _main_canvas->GetViewStart (&vsx, &vsy);
479 Position<int> const p (ev.GetX() + vsx * _x_scroll_rate, ev.GetY() + vsy * _y_scroll_rate);
481 while (i != _views.rend() && !(*i)->bbox().contains (p)) {
482 auto cv = dynamic_pointer_cast<TimelineContentView>(*i);
486 if (i == _views.rend ()) {
495 Timeline::left_down (wxMouseEvent& ev)
498 _down_point = ev.GetPosition ();
502 left_down_select (ev);
515 Timeline::left_down_select (wxMouseEvent& ev)
517 auto view = event_to_view (ev);
518 auto content_view = dynamic_pointer_cast<TimelineContentView>(view);
523 _down_view = content_view;
524 _down_view_position = content_view->content()->position ();
527 for (auto i: _views) {
528 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
533 if (!ev.ShiftDown ()) {
534 cv->set_selected (view == i);
538 if (content_view && ev.ShiftDown ()) {
539 content_view->set_selected (!content_view->selected ());
545 /* Pre-compute the points that we might snap to */
546 for (auto i: _views) {
547 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
548 if (!cv || cv == _down_view || cv->content() == _down_view->content()) {
552 auto film = _film.lock ();
553 DCPOMATIC_ASSERT (film);
555 _start_snaps.push_back (cv->content()->position());
556 _end_snaps.push_back (cv->content()->position());
557 _start_snaps.push_back (cv->content()->end(film));
558 _end_snaps.push_back (cv->content()->end(film));
560 for (auto i: cv->content()->reel_split_points(film)) {
561 _start_snaps.push_back (i);
565 /* Tell everyone that things might change frequently during the drag */
566 _down_view->content()->set_change_signals_frequent (true);
572 Timeline::left_up (wxMouseEvent& ev)
592 Timeline::left_up_select (wxMouseEvent& ev)
595 _down_view->content()->set_change_signals_frequent (false);
598 _content_panel->set_selection (selected_content ());
599 /* Since we may have just set change signals back to `not-frequent', we have to
600 make sure this position change is signalled, even if the position value has
601 not changed since the last time it was set (with frequent=true). This is
604 set_position_from_event (ev, true);
606 /* Clear up up the stuff we don't do during drag */
611 _start_snaps.clear ();
617 Timeline::left_up_zoom (wxMouseEvent& ev)
619 _zoom_point = ev.GetPosition ();
622 _main_canvas->GetViewStart (&vsx, &vsy);
624 wxPoint top_left(min(_down_point.x, _zoom_point->x), min(_down_point.y, _zoom_point->y));
625 wxPoint bottom_right(max(_down_point.x, _zoom_point->x), max(_down_point.y, _zoom_point->y));
627 if ((bottom_right.x - top_left.x) < 8 || (bottom_right.y - top_left.y) < 8) {
628 /* Very small zoom rectangle: we assume it wasn't intentional */
629 _zoom_point = optional<wxPoint> ();
634 auto const time_left = DCPTime::from_seconds((top_left.x + vsx) / *_pixels_per_second);
635 auto const time_right = DCPTime::from_seconds((bottom_right.x + vsx) / *_pixels_per_second);
636 set_pixels_per_second (double(GetSize().GetWidth()) / (time_right.seconds() - time_left.seconds()));
638 double const tracks_top = double(top_left.y - tracks_y_offset()) / _pixels_per_track;
639 double const tracks_bottom = double(bottom_right.y - tracks_y_offset()) / _pixels_per_track;
640 set_pixels_per_track (lrint(GetSize().GetHeight() / (tracks_bottom - tracks_top)));
643 int const y = (tracks_top * _pixels_per_track + tracks_y_offset()) / _y_scroll_rate;
644 _main_canvas->Scroll (time_left.seconds() * *_pixels_per_second / _x_scroll_rate, y);
645 _labels_canvas->Scroll (0, y);
647 _zoom_point = optional<wxPoint> ();
653 Timeline::set_pixels_per_track (int h)
655 _pixels_per_track = max(_minimum_pixels_per_track, h);
660 Timeline::mouse_moved (wxMouseEvent& ev)
664 mouse_moved_select (ev);
667 mouse_moved_zoom (ev);
678 Timeline::mouse_moved_select (wxMouseEvent& ev)
684 set_position_from_event (ev);
689 Timeline::mouse_moved_zoom (wxMouseEvent& ev)
695 _zoom_point = ev.GetPosition ();
701 Timeline::right_down (wxMouseEvent& ev)
705 right_down_select (ev);
709 set_pixels_per_second (*_pixels_per_second / 2);
710 set_pixels_per_track (_pixels_per_track / 2);
723 Timeline::right_down_select (wxMouseEvent& ev)
725 auto view = event_to_view (ev);
726 auto cv = dynamic_pointer_cast<TimelineContentView> (view);
731 if (!cv->selected ()) {
733 cv->set_selected (true);
736 _menu.popup (_film, selected_content (), selected_views (), ev.GetPosition ());
741 Timeline::maybe_snap (DCPTime a, DCPTime b, optional<DCPTime>& nearest_distance) const
743 auto const d = a - b;
744 if (!nearest_distance || d.abs() < nearest_distance.get().abs()) {
745 nearest_distance = d;
751 Timeline::set_position_from_event (wxMouseEvent& ev, bool force_emit)
753 if (!_pixels_per_second) {
757 double const pps = _pixels_per_second.get ();
759 auto const p = ev.GetPosition();
762 /* We haven't moved yet; in that case, we must move the mouse some reasonable distance
763 before the drag is considered to have started.
765 int const dist = sqrt (pow (p.x - _down_point.x, 2) + pow (p.y - _down_point.y, 2));
776 auto new_position = _down_view_position + DCPTime::from_seconds ((p.x - _down_point.x) / pps);
778 auto film = _film.lock ();
779 DCPOMATIC_ASSERT (film);
782 auto const new_end = new_position + _down_view->content()->length_after_trim(film);
783 /* Signed `distance' to nearest thing (i.e. negative is left on the timeline,
786 optional<DCPTime> nearest_distance;
788 /* Find the nearest snap point */
790 for (auto i: _start_snaps) {
791 maybe_snap (i, new_position, nearest_distance);
794 for (auto i: _end_snaps) {
795 maybe_snap (i, new_end, nearest_distance);
798 if (nearest_distance) {
799 /* Snap if it's close; `close' means within a proportion of the time on the timeline */
800 if (nearest_distance.get().abs() < DCPTime::from_seconds ((width() / pps) / 64)) {
801 new_position += nearest_distance.get ();
806 if (new_position < DCPTime ()) {
807 new_position = DCPTime ();
810 _down_view->content()->set_position (film, new_position, force_emit);
812 film->set_sequence (false);
817 Timeline::force_redraw (dcpomatic::Rect<int> const & r)
819 _main_canvas->RefreshRect (wxRect (r.x, r.y, r.width, r.height), false);
823 shared_ptr<const Film>
824 Timeline::film () const
826 return _film.lock ();
833 if (_main_canvas->GetSize().GetWidth() > 0 && _first_resize) {
835 _first_resize = false;
842 Timeline::clear_selection ()
844 for (auto i: _views) {
845 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView>(i);
847 cv->set_selected (false);
853 TimelineContentViewList
854 Timeline::selected_views () const
856 TimelineContentViewList sel;
858 for (auto i: _views) {
859 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
860 if (cv && cv->selected()) {
870 Timeline::selected_content () const
874 for (auto i: selected_views()) {
875 sel.push_back(i->content());
883 Timeline::set_selection (ContentList selection)
885 for (auto i: _views) {
886 auto cv = dynamic_pointer_cast<TimelineContentView> (i);
888 cv->set_selected (find (selection.begin(), selection.end(), cv->content ()) != selection.end ());
895 Timeline::tracks_y_offset () const
897 return _reels_view->bbox().height + 4;
902 Timeline::width () const
904 return _main_canvas->GetVirtualSize().GetWidth();
909 Timeline::scrolled (wxScrollWinEvent& ev)
911 if (ev.GetOrientation() == wxVERTICAL) {
913 _main_canvas->GetViewStart (&x, &y);
914 _labels_canvas->Scroll (0, y);
921 Timeline::tool_clicked (Tool t)
939 Timeline::zoom_all ()
941 auto film = _film.lock ();
942 DCPOMATIC_ASSERT (film);
943 set_pixels_per_second ((_main_canvas->GetSize().GetWidth() - 32) / film->length().seconds());
944 set_pixels_per_track ((_main_canvas->GetSize().GetHeight() - tracks_y_offset() - _time_axis_view->bbox().height - 32) / _tracks);
946 _main_canvas->Scroll (0, 0);
947 _labels_canvas->Scroll (0, 0);