2 Copyright (C) 2013-2018 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_subtitle_content_view.h"
29 #include "timeline_atmos_content_view.h"
30 #include "content_panel.h"
33 #include "lib/playlist.h"
34 #include "lib/image_content.h"
35 #include "lib/timer.h"
36 #include "lib/audio_content.h"
37 #include "lib/subtitle_content.h"
38 #include "lib/video_content.h"
39 #include "lib/atmos_mxf_content.h"
40 #include <wx/graphics.h>
41 #include <boost/weak_ptr.hpp>
42 #include <boost/foreach.hpp>
50 using boost::shared_ptr;
51 using boost::weak_ptr;
52 using boost::dynamic_pointer_cast;
54 using boost::optional;
56 /* 3 hours in 640 pixels */
57 double const Timeline::_minimum_pixels_per_second = 640.0 / (60 * 60 * 3);
58 int const Timeline::_minimum_pixels_per_track = 16;
60 Timeline::Timeline (wxWindow* parent, ContentPanel* cp, shared_ptr<Film> film)
61 : wxPanel (parent, wxID_ANY)
62 , _labels_canvas (new wxScrolledCanvas (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE))
63 , _main_canvas (new wxScrolledCanvas (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE))
66 , _time_axis_view (new TimelineTimeAxisView (*this, 64))
67 , _reels_view (new TimelineReelsView (*this, 32))
68 , _labels_view (new TimelineLabelsView (*this))
71 , _down_view_position (0)
78 , _pixels_per_track (48)
79 , _first_resize (true)
82 _labels_canvas->SetDoubleBuffered (true);
83 _main_canvas->SetDoubleBuffered (true);
86 wxSizer* sizer = new wxBoxSizer (wxHORIZONTAL);
87 sizer->Add (_labels_canvas, 0, wxEXPAND);
88 _labels_canvas->SetMinSize (wxSize (_labels_view->bbox().width, -1));
89 sizer->Add (_main_canvas, 1, wxEXPAND);
92 _labels_canvas->Bind (wxEVT_PAINT, boost::bind (&Timeline::paint_labels, this));
93 _main_canvas->Bind (wxEVT_PAINT, boost::bind (&Timeline::paint_main, this));
94 _main_canvas->Bind (wxEVT_LEFT_DOWN, boost::bind (&Timeline::left_down, this, _1));
95 _main_canvas->Bind (wxEVT_LEFT_UP, boost::bind (&Timeline::left_up, this, _1));
96 _main_canvas->Bind (wxEVT_RIGHT_DOWN, boost::bind (&Timeline::right_down, this, _1));
97 _main_canvas->Bind (wxEVT_MOTION, boost::bind (&Timeline::mouse_moved, this, _1));
98 _main_canvas->Bind (wxEVT_SIZE, boost::bind (&Timeline::resized, this));
99 _main_canvas->Bind (wxEVT_SCROLLWIN_TOP, boost::bind (&Timeline::scrolled, this, _1));
100 _main_canvas->Bind (wxEVT_SCROLLWIN_BOTTOM, boost::bind (&Timeline::scrolled, this, _1));
101 _main_canvas->Bind (wxEVT_SCROLLWIN_LINEUP, boost::bind (&Timeline::scrolled, this, _1));
102 _main_canvas->Bind (wxEVT_SCROLLWIN_LINEDOWN, boost::bind (&Timeline::scrolled, this, _1));
103 _main_canvas->Bind (wxEVT_SCROLLWIN_PAGEUP, boost::bind (&Timeline::scrolled, this, _1));
104 _main_canvas->Bind (wxEVT_SCROLLWIN_PAGEDOWN, boost::bind (&Timeline::scrolled, this, _1));
105 _main_canvas->Bind (wxEVT_SCROLLWIN_THUMBTRACK, boost::bind (&Timeline::scrolled, this, _1));
107 film_changed (Film::CONTENT);
109 SetMinSize (wxSize (640, 4 * pixels_per_track() + 96));
111 _film_changed_connection = film->Changed.connect (bind (&Timeline::film_changed, this, _1));
112 _film_content_changed_connection = film->ContentChanged.connect (bind (&Timeline::film_content_changed, this, _2, _3));
115 _labels_canvas->ShowScrollbars (wxSHOW_SB_NEVER, wxSHOW_SB_NEVER);
119 Timeline::set_pixels_per_second (double pps)
121 _pixels_per_second = max (_minimum_pixels_per_second, pps);
125 Timeline::paint_labels ()
127 wxPaintDC dc (_labels_canvas);
129 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
135 _labels_canvas->GetViewStart (&vsx, &vsy);
136 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate + tracks_y_offset());
138 _labels_view->paint (gc, list<dcpomatic::Rect<int> >());
144 Timeline::paint_main ()
146 wxPaintDC dc (_main_canvas);
147 _main_canvas->DoPrepareDC (dc);
149 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
155 _main_canvas->GetViewStart (&vsx, &vsy);
156 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate);
158 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
160 BOOST_FOREACH (shared_ptr<TimelineView> i, _views) {
162 shared_ptr<TimelineContentView> ic = dynamic_pointer_cast<TimelineContentView> (i);
164 /* Find areas of overlap with other content views, so that we can plot them */
165 list<dcpomatic::Rect<int> > overlaps;
166 BOOST_FOREACH (shared_ptr<TimelineView> j, _views) {
167 shared_ptr<TimelineContentView> jc = dynamic_pointer_cast<TimelineContentView> (j);
168 /* No overlap with non-content views, views no different tracks, audio views or non-active views */
169 if (!ic || !jc || i == j || ic->track() != jc->track() || ic->track().get_value_or(2) >= 2 || !ic->active() || !jc->active()) {
173 optional<dcpomatic::Rect<int> > r = j->bbox().intersection (i->bbox());
175 overlaps.push_back (r.get ());
179 i->paint (gc, overlaps);
183 /* Translate back as _down_point and _zoom_point do not take scroll into account */
184 gc->Translate (vsx * _x_scroll_rate, vsy * _y_scroll_rate);
185 gc->SetPen (*wxBLACK_PEN);
186 gc->SetBrush (*wxTRANSPARENT_BRUSH);
188 min (_down_point.x, _zoom_point->x),
189 min (_down_point.y, _zoom_point->y),
190 fabs (_down_point.x - _zoom_point->x),
191 fabs (_down_point.y - _zoom_point->y)
199 Timeline::film_changed (Film::Property p)
201 if (p == Film::CONTENT || p == Film::REEL_TYPE || p == Film::REEL_LENGTH) {
204 } else if (p == Film::CONTENT_ORDER) {
210 Timeline::recreate_views ()
212 shared_ptr<const Film> film = _film.lock ();
218 _views.push_back (_time_axis_view);
219 _views.push_back (_reels_view);
221 BOOST_FOREACH (shared_ptr<Content> i, film->content ()) {
223 _views.push_back (shared_ptr<TimelineView> (new TimelineVideoContentView (*this, i)));
226 if (i->audio && !i->audio->mapping().mapped_output_channels().empty ()) {
227 _views.push_back (shared_ptr<TimelineView> (new TimelineAudioContentView (*this, i)));
231 _views.push_back (shared_ptr<TimelineView> (new TimelineSubtitleContentView (*this, i)));
234 if (dynamic_pointer_cast<AtmosMXFContent> (i)) {
235 _views.push_back (shared_ptr<TimelineView> (new TimelineAtmosContentView (*this, i)));
245 Timeline::film_content_changed (int property, bool frequent)
249 if (property == AudioContentProperty::STREAMS) {
251 } else if (!frequent) {
259 place (TimelineViewList& views, int& tracks)
261 int const base = tracks;
263 BOOST_FOREACH (shared_ptr<TimelineView> i, views) {
264 if (!dynamic_pointer_cast<T>(i)) {
268 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (i);
272 shared_ptr<Content> content = cv->content();
273 DCPTimePeriod const content_period (content->position(), content->end());
276 TimelineViewList::iterator j = views.begin();
277 while (j != views.end()) {
278 shared_ptr<T> test = dynamic_pointer_cast<T> (*j);
284 shared_ptr<Content> test_content = test->content();
286 test->track() && test->track().get() == t &&
287 content_period.overlap(DCPTimePeriod(test_content->position(), test_content->end()))) {
288 /* we have an overlap on track `t' */
296 if (j == views.end ()) {
297 /* no overlap on `t' */
303 tracks = max (tracks, t + 1);
306 return tracks - base;
309 /** Compare the mapped output channels of two TimelineViews, so we can into
310 * order of first mapped DCP channel.
312 struct AudioMappingComparator {
313 bool operator()(shared_ptr<TimelineView> a, shared_ptr<TimelineView> b) {
315 shared_ptr<TimelineAudioContentView> cva = dynamic_pointer_cast<TimelineAudioContentView>(a);
317 list<int> oc = cva->content()->audio->mapping().mapped_output_channels();
318 la = *min_element(begin(oc), end(oc));
321 shared_ptr<TimelineAudioContentView> cvb = dynamic_pointer_cast<TimelineAudioContentView>(b);
323 list<int> oc = cvb->content()->audio->mapping().mapped_output_channels();
324 lb = *min_element(begin(oc), end(oc));
331 Timeline::assign_tracks ()
334 Video (mono or left-eye)
347 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
348 shared_ptr<TimelineContentView> c = dynamic_pointer_cast<TimelineContentView> (*i);
356 bool have_3d = false;
357 BOOST_FOREACH (shared_ptr<TimelineView> i, _views) {
358 shared_ptr<TimelineVideoContentView> cv = dynamic_pointer_cast<TimelineVideoContentView> (i);
363 /* Video on tracks 0 and maybe 1 (left and right eye) */
364 if (cv->content()->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
366 _tracks = max (_tracks, 2);
373 _tracks = max (_tracks, 1);
377 int const subtitle_tracks = place<TimelineSubtitleContentView> (_views, _tracks);
381 bool have_atmos = false;
382 BOOST_FOREACH (shared_ptr<TimelineView> i, _views) {
383 shared_ptr<TimelineVideoContentView> cv = dynamic_pointer_cast<TimelineVideoContentView> (i);
387 if (dynamic_pointer_cast<TimelineAtmosContentView> (i)) {
388 cv->set_track (_tracks - 1);
397 /* Audio. We're sorting the views so that we get the audio views in order of increasing
401 TimelineViewList views = _views;
402 sort(views.begin(), views.end(), AudioMappingComparator());
403 int const audio_tracks = place<TimelineAudioContentView> (views, _tracks);
405 _labels_view->set_3d (have_3d);
406 _labels_view->set_audio_tracks (audio_tracks);
407 _labels_view->set_subtitle_tracks (subtitle_tracks);
408 _labels_view->set_atmos (have_atmos);
410 _time_axis_view->set_y (tracks());
411 _reels_view->set_y (8);
415 Timeline::tracks () const
421 Timeline::setup_scrollbars ()
423 shared_ptr<const Film> film = _film.lock ();
424 if (!film || !_pixels_per_second) {
428 int const h = tracks() * pixels_per_track() + tracks_y_offset() + _time_axis_view->bbox().height;
430 _labels_canvas->SetVirtualSize (_labels_view->bbox().width, h);
431 _labels_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
432 _main_canvas->SetVirtualSize (*_pixels_per_second * film->length().seconds(), h);
433 _main_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
436 shared_ptr<TimelineView>
437 Timeline::event_to_view (wxMouseEvent& ev)
439 /* Search backwards through views so that we find the uppermost one first */
440 TimelineViewList::reverse_iterator i = _views.rbegin();
441 Position<int> const p (ev.GetX(), ev.GetY());
442 while (i != _views.rend() && !(*i)->bbox().contains (p)) {
443 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
447 if (i == _views.rend ()) {
448 return shared_ptr<TimelineView> ();
455 Timeline::left_down (wxMouseEvent& ev)
458 _down_point = ev.GetPosition ();
462 left_down_select (ev);
474 Timeline::left_down_select (wxMouseEvent& ev)
476 shared_ptr<TimelineView> view = event_to_view (ev);
477 shared_ptr<TimelineContentView> content_view = dynamic_pointer_cast<TimelineContentView> (view);
482 _down_view = content_view;
483 _down_view_position = content_view->content()->position ();
486 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
487 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
492 if (!ev.ShiftDown ()) {
493 cv->set_selected (view == *i);
497 if (content_view && ev.ShiftDown ()) {
498 content_view->set_selected (!content_view->selected ());
504 /* Pre-compute the points that we might snap to */
505 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
506 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
507 if (!cv || cv == _down_view || cv->content() == _down_view->content()) {
511 _start_snaps.push_back (cv->content()->position());
512 _end_snaps.push_back (cv->content()->position());
513 _start_snaps.push_back (cv->content()->end());
514 _end_snaps.push_back (cv->content()->end());
516 BOOST_FOREACH (DCPTime i, cv->content()->reel_split_points()) {
517 _start_snaps.push_back (i);
521 /* Tell everyone that things might change frequently during the drag */
522 _down_view->content()->set_change_signals_frequent (true);
527 Timeline::left_up (wxMouseEvent& ev)
546 Timeline::left_up_select (wxMouseEvent& ev)
549 _down_view->content()->set_change_signals_frequent (false);
552 _content_panel->set_selection (selected_content ());
553 set_position_from_event (ev);
555 /* Clear up up the stuff we don't do during drag */
560 _start_snaps.clear ();
565 Timeline::left_up_zoom (wxMouseEvent& ev)
567 _zoom_point = ev.GetPosition ();
570 _main_canvas->GetViewStart (&vsx, &vsy);
572 wxPoint top_left(min(_down_point.x, _zoom_point->x), min(_down_point.y, _zoom_point->y));
573 wxPoint bottom_right(max(_down_point.x, _zoom_point->x), max(_down_point.y, _zoom_point->y));
575 if ((bottom_right.x - top_left.x) < 8 || (bottom_right.y - top_left.y) < 8) {
576 /* Very small zoom rectangle: we assume it wasn't intentional */
580 DCPTime const time_left = DCPTime::from_seconds((top_left.x + vsx) / *_pixels_per_second);
581 DCPTime const time_right = DCPTime::from_seconds((bottom_right.x + vsx) / *_pixels_per_second);
582 set_pixels_per_second (double(GetSize().GetWidth()) / (time_right.seconds() - time_left.seconds()));
584 double const tracks_top = double(top_left.y - tracks_y_offset()) / _pixels_per_track;
585 double const tracks_bottom = double(bottom_right.y - tracks_y_offset()) / _pixels_per_track;
586 set_pixels_per_track (lrint(GetSize().GetHeight() / (tracks_bottom - tracks_top)));
589 int const y = (tracks_top * _pixels_per_track + tracks_y_offset()) / _y_scroll_rate;
590 _main_canvas->Scroll (time_left.seconds() * *_pixels_per_second / _x_scroll_rate, y);
591 _labels_canvas->Scroll (0, y);
593 _zoom_point = optional<wxPoint> ();
598 Timeline::set_pixels_per_track (int h)
600 _pixels_per_track = max(_minimum_pixels_per_track, h);
604 Timeline::mouse_moved (wxMouseEvent& ev)
608 mouse_moved_select (ev);
611 mouse_moved_zoom (ev);
621 Timeline::mouse_moved_select (wxMouseEvent& ev)
627 set_position_from_event (ev);
631 Timeline::mouse_moved_zoom (wxMouseEvent& ev)
637 _zoom_point = ev.GetPosition ();
642 Timeline::right_down (wxMouseEvent& ev)
646 right_down_select (ev);
650 set_pixels_per_second (*_pixels_per_second / 2);
651 set_pixels_per_track (_pixels_per_track / 2);
663 Timeline::right_down_select (wxMouseEvent& ev)
665 shared_ptr<TimelineView> view = event_to_view (ev);
666 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (view);
671 if (!cv->selected ()) {
673 cv->set_selected (true);
676 _menu.popup (_film, selected_content (), selected_views (), ev.GetPosition ());
680 Timeline::maybe_snap (DCPTime a, DCPTime b, optional<DCPTime>& nearest_distance) const
682 DCPTime const d = a - b;
683 if (!nearest_distance || d.abs() < nearest_distance.get().abs()) {
684 nearest_distance = d;
689 Timeline::set_position_from_event (wxMouseEvent& ev)
691 if (!_pixels_per_second) {
695 double const pps = _pixels_per_second.get ();
697 wxPoint const p = ev.GetPosition();
700 /* We haven't moved yet; in that case, we must move the mouse some reasonable distance
701 before the drag is considered to have started.
703 int const dist = sqrt (pow (p.x - _down_point.x, 2) + pow (p.y - _down_point.y, 2));
714 DCPTime new_position = _down_view_position + DCPTime::from_seconds ((p.x - _down_point.x) / pps);
718 DCPTime const new_end = new_position + _down_view->content()->length_after_trim();
719 /* Signed `distance' to nearest thing (i.e. negative is left on the timeline,
722 optional<DCPTime> nearest_distance;
724 /* Find the nearest snap point */
726 BOOST_FOREACH (DCPTime i, _start_snaps) {
727 maybe_snap (i, new_position, nearest_distance);
730 BOOST_FOREACH (DCPTime i, _end_snaps) {
731 maybe_snap (i, new_end, nearest_distance);
734 if (nearest_distance) {
735 /* Snap if it's close; `close' means within a proportion of the time on the timeline */
736 if (nearest_distance.get().abs() < DCPTime::from_seconds ((width() / pps) / 64)) {
737 new_position += nearest_distance.get ();
742 if (new_position < DCPTime ()) {
743 new_position = DCPTime ();
746 _down_view->content()->set_position (new_position);
748 shared_ptr<Film> film = _film.lock ();
749 DCPOMATIC_ASSERT (film);
750 film->set_sequence (false);
754 Timeline::force_redraw (dcpomatic::Rect<int> const & r)
756 RefreshRect (wxRect (r.x, r.y, r.width, r.height), false);
759 shared_ptr<const Film>
760 Timeline::film () const
762 return _film.lock ();
768 if (_main_canvas->GetSize().GetWidth() > 0 && _first_resize) {
770 _first_resize = false;
776 Timeline::clear_selection ()
778 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
779 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
781 cv->set_selected (false);
786 TimelineContentViewList
787 Timeline::selected_views () const
789 TimelineContentViewList sel;
791 for (TimelineViewList::const_iterator i = _views.begin(); i != _views.end(); ++i) {
792 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
793 if (cv && cv->selected()) {
802 Timeline::selected_content () const
805 TimelineContentViewList views = selected_views ();
807 for (TimelineContentViewList::const_iterator i = views.begin(); i != views.end(); ++i) {
808 sel.push_back ((*i)->content ());
815 Timeline::set_selection (ContentList selection)
817 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
818 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
820 cv->set_selected (find (selection.begin(), selection.end(), cv->content ()) != selection.end ());
826 Timeline::tracks_y_offset () const
828 return _reels_view->bbox().height + 4;
832 Timeline::width () const
834 return _main_canvas->GetVirtualSize().GetWidth();
838 Timeline::scrolled (wxScrollWinEvent& ev)
840 if (ev.GetOrientation() == wxVERTICAL) {
842 _main_canvas->GetViewStart (&x, &y);
843 _labels_canvas->Scroll (0, y);
849 Timeline::tool_clicked (Tool t)
866 Timeline::zoom_all ()
868 shared_ptr<Film> film = _film.lock ();
869 DCPOMATIC_ASSERT (film);
870 set_pixels_per_second ((_main_canvas->GetSize().GetWidth() - 32) / film->length().seconds());
871 set_pixels_per_track ((_main_canvas->GetSize().GetHeight() - tracks_y_offset() - _time_axis_view->bbox().height - 32) / _tracks);
873 _main_canvas->Scroll (0, 0);
874 _labels_canvas->Scroll (0, 0);