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/scope_guard.h>
42 #include <dcp/warnings.h>
43 LIBDCP_DISABLE_WARNINGS
44 #include <wx/graphics.h>
45 LIBDCP_ENABLE_WARNINGS
51 using std::dynamic_pointer_cast;
53 using std::make_shared;
56 using std::shared_ptr;
59 using boost::optional;
60 using namespace dcpomatic;
61 #if BOOST_VERSION >= 106100
62 using namespace boost::placeholders;
66 /* 3 hours in 640 pixels */
67 double const Timeline::_minimum_pixels_per_second = 640.0 / (60 * 60 * 3);
68 int const Timeline::_minimum_pixels_per_track = 16;
71 Timeline::Timeline(wxWindow* parent, ContentPanel* cp, shared_ptr<Film> film, FilmViewer& viewer)
72 : wxPanel (parent, wxID_ANY)
73 , _labels_canvas (new wxScrolledCanvas (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE))
74 , _main_canvas (new wxScrolledCanvas (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE))
78 , _time_axis_view (new TimelineTimeAxisView (*this, 64))
79 , _reels_view (new TimelineReelsView (*this, 32))
80 , _labels_view (new TimelineLabelsView (*this))
83 , _down_view_position (0)
85 , _menu (this, viewer)
90 , _pixels_per_track (48)
91 , _first_resize (true)
95 _labels_canvas->SetDoubleBuffered (true);
96 _main_canvas->SetDoubleBuffered (true);
99 auto sizer = new wxBoxSizer (wxHORIZONTAL);
100 sizer->Add (_labels_canvas, 0, wxEXPAND);
101 _labels_canvas->SetMinSize (wxSize (_labels_view->bbox().width, -1));
102 sizer->Add (_main_canvas, 1, wxEXPAND);
105 _labels_canvas->Bind (wxEVT_PAINT, boost::bind (&Timeline::paint_labels, this));
106 _main_canvas->Bind (wxEVT_PAINT, boost::bind (&Timeline::paint_main, this));
107 _main_canvas->Bind (wxEVT_LEFT_DOWN, boost::bind (&Timeline::left_down, this, _1));
108 _main_canvas->Bind (wxEVT_LEFT_UP, boost::bind (&Timeline::left_up, this, _1));
109 _main_canvas->Bind (wxEVT_RIGHT_DOWN, boost::bind (&Timeline::right_down, this, _1));
110 _main_canvas->Bind (wxEVT_MOTION, boost::bind (&Timeline::mouse_moved, this, _1));
111 _main_canvas->Bind (wxEVT_SIZE, boost::bind (&Timeline::resized, this));
112 _main_canvas->Bind (wxEVT_MOUSEWHEEL, boost::bind(&Timeline::mouse_wheel_turned, this, _1));
113 _main_canvas->Bind (wxEVT_SCROLLWIN_TOP, boost::bind (&Timeline::scrolled, this, _1));
114 _main_canvas->Bind (wxEVT_SCROLLWIN_BOTTOM, boost::bind (&Timeline::scrolled, this, _1));
115 _main_canvas->Bind (wxEVT_SCROLLWIN_LINEUP, boost::bind (&Timeline::scrolled, this, _1));
116 _main_canvas->Bind (wxEVT_SCROLLWIN_LINEDOWN, boost::bind (&Timeline::scrolled, this, _1));
117 _main_canvas->Bind (wxEVT_SCROLLWIN_PAGEUP, boost::bind (&Timeline::scrolled, this, _1));
118 _main_canvas->Bind (wxEVT_SCROLLWIN_PAGEDOWN, boost::bind (&Timeline::scrolled, this, _1));
119 _main_canvas->Bind (wxEVT_SCROLLWIN_THUMBTRACK, boost::bind (&Timeline::scrolled, this, _1));
121 film_change(ChangeType::DONE, FilmProperty::CONTENT);
123 SetMinSize (wxSize (640, 4 * pixels_per_track() + 96));
125 _film_changed_connection = film->Change.connect (bind (&Timeline::film_change, this, _1, _2));
126 _film_content_change_connection = film->ContentChange.connect (bind (&Timeline::film_content_change, this, _1, _3, _4));
128 Bind (wxEVT_TIMER, boost::bind(&Timeline::update_playhead, this));
129 _timer.Start (200, wxTIMER_CONTINUOUS);
132 _labels_canvas->ShowScrollbars (wxSHOW_SB_NEVER, wxSHOW_SB_NEVER);
137 Timeline::mouse_wheel_turned(wxMouseEvent& event)
139 auto const rotation = event.GetWheelRotation();
141 if (event.ControlDown()) {
142 /* On my mouse one click of the scroll wheel is 120, and it's -ve when
143 * scrolling the wheel towards me.
145 auto const scale = rotation > 0 ?
146 (1.0 / (rotation / 90.0)) :
151 _main_canvas->GetViewStart(&before_start_x, &before_start_y);
153 auto const before_pps = _pixels_per_second.get_value_or(1);
154 auto const before_pos = _last_mouse_wheel_x && *_last_mouse_wheel_x == event.GetX() ?
155 *_last_mouse_wheel_time :
156 (before_start_x * _x_scroll_rate + event.GetX()) / before_pps;
158 set_pixels_per_second(before_pps * scale);
161 auto after_left = std::max(0.0, before_pos * _pixels_per_second.get_value_or(1) - event.GetX());
162 _main_canvas->Scroll(after_left / _x_scroll_rate, before_start_y);
163 _labels_canvas->Scroll(0, before_start_y);
166 if (!_last_mouse_wheel_x || *_last_mouse_wheel_x != event.GetX()) {
167 _last_mouse_wheel_x = event.GetX();
168 _last_mouse_wheel_time = before_pos;
170 } else if (event.ShiftDown()) {
173 _main_canvas->GetViewStart(&before_start_x, &before_start_y);
174 auto const width = _main_canvas->GetSize().GetWidth();
175 _main_canvas->Scroll(std::max(0.0, before_start_x - rotation * 100.0 / width), before_start_y);
181 Timeline::update_playhead ()
188 Timeline::set_pixels_per_second (double pps)
190 _pixels_per_second = max (_minimum_pixels_per_second, pps);
195 Timeline::paint_labels ()
197 wxPaintDC dc (_labels_canvas);
199 auto film = _film.lock();
200 if (film->content().empty()) {
204 auto gc = wxGraphicsContext::Create (dc);
209 dcp::ScopeGuard sg = [gc]() { delete gc; };
212 _labels_canvas->GetViewStart (&vsx, &vsy);
213 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate + tracks_y_offset());
215 _labels_view->paint (gc, {});
220 Timeline::paint_main ()
222 wxPaintDC dc (_main_canvas);
225 auto film = _film.lock();
226 if (film->content().empty()) {
230 _main_canvas->DoPrepareDC (dc);
232 auto gc = wxGraphicsContext::Create (dc);
237 dcp::ScopeGuard sg = [gc]() { delete gc; };
239 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
241 for (auto i: _views) {
243 auto ic = dynamic_pointer_cast<TimelineContentView> (i);
245 /* Find areas of overlap with other content views, so that we can plot them */
246 list<dcpomatic::Rect<int>> overlaps;
247 for (auto j: _views) {
248 auto jc = dynamic_pointer_cast<TimelineContentView> (j);
249 /* No overlap with non-content views, views on different tracks, audio views or non-active views */
250 if (!ic || !jc || i == j || ic->track() != jc->track() || ic->track().get_value_or(2) >= 2 || !ic->active() || !jc->active()) {
254 auto r = j->bbox().intersection(i->bbox());
256 overlaps.push_back (r.get ());
260 i->paint (gc, overlaps);
264 gc->SetPen(gui_is_dark() ? *wxWHITE_PEN : *wxBLACK_PEN);
265 gc->SetBrush (*wxTRANSPARENT_BRUSH);
267 min (_down_point.x, _zoom_point->x),
268 min (_down_point.y, _zoom_point->y),
269 abs (_down_point.x - _zoom_point->x),
270 abs (_down_point.y - _zoom_point->y)
276 gc->SetPen (*wxRED_PEN);
277 auto path = gc->CreatePath ();
278 double const ph = _viewer.position().seconds() * pixels_per_second().get_value_or(0);
279 path.MoveToPoint (ph, 0);
280 path.AddLineToPoint (ph, pixels_per_track() * _tracks + 32);
281 gc->StrokePath (path);
286 Timeline::film_change(ChangeType type, FilmProperty p)
288 if (type != ChangeType::DONE) {
292 if (p == FilmProperty::CONTENT || p == FilmProperty::REEL_TYPE || p == FilmProperty::REEL_LENGTH) {
295 } else if (p == FilmProperty::CONTENT_ORDER) {
302 Timeline::recreate_views ()
304 auto film = _film.lock ();
310 _views.push_back (_time_axis_view);
311 _views.push_back (_reels_view);
313 for (auto i: film->content ()) {
315 _views.push_back (make_shared<TimelineVideoContentView>(*this, i));
318 if (i->has_mapped_audio()) {
319 _views.push_back (make_shared<TimelineAudioContentView>(*this, i));
322 for (auto j: i->text) {
323 _views.push_back (make_shared<TimelineTextContentView>(*this, i, j));
327 _views.push_back (make_shared<TimelineAtmosContentView>(*this, i));
338 Timeline::film_content_change (ChangeType type, int property, bool frequent)
340 if (type != ChangeType::DONE) {
346 if (property == AudioContentProperty::STREAMS || property == VideoContentProperty::FRAME_TYPE) {
348 } else if (property == ContentProperty::POSITION || property == ContentProperty::LENGTH) {
349 _reels_view->force_redraw ();
350 } else if (!frequent) {
359 place (shared_ptr<const Film> film, TimelineViewList& views, int& tracks)
361 int const base = tracks;
363 for (auto i: views) {
364 if (!dynamic_pointer_cast<T>(i)) {
368 auto cv = dynamic_pointer_cast<TimelineContentView> (i);
369 DCPOMATIC_ASSERT(cv);
373 auto content = cv->content();
374 DCPTimePeriod const content_period = content->period(film);
377 auto j = views.begin();
378 while (j != views.end()) {
379 auto test = dynamic_pointer_cast<T> (*j);
385 auto test_content = test->content();
387 test->track() && test->track().get() == t &&
388 content_period.overlap(test_content->period(film))
390 /* we have an overlap on track `t' */
398 if (j == views.end ()) {
399 /* no overlap on `t' */
405 tracks = max (tracks, t + 1);
408 return tracks - base;
412 /** Compare the mapped output channels of two TimelineViews, so we can into
413 * order of first mapped DCP channel.
415 struct AudioMappingComparator {
416 bool operator()(shared_ptr<TimelineView> a, shared_ptr<TimelineView> b) {
418 auto cva = dynamic_pointer_cast<TimelineAudioContentView>(a);
420 auto oc = cva->content()->audio->mapping().mapped_output_channels();
421 la = *min_element(boost::begin(oc), boost::end(oc));
424 auto cvb = dynamic_pointer_cast<TimelineAudioContentView>(b);
426 auto oc = cvb->content()->audio->mapping().mapped_output_channels();
427 lb = *min_element(boost::begin(oc), boost::end(oc));
435 Timeline::assign_tracks ()
450 auto film = _film.lock ();
451 DCPOMATIC_ASSERT (film);
455 for (auto i: _views) {
456 auto c = dynamic_pointer_cast<TimelineContentView>(i);
462 int const video_tracks = place<TimelineVideoContentView> (film, _views, _tracks);
463 int const text_tracks = place<TimelineTextContentView> (film, _views, _tracks);
467 bool have_atmos = false;
468 for (auto i: _views) {
469 auto cv = dynamic_pointer_cast<TimelineAtmosContentView>(i);
471 cv->set_track (_tracks);
480 /* Audio. We're sorting the views so that we get the audio views in order of increasing
485 sort(views.begin(), views.end(), AudioMappingComparator());
486 int const audio_tracks = place<TimelineAudioContentView> (film, views, _tracks);
488 _labels_view->set_video_tracks (video_tracks);
489 _labels_view->set_audio_tracks (audio_tracks);
490 _labels_view->set_text_tracks (text_tracks);
491 _labels_view->set_atmos (have_atmos);
493 _time_axis_view->set_y (tracks());
494 _reels_view->set_y (8);
499 Timeline::tracks () const
506 Timeline::setup_scrollbars ()
508 auto film = _film.lock ();
509 if (!film || !_pixels_per_second) {
513 int const h = tracks() * pixels_per_track() + tracks_y_offset() + _time_axis_view->bbox().height;
515 _labels_canvas->SetVirtualSize (_labels_view->bbox().width, h);
516 _labels_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
517 _main_canvas->SetVirtualSize (*_pixels_per_second * film->length().seconds(), h);
518 _main_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
522 shared_ptr<TimelineView>
523 Timeline::event_to_view (wxMouseEvent& ev)
525 /* Search backwards through views so that we find the uppermost one first */
526 auto i = _views.rbegin();
529 _main_canvas->GetViewStart (&vsx, &vsy);
530 Position<int> const p (ev.GetX() + vsx * _x_scroll_rate, ev.GetY() + vsy * _y_scroll_rate);
532 while (i != _views.rend() && !(*i)->bbox().contains (p)) {
536 if (i == _views.rend ()) {
545 Timeline::left_down (wxMouseEvent& ev)
548 _down_point = ev.GetPosition ();
552 left_down_select (ev);
565 Timeline::left_down_select (wxMouseEvent& ev)
567 auto view = event_to_view (ev);
568 auto content_view = dynamic_pointer_cast<TimelineContentView>(view);
573 _down_view = content_view;
574 _down_view_position = content_view->content()->position ();
577 if (dynamic_pointer_cast<TimelineTimeAxisView>(view)) {
579 _main_canvas->GetViewStart(&vsx, &vsy);
580 _viewer.seek(DCPTime::from_seconds((ev.GetPosition().x + vsx * _x_scroll_rate) / _pixels_per_second.get_value_or(1)), true);
583 for (auto i: _views) {
584 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
589 if (!ev.ShiftDown ()) {
590 cv->set_selected (view == i);
594 if (content_view && ev.ShiftDown ()) {
595 content_view->set_selected (!content_view->selected ());
601 /* Pre-compute the points that we might snap to */
602 for (auto i: _views) {
603 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
604 if (!cv || cv == _down_view || cv->content() == _down_view->content()) {
608 auto film = _film.lock ();
609 DCPOMATIC_ASSERT (film);
611 _start_snaps.push_back (cv->content()->position());
612 _end_snaps.push_back (cv->content()->position());
613 _start_snaps.push_back (cv->content()->end(film));
614 _end_snaps.push_back (cv->content()->end(film));
616 for (auto i: cv->content()->reel_split_points(film)) {
617 _start_snaps.push_back (i);
621 /* Tell everyone that things might change frequently during the drag */
622 _down_view->content()->set_change_signals_frequent (true);
628 Timeline::left_up (wxMouseEvent& ev)
648 Timeline::left_up_select (wxMouseEvent& ev)
651 _down_view->content()->set_change_signals_frequent (false);
654 _content_panel->set_selection (selected_content ());
655 /* Since we may have just set change signals back to `not-frequent', we have to
656 make sure this position change is signalled, even if the position value has
657 not changed since the last time it was set (with frequent=true). This is
660 set_position_from_event (ev, true);
662 /* Clear up up the stuff we don't do during drag */
667 _start_snaps.clear ();
673 Timeline::left_up_zoom (wxMouseEvent& ev)
675 _zoom_point = ev.GetPosition ();
678 _main_canvas->GetViewStart (&vsx, &vsy);
680 wxPoint top_left(min(_down_point.x, _zoom_point->x), min(_down_point.y, _zoom_point->y));
681 wxPoint bottom_right(max(_down_point.x, _zoom_point->x), max(_down_point.y, _zoom_point->y));
683 if ((bottom_right.x - top_left.x) < 8 || (bottom_right.y - top_left.y) < 8) {
684 /* Very small zoom rectangle: we assume it wasn't intentional */
685 _zoom_point = optional<wxPoint> ();
690 auto const time_left = DCPTime::from_seconds((top_left.x + vsx) / *_pixels_per_second);
691 auto const time_right = DCPTime::from_seconds((bottom_right.x + vsx) / *_pixels_per_second);
692 set_pixels_per_second (double(GetSize().GetWidth()) / (time_right.seconds() - time_left.seconds()));
694 double const tracks_top = double(top_left.y - tracks_y_offset()) / _pixels_per_track;
695 double const tracks_bottom = double(bottom_right.y - tracks_y_offset()) / _pixels_per_track;
696 set_pixels_per_track (lrint(GetSize().GetHeight() / (tracks_bottom - tracks_top)));
699 int const y = (tracks_top * _pixels_per_track + tracks_y_offset()) / _y_scroll_rate;
700 _main_canvas->Scroll (time_left.seconds() * *_pixels_per_second / _x_scroll_rate, y);
701 _labels_canvas->Scroll (0, y);
703 _zoom_point = optional<wxPoint> ();
709 Timeline::set_pixels_per_track (int h)
711 _pixels_per_track = max(_minimum_pixels_per_track, h);
716 Timeline::mouse_moved (wxMouseEvent& ev)
720 mouse_moved_select (ev);
723 mouse_moved_zoom (ev);
734 Timeline::mouse_moved_select (wxMouseEvent& ev)
740 set_position_from_event (ev);
745 Timeline::mouse_moved_zoom (wxMouseEvent& ev)
751 _zoom_point = ev.GetPosition ();
758 Timeline::right_down (wxMouseEvent& ev)
762 right_down_select (ev);
766 set_pixels_per_second (*_pixels_per_second / 2);
767 set_pixels_per_track (_pixels_per_track / 2);
780 Timeline::right_down_select (wxMouseEvent& ev)
782 auto view = event_to_view (ev);
783 auto cv = dynamic_pointer_cast<TimelineContentView> (view);
788 if (!cv->selected ()) {
790 cv->set_selected (true);
793 _menu.popup (_film, selected_content (), selected_views (), ev.GetPosition ());
798 Timeline::maybe_snap (DCPTime a, DCPTime b, optional<DCPTime>& nearest_distance) const
800 auto const d = a - b;
801 if (!nearest_distance || d.abs() < nearest_distance.get().abs()) {
802 nearest_distance = d;
808 Timeline::set_position_from_event (wxMouseEvent& ev, bool force_emit)
810 if (!_pixels_per_second) {
814 double const pps = _pixels_per_second.get ();
816 auto const p = ev.GetPosition();
819 /* We haven't moved yet; in that case, we must move the mouse some reasonable distance
820 before the drag is considered to have started.
822 int const dist = sqrt (pow (p.x - _down_point.x, 2) + pow (p.y - _down_point.y, 2));
833 auto new_position = _down_view_position + DCPTime::from_seconds ((p.x - _down_point.x) / pps);
835 auto film = _film.lock ();
836 DCPOMATIC_ASSERT (film);
839 auto const new_end = new_position + _down_view->content()->length_after_trim(film);
840 /* Signed `distance' to nearest thing (i.e. negative is left on the timeline,
843 optional<DCPTime> nearest_distance;
845 /* Find the nearest snap point */
847 for (auto i: _start_snaps) {
848 maybe_snap (i, new_position, nearest_distance);
851 for (auto i: _end_snaps) {
852 maybe_snap (i, new_end, nearest_distance);
855 if (nearest_distance) {
856 /* Snap if it's close; `close' means within a proportion of the time on the timeline */
857 if (nearest_distance.get().abs() < DCPTime::from_seconds ((width() / pps) / 64)) {
858 new_position += nearest_distance.get ();
863 if (new_position < DCPTime ()) {
864 new_position = DCPTime ();
867 _down_view->content()->set_position (film, new_position, force_emit);
869 film->set_sequence (false);
874 Timeline::force_redraw (dcpomatic::Rect<int> const & r)
876 _main_canvas->RefreshRect (wxRect (r.x, r.y, r.width, r.height), false);
880 shared_ptr<const Film>
881 Timeline::film () const
883 return _film.lock ();
890 if (_main_canvas->GetSize().GetWidth() > 0 && _first_resize) {
892 _first_resize = false;
899 Timeline::clear_selection ()
901 for (auto i: _views) {
902 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView>(i);
904 cv->set_selected (false);
910 TimelineContentViewList
911 Timeline::selected_views () const
913 TimelineContentViewList sel;
915 for (auto i: _views) {
916 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
917 if (cv && cv->selected()) {
927 Timeline::selected_content () const
931 for (auto i: selected_views()) {
932 sel.push_back(i->content());
940 Timeline::set_selection (ContentList selection)
942 for (auto i: _views) {
943 auto cv = dynamic_pointer_cast<TimelineContentView> (i);
945 cv->set_selected (find (selection.begin(), selection.end(), cv->content ()) != selection.end ());
952 Timeline::tracks_y_offset () const
954 return _reels_view->bbox().height + 4;
959 Timeline::width () const
961 return _main_canvas->GetVirtualSize().GetWidth();
966 Timeline::scrolled (wxScrollWinEvent& ev)
968 if (ev.GetOrientation() == wxVERTICAL) {
970 _main_canvas->GetViewStart (&x, &y);
971 _labels_canvas->Scroll (0, y);
978 Timeline::tool_clicked (Tool t)
996 Timeline::zoom_all ()
998 auto film = _film.lock ();
999 DCPOMATIC_ASSERT (film);
1000 set_pixels_per_second((_main_canvas->GetSize().GetWidth() - 32) / std::max(1.0, film->length().seconds()));
1001 set_pixels_per_track((_main_canvas->GetSize().GetHeight() - tracks_y_offset() - _time_axis_view->bbox().height - 32) / std::max(1, _tracks));
1002 setup_scrollbars ();
1003 _main_canvas->Scroll (0, 0);
1004 _labels_canvas->Scroll (0, 0);
1010 Timeline::keypress(wxKeyEvent const& event)
1012 if (event.GetKeyCode() == WXK_DELETE) {
1013 auto film = _film.lock();
1014 DCPOMATIC_ASSERT(film);
1015 film->remove_content(selected_content());
1017 switch (event.GetRawKeyCode()) {
1019 set_pixels_per_second(_pixels_per_second.get_value_or(1) * 2);
1023 set_pixels_per_second(_pixels_per_second.get_value_or(1) / 2);