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 "film_editor.h"
23 #include "timeline_time_axis_view.h"
24 #include "timeline_reels_view.h"
25 #include "timeline_labels_view.h"
26 #include "timeline_video_content_view.h"
27 #include "timeline_audio_content_view.h"
28 #include "timeline_text_content_view.h"
29 #include "timeline_atmos_content_view.h"
30 #include "content_panel.h"
32 #include "film_viewer.h"
34 #include "lib/playlist.h"
35 #include "lib/image_content.h"
36 #include "lib/timer.h"
37 #include "lib/audio_content.h"
38 #include "lib/text_content.h"
39 #include "lib/video_content.h"
40 #include "lib/atmos_mxf_content.h"
41 #include <wx/graphics.h>
51 using std::shared_ptr;
53 using std::dynamic_pointer_cast;
54 using std::make_shared;
56 using boost::optional;
57 using namespace dcpomatic;
58 #if BOOST_VERSION >= 106100
59 using namespace boost::placeholders;
62 /* 3 hours in 640 pixels */
63 double const Timeline::_minimum_pixels_per_second = 640.0 / (60 * 60 * 3);
64 int const Timeline::_minimum_pixels_per_track = 16;
66 Timeline::Timeline (wxWindow* parent, ContentPanel* cp, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
67 : wxPanel (parent, wxID_ANY)
68 , _labels_canvas (new wxScrolledCanvas (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE))
69 , _main_canvas (new wxScrolledCanvas (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE))
73 , _time_axis_view (new TimelineTimeAxisView (*this, 64))
74 , _reels_view (new TimelineReelsView (*this, 32))
75 , _labels_view (new TimelineLabelsView (*this))
78 , _down_view_position (0)
85 , _pixels_per_track (48)
86 , _first_resize (true)
90 _labels_canvas->SetDoubleBuffered (true);
91 _main_canvas->SetDoubleBuffered (true);
94 auto sizer = new wxBoxSizer (wxHORIZONTAL);
95 sizer->Add (_labels_canvas, 0, wxEXPAND);
96 _labels_canvas->SetMinSize (wxSize (_labels_view->bbox().width, -1));
97 sizer->Add (_main_canvas, 1, wxEXPAND);
100 _labels_canvas->Bind (wxEVT_PAINT, boost::bind (&Timeline::paint_labels, this));
101 _main_canvas->Bind (wxEVT_PAINT, boost::bind (&Timeline::paint_main, this));
102 _main_canvas->Bind (wxEVT_LEFT_DOWN, boost::bind (&Timeline::left_down, this, _1));
103 _main_canvas->Bind (wxEVT_LEFT_UP, boost::bind (&Timeline::left_up, this, _1));
104 _main_canvas->Bind (wxEVT_RIGHT_DOWN, boost::bind (&Timeline::right_down, this, _1));
105 _main_canvas->Bind (wxEVT_MOTION, boost::bind (&Timeline::mouse_moved, this, _1));
106 _main_canvas->Bind (wxEVT_SIZE, boost::bind (&Timeline::resized, this));
107 _main_canvas->Bind (wxEVT_SCROLLWIN_TOP, boost::bind (&Timeline::scrolled, this, _1));
108 _main_canvas->Bind (wxEVT_SCROLLWIN_BOTTOM, boost::bind (&Timeline::scrolled, this, _1));
109 _main_canvas->Bind (wxEVT_SCROLLWIN_LINEUP, boost::bind (&Timeline::scrolled, this, _1));
110 _main_canvas->Bind (wxEVT_SCROLLWIN_LINEDOWN, boost::bind (&Timeline::scrolled, this, _1));
111 _main_canvas->Bind (wxEVT_SCROLLWIN_PAGEUP, boost::bind (&Timeline::scrolled, this, _1));
112 _main_canvas->Bind (wxEVT_SCROLLWIN_PAGEDOWN, boost::bind (&Timeline::scrolled, this, _1));
113 _main_canvas->Bind (wxEVT_SCROLLWIN_THUMBTRACK, boost::bind (&Timeline::scrolled, this, _1));
115 film_change (ChangeType::DONE, Film::Property::CONTENT);
117 SetMinSize (wxSize (640, 4 * pixels_per_track() + 96));
119 _film_changed_connection = film->Change.connect (bind (&Timeline::film_change, this, _1, _2));
120 _film_content_change_connection = film->ContentChange.connect (bind (&Timeline::film_content_change, this, _1, _3, _4));
122 Bind (wxEVT_TIMER, boost::bind(&Timeline::update_playhead, this));
123 _timer.Start (200, wxTIMER_CONTINUOUS);
126 _labels_canvas->ShowScrollbars (wxSHOW_SB_NEVER, wxSHOW_SB_NEVER);
130 Timeline::update_playhead ()
136 Timeline::set_pixels_per_second (double pps)
138 _pixels_per_second = max (_minimum_pixels_per_second, pps);
142 Timeline::paint_labels ()
144 wxPaintDC dc (_labels_canvas);
146 auto gc = wxGraphicsContext::Create (dc);
152 _labels_canvas->GetViewStart (&vsx, &vsy);
153 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate + tracks_y_offset());
155 _labels_view->paint (gc, list<dcpomatic::Rect<int> >());
161 Timeline::paint_main ()
163 wxPaintDC dc (_main_canvas);
164 _main_canvas->DoPrepareDC (dc);
166 auto gc = wxGraphicsContext::Create (dc);
172 _main_canvas->GetViewStart (&vsx, &vsy);
173 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate);
175 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
177 for (auto i: _views) {
179 auto ic = dynamic_pointer_cast<TimelineContentView> (i);
181 /* Find areas of overlap with other content views, so that we can plot them */
182 list<dcpomatic::Rect<int>> overlaps;
183 for (auto j: _views) {
184 auto jc = dynamic_pointer_cast<TimelineContentView> (j);
185 /* No overlap with non-content views, views no different tracks, audio views or non-active views */
186 if (!ic || !jc || i == j || ic->track() != jc->track() || ic->track().get_value_or(2) >= 2 || !ic->active() || !jc->active()) {
190 auto r = j->bbox().intersection(i->bbox());
192 overlaps.push_back (r.get ());
196 i->paint (gc, overlaps);
200 /* Translate back as _down_point and _zoom_point do not take scroll into account */
201 gc->Translate (vsx * _x_scroll_rate, vsy * _y_scroll_rate);
202 gc->SetPen (*wxBLACK_PEN);
203 gc->SetBrush (*wxTRANSPARENT_BRUSH);
205 min (_down_point.x, _zoom_point->x),
206 min (_down_point.y, _zoom_point->y),
207 abs (_down_point.x - _zoom_point->x),
208 abs (_down_point.y - _zoom_point->y)
214 auto vp = _viewer.lock ();
215 DCPOMATIC_ASSERT (vp);
217 gc->SetPen (*wxRED_PEN);
218 auto path = gc->CreatePath ();
219 double const ph = vp->position().seconds() * pixels_per_second().get_value_or(0);
220 path.MoveToPoint (ph, 0);
221 path.AddLineToPoint (ph, pixels_per_track() * _tracks + 32);
222 gc->StrokePath (path);
228 Timeline::film_change (ChangeType type, Film::Property p)
230 if (type != ChangeType::DONE) {
234 if (p == Film::Property::CONTENT || p == Film::Property::REEL_TYPE || p == Film::Property::REEL_LENGTH) {
237 } else if (p == Film::Property::CONTENT_ORDER) {
243 Timeline::recreate_views ()
245 auto film = _film.lock ();
251 _views.push_back (_time_axis_view);
252 _views.push_back (_reels_view);
254 for (auto i: film->content ()) {
256 _views.push_back (make_shared<TimelineVideoContentView>(*this, i));
259 if (i->audio && !i->audio->mapping().mapped_output_channels().empty ()) {
260 _views.push_back (make_shared<TimelineAudioContentView>(*this, i));
263 for (auto j: i->text) {
264 _views.push_back (make_shared<TimelineTextContentView>(*this, i, j));
268 _views.push_back (make_shared<TimelineAtmosContentView>(*this, i));
278 Timeline::film_content_change (ChangeType type, int property, bool frequent)
280 if (type != ChangeType::DONE) {
286 if (property == AudioContentProperty::STREAMS || property == VideoContentProperty::FRAME_TYPE) {
288 } else if (property == ContentProperty::POSITION || property == ContentProperty::LENGTH) {
289 _reels_view->force_redraw ();
290 } else if (!frequent) {
298 place (shared_ptr<const Film> film, TimelineViewList& views, int& tracks)
300 int const base = tracks;
302 for (auto i: views) {
303 if (!dynamic_pointer_cast<T>(i)) {
307 auto cv = dynamic_pointer_cast<TimelineContentView> (i);
311 auto content = cv->content();
312 DCPTimePeriod const content_period (content->position(), content->end(film));
315 auto j = views.begin();
316 while (j != views.end()) {
317 auto test = dynamic_pointer_cast<T> (*j);
323 auto test_content = test->content();
325 test->track() && test->track().get() == t &&
326 content_period.overlap(DCPTimePeriod(test_content->position(), test_content->end(film)))) {
327 /* we have an overlap on track `t' */
335 if (j == views.end ()) {
336 /* no overlap on `t' */
342 tracks = max (tracks, t + 1);
345 return tracks - base;
348 /** Compare the mapped output channels of two TimelineViews, so we can into
349 * order of first mapped DCP channel.
351 struct AudioMappingComparator {
352 bool operator()(shared_ptr<TimelineView> a, shared_ptr<TimelineView> b) {
354 auto cva = dynamic_pointer_cast<TimelineAudioContentView>(a);
356 auto oc = cva->content()->audio->mapping().mapped_output_channels();
357 la = *min_element(boost::begin(oc), boost::end(oc));
360 auto cvb = dynamic_pointer_cast<TimelineAudioContentView>(b);
362 auto oc = cvb->content()->audio->mapping().mapped_output_channels();
363 lb = *min_element(boost::begin(oc), boost::end(oc));
370 Timeline::assign_tracks ()
373 Video (mono or left-eye)
384 auto film = _film.lock ();
385 DCPOMATIC_ASSERT (film);
389 for (auto i: _views) {
390 auto c = dynamic_pointer_cast<TimelineContentView>(i);
398 bool have_3d = false;
399 for (auto i: _views) {
400 auto cv = dynamic_pointer_cast<TimelineVideoContentView>(i);
405 /* Video on tracks 0 and maybe 1 (left and right eye) */
406 if (cv->content()->video->frame_type() == VideoFrameType::THREE_D_RIGHT) {
408 _tracks = max (_tracks, 2);
415 _tracks = max (_tracks, 1);
419 int const text_tracks = place<TimelineTextContentView> (film, _views, _tracks);
423 bool have_atmos = false;
424 for (auto i: _views) {
425 auto cv = dynamic_pointer_cast<TimelineAtmosContentView>(i);
427 cv->set_track (_tracks);
436 /* Audio. We're sorting the views so that we get the audio views in order of increasing
441 sort(views.begin(), views.end(), AudioMappingComparator());
442 int const audio_tracks = place<TimelineAudioContentView> (film, views, _tracks);
444 _labels_view->set_3d (have_3d);
445 _labels_view->set_audio_tracks (audio_tracks);
446 _labels_view->set_text_tracks (text_tracks);
447 _labels_view->set_atmos (have_atmos);
449 _time_axis_view->set_y (tracks());
450 _reels_view->set_y (8);
454 Timeline::tracks () const
460 Timeline::setup_scrollbars ()
462 auto film = _film.lock ();
463 if (!film || !_pixels_per_second) {
467 int const h = tracks() * pixels_per_track() + tracks_y_offset() + _time_axis_view->bbox().height;
469 _labels_canvas->SetVirtualSize (_labels_view->bbox().width, h);
470 _labels_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
471 _main_canvas->SetVirtualSize (*_pixels_per_second * film->length().seconds(), h);
472 _main_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
475 shared_ptr<TimelineView>
476 Timeline::event_to_view (wxMouseEvent& ev)
478 /* Search backwards through views so that we find the uppermost one first */
479 auto i = _views.rbegin();
482 _main_canvas->GetViewStart (&vsx, &vsy);
483 Position<int> const p (ev.GetX() + vsx * _x_scroll_rate, ev.GetY() + vsy * _y_scroll_rate);
485 while (i != _views.rend() && !(*i)->bbox().contains (p)) {
486 auto cv = dynamic_pointer_cast<TimelineContentView>(*i);
490 if (i == _views.rend ()) {
498 Timeline::left_down (wxMouseEvent& ev)
501 _down_point = ev.GetPosition ();
505 left_down_select (ev);
517 Timeline::left_down_select (wxMouseEvent& ev)
519 auto view = event_to_view (ev);
520 auto content_view = dynamic_pointer_cast<TimelineContentView>(view);
525 _down_view = content_view;
526 _down_view_position = content_view->content()->position ();
529 for (auto i: _views) {
530 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
535 if (!ev.ShiftDown ()) {
536 cv->set_selected (view == i);
540 if (content_view && ev.ShiftDown ()) {
541 content_view->set_selected (!content_view->selected ());
547 /* Pre-compute the points that we might snap to */
548 for (auto i: _views) {
549 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
550 if (!cv || cv == _down_view || cv->content() == _down_view->content()) {
554 auto film = _film.lock ();
555 DCPOMATIC_ASSERT (film);
557 _start_snaps.push_back (cv->content()->position());
558 _end_snaps.push_back (cv->content()->position());
559 _start_snaps.push_back (cv->content()->end(film));
560 _end_snaps.push_back (cv->content()->end(film));
562 for (auto i: cv->content()->reel_split_points(film)) {
563 _start_snaps.push_back (i);
567 /* Tell everyone that things might change frequently during the drag */
568 _down_view->content()->set_change_signals_frequent (true);
573 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 ();
616 Timeline::left_up_zoom (wxMouseEvent& ev)
618 _zoom_point = ev.GetPosition ();
621 _main_canvas->GetViewStart (&vsx, &vsy);
623 wxPoint top_left(min(_down_point.x, _zoom_point->x), min(_down_point.y, _zoom_point->y));
624 wxPoint bottom_right(max(_down_point.x, _zoom_point->x), max(_down_point.y, _zoom_point->y));
626 if ((bottom_right.x - top_left.x) < 8 || (bottom_right.y - top_left.y) < 8) {
627 /* Very small zoom rectangle: we assume it wasn't intentional */
631 auto const time_left = DCPTime::from_seconds((top_left.x + vsx) / *_pixels_per_second);
632 auto const time_right = DCPTime::from_seconds((bottom_right.x + vsx) / *_pixels_per_second);
633 set_pixels_per_second (double(GetSize().GetWidth()) / (time_right.seconds() - time_left.seconds()));
635 double const tracks_top = double(top_left.y - tracks_y_offset()) / _pixels_per_track;
636 double const tracks_bottom = double(bottom_right.y - tracks_y_offset()) / _pixels_per_track;
637 set_pixels_per_track (lrint(GetSize().GetHeight() / (tracks_bottom - tracks_top)));
640 int const y = (tracks_top * _pixels_per_track + tracks_y_offset()) / _y_scroll_rate;
641 _main_canvas->Scroll (time_left.seconds() * *_pixels_per_second / _x_scroll_rate, y);
642 _labels_canvas->Scroll (0, y);
644 _zoom_point = optional<wxPoint> ();
649 Timeline::set_pixels_per_track (int h)
651 _pixels_per_track = max(_minimum_pixels_per_track, h);
655 Timeline::mouse_moved (wxMouseEvent& ev)
659 mouse_moved_select (ev);
662 mouse_moved_zoom (ev);
672 Timeline::mouse_moved_select (wxMouseEvent& ev)
678 set_position_from_event (ev);
682 Timeline::mouse_moved_zoom (wxMouseEvent& ev)
688 _zoom_point = ev.GetPosition ();
693 Timeline::right_down (wxMouseEvent& ev)
697 right_down_select (ev);
701 set_pixels_per_second (*_pixels_per_second / 2);
702 set_pixels_per_track (_pixels_per_track / 2);
714 Timeline::right_down_select (wxMouseEvent& ev)
716 auto view = event_to_view (ev);
717 auto cv = dynamic_pointer_cast<TimelineContentView> (view);
722 if (!cv->selected ()) {
724 cv->set_selected (true);
727 _menu.popup (_film, selected_content (), selected_views (), ev.GetPosition ());
731 Timeline::maybe_snap (DCPTime a, DCPTime b, optional<DCPTime>& nearest_distance) const
733 auto const d = a - b;
734 if (!nearest_distance || d.abs() < nearest_distance.get().abs()) {
735 nearest_distance = d;
740 Timeline::set_position_from_event (wxMouseEvent& ev, bool force_emit)
742 if (!_pixels_per_second) {
746 double const pps = _pixels_per_second.get ();
748 auto const p = ev.GetPosition();
751 /* We haven't moved yet; in that case, we must move the mouse some reasonable distance
752 before the drag is considered to have started.
754 int const dist = sqrt (pow (p.x - _down_point.x, 2) + pow (p.y - _down_point.y, 2));
765 auto new_position = _down_view_position + DCPTime::from_seconds ((p.x - _down_point.x) / pps);
767 auto film = _film.lock ();
768 DCPOMATIC_ASSERT (film);
771 auto const new_end = new_position + _down_view->content()->length_after_trim(film);
772 /* Signed `distance' to nearest thing (i.e. negative is left on the timeline,
775 optional<DCPTime> nearest_distance;
777 /* Find the nearest snap point */
779 for (auto i: _start_snaps) {
780 maybe_snap (i, new_position, nearest_distance);
783 for (auto i: _end_snaps) {
784 maybe_snap (i, new_end, nearest_distance);
787 if (nearest_distance) {
788 /* Snap if it's close; `close' means within a proportion of the time on the timeline */
789 if (nearest_distance.get().abs() < DCPTime::from_seconds ((width() / pps) / 64)) {
790 new_position += nearest_distance.get ();
795 if (new_position < DCPTime ()) {
796 new_position = DCPTime ();
799 _down_view->content()->set_position (film, new_position, force_emit);
801 film->set_sequence (false);
805 Timeline::force_redraw (dcpomatic::Rect<int> const & r)
807 _main_canvas->RefreshRect (wxRect (r.x, r.y, r.width, r.height), false);
810 shared_ptr<const Film>
811 Timeline::film () const
813 return _film.lock ();
819 if (_main_canvas->GetSize().GetWidth() > 0 && _first_resize) {
821 _first_resize = false;
827 Timeline::clear_selection ()
829 for (auto i: _views) {
830 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView>(i);
832 cv->set_selected (false);
837 TimelineContentViewList
838 Timeline::selected_views () const
840 TimelineContentViewList sel;
842 for (auto i: _views) {
843 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
844 if (cv && cv->selected()) {
853 Timeline::selected_content () const
857 for (auto i: selected_views()) {
858 sel.push_back(i->content());
865 Timeline::set_selection (ContentList selection)
867 for (auto i: _views) {
868 auto cv = dynamic_pointer_cast<TimelineContentView> (i);
870 cv->set_selected (find (selection.begin(), selection.end(), cv->content ()) != selection.end ());
876 Timeline::tracks_y_offset () const
878 return _reels_view->bbox().height + 4;
882 Timeline::width () const
884 return _main_canvas->GetVirtualSize().GetWidth();
888 Timeline::scrolled (wxScrollWinEvent& ev)
890 if (ev.GetOrientation() == wxVERTICAL) {
892 _main_canvas->GetViewStart (&x, &y);
893 _labels_canvas->Scroll (0, y);
899 Timeline::tool_clicked (Tool t)
916 Timeline::zoom_all ()
918 auto film = _film.lock ();
919 DCPOMATIC_ASSERT (film);
920 set_pixels_per_second ((_main_canvas->GetSize().GetWidth() - 32) / film->length().seconds());
921 set_pixels_per_track ((_main_canvas->GetSize().GetHeight() - tracks_y_offset() - _time_axis_view->bbox().height - 32) / _tracks);
923 _main_canvas->Scroll (0, 0);
924 _labels_canvas->Scroll (0, 0);