#include trimming.
[dcpomatic.git] / src / wx / timeline.cc
index 8b0e4762a6ac9f6b888bb9190b23c9da686cb4ef..1096a435aa5b7386e28ef1419e46e90621a342b9 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
 #include <boost/weak_ptr.hpp>
 #include "lib/film.h"
 #include "lib/playlist.h"
+#include "lib/image_content.h"
 #include "film_editor.h"
 #include "timeline.h"
+#include "content_panel.h"
 #include "wx_util.h"
 
 using std::list;
@@ -33,7 +35,11 @@ using boost::shared_ptr;
 using boost::weak_ptr;
 using boost::dynamic_pointer_cast;
 using boost::bind;
+using boost::optional;
 
+/** @class View
+ *  @brief Parent class for components of the timeline (e.g. a piece of content or an axis).
+ */
 class View : public boost::noncopyable
 {
 public:
@@ -42,6 +48,8 @@ public:
        {
 
        }
+
+       virtual ~View () {}
                
        void paint (wxGraphicsContext* g)
        {
@@ -60,9 +68,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().get_value_or (0);
        }
        
        Timeline& _timeline;
@@ -71,13 +79,16 @@ private:
        dcpomatic::Rect<int> _last_paint_bbox;
 };
 
+
+/** @class ContentView
+ *  @brief Parent class for views of pieces of content.
+ */
 class ContentView : public View
 {
 public:
        ContentView (Timeline& tl, shared_ptr<Content> c)
                : View (tl)
                , _content (c)
-               , _track (0)
                , _selected (false)
        {
                _content_connection = c->Changed.connect (bind (&ContentView::content_changed, this, _2, _3));
@@ -85,6 +96,8 @@ public:
 
        dcpomatic::Rect<int> bbox () const
        {
+               assert (_track);
+
                shared_ptr<const Film> film = _timeline.film ();
                shared_ptr<const Content> content = _content.lock ();
                if (!film || !content) {
@@ -92,9 +105,9 @@ public:
                }
                
                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().get_value_or(0) + 16,
                        _timeline.track_height() + 16
                        );
        }
@@ -116,55 +129,61 @@ public:
                _track = t;
        }
 
-       int track () const {
+       void unset_track () {
+               _track = boost::optional<int> ();
+       }
+
+       optional<int> track () const {
                return _track;
        }
 
        virtual wxString type () const = 0;
-       virtual wxColour colour () const = 0;
+       virtual wxColour background_colour () const = 0;
+       virtual wxColour foreground_colour () const = 0;
        
 private:
 
        void do_paint (wxGraphicsContext* gc)
        {
+               assert (_track);
+
                shared_ptr<const Film> film = _timeline.film ();
                shared_ptr<const Content> cont = content ();
                if (!film || !cont) {
                        return;
                }
 
-               Time const start = cont->start ();
-               Time const len = cont->length ();
+               DCPTime const position = cont->position ();
+               DCPTime const len = cont->length_after_trim ();
 
-               wxColour selected (colour().Red() / 2, colour().Green() / 2, colour().Blue() / 2);
+               wxColour selected (background_colour().Red() / 2, background_colour().Green() / 2, background_colour().Blue() / 2);
 
-               gc->SetPen (*wxBLACK_PEN);
-               
-               gc->SetPen (*wxThePenList->FindOrCreatePen (wxColour (0, 0, 0), 4, wxPENSTYLE_SOLID));
+               gc->SetPen (*wxThePenList->FindOrCreatePen (foreground_colour(), 4, wxPENSTYLE_SOLID));
                if (_selected) {
                        gc->SetBrush (*wxTheBrushList->FindOrCreateBrush (selected, wxBRUSHSTYLE_SOLID));
                } else {
-                       gc->SetBrush (*wxTheBrushList->FindOrCreateBrush (colour(), wxBRUSHSTYLE_SOLID));
+                       gc->SetBrush (*wxTheBrushList->FindOrCreateBrush (background_colour(), wxBRUSHSTYLE_SOLID));
                }
 
                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 (cont->path().filename().string()).data(), type().data());
+               wxString name = wxString::Format (wxT ("%s [%s]"), std_to_wx (cont->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().get_value_or(0), _timeline.track_height()));
+               gc->SetFont (gc->CreateFont (*wxNORMAL_FONT, foreground_colour ()));
+               gc->DrawText (name, time_x (position) + 12, y_pos (_track.get() + 1) - name_height - 4);
                gc->ResetClip ();
        }
 
