#include trimming.
[dcpomatic.git] / src / wx / timeline.cc
1 /*
2     Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
3
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.
8
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.
13
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.
17
18 */
19
20 #include <list>
21 #include <wx/graphics.h>
22 #include <boost/weak_ptr.hpp>
23 #include "lib/film.h"
24 #include "lib/playlist.h"
25 #include "lib/image_content.h"
26 #include "film_editor.h"
27 #include "timeline.h"
28 #include "content_panel.h"
29 #include "wx_util.h"
30
31 using std::list;
32 using std::cout;
33 using std::max;
34 using boost::shared_ptr;
35 using boost::weak_ptr;
36 using boost::dynamic_pointer_cast;
37 using boost::bind;
38 using boost::optional;
39
40 /** @class View
41  *  @brief Parent class for components of the timeline (e.g. a piece of content or an axis).
42  */
43 class View : public boost::noncopyable
44 {
45 public:
46         View (Timeline& t)
47                 : _timeline (t)
48         {
49
50         }
51
52         virtual ~View () {}
53                 
54         void paint (wxGraphicsContext* g)
55         {
56                 _last_paint_bbox = bbox ();
57                 do_paint (g);
58         }
59         
60         void force_redraw ()
61         {
62                 _timeline.force_redraw (_last_paint_bbox);
63                 _timeline.force_redraw (bbox ());
64         }
65
66         virtual dcpomatic::Rect<int> bbox () const = 0;
67
68 protected:
69         virtual void do_paint (wxGraphicsContext *) = 0;
70         
71         int time_x (DCPTime t) const
72         {
73                 return _timeline.tracks_position().x + t.seconds() * _timeline.pixels_per_second().get_value_or (0);
74         }
75         
76         Timeline& _timeline;
77
78 private:
79         dcpomatic::Rect<int> _last_paint_bbox;
80 };
81
82
83 /** @class ContentView
84  *  @brief Parent class for views of pieces of content.
85  */
86 class ContentView : public View
87 {
88 public:
89         ContentView (Timeline& tl, shared_ptr<Content> c)
90                 : View (tl)
91                 , _content (c)
92                 , _selected (false)
93         {
94                 _content_connection = c->Changed.connect (bind (&ContentView::content_changed, this, _2, _3));
95         }
96
97         dcpomatic::Rect<int> bbox () const
98         {
99                 assert (_track);
100
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> ();
105                 }
106                 
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
112                         );
113         }
114
115         void set_selected (bool s) {
116                 _selected = s;
117                 force_redraw ();
118         }
119         
120         bool selected () const {
121                 return _selected;
122         }
123
124         shared_ptr<Content> content () const {
125                 return _content.lock ();
126         }
127
128         void set_track (int t) {
129                 _track = t;
130         }
131
132         void unset_track () {
133                 _track = boost::optional<int> ();
134         }
135
136         optional<int> track () const {
137                 return _track;
138         }
139
140         virtual wxString type () const = 0;
141         virtual wxColour background_colour () const = 0;
142         virtual wxColour foreground_colour () const = 0;
143         
144 private:
145
146         void do_paint (wxGraphicsContext* gc)
147         {
148                 assert (_track);
149
150                 shared_ptr<const Film> film = _timeline.film ();
151                 shared_ptr<const Content> cont = content ();
152                 if (!film || !cont) {
153                         return;
154                 }
155
156                 DCPTime const position = cont->position ();
157                 DCPTime const len = cont->length_after_trim ();
158
159                 wxColour selected (background_colour().Red() / 2, background_colour().Green() / 2, background_colour().Blue() / 2);
160
161                 gc->SetPen (*wxThePenList->FindOrCreatePen (foreground_colour(), 4, wxPENSTYLE_SOLID));
162                 if (_selected) {
163                         gc->SetBrush (*wxTheBrushList->FindOrCreateBrush (selected, wxBRUSHSTYLE_SOLID));
164                 } else {
165                         gc->SetBrush (*wxTheBrushList->FindOrCreateBrush (background_colour(), wxBRUSHSTYLE_SOLID));
166                 }
167
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);
175                 gc->FillPath (path);
176
177                 wxString name = wxString::Format (wxT ("%s [%s]"), std_to_wx (cont->summary()).data(), type().data());
178                 wxDouble name_width;
179                 wxDouble name_height;
180                 wxDouble name_descent;
181                 wxDouble name_leading;
182                 gc->GetTextExtent (name, &name_width, &name_height, &name_descent, &name_leading);
183                 
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);
187                 gc->ResetClip ();
188         }
189
190         int y_pos (int t) const
191         {
192                 return _timeline.tracks_position().y + t * _timeline.track_height();
193         }
194
195         void content_changed (int p, bool frequent)
196         {
197                 ensure_ui_thread ();
198                 
199                 if (p == ContentProperty::POSITION || p == ContentProperty::LENGTH) {
200                         force_redraw ();
201                 }
202
203                 if (!frequent) {
204                         _timeline.setup_pixels_per_second ();
205                         _timeline.Refresh ();
206                 }
207         }
208
209         boost::weak_ptr<Content> _content;
210         optional<int> _track;
211         bool _selected;
212
213         boost::signals2::scoped_connection _content_connection;
214 };
215
216 class AudioContentView : public ContentView
217 {
218 public:
219         AudioContentView (Timeline& tl, shared_ptr<Content> c)
220                 : ContentView (tl, c)
221         {}
222         
223 private:
224         wxString type () const
225         {
226                 return _("audio");
227         }
228
229         wxColour background_colour () const
230         {
231                 return wxColour (149, 121, 232, 255);
232         }
233
234         wxColour foreground_colour () const
235         {
236                 return wxColour (0, 0, 0, 255);
237         }
238 };
239
240 class VideoContentView : public ContentView
241 {
242 public:
243         VideoContentView (Timeline& tl, shared_ptr<Content> c)
244                 : ContentView (tl, c)
245         {}
246
247 private:        
248
249         wxString type () const
250         {
251                 if (dynamic_pointer_cast<ImageContent> (content ()) && content()->number_of_paths() == 1) {
252                         return _("still");
253                 } else {
254                         return _("video");
255                 }
256         }
257
258         wxColour background_colour () const
259         {
260                 return wxColour (242, 92, 120, 255);
261         }
262
263         wxColour foreground_colour () const
264         {
265                 return wxColour (0, 0, 0, 255);
266         }
267 };
268
269 class SubtitleContentView : public ContentView
270 {
271 public:
272         SubtitleContentView (Timeline& tl, shared_ptr<SubtitleContent> c)
273                 : ContentView (tl, c)
274                 , _subtitle_content (c)
275         {}
276
277 private:
278         wxString type () const
279         {
280                 return _("subtitles");
281         }
282
283         wxColour background_colour () const
284         {
285                 shared_ptr<SubtitleContent> sc = _subtitle_content.lock ();
286                 if (!sc || !sc->use_subtitles ()) {
287                         return wxColour (210, 210, 210, 128);
288                 }
289                 
290                 return wxColour (163, 255, 154, 255);
291         }
292
293         wxColour foreground_colour () const
294         {
295                 shared_ptr<SubtitleContent> sc = _subtitle_content.lock ();
296                 if (!sc || !sc->use_subtitles ()) {
297                         return wxColour (180, 180, 180, 128);
298                 }
299
300                 return wxColour (0, 0, 0, 255);
301         }
302
303         boost::weak_ptr<SubtitleContent> _subtitle_content;
304 };
305
306 class TimeAxisView : public View
307 {
308 public:
309         TimeAxisView (Timeline& tl, int y)
310                 : View (tl)
311                 , _y (y)
312         {}
313         
314         dcpomatic::Rect<int> bbox () const
315         {
316                 return dcpomatic::Rect<int> (0, _y - 4, _timeline.width(), 24);
317         }
318
319         void set_y (int y)
320         {
321                 _y = y;
322                 force_redraw ();
323         }
324
325 private:        
326
327         void do_paint (wxGraphicsContext* gc)
328         {
329                 if (!_timeline.pixels_per_second()) {
330                         return;
331                 }
332
333                 double const pps = _timeline.pixels_per_second().get ();
334                 
335                 gc->SetPen (*wxThePenList->FindOrCreatePen (wxColour (0, 0, 0), 1, wxPENSTYLE_SOLID));
336                 
337                 double mark_interval = rint (128 / pps);
338                 if (mark_interval > 5) {
339                         mark_interval -= int (rint (mark_interval)) % 5;
340                 }
341                 if (mark_interval > 10) {
342                         mark_interval -= int (rint (mark_interval)) % 10;
343                 }
344                 if (mark_interval > 60) {
345                         mark_interval -= int (rint (mark_interval)) % 60;
346                 }
347                 if (mark_interval > 3600) {
348                         mark_interval -= int (rint (mark_interval)) % 3600;
349                 }
350                 
351                 if (mark_interval < 1) {
352                         mark_interval = 1;
353                 }
354
355                 wxGraphicsPath path = gc->CreatePath ();
356                 path.MoveToPoint (_timeline.x_offset(), _y);
357                 path.AddLineToPoint (_timeline.width(), _y);
358                 gc->StrokePath (path);
359
360                 gc->SetFont (gc->CreateFont (*wxNORMAL_FONT));
361                 
362                 /* Time in seconds */
363                 DCPTime t;
364                 while ((t.seconds() * pps) < _timeline.width()) {
365                         wxGraphicsPath path = gc->CreatePath ();
366                         path.MoveToPoint (time_x (t), _y - 4);
367                         path.AddLineToPoint (time_x (t), _y + 4);
368                         gc->StrokePath (path);
369
370                         double tc = t.seconds ();
371                         int const h = tc / 3600;
372                         tc -= h * 3600;
373                         int const m = tc / 60;
374                         tc -= m * 60;
375                         int const s = tc;
376                         
377                         wxString str = wxString::Format (wxT ("%02d:%02d:%02d"), h, m, s);
378                         wxDouble str_width;
379                         wxDouble str_height;
380                         wxDouble str_descent;
381                         wxDouble str_leading;
382                         gc->GetTextExtent (str, &str_width, &str_height, &str_descent, &str_leading);
383                         
384                         int const tx = _timeline.x_offset() + t.seconds() * pps;
385                         if ((tx + str_width) < _timeline.width()) {
386                                 gc->DrawText (str, time_x (t), _y + 16);
387                         }
388                         
389                         t += DCPTime::from_seconds (mark_interval);
390                 }
391         }
392
393 private:
394         int _y;
395 };
396
397
398 Timeline::Timeline (wxWindow* parent, ContentPanel* cp, shared_ptr<Film> film)
399         : wxPanel (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE)
400         , _content_panel (cp)
401         , _film (film)
402         , _time_axis_view (new TimeAxisView (*this, 32))
403         , _tracks (0)
404         , _left_down (false)
405         , _down_view_position (0)
406         , _first_move (false)
407         , _menu (this)
408         , _snap (true)
409 {
410 #ifndef __WXOSX__
411         SetDoubleBuffered (true);
412 #endif  
413
414         Bind (wxEVT_PAINT,      boost::bind (&Timeline::paint,       this));
415         Bind (wxEVT_LEFT_DOWN,  boost::bind (&Timeline::left_down,   this, _1));
416         Bind (wxEVT_LEFT_UP,    boost::bind (&Timeline::left_up,     this, _1));
417         Bind (wxEVT_RIGHT_DOWN, boost::bind (&Timeline::right_down,  this, _1));
418         Bind (wxEVT_MOTION,     boost::bind (&Timeline::mouse_moved, this, _1));
419         Bind (wxEVT_SIZE,       boost::bind (&Timeline::resized,     this));
420
421         playlist_changed ();
422
423         SetMinSize (wxSize (640, tracks() * track_height() + 96));
424
425         _playlist_changed_connection = film->playlist()->Changed.connect (bind (&Timeline::playlist_changed, this));
426         _playlist_content_changed_connection = film->playlist()->ContentChanged.connect (bind (&Timeline::playlist_content_changed, this, _2));
427 }
428
429 void
430 Timeline::paint ()
431 {
432         wxPaintDC dc (this);
433
434         wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
435         if (!gc) {
436                 return;
437         }
438
439         for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
440                 (*i)->paint (gc);
441         }
442
443         delete gc;
444 }
445
446 void
447 Timeline::playlist_changed ()
448 {
449         ensure_ui_thread ();
450         
451         shared_ptr<const Film> fl = _film.lock ();
452         if (!fl) {
453                 return;
454         }
455
456         _views.clear ();
457         _views.push_back (_time_axis_view);
458
459         ContentList content = fl->playlist()->content ();
460
461         for (ContentList::iterator i = content.begin(); i != content.end(); ++i) {
462                 if (dynamic_pointer_cast<VideoContent> (*i)) {
463                         _views.push_back (shared_ptr<View> (new VideoContentView (*this, *i)));
464                 }
465                 if (dynamic_pointer_cast<AudioContent> (*i)) {
466                         _views.push_back (shared_ptr<View> (new AudioContentView (*this, *i)));
467                 }
468
469                 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (*i);
470                 if (sc && sc->has_subtitles ()) {
471                         _views.push_back (shared_ptr<View> (new SubtitleContentView (*this, sc)));
472                 }
473         }
474
475         assign_tracks ();
476         setup_pixels_per_second ();
477         Refresh ();
478 }
479
480 void
481 Timeline::playlist_content_changed (int property)
482 {
483         ensure_ui_thread ();
484
485         if (property == ContentProperty::POSITION) {
486                 assign_tracks ();
487                 setup_pixels_per_second ();
488                 Refresh ();
489         }
490 }
491
492 void
493 Timeline::assign_tracks ()
494 {
495         for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
496                 shared_ptr<ContentView> c = dynamic_pointer_cast<ContentView> (*i);
497                 if (c) {
498                         c->unset_track ();
499                 }
500         }
501
502         for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
503                 shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
504                 if (!cv) {
505                         continue;
506                 }
507
508                 shared_ptr<Content> content = cv->content();
509
510                 int t = 0;
511                 while (true) {
512                         ViewList::iterator j = _views.begin();
513                         while (j != _views.end()) {
514                                 shared_ptr<ContentView> test = dynamic_pointer_cast<ContentView> (*j);
515                                 if (!test) {
516                                         ++j;
517                                         continue;
518                                 }
519                                 
520                                 shared_ptr<Content> test_content = test->content();
521                                         
522                                 if (test && test->track() && test->track().get() == t) {
523                                         bool const no_overlap =
524                                                 (content->position() < test_content->position() && content->end() < test_content->position()) ||
525                                                 (content->position() > test_content->end()      && content->end() > test_content->end());
526                                         
527                                         if (!no_overlap) {
528                                                 /* we have an overlap on track `t' */
529                                                 ++t;
530                                                 break;
531                                         }
532                                 }
533                                 
534                                 ++j;
535                         }
536
537                         if (j == _views.end ()) {
538                                 /* no overlap on `t' */
539                                 break;
540                         }
541                 }
542
543                 cv->set_track (t);
544                 _tracks = max (_tracks, t + 1);
545         }
546
547         _time_axis_view->set_y (tracks() * track_height() + 32);
548 }
549
550 int
551 Timeline::tracks () const
552 {
553         return _tracks;
554 }
555
556 void
557 Timeline::setup_pixels_per_second ()
558 {
559         shared_ptr<const Film> film = _film.lock ();
560         if (!film || film->length() == DCPTime ()) {
561                 return;
562         }
563
564         _pixels_per_second = static_cast<double>(width() - x_offset() * 2) / film->length().seconds ();
565 }
566
567 shared_ptr<View>
568 Timeline::event_to_view (wxMouseEvent& ev)
569 {
570         ViewList::iterator i = _views.begin();
571         Position<int> const p (ev.GetX(), ev.GetY());
572         while (i != _views.end() && !(*i)->bbox().contains (p)) {
573                 ++i;
574         }
575
576         if (i == _views.end ()) {
577                 return shared_ptr<View> ();
578         }
579
580         return *i;
581 }
582
583 void
584 Timeline::left_down (wxMouseEvent& ev)
585 {
586         shared_ptr<View> view = event_to_view (ev);
587         shared_ptr<ContentView> content_view = dynamic_pointer_cast<ContentView> (view);
588
589         _down_view.reset ();
590
591         if (content_view) {
592                 _down_view = content_view;
593                 _down_view_position = content_view->content()->position ();
594         }
595
596         for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
597                 shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
598                 if (!cv) {
599                         continue;
600                 }
601                 
602                 if (!ev.ShiftDown ()) {
603                         cv->set_selected (view == *i);
604                 }
605                 
606                 if (view == *i) {
607                         _content_panel->set_selection (cv->content ());
608                 }
609         }
610
611         if (content_view && ev.ShiftDown ()) {
612                 content_view->set_selected (!content_view->selected ());
613         }
614
615         _left_down = true;
616         _down_point = ev.GetPosition ();
617         _first_move = false;
618
619         if (_down_view) {
620                 _down_view->content()->set_change_signals_frequent (true);
621         }
622 }
623
624 void
625 Timeline::left_up (wxMouseEvent& ev)
626 {
627         _left_down = false;
628
629         if (_down_view) {
630                 _down_view->content()->set_change_signals_frequent (false);
631         }
632
633         set_position_from_event (ev);
634 }
635
636 void
637 Timeline::mouse_moved (wxMouseEvent& ev)
638 {
639         if (!_left_down) {
640                 return;
641         }
642
643         set_position_from_event (ev);
644 }
645
646 void
647 Timeline::right_down (wxMouseEvent& ev)
648 {
649         shared_ptr<View> view = event_to_view (ev);
650         shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (view);
651         if (!cv) {
652                 return;
653         }
654
655         if (!cv->selected ()) {
656                 clear_selection ();
657                 cv->set_selected (true);
658         }
659
660         _menu.popup (_film, selected_content (), ev.GetPosition ());
661 }
662
663 void
664 Timeline::set_position_from_event (wxMouseEvent& ev)
665 {
666         if (!_pixels_per_second) {
667                 return;
668         }
669
670         double const pps = _pixels_per_second.get ();
671
672         wxPoint const p = ev.GetPosition();
673
674         if (!_first_move) {
675                 /* We haven't moved yet; in that case, we must move the mouse some reasonable distance
676                    before the drag is considered to have started.
677                 */
678                 int const dist = sqrt (pow (p.x - _down_point.x, 2) + pow (p.y - _down_point.y, 2));
679                 if (dist < 8) {
680                         return;
681                 }
682                 _first_move = true;
683         }
684
685         if (!_down_view) {
686                 return;
687         }
688         
689         DCPTime new_position = _down_view_position + DCPTime::from_seconds ((p.x - _down_point.x) / pps);
690         
691         if (_snap) {
692                 
693                 bool first = true;
694                 DCPTime nearest_distance = DCPTime::max ();
695                 DCPTime nearest_new_position = DCPTime::max ();
696                 
697                 /* Find the nearest content edge; this is inefficient */
698                 for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
699                         shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
700                         if (!cv || cv == _down_view) {
701                                 continue;
702                         }
703                         
704                         {
705                                 /* Snap starts to ends */
706                                 DCPTime const d = DCPTime (cv->content()->end() - new_position).abs ();
707                                 if (first || d < nearest_distance) {
708                                         nearest_distance = d;
709                                         nearest_new_position = cv->content()->end();
710                                 }
711                         }
712                         
713                         {
714                                 /* Snap ends to starts */
715                                 DCPTime const d = DCPTime (
716                                         cv->content()->position() - (new_position + _down_view->content()->length_after_trim())
717                                         ).abs ();
718                                 
719                                 if (d < nearest_distance) {
720                                         nearest_distance = d;
721                                         nearest_new_position = cv->content()->position() - _down_view->content()->length_after_trim ();
722                                 }
723                         }
724                         
725                         first = false;
726                 }
727                 
728                 if (!first) {
729                         /* Snap if it's close; `close' means within a proportion of the time on the timeline */
730                         if (nearest_distance < DCPTime::from_seconds ((width() / pps) / 32)) {
731                                 new_position = nearest_new_position;
732                         }
733                 }
734         }
735         
736         if (new_position < DCPTime ()) {
737                 new_position = DCPTime ();
738         }
739
740         _down_view->content()->set_position (new_position);
741         
742         shared_ptr<Film> film = _film.lock ();
743         assert (film);
744         film->set_sequence_video (false);
745 }
746
747 void
748 Timeline::force_redraw (dcpomatic::Rect<int> const & r)
749 {
750         RefreshRect (wxRect (r.x, r.y, r.width, r.height), false);
751 }
752
753 shared_ptr<const Film>
754 Timeline::film () const
755 {
756         return _film.lock ();
757 }
758
759 void
760 Timeline::resized ()
761 {
762         setup_pixels_per_second ();
763 }
764
765 void
766 Timeline::clear_selection ()
767 {
768         for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
769                 shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
770                 if (cv) {
771                         cv->set_selected (false);
772                 }
773         }
774 }
775
776 Timeline::ContentViewList
777 Timeline::selected_views () const
778 {
779         ContentViewList sel;
780         
781         for (ViewList::const_iterator i = _views.begin(); i != _views.end(); ++i) {
782                 shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
783                 if (cv && cv->selected()) {
784                         sel.push_back (cv);
785                 }
786         }
787
788         return sel;
789 }
790
791 ContentList
792 Timeline::selected_content () const
793 {
794         ContentList sel;
795         ContentViewList views = selected_views ();
796         
797         for (ContentViewList::const_iterator i = views.begin(); i != views.end(); ++i) {
798                 sel.push_back ((*i)->content ());
799         }
800
801         return sel;
802 }