2 Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include <wx/graphics.h>
22 #include <boost/weak_ptr.hpp>
24 #include "lib/playlist.h"
25 #include "lib/image_content.h"
26 #include "film_editor.h"
28 #include "content_panel.h"
34 using boost::shared_ptr;
35 using boost::weak_ptr;
36 using boost::dynamic_pointer_cast;
38 using boost::optional;
41 * @brief Parent class for components of the timeline (e.g. a piece of content or an axis).
43 class View : public boost::noncopyable
54 void paint (wxGraphicsContext* g)
56 _last_paint_bbox = bbox ();
62 _timeline.force_redraw (_last_paint_bbox);
63 _timeline.force_redraw (bbox ());
66 virtual dcpomatic::Rect<int> bbox () const = 0;
69 virtual void do_paint (wxGraphicsContext *) = 0;
71 int time_x (DCPTime t) const
73 return _timeline.tracks_position().x + t.seconds() * _timeline.pixels_per_second().get_value_or (0);
79 dcpomatic::Rect<int> _last_paint_bbox;
83 /** @class ContentView
84 * @brief Parent class for views of pieces of content.
86 class ContentView : public View
89 ContentView (Timeline& tl, shared_ptr<Content> c)
94 _content_connection = c->Changed.connect (bind (&ContentView::content_changed, this, _2, _3));
97 dcpomatic::Rect<int> bbox () const
99 DCPOMATIC_ASSERT (_track);
101 shared_ptr<const Film> film = _timeline.film ();
102 shared_ptr<const Content> content = _content.lock ();
103 if (!film || !content) {
104 return dcpomatic::Rect<int> ();
107 return dcpomatic::Rect<int> (
108 time_x (content->position ()) - 8,
109 y_pos (_track.get()) - 8,
110 content->length_after_trim().seconds() * _timeline.pixels_per_second().get_value_or(0) + 16,
111 _timeline.track_height() + 16
115 void set_selected (bool s) {
120 bool selected () const {
124 shared_ptr<Content> content () const {
125 return _content.lock ();
128 void set_track (int t) {
132 void unset_track () {
133 _track = boost::optional<int> ();
136 optional<int> track () const {
140 virtual wxString type () const = 0;
141 virtual wxColour background_colour () const = 0;
142 virtual wxColour foreground_colour () const = 0;
146 void do_paint (wxGraphicsContext* gc)
148 DCPOMATIC_ASSERT (_track);
150 shared_ptr<const Film> film = _timeline.film ();
151 shared_ptr<const Content> cont = content ();
152 if (!film || !cont) {
156 DCPTime const position = cont->position ();
157 DCPTime const len = cont->length_after_trim ();
159 wxColour selected (background_colour().Red() / 2, background_colour().Green() / 2, background_colour().Blue() / 2);
161 gc->SetPen (*wxThePenList->FindOrCreatePen (foreground_colour(), 4, wxPENSTYLE_SOLID));
163 gc->SetBrush (*wxTheBrushList->FindOrCreateBrush (selected, wxBRUSHSTYLE_SOLID));
165 gc->SetBrush (*wxTheBrushList->FindOrCreateBrush (background_colour(), wxBRUSHSTYLE_SOLID));
168 wxGraphicsPath path = gc->CreatePath ();
169 path.MoveToPoint (time_x (position), y_pos (_track.get()) + 4);
170 path.AddLineToPoint (time_x (position + len), y_pos (_track.get()) + 4);
171 path.AddLineToPoint (time_x (position + len), y_pos (_track.get() + 1) - 4);
172 path.AddLineToPoint (time_x (position), y_pos (_track.get() + 1) - 4);
173 path.AddLineToPoint (time_x (position), y_pos (_track.get()) + 4);
174 gc->StrokePath (path);
177 wxString name = wxString::Format (wxT ("%s [%s]"), std_to_wx (cont->summary()).data(), type().data());
179 wxDouble name_height;
180 wxDouble name_descent;
181 wxDouble name_leading;
182 gc->GetTextExtent (name, &name_width, &name_height, &name_descent, &name_leading);
184 gc->Clip (wxRegion (time_x (position), y_pos (_track.get()), len.seconds() * _timeline.pixels_per_second().get_value_or(0), _timeline.track_height()));
185 gc->SetFont (gc->CreateFont (*wxNORMAL_FONT, foreground_colour ()));
186 gc->DrawText (name, time_x (position) + 12, y_pos (_track.get() + 1) - name_height - 4);
190 int y_pos (int t) const
192 return _timeline.tracks_position().y + t * _timeline.track_height();
195 void content_changed (int p, bool frequent)
199 if (p == ContentProperty::POSITION || p == ContentProperty::LENGTH) {
204 _timeline.setup_pixels_per_second ();
205 _timeline.Refresh ();
209 boost::weak_ptr<Content> _content;
210 optional<int> _track;
213 boost::signals2::scoped_connection _content_connection;
216 /** @class AudioContentView
217 * @brief Timeline view for AudioContent.
219 class AudioContentView : public ContentView
222 AudioContentView (Timeline& tl, shared_ptr<Content> c)
223 : ContentView (tl, c)
227 wxString type () const
232 wxColour background_colour () const
234 return wxColour (149, 121, 232, 255);
237 wxColour foreground_colour () const
239 return wxColour (0, 0, 0, 255);
243 /** @class AudioContentView
244 * @brief Timeline view for VideoContent.
246 class VideoContentView : public ContentView
249 VideoContentView (Timeline& tl, shared_ptr<Content> c)
250 : ContentView (tl, c)
255 wxString type () const
257 if (dynamic_pointer_cast<ImageContent> (content ()) && content()->number_of_paths() == 1) {
264 wxColour background_colour () const
266 return wxColour (242, 92, 120, 255);
269 wxColour foreground_colour () const
271 return wxColour (0, 0, 0, 255);
275 /** @class AudioContentView
276 * @brief Timeline view for SubtitleContent.
278 class SubtitleContentView : public ContentView
281 SubtitleContentView (Timeline& tl, shared_ptr<SubtitleContent> c)
282 : ContentView (tl, c)
283 , _subtitle_content (c)
287 wxString type () const
289 return _("subtitles");
292 wxColour background_colour () const
294 shared_ptr<SubtitleContent> sc = _subtitle_content.lock ();
295 if (!sc || !sc->use_subtitles ()) {
296 return wxColour (210, 210, 210, 128);
299 return wxColour (163, 255, 154, 255);
302 wxColour foreground_colour () const
304 shared_ptr<SubtitleContent> sc = _subtitle_content.lock ();
305 if (!sc || !sc->use_subtitles ()) {
306 return wxColour (180, 180, 180, 128);
309 return wxColour (0, 0, 0, 255);
312 boost::weak_ptr<SubtitleContent> _subtitle_content;
315 class TimeAxisView : public View
318 TimeAxisView (Timeline& tl, int y)
323 dcpomatic::Rect<int> bbox () const
325 return dcpomatic::Rect<int> (0, _y - 4, _timeline.width(), 24);
336 void do_paint (wxGraphicsContext* gc)
338 if (!_timeline.pixels_per_second()) {
342 double const pps = _timeline.pixels_per_second().get ();
344 gc->SetPen (*wxThePenList->FindOrCreatePen (wxColour (0, 0, 0), 1, wxPENSTYLE_SOLID));
346 double mark_interval = rint (128 / pps);
347 if (mark_interval > 5) {
348 mark_interval -= int (rint (mark_interval)) % 5;
350 if (mark_interval > 10) {
351 mark_interval -= int (rint (mark_interval)) % 10;
353 if (mark_interval > 60) {
354 mark_interval -= int (rint (mark_interval)) % 60;
356 if (mark_interval > 3600) {
357 mark_interval -= int (rint (mark_interval)) % 3600;
360 if (mark_interval < 1) {
364 wxGraphicsPath path = gc->CreatePath ();
365 path.MoveToPoint (_timeline.x_offset(), _y);
366 path.AddLineToPoint (_timeline.width(), _y);
367 gc->StrokePath (path);
369 gc->SetFont (gc->CreateFont (*wxNORMAL_FONT));
371 /* Time in seconds */
373 while ((t.seconds() * pps) < _timeline.width()) {
374 wxGraphicsPath path = gc->CreatePath ();
375 path.MoveToPoint (time_x (t), _y - 4);
376 path.AddLineToPoint (time_x (t), _y + 4);
377 gc->StrokePath (path);
379 double tc = t.seconds ();
380 int const h = tc / 3600;
382 int const m = tc / 60;
386 wxString str = wxString::Format (wxT ("%02d:%02d:%02d"), h, m, s);
389 wxDouble str_descent;
390 wxDouble str_leading;
391 gc->GetTextExtent (str, &str_width, &str_height, &str_descent, &str_leading);
393 int const tx = _timeline.x_offset() + t.seconds() * pps;
394 if ((tx + str_width) < _timeline.width()) {
395 gc->DrawText (str, time_x (t), _y + 16);
398 t += DCPTime::from_seconds (mark_interval);
407 Timeline::Timeline (wxWindow* parent, ContentPanel* cp, shared_ptr<Film> film)
408 : wxPanel (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE)
409 , _content_panel (cp)
411 , _time_axis_view (new TimeAxisView (*this, 32))
414 , _down_view_position (0)
415 , _first_move (false)
420 SetDoubleBuffered (true);
423 Bind (wxEVT_PAINT, boost::bind (&Timeline::paint, this));
424 Bind (wxEVT_LEFT_DOWN, boost::bind (&Timeline::left_down, this, _1));
425 Bind (wxEVT_LEFT_UP, boost::bind (&Timeline::left_up, this, _1));
426 Bind (wxEVT_RIGHT_DOWN, boost::bind (&Timeline::right_down, this, _1));
427 Bind (wxEVT_MOTION, boost::bind (&Timeline::mouse_moved, this, _1));
428 Bind (wxEVT_SIZE, boost::bind (&Timeline::resized, this));
432 SetMinSize (wxSize (640, tracks() * track_height() + 96));
434 _playlist_changed_connection = film->playlist()->Changed.connect (bind (&Timeline::playlist_changed, this));
435 _playlist_content_changed_connection = film->playlist()->ContentChanged.connect (bind (&Timeline::playlist_content_changed, this, _2));
443 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
448 for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
456 Timeline::playlist_changed ()
460 shared_ptr<const Film> fl = _film.lock ();
466 _views.push_back (_time_axis_view);
468 ContentList content = fl->playlist()->content ();
470 for (ContentList::iterator i = content.begin(); i != content.end(); ++i) {
471 if (dynamic_pointer_cast<VideoContent> (*i)) {
472 _views.push_back (shared_ptr<View> (new VideoContentView (*this, *i)));
474 if (dynamic_pointer_cast<AudioContent> (*i)) {
475 _views.push_back (shared_ptr<View> (new AudioContentView (*this, *i)));
478 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (*i);
479 if (sc && sc->has_subtitles ()) {
480 _views.push_back (shared_ptr<View> (new SubtitleContentView (*this, sc)));
485 setup_pixels_per_second ();
490 Timeline::playlist_content_changed (int property)
494 if (property == ContentProperty::POSITION) {
496 setup_pixels_per_second ();
502 Timeline::assign_tracks ()
504 for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
505 shared_ptr<ContentView> c = dynamic_pointer_cast<ContentView> (*i);
511 for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
512 shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
517 shared_ptr<Content> content = cv->content();
521 ViewList::iterator j = _views.begin();
522 while (j != _views.end()) {
523 shared_ptr<ContentView> test = dynamic_pointer_cast<ContentView> (*j);
529 shared_ptr<Content> test_content = test->content();
531 if (test && test->track() && test->track().get() == t) {
532 bool const no_overlap =
533 (content->position() < test_content->position() && content->end() < test_content->position()) ||
534 (content->position() > test_content->end() && content->end() > test_content->end());
537 /* we have an overlap on track `t' */
546 if (j == _views.end ()) {
547 /* no overlap on `t' */
553 _tracks = max (_tracks, t + 1);
556 _time_axis_view->set_y (tracks() * track_height() + 32);
560 Timeline::tracks () const
566 Timeline::setup_pixels_per_second ()
568 shared_ptr<const Film> film = _film.lock ();
569 if (!film || film->length() == DCPTime ()) {
573 _pixels_per_second = static_cast<double>(width() - x_offset() * 2) / film->length().seconds ();
577 Timeline::event_to_view (wxMouseEvent& ev)
579 ViewList::iterator i = _views.begin();
580 Position<int> const p (ev.GetX(), ev.GetY());
581 while (i != _views.end() && !(*i)->bbox().contains (p)) {
585 if (i == _views.end ()) {
586 return shared_ptr<View> ();
593 Timeline::left_down (wxMouseEvent& ev)
595 shared_ptr<View> view = event_to_view (ev);
596 shared_ptr<ContentView> content_view = dynamic_pointer_cast<ContentView> (view);
601 _down_view = content_view;
602 _down_view_position = content_view->content()->position ();
605 for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
606 shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
611 if (!ev.ShiftDown ()) {
612 cv->set_selected (view == *i);
616 _content_panel->set_selection (cv->content ());
620 if (content_view && ev.ShiftDown ()) {
621 content_view->set_selected (!content_view->selected ());
625 _down_point = ev.GetPosition ();
629 _down_view->content()->set_change_signals_frequent (true);
634 Timeline::left_up (wxMouseEvent& ev)
639 _down_view->content()->set_change_signals_frequent (false);
642 set_position_from_event (ev);
646 Timeline::mouse_moved (wxMouseEvent& ev)
652 set_position_from_event (ev);
656 Timeline::right_down (wxMouseEvent& ev)
658 shared_ptr<View> view = event_to_view (ev);
659 shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (view);
664 if (!cv->selected ()) {
666 cv->set_selected (true);
669 _menu.popup (_film, selected_content (), ev.GetPosition ());
673 Timeline::maybe_snap (DCPTime a, DCPTime b, optional<DCPTime>& nearest_distance) const
675 DCPTime const d = a - b;
676 if (!nearest_distance || d.abs() < nearest_distance.get().abs()) {
677 nearest_distance = d;
682 Timeline::set_position_from_event (wxMouseEvent& ev)
684 if (!_pixels_per_second) {
688 double const pps = _pixels_per_second.get ();
690 wxPoint const p = ev.GetPosition();
693 /* We haven't moved yet; in that case, we must move the mouse some reasonable distance
694 before the drag is considered to have started.
696 int const dist = sqrt (pow (p.x - _down_point.x, 2) + pow (p.y - _down_point.y, 2));
707 DCPTime new_position = _down_view_position + DCPTime::from_seconds ((p.x - _down_point.x) / pps);
711 DCPTime const new_end = new_position + _down_view->content()->length_after_trim ();
712 /* Signed `distance' to nearest thing (i.e. negative is left on the timeline,
715 optional<DCPTime> nearest_distance;
717 /* Find the nearest content edge; this is inefficient */
718 for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
719 shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
720 if (!cv || cv == _down_view) {
724 maybe_snap (cv->content()->position(), new_position, nearest_distance);
725 maybe_snap (cv->content()->position(), new_end, nearest_distance);
726 maybe_snap (cv->content()->end(), new_position, nearest_distance);
727 maybe_snap (cv->content()->end(), new_end, nearest_distance);
730 if (nearest_distance) {
731 /* Snap if it's close; `close' means within a proportion of the time on the timeline */
732 if (nearest_distance.get().abs() < DCPTime::from_seconds ((width() / pps) / 64)) {
733 new_position += nearest_distance.get ();
738 if (new_position < DCPTime ()) {
739 new_position = DCPTime ();
742 _down_view->content()->set_position (new_position);
744 shared_ptr<Film> film = _film.lock ();
745 DCPOMATIC_ASSERT (film);
746 film->set_sequence_video (false);
750 Timeline::force_redraw (dcpomatic::Rect<int> const & r)
752 RefreshRect (wxRect (r.x, r.y, r.width, r.height), false);
755 shared_ptr<const Film>
756 Timeline::film () const
758 return _film.lock ();
764 setup_pixels_per_second ();
768 Timeline::clear_selection ()
770 for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
771 shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
773 cv->set_selected (false);
778 Timeline::ContentViewList
779 Timeline::selected_views () const
783 for (ViewList::const_iterator i = _views.begin(); i != _views.end(); ++i) {
784 shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
785 if (cv && cv->selected()) {
794 Timeline::selected_content () const
797 ContentViewList views = selected_views ();
799 for (ContentViewList::const_iterator i = views.begin(); i != views.end(); ++i) {
800 sel.push_back ((*i)->content ());