@@ -177,18 +196,18 @@ private:
        {
                ensure_ui_thread ();
                
-               if (p == ContentProperty::START || p == ContentProperty::LENGTH) {
+               if (p == ContentProperty::POSITION || p == ContentProperty::LENGTH) {
                        force_redraw ();
                }
 
                if (!frequent) {
-                       _timeline.setup_pixels_per_time_unit ();
+                       _timeline.setup_pixels_per_second ();
                        _timeline.Refresh ();
                }
        }
 
        boost::weak_ptr<Content> _content;
-       int _track;
+       optional<int> _track;
        bool _selected;
 
        boost::signals2::scoped_connection _content_connection;
@@ -207,10 +226,15 @@ private:
                return _("audio");
        }
 
-       wxColour colour () const
+       wxColour background_colour () const
        {
                return wxColour (149, 121, 232, 255);
        }
+
+       wxColour foreground_colour () const
+       {
+               return wxColour (0, 0, 0, 255);
+       }
 };
 
 class VideoContentView : public ContentView
@@ -224,17 +248,59 @@ private:
 
        wxString type () const
        {
-               if (dynamic_pointer_cast<FFmpegContent> (content ())) {
-                       return _("video");
-               } else {
+               if (dynamic_pointer_cast<ImageContent> (content ()) && content()->number_of_paths() == 1) {
                        return _("still");
+               } else {
+                       return _("video");
                }
        }
 
-       wxColour colour () const
+       wxColour background_colour () const
        {
                return wxColour (242, 92, 120, 255);
        }
+
+       wxColour foreground_colour () const
+       {
+               return wxColour (0, 0, 0, 255);
+       }
+};
+
+class SubtitleContentView : public ContentView
+{
+public:
+       SubtitleContentView (Timeline& tl, shared_ptr<SubtitleContent> c)
+               : ContentView (tl, c)
+               , _subtitle_content (c)
+       {}
+
+private:
+       wxString type () const
+       {
+               return _("subtitles");
+       }
+
+       wxColour background_colour () const
+       {
+               shared_ptr<SubtitleContent> sc = _subtitle_content.lock ();
+               if (!sc || !sc->use_subtitles ()) {
+                       return wxColour (210, 210, 210, 128);
+               }
+               
+               return wxColour (163, 255, 154, 255);
+       }
+
+       wxColour foreground_colour () const
+       {
+               shared_ptr<SubtitleContent> sc = _subtitle_content.lock ();
+               if (!sc || !sc->use_subtitles ()) {
+                       return wxColour (180, 180, 180, 128);
+               }
+
+               return wxColour (0, 0, 0, 255);
+       }
+
+       boost::weak_ptr<SubtitleContent> _subtitle_content;
 };
 
 class TimeAxisView : public View
@@ -260,20 +326,26 @@ private:
 
        void do_paint (wxGraphicsContext* gc)
        {
+               if (!_timeline.pixels_per_second()) {
+                       return;
+               }
+
+               double const pps = _timeline.pixels_per_second().get ();
+               
                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 / pps);
                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) {
@@ -285,14 +357,17 @@ private:
                path.AddLineToPoint (_timeline.width(), _y);
                gc->StrokePath (path);
 
-               Time t = 0;
-               while ((t * _timeline.pixels_per_time_unit()) < _timeline.width()) {
+               gc->SetFont (gc->CreateFont (*wxNORMAL_FONT));
+               
+               /* Time in seconds */
+               DCPTime t;
+               while ((t.seconds() * pps) < _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;
@@ -306,12 +381,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() * pps;
                        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);
                }
        }
 
@@ -319,38 +394,40 @@ private:
        int _y;
 };
 
-Timeline::Timeline (wxWindow* parent, FilmEditor* ed, shared_ptr<Film> film)
+
+Timeline::Timeline (wxWindow* parent, ContentPanel* cp, shared_ptr<Film> film)
        : wxPanel (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE)
-       , _film_editor (ed)
+       , _content_panel (cp)
        , _film (film)
        , _time_axis_view (new TimeAxisView (*this, 32))
        , _tracks (0)
-       , _pixels_per_time_unit (0)
        , _left_down (false)
-       , _down_view_start (0)
+       , _down_view_position (0)
        , _first_move (false)
-       , _menu (film, this)
+       , _menu (this)
+       , _snap (true)
 {
 #ifndef __WXOSX__
        SetDoubleBuffered (true);
 #endif 
 
-       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_RIGHT_DOWN, wxMouseEventHandler (Timeline::right_down), 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));
+       _playlist_changed_connection = film->playlist()->Changed.connect (bind (&Timeline::playlist_changed, this));
+       _playlist_content_changed_connection = film->playlist()->ContentChanged.connect (bind (&Timeline::playlist_content_changed, this, _2));
 }
 
 void
