Merge master.
[dcpomatic.git] / src / wx / timeline.cc
index 3747a3dac0c44574e271d4bac6afdf95ae07648c..185abefeb8b5e6c1041c937d02f491c9de00ea3f 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -33,7 +33,9 @@ using boost::shared_ptr;
 using boost::weak_ptr;
 using boost::dynamic_pointer_cast;
 using boost::bind;
+using boost::optional;
 
+/** Parent class for components of the timeline (e.g. a piece of content or an axis) */
 class View : public boost::noncopyable
 {
 public:
@@ -42,6 +44,8 @@ public:
        {
 
        }
+
+       virtual ~View () {}
                
        void paint (wxGraphicsContext* g)
        {
@@ -60,9 +64,9 @@ public:
 protected:
        virtual void do_paint (wxGraphicsContext *) = 0;
        
-       int time_x (Time t) const
+       int time_x (DCPTime t) const
        {
-               return _timeline.tracks_position().x + t * _timeline.pixels_per_time_unit();
+               return _timeline.tracks_position().x + t.seconds() * _timeline.pixels_per_second ();
        }
        
        Timeline& _timeline;
@@ -71,29 +75,33 @@ private:
        dcpomatic::Rect<int> _last_paint_bbox;
 };
 
+
+/** Parent class for views of pieces of content */
 class ContentView : public View
 {
 public:
-       ContentView (Timeline& tl, shared_ptr<Content> c, int t)
+       ContentView (Timeline& tl, shared_ptr<Content> c)
                : View (tl)
                , _content (c)
-               , _track (t)
                , _selected (false)
        {
-               _content_connection = c->Changed.connect (bind (&ContentView::content_changed, this, _2));
+               _content_connection = c->Changed.connect (bind (&ContentView::content_changed, this, _2, _3));
        }
 
        dcpomatic::Rect<int> bbox () const
        {
+               assert (_track);
+
                shared_ptr<const Film> film = _timeline.film ();
-               if (!film) {
+               shared_ptr<const Content> content = _content.lock ();
+               if (!film || !content) {
                        return dcpomatic::Rect<int> ();
                }
                
                return dcpomatic::Rect<int> (
-                       time_x (_content->start ()) - 8,
-                       y_pos (_track) - 8,
-                       _content->length () * _timeline.pixels_per_time_unit() + 16,
+                       time_x (content->position ()) - 8,
+                       y_pos (_track.get()) - 8,
+                       content->length_after_trim().seconds() * _timeline.pixels_per_second() + 16,
                        _timeline.track_height() + 16
                        );
        }
@@ -108,14 +116,14 @@ public:
        }
 
        shared_ptr<Content> content () const {
-               return _content;
+               return _content.lock ();
        }
 
        void set_track (int t) {
                _track = t;
        }
 
-       int track () const {
+       optional<int> track () const {
                return _track;
        }
 
@@ -126,13 +134,16 @@ private:
 
        void do_paint (wxGraphicsContext* gc)
        {
+               assert (_track);
+
                shared_ptr<const Film> film = _timeline.film ();
-               if (!film) {
+               shared_ptr<const Content> cont = content ();
+               if (!film || !cont) {
                        return;
                }
 
-               Time const start = _content->start ();
-               Time const len = _content->length ();
+               DCPTime const position = cont->position ();
+               DCPTime const len = cont->length_after_trim ();
 
                wxColour selected (colour().Red() / 2, colour().Green() / 2, colour().Blue() / 2);
 
@@ -146,23 +157,23 @@ private:
                }
 
                wxGraphicsPath path = gc->CreatePath ();
-               path.MoveToPoint    (time_x (start),       y_pos (_track) + 4);
-               path.AddLineToPoint (time_x (start + len), y_pos (_track) + 4);
-               path.AddLineToPoint (time_x (start + len), y_pos (_track + 1) - 4);
-               path.AddLineToPoint (time_x (start),       y_pos (_track + 1) - 4);
-               path.AddLineToPoint (time_x (start),       y_pos (_track) + 4);
+               path.MoveToPoint    (time_x (position),       y_pos (_track.get()) + 4);
+               path.AddLineToPoint (time_x (position + len), y_pos (_track.get()) + 4);
+               path.AddLineToPoint (time_x (position + len), y_pos (_track.get() + 1) - 4);
+               path.AddLineToPoint (time_x (position),       y_pos (_track.get() + 1) - 4);
+               path.AddLineToPoint (time_x (position),       y_pos (_track.get()) + 4);
                gc->StrokePath (path);
                gc->FillPath (path);
 
-               wxString name = wxString::Format (wxT ("%s [%s]"), std_to_wx (_content->file().filename().string()).data(), type().data());
+               wxString name = wxString::Format (wxT ("%s [%s]"), std_to_wx (cont->path_summary()).data(), type().data());
                wxDouble name_width;
                wxDouble name_height;
                wxDouble name_descent;
                wxDouble name_leading;
                gc->GetTextExtent (name, &name_width, &name_height, &name_descent, &name_leading);
                
-               gc->Clip (wxRegion (time_x (start), y_pos (_track), len * _timeline.pixels_per_time_unit(), _timeline.track_height()));
-               gc->DrawText (name, time_x (start) + 12, y_pos (_track + 1) - name_height - 4);
+               gc->Clip (wxRegion (time_x (position), y_pos (_track.get()), len.seconds() * _timeline.pixels_per_second(), _timeline.track_height()));
+               gc->DrawText (name, time_x (position) + 12, y_pos (_track.get() + 1) - name_height - 4);
                gc->ResetClip ();
        }
 
@@ -171,19 +182,22 @@ private:
                return _timeline.tracks_position().y + t * _timeline.track_height();
        }
 
-       void content_changed (int p)
+       void content_changed (int p, bool frequent)
        {
-               if (p == ContentProperty::START || p == ContentProperty::LENGTH) {
+               ensure_ui_thread ();
+               
+               if (p == ContentProperty::POSITION || p == ContentProperty::LENGTH) {
                        force_redraw ();
                }
+
+               if (!frequent) {
+                       _timeline.setup_pixels_per_second ();
+                       _timeline.Refresh ();
+               }
        }
 
-       /* This must be a shared_ptr, not a weak_ptr, as in the looped case this
-          will be the only remaining pointer to the looped content that we get
-          from the playlist.
-       */
-       boost::shared_ptr<Content> _content;
-       int _track;
+       boost::weak_ptr<Content> _content;
+       optional<int> _track;
        bool _selected;
 
        boost::signals2::scoped_connection _content_connection;
@@ -192,8 +206,8 @@ private:
 class AudioContentView : public ContentView
 {
 public:
-       AudioContentView (Timeline& tl, shared_ptr<Content> c, int t)
-               : ContentView (tl, c, t)
+       AudioContentView (Timeline& tl, shared_ptr<Content> c)
+               : ContentView (tl, c)
        {}
        
 private:
@@ -211,8 +225,8 @@ private:
 class VideoContentView : public ContentView
 {
 public:
-       VideoContentView (Timeline& tl, shared_ptr<Content> c, int t)
-               : ContentView (tl, c, t)
+       VideoContentView (Timeline& tl, shared_ptr<Content> c)
+               : ContentView (tl, c)
        {}
 
 private:       
@@ -232,6 +246,25 @@ private:
        }
 };
 
+class SubtitleContentView : public ContentView
+{
+public:
+       SubtitleContentView (Timeline& tl, shared_ptr<Content> c)
+               : ContentView (tl, c)
+       {}
+
+private:
+       wxString type () const
+       {
+               return _("subtitles");
+       }
+
+       wxColour colour () const
+       {
+               return wxColour (163, 255, 154, 255);
+       }
+};
+
 class TimeAxisView : public View
 {
 public:
@@ -257,18 +290,18 @@ private:
        {
                gc->SetPen (*wxThePenList->FindOrCreatePen (wxColour (0, 0, 0), 1, wxPENSTYLE_SOLID));
                
-               int mark_interval = rint (128 / (TIME_HZ * _timeline.pixels_per_time_unit ()));
+               double mark_interval = rint (128 / _timeline.pixels_per_second ());
                if (mark_interval > 5) {
-                       mark_interval -= mark_interval % 5;
+                       mark_interval -= int (rint (mark_interval)) % 5;
                }
                if (mark_interval > 10) {
-                       mark_interval -= mark_interval % 10;
+                       mark_interval -= int (rint (mark_interval)) % 10;
                }
                if (mark_interval > 60) {
-                       mark_interval -= mark_interval % 60;
+                       mark_interval -= int (rint (mark_interval)) % 60;
                }
                if (mark_interval > 3600) {
-                       mark_interval -= mark_interval % 3600;
+                       mark_interval -= int (rint (mark_interval)) % 3600;
                }
                
                if (mark_interval < 1) {
@@ -280,14 +313,15 @@ private:
                path.AddLineToPoint (_timeline.width(), _y);
                gc->StrokePath (path);
 
-               Time t = 0;
-               while ((t * _timeline.pixels_per_time_unit()) < _timeline.width()) {
+               /* Time in seconds */
+               DCPTime t;
+               while ((t.seconds() * _timeline.pixels_per_second()) < _timeline.width()) {
                        wxGraphicsPath path = gc->CreatePath ();
                        path.MoveToPoint (time_x (t), _y - 4);
                        path.AddLineToPoint (time_x (t), _y + 4);
                        gc->StrokePath (path);
 
-                       int tc = t / TIME_HZ;
+                       double tc = t.seconds ();
                        int const h = tc / 3600;
                        tc -= h * 3600;
                        int const m = tc / 60;
@@ -301,12 +335,12 @@ private:
                        wxDouble str_leading;
                        gc->GetTextExtent (str, &str_width, &str_height, &str_descent, &str_leading);
                        
-                       int const tx = _timeline.x_offset() + t * _timeline.pixels_per_time_unit();
+                       int const tx = _timeline.x_offset() + t.seconds() * _timeline.pixels_per_second();
                        if ((tx + str_width) < _timeline.width()) {
                                gc->DrawText (str, time_x (t), _y + 16);
                        }
                        
-                       t += mark_interval * TIME_HZ;
+                       t += DCPTime::from_seconds (mark_interval);
                }
        }
 
@@ -314,40 +348,40 @@ private:
        int _y;
 };
 
+
 Timeline::Timeline (wxWindow* parent, FilmEditor* ed, shared_ptr<Film> film)
        : wxPanel (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE)
        , _film_editor (ed)
        , _film (film)
        , _time_axis_view (new TimeAxisView (*this, 32))
        , _tracks (0)
-       , _pixels_per_time_unit (0)
+       , _pixels_per_second (0)
        , _left_down (false)
-       , _down_view_start (0)
+       , _down_view_position (0)
        , _first_move (false)
+       , _menu (this)
+       , _snap (true)
 {
 #ifndef __WXOSX__
        SetDoubleBuffered (true);
 #endif 
 
-       setup_pixels_per_time_unit ();
-       
-       Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (Timeline::paint), 0, this);
-       Connect (wxID_ANY, wxEVT_LEFT_DOWN, wxMouseEventHandler (Timeline::left_down), 0, this);
-       Connect (wxID_ANY, wxEVT_LEFT_UP, wxMouseEventHandler (Timeline::left_up), 0, this);
-       Connect (wxID_ANY, wxEVT_MOTION, wxMouseEventHandler (Timeline::mouse_moved), 0, this);
-       Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (Timeline::resized), 0, this);
+       Bind (wxEVT_PAINT,      boost::bind (&Timeline::paint,       this));
+       Bind (wxEVT_LEFT_DOWN,  boost::bind (&Timeline::left_down,   this, _1));
+       Bind (wxEVT_LEFT_UP,    boost::bind (&Timeline::left_up,     this, _1));
+       Bind (wxEVT_RIGHT_DOWN, boost::bind (&Timeline::right_down,  this, _1));
+       Bind (wxEVT_MOTION,     boost::bind (&Timeline::mouse_moved, this, _1));
+       Bind (wxEVT_SIZE,       boost::bind (&Timeline::resized,     this));
 
        playlist_changed ();
 
        SetMinSize (wxSize (640, tracks() * track_height() + 96));
 
        _playlist_connection = film->playlist()->Changed.connect (bind (&Timeline::playlist_changed, this));
-
-       _views.push_back (_time_axis_view);
 }
 
 void
-Timeline::paint (wxPaintEvent &)
+Timeline::paint ()
 {
        wxPaintDC dc (this);
 
@@ -358,7 +392,7 @@ Timeline::paint (wxPaintEvent &)
 
        gc->SetFont (gc->CreateFont (*wxNORMAL_FONT));
 
-       for (list<shared_ptr<View> >::iterator i = _views.begin(); i != _views.end(); ++i) {
+       for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
                (*i)->paint (gc);
        }
 
@@ -368,52 +402,51 @@ Timeline::paint (wxPaintEvent &)
 void
 Timeline::playlist_changed ()
 {
+       ensure_ui_thread ();
+       
        shared_ptr<const Film> fl = _film.lock ();
        if (!fl) {
                return;
        }
 
        _views.clear ();
+       _views.push_back (_time_axis_view);
 
-       Playlist::ContentList content = fl->playlist()->content_with_loop ();
+       ContentList content = fl->playlist()->content ();
 
-       for (Playlist::ContentList::iterator i = content.begin(); i != content.end(); ++i) {
+       for (ContentList::iterator i = content.begin(); i != content.end(); ++i) {
                if (dynamic_pointer_cast<VideoContent> (*i)) {
-                       _views.push_back (shared_ptr<View> (new VideoContentView (*this, *i, 0)));
+                       _views.push_back (shared_ptr<View> (new VideoContentView (*this, *i)));
                }
                if (dynamic_pointer_cast<AudioContent> (*i)) {
-                       _views.push_back (shared_ptr<View> (new AudioContentView (*this, *i, 0)));
+                       _views.push_back (shared_ptr<View> (new AudioContentView (*this, *i)));
+               }
+               if (dynamic_pointer_cast<SubtitleContent> (*i)) {
+                       _views.push_back (shared_ptr<View> (new SubtitleContentView (*this, *i)));
                }
        }
 
        assign_tracks ();
+       setup_pixels_per_second ();
        Refresh ();
 }
 
 void
 Timeline::assign_tracks ()
 {
-       for (list<shared_ptr<View> >::iterator i = _views.begin(); i != _views.end(); ++i) {
+       for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
                shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
-               if (cv) {
-                       cv->set_track (0);
-                       _tracks = 1;
-               }
-       }
-
-       for (list<shared_ptr<View> >::iterator i = _views.begin(); i != _views.end(); ++i) {
-               shared_ptr<AudioContentView> acv = dynamic_pointer_cast<AudioContentView> (*i);
-               if (!acv) {
+               if (!cv) {
                        continue;
                }
-       
-               shared_ptr<Content> acv_content = acv->content();
-               
-               int t = 1;
-               while (1) {
-                       list<shared_ptr<View> >::iterator j = _views.begin();
+
+               shared_ptr<Content> content = cv->content();
+
+               int t = 0;
+               while (true) {
+                       ViewList::iterator j = _views.begin();
                        while (j != _views.end()) {
-                               shared_ptr<AudioContentView> test = dynamic_pointer_cast<AudioContentView> (*j);
+                               shared_ptr<ContentView> test = dynamic_pointer_cast<ContentView> (*j);
                                if (!test) {
                                        ++j;
                                        continue;
@@ -421,9 +454,12 @@ Timeline::assign_tracks ()
                                
                                shared_ptr<Content> test_content = test->content();
                                        
-                               if (test && test->track() == t) {
-                                       if ((acv_content->start() < test_content->start() && test_content->start() < acv_content->end()) ||
-                                           (acv_content->start() < test_content->end()   && test_content->end()   < acv_content->end())) {
+                               if (test && test->track() && test->track().get() == t) {
+                                       bool const no_overlap =
+                                               (content->position() < test_content->position() && content->end() < test_content->position()) ||
+                                               (content->position() > test_content->end()      && content->end() > test_content->end());
+                                       
+                                       if (!no_overlap) {
                                                /* we have an overlap on track `t' */
                                                ++t;
                                                break;
@@ -439,7 +475,7 @@ Timeline::assign_tracks ()
                        }
                }
 
-               acv->set_track (t);
+               cv->set_track (t);
                _tracks = max (_tracks, t + 1);
        }
 
@@ -453,43 +489,62 @@ Timeline::tracks () const
 }
 
 void
-Timeline::setup_pixels_per_time_unit ()
+Timeline::setup_pixels_per_second ()
 {
        shared_ptr<const Film> film = _film.lock ();
-       if (!film) {
+       if (!film || film->length() == DCPTime ()) {
                return;
        }
 
-       _pixels_per_time_unit = static_cast<double>(width() - x_offset() * 2) / film->length_with_loop();
+       _pixels_per_second = static_cast<double>(width() - x_offset() * 2) / film->length().seconds ();
 }
 
-void
-Timeline::left_down (wxMouseEvent& ev)
+shared_ptr<View>
+Timeline::event_to_view (wxMouseEvent& ev)
 {
-       list<shared_ptr<View> >::iterator i = _views.begin();
+       ViewList::iterator i = _views.begin();
        Position<int> const p (ev.GetX(), ev.GetY());
        while (i != _views.end() && !(*i)->bbox().contains (p)) {
                ++i;
        }
 
+       if (i == _views.end ()) {
+               return shared_ptr<View> ();
+       }
+
+       return *i;
+}
+
+void
+Timeline::left_down (wxMouseEvent& ev)
+{
+       shared_ptr<View> view = event_to_view (ev);
+       shared_ptr<ContentView> content_view = dynamic_pointer_cast<ContentView> (view);
+
        _down_view.reset ();
 
-       if (i != _views.end ()) {
+       if (content_view) {
+               _down_view = content_view;
+               _down_view_position = content_view->content()->position ();
+       }
+
+       for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
                shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
-               if (cv) {
-                       _down_view = cv;
-                       _down_view_start = cv->content()->start ();
+               if (!cv) {
+                       continue;
+               }
+               
+               if (!ev.ShiftDown ()) {
+                       cv->set_selected (view == *i);
+               }
+               
+               if (view == *i) {
+                       _film_editor->set_selection (cv->content ());
                }
        }
 
-       for (list<shared_ptr<View> >::iterator j = _views.begin(); j != _views.end(); ++j) {
-               shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*j);
-               if (cv) {
-                       cv->set_selected (i == j);
-                       if (i == j) {
-                               _film_editor->set_selection (cv->content ());
-                       }
-               }
+       if (content_view && ev.ShiftDown ()) {
+               content_view->set_selected (!content_view->selected ());
        }
 
        _left_down = true;
@@ -510,7 +565,7 @@ Timeline::left_up (wxMouseEvent& ev)
                _down_view->content()->set_change_signals_frequent (false);
        }
 
-       set_start_from_event (ev);
+       set_position_from_event (ev);
 }
 
 void
@@ -520,15 +575,35 @@ Timeline::mouse_moved (wxMouseEvent& ev)
                return;
        }
 
-       set_start_from_event (ev);
+       set_position_from_event (ev);
 }
 
 void
-Timeline::set_start_from_event (wxMouseEvent& ev)
+Timeline::right_down (wxMouseEvent& ev)
+{
+       shared_ptr<View> view = event_to_view (ev);
+       shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (view);
+       if (!cv) {
+               return;
+       }
+
+       if (!cv->selected ()) {
+               clear_selection ();
+               cv->set_selected (true);
+       }
+
+       _menu.popup (_film, selected_content (), ev.GetPosition ());
+}
+
+void
+Timeline::set_position_from_event (wxMouseEvent& ev)
 {
        wxPoint const p = ev.GetPosition();
 
        if (!_first_move) {
+               /* We haven't moved yet; in that case, we must move the mouse some reasonable distance
+                  before the drag is considered to have started.
+               */
                int const dist = sqrt (pow (p.x - _down_point.x, 2) + pow (p.y - _down_point.y, 2));
                if (dist < 8) {
                        return;
@@ -536,14 +611,66 @@ Timeline::set_start_from_event (wxMouseEvent& ev)
                _first_move = true;
        }
 
-       Time const time_diff = (p.x - _down_point.x) / _pixels_per_time_unit;
-       if (_down_view) {
-               _down_view->content()->set_start (max (static_cast<Time> (0), _down_view_start + time_diff));
-
-               shared_ptr<Film> film = _film.lock ();
-               assert (film);
-               film->set_sequence_video (false);
+       if (!_down_view) {
+               return;
        }
+       
+       DCPTime new_position = _down_view_position + DCPTime::from_seconds ((p.x - _down_point.x) / _pixels_per_second);
+       
+       if (_snap) {
+               
+               bool first = true;
+               DCPTime nearest_distance = DCPTime::max ();
+               DCPTime nearest_new_position = DCPTime::max ();
+               
+               /* Find the nearest content edge; this is inefficient */
+               for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
+                       shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
+                       if (!cv || cv == _down_view) {
+                               continue;
+                       }
+                       
+                       {
+                               /* Snap starts to ends */
+                               DCPTime const d = DCPTime (cv->content()->end() - new_position).abs ();
+                               if (first || d < nearest_distance) {
+                                       nearest_distance = d;
+                                       nearest_new_position = cv->content()->end();
+                               }
+                       }
+                       
+                       {
+                               /* Snap ends to starts */
+                               DCPTime const d = DCPTime (
+                                       cv->content()->position() - (new_position + _down_view->content()->length_after_trim())
+                                       ).abs ();
+                               
+                               if (d < nearest_distance) {
+                                       nearest_distance = d;
+                                       nearest_new_position = cv->content()->position() - _down_view->content()->length_after_trim ();
+                               }
+                       }
+                       
+                       first = false;
+               }
+               
+               if (!first) {
+                       /* Snap if it's close; `close' means within a proportion of the time on the timeline */
+                       if (nearest_distance < DCPTime::from_seconds ((width() / pixels_per_second()) / 32)) {
+                               new_position = nearest_new_position;
+                       }
+               }
+       }
+       
+       if (new_position < DCPTime ()) {
+               new_position = DCPTime ();
+       }
+       
+       _down_view->content()->set_position (new_position);
+       
+       shared_ptr<Film> film = _film.lock ();
+       assert (film);
+       film->set_sequence_video (false);
 }
 
 void
@@ -559,7 +686,46 @@ Timeline::film () const
 }
 
 void
-Timeline::resized (wxSizeEvent &)
+Timeline::resized ()
+{
+       setup_pixels_per_second ();
+}
+
+void
+Timeline::clear_selection ()
+{
+       for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
+               shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
+               if (cv) {
+                       cv->set_selected (false);
+               }
+       }
+}
+
+Timeline::ContentViewList
+Timeline::selected_views () const
+{
+       ContentViewList sel;
+       
+       for (ViewList::const_iterator i = _views.begin(); i != _views.end(); ++i) {
+               shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
+               if (cv && cv->selected()) {
+                       sel.push_back (cv);
+               }
+       }
+
+       return sel;
+}
+
+ContentList
+Timeline::selected_content () const
 {
-       setup_pixels_per_time_unit ();
+       ContentList sel;
+       ContentViewList views = selected_views ();
+       
+       for (ContentViewList::const_iterator i = views.begin(); i != views.end(); ++i) {
+               sel.push_back ((*i)->content ());
+       }
+
+       return sel;
 }