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/scope_guard.h"
39 #include "lib/text_content.h"
40 #include "lib/timer.h"
41 #include "lib/video_content.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_SCROLLWIN_TOP, boost::bind (&Timeline::scrolled, this, _1));
113 _main_canvas->Bind (wxEVT_SCROLLWIN_BOTTOM, boost::bind (&Timeline::scrolled, this, _1));
114 _main_canvas->Bind (wxEVT_SCROLLWIN_LINEUP, boost::bind (&Timeline::scrolled, this, _1));
115 _main_canvas->Bind (wxEVT_SCROLLWIN_LINEDOWN, boost::bind (&Timeline::scrolled, this, _1));
116 _main_canvas->Bind (wxEVT_SCROLLWIN_PAGEUP, boost::bind (&Timeline::scrolled, this, _1));
117 _main_canvas->Bind (wxEVT_SCROLLWIN_PAGEDOWN, boost::bind (&Timeline::scrolled, this, _1));
118 _main_canvas->Bind (wxEVT_SCROLLWIN_THUMBTRACK, boost::bind (&Timeline::scrolled, this, _1));
120 film_change (ChangeType::DONE, Film::Property::CONTENT);
122 SetMinSize (wxSize (640, 4 * pixels_per_track() + 96));
124 _film_changed_connection = film->Change.connect (bind (&Timeline::film_change, this, _1, _2));
125 _film_content_change_connection = film->ContentChange.connect (bind (&Timeline::film_content_change, this, _1, _3, _4));
127 Bind (wxEVT_TIMER, boost::bind(&Timeline::update_playhead, this));
128 _timer.Start (200, wxTIMER_CONTINUOUS);
131 _labels_canvas->ShowScrollbars (wxSHOW_SB_NEVER, wxSHOW_SB_NEVER);
136 Timeline::update_playhead ()
143 Timeline::set_pixels_per_second (double pps)
145 _pixels_per_second = max (_minimum_pixels_per_second, pps);
150 Timeline::paint_labels ()
152 wxPaintDC dc (_labels_canvas);
154 auto film = _film.lock();
155 if (film->content().empty()) {
159 auto gc = wxGraphicsContext::Create (dc);
164 ScopeGuard sg = [gc]() { delete gc; };
167 _labels_canvas->GetViewStart (&vsx, &vsy);
168 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate + tracks_y_offset());
170 _labels_view->paint (gc, {});
175 Timeline::paint_main ()
177 wxPaintDC dc (_main_canvas);
179 auto film = _film.lock();
180 if (film->content().empty()) {
184 _main_canvas->DoPrepareDC (dc);
186 auto gc = wxGraphicsContext::Create (dc);
191 ScopeGuard sg = [gc]() { delete gc; };
194 _main_canvas->GetViewStart (&vsx, &vsy);
195 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate);
197 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
199 for (auto i: _views) {
201 auto ic = dynamic_pointer_cast<TimelineContentView> (i);
203 /* Find areas of overlap with other content views, so that we can plot them */
204 list<dcpomatic::Rect<int>> overlaps;
205 for (auto j: _views) {
206 auto jc = dynamic_pointer_cast<TimelineContentView> (j);
207 /* No overlap with non-content views, views on different tracks, audio views or non-active views */
208 if (!ic || !jc || i == j || ic->track() != jc->track() || ic->track().get_value_or(2) >= 2 || !ic->active() || !jc->active()) {
212 auto r = j->bbox().intersection(i->bbox());
214 overlaps.push_back (r.get ());
218 i->paint (gc, overlaps);
222 /* Translate back as _down_point and _zoom_point do not take scroll into account */
223 gc->Translate (vsx * _x_scroll_rate, vsy * _y_scroll_rate);
224 gc->SetPen(gui_is_dark() ? *wxWHITE_PEN : *wxBLACK_PEN);
225 gc->SetBrush (*wxTRANSPARENT_BRUSH);
227 min (_down_point.x, _zoom_point->x),
228 min (_down_point.y, _zoom_point->y),
229 abs (_down_point.x - _zoom_point->x),
230 abs (_down_point.y - _zoom_point->y)
236 gc->SetPen (*wxRED_PEN);
237 auto path = gc->CreatePath ();
238 double const ph = _viewer.position().seconds() * pixels_per_second().get_value_or(0);
239 path.MoveToPoint (ph, 0);
240 path.AddLineToPoint (ph, pixels_per_track() * _tracks + 32);
241 gc->StrokePath (path);
246 Timeline::film_change (ChangeType type, Film::Property p)
248 if (type != ChangeType::DONE) {
252 if (p == Film::Property::CONTENT || p == Film::Property::REEL_TYPE || p == Film::Property::REEL_LENGTH) {
255 } else if (p == Film::Property::CONTENT_ORDER) {
262 Timeline::recreate_views ()
264 auto film = _film.lock ();
270 _views.push_back (_time_axis_view);
271 _views.push_back (_reels_view);
273 for (auto i: film->content ()) {
275 _views.push_back (make_shared<TimelineVideoContentView>(*this, i));
278 if (i->audio && !i->audio->mapping().mapped_output_channels().empty ()) {
279 _views.push_back (make_shared<TimelineAudioContentView>(*this, i));
282 for (auto j: i->text) {
283 _views.push_back (make_shared<TimelineTextContentView>(*this, i, j));
287 _views.push_back (make_shared<TimelineAtmosContentView>(*this, i));
298 Timeline::film_content_change (ChangeType type, int property, bool frequent)
300 if (type != ChangeType::DONE) {
306 if (property == AudioContentProperty::STREAMS || property == VideoContentProperty::FRAME_TYPE) {
308 } else if (property == ContentProperty::POSITION || property == ContentProperty::LENGTH) {
309 _reels_view->force_redraw ();
310 } else if (!frequent) {
319 place (shared_ptr<const Film> film, TimelineViewList& views, int& tracks)
321 int const base = tracks;
323 for (auto i: views) {
324 if (!dynamic_pointer_cast<T>(i)) {
328 auto cv = dynamic_pointer_cast<TimelineContentView> (i);
332 auto content = cv->content();
333 DCPTimePeriod const content_period = content->period(film);
336 auto j = views.begin();
337 while (j != views.end()) {
338 auto test = dynamic_pointer_cast<T> (*j);
344 auto test_content = test->content();
346 test->track() && test->track().get() == t &&
347 content_period.overlap(test_content->period(film))
349 /* we have an overlap on track `t' */
357 if (j == views.end ()) {
358 /* no overlap on `t' */
364 tracks = max (tracks, t + 1);
367 return tracks - base;
371 /** Compare the mapped output channels of two TimelineViews, so we can into
372 * order of first mapped DCP channel.
374 struct AudioMappingComparator {
375 bool operator()(shared_ptr<TimelineView> a, shared_ptr<TimelineView> b) {
377 auto cva = dynamic_pointer_cast<TimelineAudioContentView>(a);
379 auto oc = cva->content()->audio->mapping().mapped_output_channels();
380 la = *min_element(boost::begin(oc), boost::end(oc));
383 auto cvb = dynamic_pointer_cast<TimelineAudioContentView>(b);
385 auto oc = cvb->content()->audio->mapping().mapped_output_channels();
386 lb = *min_element(boost::begin(oc), boost::end(oc));
394 Timeline::assign_tracks ()
409 auto film = _film.lock ();
410 DCPOMATIC_ASSERT (film);
414 for (auto i: _views) {
415 auto c = dynamic_pointer_cast<TimelineContentView>(i);
421 int const video_tracks = place<TimelineVideoContentView> (film, _views, _tracks);
422 int const text_tracks = place<TimelineTextContentView> (film, _views, _tracks);
426 bool have_atmos = false;
427 for (auto i: _views) {
428 auto cv = dynamic_pointer_cast<TimelineAtmosContentView>(i);
430 cv->set_track (_tracks);
439 /* Audio. We're sorting the views so that we get the audio views in order of increasing
444 sort(views.begin(), views.end(), AudioMappingComparator());
445 int const audio_tracks = place<TimelineAudioContentView> (film, views, _tracks);
447 _labels_view->set_video_tracks (video_tracks);
448 _labels_view->set_audio_tracks (audio_tracks);
449 _labels_view->set_text_tracks (text_tracks);
450 _labels_view->set_atmos (have_atmos);
452 _time_axis_view->set_y (tracks());
453 _reels_view->set_y (8);
458 Timeline::tracks () const
465 Timeline::setup_scrollbars ()
467 auto film = _film.lock ();
468 if (!film || !_pixels_per_second) {
472 int const h = tracks() * pixels_per_track() + tracks_y_offset() + _time_axis_view->bbox().height;
474 _labels_canvas->SetVirtualSize (_labels_view->bbox().width, h);
475 _labels_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
476 _main_canvas->SetVirtualSize (*_pixels_per_second * film->length().seconds(), h);
477 _main_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
481 shared_ptr<TimelineView>
482 Timeline::event_to_view (wxMouseEvent& ev)
484 /* Search backwards through views so that we find the uppermost one first */
485 auto i = _views.rbegin();
488 _main_canvas->GetViewStart (&vsx, &vsy);
489 Position<int> const p (ev.GetX() + vsx * _x_scroll_rate, ev.GetY() + vsy * _y_scroll_rate);
491 while (i != _views.rend() && !(*i)->bbox().contains (p)) {
495 if (i == _views.rend ()) {
504 Timeline::left_down (wxMouseEvent& ev)
507 _down_point = ev.GetPosition ();
511 left_down_select (ev);
524 Timeline::left_down_select (wxMouseEvent& ev)
526 auto view = event_to_view (ev);
527 auto content_view = dynamic_pointer_cast<TimelineContentView>(view);
532 _down_view = content_view;
533 _down_view_position = content_view->content()->position ();
536 if (dynamic_pointer_cast<TimelineTimeAxisView>(view)) {
538 _main_canvas->GetViewStart(&vsx, &vsy);
539 _viewer.seek(DCPTime::from_seconds((ev.GetPosition().x + vsx * _x_scroll_rate) / _pixels_per_second.get_value_or(1)), true);
542 for (auto i: _views) {
543 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
548 if (!ev.ShiftDown ()) {
549 cv->set_selected (view == i);
553 if (content_view && ev.ShiftDown ()) {
554 content_view->set_selected (!content_view->selected ());
560 /* Pre-compute the points that we might snap to */
561 for (auto i: _views) {
562 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
563 if (!cv || cv == _down_view || cv->content() == _down_view->content()) {
567 auto film = _film.lock ();
568 DCPOMATIC_ASSERT (film);
570 _start_snaps.push_back (cv->content()->position());
571 _end_snaps.push_back (cv->content()->position());
572 _start_snaps.push_back (cv->content()->end(film));
573 _end_snaps.push_back (cv->content()->end(film));
575 for (auto i: cv->content()->reel_split_points(film)) {
576 _start_snaps.push_back (i);
580 /* Tell everyone that things might change frequently during the drag */
581 _down_view->content()->set_change_signals_frequent (true);
587 Timeline::left_up (wxMouseEvent& ev)
607 Timeline::left_up_select (wxMouseEvent& ev)
610 _down_view->content()->set_change_signals_frequent (false);
613 _content_panel->set_selection (selected_content ());
614 /* Since we may have just set change signals back to `not-frequent', we have to
615 make sure this position change is signalled, even if the position value has
616 not changed since the last time it was set (with frequent=true). This is
619 set_position_from_event (ev, true);
621 /* Clear up up the stuff we don't do during drag */
626 _start_snaps.clear ();
632 Timeline::left_up_zoom (wxMouseEvent& ev)
634 _zoom_point = ev.GetPosition ();
637 _main_canvas->GetViewStart (&vsx, &vsy);
639 wxPoint top_left(min(_down_point.x, _zoom_point->x), min(_down_point.y, _zoom_point->y));
640 wxPoint bottom_right(max(_down_point.x, _zoom_point->x), max(_down_point.y, _zoom_point->y));
642 if ((bottom_right.x - top_left.x) < 8 || (bottom_right.y - top_left.y) < 8) {
643 /* Very small zoom rectangle: we assume it wasn't intentional */
644 _zoom_point = optional<wxPoint> ();
649 auto const time_left = DCPTime::from_seconds((top_left.x + vsx) / *_pixels_per_second);
650 auto const time_right = DCPTime::from_seconds((bottom_right.x + vsx) / *_pixels_per_second);
651 set_pixels_per_second (double(GetSize().GetWidth()) / (time_right.seconds() - time_left.seconds()));
653 double const tracks_top = double(top_left.y - tracks_y_offset()) / _pixels_per_track;
654 double const tracks_bottom = double(bottom_right.y - tracks_y_offset()) / _pixels_per_track;
655 set_pixels_per_track (lrint(GetSize().GetHeight() / (tracks_bottom - tracks_top)));
658 int const y = (tracks_top * _pixels_per_track + tracks_y_offset()) / _y_scroll_rate;
659 _main_canvas->Scroll (time_left.seconds() * *_pixels_per_second / _x_scroll_rate, y);
660 _labels_canvas->Scroll (0, y);
662 _zoom_point = optional<wxPoint> ();
668 Timeline::set_pixels_per_track (int h)
670 _pixels_per_track = max(_minimum_pixels_per_track, h);
675 Timeline::mouse_moved (wxMouseEvent& ev)
679 mouse_moved_select (ev);
682 mouse_moved_zoom (ev);
693 Timeline::mouse_moved_select (wxMouseEvent& ev)
699 set_position_from_event (ev);
704 Timeline::mouse_moved_zoom (wxMouseEvent& ev)
710 _zoom_point = ev.GetPosition ();
716 Timeline::right_down (wxMouseEvent& ev)
720 right_down_select (ev);
724 set_pixels_per_second (*_pixels_per_second / 2);
725 set_pixels_per_track (_pixels_per_track / 2);
738 Timeline::right_down_select (wxMouseEvent& ev)
740 auto view = event_to_view (ev);
741 auto cv = dynamic_pointer_cast<TimelineContentView> (view);
746 if (!cv->selected ()) {
748 cv->set_selected (true);
751 _menu.popup (_film, selected_content (), selected_views (), ev.GetPosition ());
756 Timeline::maybe_snap (DCPTime a, DCPTime b, optional<DCPTime>& nearest_distance) const
758 auto const d = a - b;
759 if (!nearest_distance || d.abs() < nearest_distance.get().abs()) {
760 nearest_distance = d;
766 Timeline::set_position_from_event (wxMouseEvent& ev, bool force_emit)
768 if (!_pixels_per_second) {
772 double const pps = _pixels_per_second.get ();
774 auto const p = ev.GetPosition();
777 /* We haven't moved yet; in that case, we must move the mouse some reasonable distance
778 before the drag is considered to have started.
780 int const dist = sqrt (pow (p.x - _down_point.x, 2) + pow (p.y - _down_point.y, 2));
791 auto new_position = _down_view_position + DCPTime::from_seconds ((p.x - _down_point.x) / pps);
793 auto film = _film.lock ();
794 DCPOMATIC_ASSERT (film);
797 auto const new_end = new_position + _down_view->content()->length_after_trim(film);
798 /* Signed `distance' to nearest thing (i.e. negative is left on the timeline,
801 optional<DCPTime> nearest_distance;
803 /* Find the nearest snap point */
805 for (auto i: _start_snaps) {
806 maybe_snap (i, new_position, nearest_distance);
809 for (auto i: _end_snaps) {
810 maybe_snap (i, new_end, nearest_distance);
813 if (nearest_distance) {
814 /* Snap if it's close; `close' means within a proportion of the time on the timeline */
815 if (nearest_distance.get().abs() < DCPTime::from_seconds ((width() / pps) / 64)) {
816 new_position += nearest_distance.get ();
821 if (new_position < DCPTime ()) {
822 new_position = DCPTime ();
825 _down_view->content()->set_position (film, new_position, force_emit);
827 film->set_sequence (false);
832 Timeline::force_redraw (dcpomatic::Rect<int> const & r)
834 _main_canvas->RefreshRect (wxRect (r.x, r.y, r.width, r.height), false);
838 shared_ptr<const Film>
839 Timeline::film () const
841 return _film.lock ();
848 if (_main_canvas->GetSize().GetWidth() > 0 && _first_resize) {
850 _first_resize = false;
857 Timeline::clear_selection ()
859 for (auto i: _views) {
860 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView>(i);
862 cv->set_selected (false);
868 TimelineContentViewList
869 Timeline::selected_views () const
871 TimelineContentViewList sel;
873 for (auto i: _views) {
874 auto cv = dynamic_pointer_cast<TimelineContentView>(i);
875 if (cv && cv->selected()) {
885 Timeline::selected_content () const
889 for (auto i: selected_views()) {
890 sel.push_back(i->content());
898 Timeline::set_selection (ContentList selection)
900 for (auto i: _views) {
901 auto cv = dynamic_pointer_cast<TimelineContentView> (i);
903 cv->set_selected (find (selection.begin(), selection.end(), cv->content ()) != selection.end ());
910 Timeline::tracks_y_offset () const
912 return _reels_view->bbox().height + 4;
917 Timeline::width () const
919 return _main_canvas->GetVirtualSize().GetWidth();
924 Timeline::scrolled (wxScrollWinEvent& ev)
926 if (ev.GetOrientation() == wxVERTICAL) {
928 _main_canvas->GetViewStart (&x, &y);
929 _labels_canvas->Scroll (0, y);
936 Timeline::tool_clicked (Tool t)
954 Timeline::zoom_all ()
956 auto film = _film.lock ();
957 DCPOMATIC_ASSERT (film);
958 set_pixels_per_second ((_main_canvas->GetSize().GetWidth() - 32) / film->length().seconds());
959 set_pixels_per_track ((_main_canvas->GetSize().GetHeight() - tracks_y_offset() - _time_axis_view->bbox().height - 32) / _tracks);
961 _main_canvas->Scroll (0, 0);
962 _labels_canvas->Scroll (0, 0);
968 Timeline::keypress(wxKeyEvent const& event)
970 if (event.GetKeyCode() == WXK_DELETE) {
971 auto film = _film.lock();
972 film->remove_content(selected_content());