-Timeline::paint (wxPaintEvent &)
+Timeline::paint ()
 {
        wxPaintDC dc (this);
 
@@ -359,8 +436,6 @@ Timeline::paint (wxPaintEvent &)
                return;
        }
 
-       gc->SetFont (gc->CreateFont (*wxNORMAL_FONT));
-
        for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
                (*i)->paint (gc);
        }
@@ -390,37 +465,53 @@ Timeline::playlist_changed ()
                if (dynamic_pointer_cast<AudioContent> (*i)) {
                        _views.push_back (shared_ptr<View> (new AudioContentView (*this, *i)));
                }
+
+               shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (*i);
+               if (sc && sc->has_subtitles ()) {
+                       _views.push_back (shared_ptr<View> (new SubtitleContentView (*this, sc)));
+               }
        }
 
        assign_tracks ();
-       setup_pixels_per_time_unit ();
+       setup_pixels_per_second ();
        Refresh ();
 }
 
+void
+Timeline::playlist_content_changed (int property)
+{
+       ensure_ui_thread ();
+
+       if (property == ContentProperty::POSITION) {
+               assign_tracks ();
+               setup_pixels_per_second ();
+               Refresh ();
+       }
+}
+
 void
 Timeline::assign_tracks ()
 {
        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;
+               shared_ptr<ContentView> c = dynamic_pointer_cast<ContentView> (*i);
+               if (c) {
+                       c->unset_track ();
                }
        }
 
        for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
-               shared_ptr<AudioContentView> acv = dynamic_pointer_cast<AudioContentView> (*i);
-               if (!acv) {
+               shared_ptr<ContentView> cv = dynamic_pointer_cast<ContentView> (*i);
+               if (!cv) {
                        continue;
                }
-       
-               shared_ptr<Content> acv_content = acv->content();
 
-               int t = 1;
-               while (1) {
+               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;
@@ -428,10 +519,10 @@ Timeline::assign_tracks ()
                                
                                shared_ptr<Content> test_content = test->content();
                                        
-                               if (test && test->track() == t) {
+                               if (test && test->track() && test->track().get() == t) {
                                        bool const no_overlap =
-                                               (acv_content->start() < test_content->start() && acv_content->end() < test_content->start()) ||
-                                               (acv_content->start() > test_content->end()   && acv_content->end() > test_content->end());
+                                               (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' */
@@ -449,7 +540,7 @@ Timeline::assign_tracks ()
                        }
                }
 
-               acv->set_track (t);
+               cv->set_track (t);
                _tracks = max (_tracks, t + 1);
        }
 
@@ -463,14 +554,14 @@ 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 ();
+       _pixels_per_second = static_cast<double>(width() - x_offset() * 2) / film->length().seconds ();
 }
 
 shared_ptr<View>
@@ -499,7 +590,7 @@ Timeline::left_down (wxMouseEvent& ev)
 
        if (content_view) {
                _down_view = content_view;
-               _down_view_start = content_view->content()->start ();
+               _down_view_position = content_view->content()->position ();
        }
 
        for (ViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
@@ -513,7 +604,7 @@ Timeline::left_down (wxMouseEvent& ev)
                }
                
                if (view == *i) {
-                       _film_editor->set_selection (cv->content ());
+                       _content_panel->set_selection (cv->content ());
                }
        }
 
@@ -539,7 +630,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
@@ -549,7 +640,7 @@ Timeline::mouse_moved (wxMouseEvent& ev)
                return;
        }
 
-       set_start_from_event (ev);
+       set_position_from_event (ev);
 }
 
 void
@@ -566,15 +657,24 @@ Timeline::right_down (wxMouseEvent& ev)
                cv->set_selected (true);
        }
 
-       _menu.popup (selected_content (), ev.GetPosition ());
+       _menu.popup (_film, selected_content (), ev.GetPosition ());
 }
 
 void
-Timeline::set_start_from_event (wxMouseEvent& ev)
+Timeline::set_position_from_event (wxMouseEvent& ev)
 {
+       if (!_pixels_per_second) {
+               return;
+       }
+
+       double const pps = _pixels_per_second.get ();
+
        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;
@@ -582,14 +682,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) / pps);
+       
+       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() / pps) / 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
@@ -605,9 +757,9 @@ Timeline::film () const
 }
 
 void
-Timeline::resized (wxSizeEvent &)
+Timeline::resized ()
 {
-       setup_pixels_per_time_unit ();
+       setup_pixels_per_second ();
 }
 
 void