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