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 Timeline::Timeline (wxWindow* parent, ContentPanel* cp, shared_ptr<Film> film)
57 : wxPanel (parent, wxID_ANY)
58 , _labels_canvas (new wxScrolledCanvas (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE))
59 , _main_canvas (new wxScrolledCanvas (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE))
62 , _time_axis_view (new TimelineTimeAxisView (*this, 64))
63 , _reels_view (new TimelineReelsView (*this, 32))
64 , _labels_view (new TimelineLabelsView (*this))
67 , _down_view_position (0)
77 _labels_canvas->SetDoubleBuffered (true);
78 _main_canvas->SetDoubleBuffered (true);
81 wxSizer* sizer = new wxBoxSizer (wxHORIZONTAL);
82 sizer->Add (_labels_canvas, 0, wxEXPAND);
83 _labels_canvas->SetMinSize (wxSize (_labels_view->bbox().width, -1));
84 sizer->Add (_main_canvas, 1, wxEXPAND);
87 _labels_canvas->Bind (wxEVT_PAINT, boost::bind (&Timeline::paint_labels, this));
88 _main_canvas->Bind (wxEVT_PAINT, boost::bind (&Timeline::paint_main, this));
89 _main_canvas->Bind (wxEVT_LEFT_DOWN, boost::bind (&Timeline::left_down, this, _1));
90 _main_canvas->Bind (wxEVT_LEFT_UP, boost::bind (&Timeline::left_up, this, _1));
91 _main_canvas->Bind (wxEVT_RIGHT_DOWN, boost::bind (&Timeline::right_down, this, _1));
92 _main_canvas->Bind (wxEVT_MOTION, boost::bind (&Timeline::mouse_moved, this, _1));
93 _main_canvas->Bind (wxEVT_SIZE, boost::bind (&Timeline::resized, this));
95 film_changed (Film::CONTENT);
97 SetMinSize (wxSize (640, 4 * track_height() + 96));
99 _film_changed_connection = film->Changed.connect (bind (&Timeline::film_changed, this, _1));
100 _film_content_changed_connection = film->ContentChanged.connect (bind (&Timeline::film_content_changed, this, _2, _3));
102 _pixels_per_second = max (0.01, static_cast<double>(640) / film->length().seconds ());
105 _labels_canvas->ShowScrollbars (wxSHOW_SB_NEVER, wxSHOW_SB_NEVER);
109 Timeline::paint_labels ()
111 wxPaintDC dc (_labels_canvas);
113 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
119 _labels_canvas->GetViewStart (&vsx, &vsy);
120 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate);
122 _labels_view->paint (gc, list<dcpomatic::Rect<int> >());
128 Timeline::paint_main ()
130 wxPaintDC dc (_main_canvas);
131 _main_canvas->DoPrepareDC (dc);
133 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
139 _main_canvas->GetViewStart (&vsx, &vsy);
140 gc->Translate (-vsx * _x_scroll_rate, -vsy * _y_scroll_rate);
142 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
144 BOOST_FOREACH (shared_ptr<TimelineView> i, _views) {
146 shared_ptr<TimelineContentView> ic = dynamic_pointer_cast<TimelineContentView> (i);
148 /* Find areas of overlap with other content views, so that we can plot them */
149 list<dcpomatic::Rect<int> > overlaps;
150 BOOST_FOREACH (shared_ptr<TimelineView> j, _views) {
151 shared_ptr<TimelineContentView> jc = dynamic_pointer_cast<TimelineContentView> (j);
152 /* No overlap with non-content views, views no different tracks, audio views or non-active views */
153 if (!ic || !jc || i == j || ic->track() != jc->track() || ic->track().get_value_or(2) >= 2 || !ic->active() || !jc->active()) {
157 optional<dcpomatic::Rect<int> > r = j->bbox().intersection (i->bbox());
159 overlaps.push_back (r.get ());
163 i->paint (gc, overlaps);
167 /* Translate back as _down_point and _zoom_point do not take scroll into account */
168 gc->Translate (vsx * _x_scroll_rate, vsy * _y_scroll_rate);
169 gc->SetPen (*wxBLACK_PEN);
170 gc->SetBrush (*wxTRANSPARENT_BRUSH);
172 min (_down_point.x, _zoom_point->x),
173 min (_down_point.y, _zoom_point->y),
174 fabs (_down_point.x - _zoom_point->x),
175 fabs (_down_point.y - _zoom_point->y)
183 Timeline::film_changed (Film::Property p)
185 if (p == Film::CONTENT || p == Film::REEL_TYPE || p == Film::REEL_LENGTH) {
188 } else if (p == Film::CONTENT_ORDER) {
194 Timeline::recreate_views ()
196 shared_ptr<const Film> film = _film.lock ();
202 _views.push_back (_time_axis_view);
203 _views.push_back (_reels_view);
205 BOOST_FOREACH (shared_ptr<Content> i, film->content ()) {
207 _views.push_back (shared_ptr<TimelineView> (new TimelineVideoContentView (*this, i)));
210 if (i->audio && !i->audio->mapping().mapped_output_channels().empty ()) {
211 _views.push_back (shared_ptr<TimelineView> (new TimelineAudioContentView (*this, i)));
215 _views.push_back (shared_ptr<TimelineView> (new TimelineSubtitleContentView (*this, i)));
218 if (dynamic_pointer_cast<AtmosMXFContent> (i)) {
219 _views.push_back (shared_ptr<TimelineView> (new TimelineAtmosContentView (*this, i)));
229 Timeline::film_content_changed (int property, bool frequent)
233 if (property == AudioContentProperty::STREAMS) {
235 } else if (!frequent) {
243 place (TimelineViewList& views, int& tracks)
245 int const base = tracks;
247 BOOST_FOREACH (shared_ptr<TimelineView> i, views) {
248 if (!dynamic_pointer_cast<T>(i)) {
252 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (i);
256 shared_ptr<Content> content = cv->content();
257 DCPTimePeriod const content_period (content->position(), content->end());
260 TimelineViewList::iterator j = views.begin();
261 while (j != views.end()) {
262 shared_ptr<T> test = dynamic_pointer_cast<T> (*j);
268 shared_ptr<Content> test_content = test->content();
270 test->track() && test->track().get() == t &&
271 content_period.overlap(DCPTimePeriod(test_content->position(), test_content->end()))) {
272 /* we have an overlap on track `t' */
280 if (j == views.end ()) {
281 /* no overlap on `t' */
287 tracks = max (tracks, t + 1);
290 return tracks - base;
294 Timeline::assign_tracks ()
297 Video (mono or left-eye)
310 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
311 shared_ptr<TimelineContentView> c = dynamic_pointer_cast<TimelineContentView> (*i);
319 bool have_3d = false;
320 BOOST_FOREACH (shared_ptr<TimelineView> i, _views) {
321 shared_ptr<TimelineVideoContentView> cv = dynamic_pointer_cast<TimelineVideoContentView> (i);
326 /* Video on tracks 0 and maybe 1 (left and right eye) */
327 if (cv->content()->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
329 _tracks = max (_tracks, 2);
336 _tracks = max (_tracks, 1);
340 int const subtitle_tracks = place<TimelineSubtitleContentView> (_views, _tracks);
344 bool have_atmos = false;
345 BOOST_FOREACH (shared_ptr<TimelineView> i, _views) {
346 shared_ptr<TimelineVideoContentView> cv = dynamic_pointer_cast<TimelineVideoContentView> (i);
350 if (dynamic_pointer_cast<TimelineAtmosContentView> (i)) {
351 cv->set_track (_tracks - 1);
362 place<TimelineAudioContentView> (_views, _tracks);
364 _labels_view->set_3d (have_3d);
365 _labels_view->set_subtitle_tracks (subtitle_tracks);
366 _labels_view->set_atmos (have_atmos);
368 _time_axis_view->set_y (tracks() * track_height() + 64);
369 _reels_view->set_y (8);
373 Timeline::tracks () const
379 Timeline::setup_scrollbars ()
381 shared_ptr<const Film> film = _film.lock ();
382 if (!film || !_pixels_per_second) {
385 _labels_canvas->SetVirtualSize (_labels_view->bbox().width, tracks() * track_height() + 96);
386 _labels_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
387 _main_canvas->SetVirtualSize (*_pixels_per_second * film->length().seconds(), tracks() * track_height() + 96);
388 _main_canvas->SetScrollRate (_x_scroll_rate, _y_scroll_rate);
391 shared_ptr<TimelineView>
392 Timeline::event_to_view (wxMouseEvent& ev)
394 /* Search backwards through views so that we find the uppermost one first */
395 TimelineViewList::reverse_iterator i = _views.rbegin();
396 Position<int> const p (ev.GetX(), ev.GetY());
397 while (i != _views.rend() && !(*i)->bbox().contains (p)) {
398 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
402 if (i == _views.rend ()) {
403 return shared_ptr<TimelineView> ();
410 Timeline::left_down (wxMouseEvent& ev)
413 _down_point = ev.GetPosition ();
417 left_down_select (ev);
426 Timeline::left_down_select (wxMouseEvent& ev)
428 shared_ptr<TimelineView> view = event_to_view (ev);
429 shared_ptr<TimelineContentView> content_view = dynamic_pointer_cast<TimelineContentView> (view);
434 _down_view = content_view;
435 _down_view_position = content_view->content()->position ();
438 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
439 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
444 if (!ev.ShiftDown ()) {
445 cv->set_selected (view == *i);
449 if (content_view && ev.ShiftDown ()) {
450 content_view->set_selected (!content_view->selected ());
456 /* Pre-compute the points that we might snap to */
457 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
458 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
459 if (!cv || cv == _down_view || cv->content() == _down_view->content()) {
463 _start_snaps.push_back (cv->content()->position());
464 _end_snaps.push_back (cv->content()->position());
465 _start_snaps.push_back (cv->content()->end());
466 _end_snaps.push_back (cv->content()->end());
468 BOOST_FOREACH (DCPTime i, cv->content()->reel_split_points()) {
469 _start_snaps.push_back (i);
473 /* Tell everyone that things might change frequently during the drag */
474 _down_view->content()->set_change_signals_frequent (true);
479 Timeline::left_up (wxMouseEvent& ev)
494 Timeline::left_up_select (wxMouseEvent& ev)
497 _down_view->content()->set_change_signals_frequent (false);
500 _content_panel->set_selection (selected_content ());
501 set_position_from_event (ev);
503 /* Clear up up the stuff we don't do during drag */
508 _start_snaps.clear ();
513 Timeline::left_up_zoom (wxMouseEvent& ev)
515 _zoom_point = ev.GetPosition ();
518 _main_canvas->GetViewStart (&vsx, &vsy);
520 wxPoint top_left(min(_down_point.x, _zoom_point->x), min(_down_point.y, _zoom_point->y));
521 wxPoint bottom_right(max(_down_point.x, _zoom_point->x), max(_down_point.y, _zoom_point->y));
523 DCPTime const time_left = DCPTime::from_seconds((top_left.x + vsx) / *_pixels_per_second);
524 DCPTime const time_right = DCPTime::from_seconds((bottom_right.x + vsx) / *_pixels_per_second);
525 _pixels_per_second = GetSize().GetWidth() / (time_right.seconds() - time_left.seconds());
527 double const tracks_top = double(top_left.y) / _track_height;
528 double const tracks_bottom = double(bottom_right.y) / _track_height;
529 _track_height = GetSize().GetHeight() / (tracks_bottom - tracks_top);
532 _main_canvas->Scroll (time_left.seconds() * *_pixels_per_second / _x_scroll_rate, tracks_top * _track_height / _y_scroll_rate);
533 _labels_canvas->Scroll (0, tracks_top * _track_height / _y_scroll_rate);
535 _zoom_point = optional<wxPoint> ();
540 Timeline::mouse_moved (wxMouseEvent& ev)
544 mouse_moved_select (ev);
547 mouse_moved_zoom (ev);
553 Timeline::mouse_moved_select (wxMouseEvent& ev)
559 set_position_from_event (ev);
563 Timeline::mouse_moved_zoom (wxMouseEvent& ev)
569 _zoom_point = ev.GetPosition ();
574 Timeline::right_down (wxMouseEvent& ev)
578 right_down_select (ev);
582 _pixels_per_second = *_pixels_per_second / 2;
583 _track_height = max (8, _track_height / 2);
591 Timeline::right_down_select (wxMouseEvent& ev)
593 shared_ptr<TimelineView> view = event_to_view (ev);
594 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (view);
599 if (!cv->selected ()) {
601 cv->set_selected (true);
604 _menu.popup (_film, selected_content (), selected_views (), ev.GetPosition ());
608 Timeline::maybe_snap (DCPTime a, DCPTime b, optional<DCPTime>& nearest_distance) const
610 DCPTime const d = a - b;
611 if (!nearest_distance || d.abs() < nearest_distance.get().abs()) {
612 nearest_distance = d;
617 Timeline::set_position_from_event (wxMouseEvent& ev)
619 if (!_pixels_per_second) {
623 double const pps = _pixels_per_second.get ();
625 wxPoint const p = ev.GetPosition();
628 /* We haven't moved yet; in that case, we must move the mouse some reasonable distance
629 before the drag is considered to have started.
631 int const dist = sqrt (pow (p.x - _down_point.x, 2) + pow (p.y - _down_point.y, 2));
642 DCPTime new_position = _down_view_position + DCPTime::from_seconds ((p.x - _down_point.x) / pps);
646 DCPTime const new_end = new_position + _down_view->content()->length_after_trim();
647 /* Signed `distance' to nearest thing (i.e. negative is left on the timeline,
650 optional<DCPTime> nearest_distance;
652 /* Find the nearest snap point */
654 BOOST_FOREACH (DCPTime i, _start_snaps) {
655 maybe_snap (i, new_position, nearest_distance);
658 BOOST_FOREACH (DCPTime i, _end_snaps) {
659 maybe_snap (i, new_end, nearest_distance);
662 if (nearest_distance) {
663 /* Snap if it's close; `close' means within a proportion of the time on the timeline */
664 if (nearest_distance.get().abs() < DCPTime::from_seconds ((width() / pps) / 64)) {
665 new_position += nearest_distance.get ();
670 if (new_position < DCPTime ()) {
671 new_position = DCPTime ();
674 _down_view->content()->set_position (new_position);
676 shared_ptr<Film> film = _film.lock ();
677 DCPOMATIC_ASSERT (film);
678 film->set_sequence (false);
682 Timeline::force_redraw (dcpomatic::Rect<int> const & r)
684 RefreshRect (wxRect (r.x, r.y, r.width, r.height), false);
687 shared_ptr<const Film>
688 Timeline::film () const
690 return _film.lock ();
700 Timeline::clear_selection ()
702 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
703 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
705 cv->set_selected (false);
710 TimelineContentViewList
711 Timeline::selected_views () const
713 TimelineContentViewList sel;
715 for (TimelineViewList::const_iterator i = _views.begin(); i != _views.end(); ++i) {
716 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
717 if (cv && cv->selected()) {
726 Timeline::selected_content () const
729 TimelineContentViewList views = selected_views ();
731 for (TimelineContentViewList::const_iterator i = views.begin(); i != views.end(); ++i) {
732 sel.push_back ((*i)->content ());
739 Timeline::set_selection (ContentList selection)
741 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
742 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
744 cv->set_selected (find (selection.begin(), selection.end(), cv->content ()) != selection.end ());