Fix detection of same-frame to speed up simple encodes (#548).
[dcpomatic.git] / src / wx / film_viewer.cc
index 79642af9c72ee9c3979cc29302bbbd35f1ef34ef..e33a3c118dc92eedf9f63bb1b79c88c88d1834d8 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-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
  *  @brief A wx widget to view a preview of a Film.
  */
 
-#include <iostream>
-#include <iomanip>
-#include <wx/tglbtn.h>
 #include "lib/film.h"
-#include "lib/format.h"
+#include "lib/ratio.h"
 #include "lib/util.h"
 #include "lib/job_manager.h"
-#include "lib/options.h"
-#include "lib/subtitle.h"
 #include "lib/image.h"
-#include "lib/scaler.h"
 #include "lib/exceptions.h"
 #include "lib/examine_content_job.h"
 #include "lib/filter.h"
+#include "lib/player.h"
+#include "lib/player_video.h"
+#include "lib/video_content.h"
+#include "lib/video_decoder.h"
+#include "lib/timer.h"
+#include "lib/log.h"
 #include "film_viewer.h"
 #include "wx_util.h"
-#include "video_decoder.h"
+#include <dcp/exceptions.h>
+#include <wx/tglbtn.h>
+#include <iostream>
+#include <iomanip>
 
 using std::string;
 using std::pair;
+using std::min;
 using std::max;
 using std::cout;
 using std::list;
+using std::bad_alloc;
+using std::make_pair;
+using std::exception;
 using boost::shared_ptr;
-using libdcp::Size;
+using boost::dynamic_pointer_cast;
+using boost::weak_ptr;
+using dcp::Size;
 
-FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
+FilmViewer::FilmViewer (wxWindow* p)
        : wxPanel (p)
        , _panel (new wxPanel (this))
+       , _outline_content (new wxCheckBox (this, wxID_ANY, _("Outline content")))
        , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
        , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
        , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
-       , _frame (new wxStaticText (this, wxID_ANY, wxT("")))
+       , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
        , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
        , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
-       , _display_frame_x (0)
-       , _got_frame (false)
+       , _last_get_accurate (true)
 {
 #ifndef __WXOSX__
        _panel->SetDoubleBuffered (true);
 #endif
        
-#if wxMAJOR_VERSION == 2 && wxMINOR_VERSION >= 9
        _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
-#endif 
        
        _v_sizer = new wxBoxSizer (wxVERTICAL);
        SetSizer (_v_sizer);
 
        _v_sizer->Add (_panel, 1, wxEXPAND);
 
+       _v_sizer->Add (_outline_content, 0, wxALL, DCPOMATIC_SIZER_GAP);
+
        wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
 
        wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
-       time_sizer->Add (_frame, 0, wxEXPAND);
+       time_sizer->Add (_frame_number, 0, wxEXPAND);
        time_sizer->Add (_timecode, 0, wxEXPAND);
 
        h_sizer->Add (_back_button, 0, wxALL, 2);
@@ -86,78 +95,28 @@ FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
 
        _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
 
-       _frame->SetMinSize (wxSize (84, -1));
+       _frame_number->SetMinSize (wxSize (84, -1));
        _back_button->SetMinSize (wxSize (32, -1));
        _forward_button->SetMinSize (wxSize (32, -1));
 
-       _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
-       _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
-       _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
-       _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
-       _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
-       _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
-       _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
-       _back_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::back_clicked), 0, this);
-       _forward_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::forward_clicked), 0, this);
-
-       set_film (f);
-
+       _panel->Bind          (wxEVT_PAINT,                        boost::bind (&FilmViewer::paint_panel,     this));
+       _panel->Bind          (wxEVT_SIZE,                         boost::bind (&FilmViewer::panel_sized,     this, _1));
+       _outline_content->Bind(wxEVT_COMMAND_CHECKBOX_CLICKED,     boost::bind (&FilmViewer::refresh_panel,   this));
+       _slider->Bind         (wxEVT_SCROLL_THUMBTRACK,            boost::bind (&FilmViewer::slider_moved,    this));
+       _slider->Bind         (wxEVT_SCROLL_PAGEUP,                boost::bind (&FilmViewer::slider_moved,    this));
+       _slider->Bind         (wxEVT_SCROLL_PAGEDOWN,              boost::bind (&FilmViewer::slider_moved,    this));
+       _play_button->Bind    (wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, boost::bind (&FilmViewer::play_clicked,    this));
+       _timer.Bind           (wxEVT_TIMER,                        boost::bind (&FilmViewer::timer,           this));
+       _back_button->Bind    (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::back_clicked,    this));
+       _forward_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::forward_clicked, this));
+
+       set_film (shared_ptr<Film> ());
+       
        JobManager::instance()->ActiveJobsChanged.connect (
                bind (&FilmViewer::active_jobs_changed, this, _1)
                );
-}
-
-void
-FilmViewer::film_changed (Film::Property p)
-{
-       switch (p) {
-       case Film::FORMAT:
-               calculate_sizes ();
-               update_from_raw ();
-               break;
-       case Film::CONTENT:
-       {
-               DecodeOptions o;
-               o.decode_audio = false;
-               o.decode_subtitles = true;
-               o.video_sync = false;
 
-               try {
-                       _decoders = decoder_factory (_film, o);
-               } catch (StringError& e) {
-                       error_dialog (this, wxString::Format (_("Could not open content file (%s)"), std_to_wx(e.what()).data()));
-                       return;
-               }
-               
-               if (_decoders.video == 0) {
-                       break;
-               }
-               _decoders.video->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3, _4));
-               _decoders.video->OutputChanged.connect (boost::bind (&FilmViewer::decoder_changed, this));
-               _decoders.video->set_subtitle_stream (_film->subtitle_stream());
-               calculate_sizes ();
-               get_frame ();
-               _panel->Refresh ();
-               _slider->Show (_film->content_type() == VIDEO);
-               _play_button->Show (_film->content_type() == VIDEO);
-               _v_sizer->Layout ();
-               break;
-       }
-       case Film::WITH_SUBTITLES:
-       case Film::SUBTITLE_OFFSET:
-       case Film::SUBTITLE_SCALE:
-       case Film::SCALER:
-       case Film::FILTERS:
-               update_from_raw ();
-               break;
-       case Film::SUBTITLE_STREAM:
-               if (_decoders.video) {
-                       _decoders.video->set_subtitle_stream (_film->subtitle_stream ());
-               }
-               break;
-       default:
-               break;
-       }
+       setup_sensitivity ();
 }
 
 void
@@ -166,54 +125,109 @@ FilmViewer::set_film (shared_ptr<Film> f)
        if (_film == f) {
                return;
        }
-       
-       _film = f;
 
-       _raw_frame.reset ();
-       _display_frame.reset ();
-       _panel->Refresh ();
-       _panel->Update ();
+       _film = f;
 
+       _frame.reset ();
+       
+       _slider->SetValue (0);
+       set_position_text ();
+       
        if (!_film) {
                return;
        }
 
-       _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
+       try {
+               _player = f->make_player ();
+       } catch (bad_alloc) {
+               error_dialog (this, _("There is not enough free memory to do that."));
+               _film.reset ();
+               return;
+       }
+
+       /* Always burn in subtitles, even if we are set not to, otherwise we won't see them
+          in the preview.
+       */
+       _player->set_burn_subtitles (true);
+       
+       _film_connection = _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
+
+       _player_connection = _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
+
+       calculate_sizes ();
+       get (_position, _last_get_accurate);
 
-       film_changed (Film::CONTENT);
-       film_changed (Film::FORMAT);
-       film_changed (Film::WITH_SUBTITLES);
-       film_changed (Film::SUBTITLE_OFFSET);
-       film_changed (Film::SUBTITLE_SCALE);
-       film_changed (Film::SUBTITLE_STREAM);
+       setup_sensitivity ();
 }
 
 void
-FilmViewer::decoder_changed ()
+FilmViewer::refresh_panel ()
 {
-       if (_decoders.video == 0 || _decoders.video->seek_to_last ()) {
-               return;
-       }
-
-       get_frame ();
        _panel->Refresh ();
        _panel->Update ();
 }
 
 void
-FilmViewer::timer (wxTimerEvent &)
+FilmViewer::get (DCPTime p, bool accurate)
 {
-       if (!_film || !_decoders.video) {
+       if (!_player) {
                return;
        }
+
+       list<shared_ptr<PlayerVideo> > pvf;
+       try {
+               pvf = _player->get_video (p, accurate);
+       } catch (exception& e) {
+               error_dialog (this, wxString::Format (_("Could not get video for view (%s)"), std_to_wx(e.what()).data()));
+       }
        
-       _panel->Refresh ();
-       _panel->Update ();
+       if (!pvf.empty ()) {
+               try {
+                       _frame = pvf.front()->image (PIX_FMT_RGB24, true, boost::bind (&Log::dcp_log, _film->log().get(), _1, _2));
 
-       get_frame ();
+                       dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
+                       if (pvf.front()->colour_conversion()) {
+                               yuv_to_rgb = pvf.front()->colour_conversion().get().yuv_to_rgb();
+                       }
+                       
+                       _frame = _frame->scale (_frame->size(), yuv_to_rgb, PIX_FMT_RGB24, false);
+                       _position = pvf.front()->time ();
+                       _inter_position = pvf.front()->inter_position ();
+                       _inter_size = pvf.front()->inter_size ();
+               } catch (dcp::DCPReadError& e) {
+                       /* This can happen on the following sequence of events:
+                        * - load encrypted DCP
+                        * - add KDM
+                        * - DCP is examined again, which sets its "playable" flag to 1
+                        * - as a side effect of the exam, the viewer is updated using the old pieces
+                        * - the DCPDecoder in the old piece gives us an encrypted frame
+                        * - then, the pieces are re-made (but too late).
+                        *
+                        * I hope there's a better way to handle this ...
+                        */
+                       _frame.reset ();
+                       _position = p;
+               }
+       } else {
+               _frame.reset ();
+               _position = p;
+       }
+
+       set_position_text ();
+       refresh_panel ();
 
-       if (_film->length()) {
-               int const new_slider_position = 4096 * _decoders.video->last_source_time() / (_film->length().get() / _film->source_frame_rate());
+       _last_get_accurate = accurate;
+}
+
+void
+FilmViewer::timer ()
+{
+       get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
+
+       DCPTime const len = _film->length ();
+
+       if (len.get ()) {
+               int const new_slider_position = 4096 * _position.get() / len.get();
                if (new_slider_position != _slider->GetValue()) {
                        _slider->SetValue (new_slider_position);
                }
@@ -222,31 +236,18 @@ FilmViewer::timer (wxTimerEvent &)
 
 
 void
-FilmViewer::paint_panel (wxPaintEvent &)
+FilmViewer::paint_panel ()
 {
        wxPaintDC dc (_panel);
 
-       if (!_display_frame || !_film || !_out_size.width || !_out_size.height) {
+       if (!_frame || !_film || !_out_size.width || !_out_size.height) {
                dc.Clear ();
                return;
        }
 
-       if (_display_frame_x) {
-               dc.SetPen(*wxBLACK_PEN);
-               dc.SetBrush(*wxBLACK_BRUSH);
-               dc.DrawRectangle (0, 0, _display_frame_x, _film_size.height);
-               dc.DrawRectangle (_display_frame_x + _film_size.width, 0, _display_frame_x, _film_size.height);
-       }
-
-       wxImage frame (_film_size.width, _film_size.height, _display_frame->data()[0], true);
+       wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
        wxBitmap frame_bitmap (frame);
-       dc.DrawBitmap (frame_bitmap, _display_frame_x, 0);
-
-       if (_film->with_subtitles() && _display_sub) {
-               wxImage sub (_display_sub->size().width, _display_sub->size().height, _display_sub->data()[0], _display_sub->alpha(), true);
-               wxBitmap sub_bitmap (sub);
-               dc.DrawBitmap (sub_bitmap, _display_sub_position.x, _display_sub_position.y);
-       }
+       dc.DrawBitmap (frame_bitmap, 0, 0);
 
        if (_out_size.width < _panel_size.width) {
                wxPen p (GetBackgroundColour ());
@@ -262,24 +263,29 @@ FilmViewer::paint_panel (wxPaintEvent &)
                dc.SetPen (p);
                dc.SetBrush (b);
                dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
-       }               
-}
+       }
 
+       if (_outline_content->GetValue ()) {
+               wxPen p (wxColour (255, 0, 0), 2);
+               dc.SetPen (p);
+               dc.SetBrush (*wxTRANSPARENT_BRUSH);
+               dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
+       }
+}
 
 void
-FilmViewer::slider_moved (wxScrollEvent &)
+FilmViewer::slider_moved ()
 {
-       if (!_film || !_film->length() || !_decoders.video) {
+       if (!_film) {
                return;
        }
-       
-       if (_decoders.video->seek (_slider->GetValue() * _film->length().get() / (4096 * _film->source_frame_rate()))) {
-               return;
+
+       DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
+       /* Ensure that we hit the end of the film at the end of the slider */
+       if (t >= _film->length ()) {
+               t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
        }
-       
-       get_frame ();
-       _panel->Refresh ();
-       _panel->Update ();
+       get (t, false);
 }
 
 void
@@ -287,103 +293,42 @@ FilmViewer::panel_sized (wxSizeEvent& ev)
 {
        _panel_size.width = ev.GetSize().GetWidth();
        _panel_size.height = ev.GetSize().GetHeight();
-       calculate_sizes ();
-       update_from_raw ();
-}
-
-void
-FilmViewer::update_from_raw ()
-{
-       if (!_raw_frame) {
-               return;
-       }
 
-       raw_to_display ();
-       
-       _panel->Refresh ();
-       _panel->Update ();
+       calculate_sizes ();
+       get (_position, _last_get_accurate);
 }
 
-void
-FilmViewer::raw_to_display ()
-{
-       if (!_raw_frame || _out_size.width < 64 || _out_size.height < 64 || !_film) {
-               return;
-       }
-
-       boost::shared_ptr<const Image> input = _raw_frame;
-
-       pair<string, string> const s = Filter::ffmpeg_strings (_film->filters());
-       if (!s.second.empty ()) {
-               input = input->post_process (s.second, true);
-       }
-       
-       /* Get a compacted image as we have to feed it to wxWidgets */
-       _display_frame = input->scale_and_convert_to_rgb (_film_size, 0, _film->scaler(), false);
-
-       if (_raw_sub) {
-
-               /* Our output is already cropped by the decoder, so we need to account for that
-                  when working out the scale that we are applying.
-               */
-
-               Size const cropped_size = _film->cropped_size (_film->size ());
-
-               dvdomatic::Rect tx = subtitle_transformed_area (
-                       float (_film_size.width) / cropped_size.width,
-                       float (_film_size.height) / cropped_size.height,
-                       _raw_sub->area(), _film->subtitle_offset(), _film->subtitle_scale()
-                       );
-               
-               _display_sub.reset (new RGBPlusAlphaImage (_raw_sub->image()->scale (tx.size(), _film->scaler(), false)));
-               _display_sub_position = tx.position();
-               _display_sub_position.x += _display_frame_x;
-       } else {
-               _display_sub.reset ();
-       }
-}      
-
 void
 FilmViewer::calculate_sizes ()
 {
-       if (!_film) {
+       if (!_film || !_player) {
                return;
        }
 
-       Format const * format = _film->format ();
+       Ratio const * container = _film->container ();
        
-       float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
-       float const film_ratio = format ? format->container_ratio () : 1.78;
+       float const panel_ratio = _panel_size.ratio ();
+       float const film_ratio = container ? container->ratio () : 1.78;
                        
        if (panel_ratio < film_ratio) {
                /* panel is less widscreen than the film; clamp width */
                _out_size.width = _panel_size.width;
-               _out_size.height = _out_size.width / film_ratio;
+               _out_size.height = rint (_out_size.width / film_ratio);
        } else {
                /* panel is more widescreen than the film; clamp height */
                _out_size.height = _panel_size.height;
-               _out_size.width = _out_size.height * film_ratio;
+               _out_size.width = rint (_out_size.height * film_ratio);
        }
 
-       /* Work out how much padding there is in terms of our display; this will be the x position
-          of our _display_frame.
-       */
-       _display_frame_x = 0;
-       if (format) {
-               _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
-       }
-
-       _film_size = _out_size;
-       _film_size.width -= _display_frame_x * 2;
-
        /* Catch silly values */
-       if (_out_size.width < 64) {
-               _out_size.width = 64;
-       }
+       _out_size.width = max (64, _out_size.width);
+       _out_size.height = max (64, _out_size.height);
+
+       _player->set_video_container_size (_out_size);
 }
 
 void
-FilmViewer::play_clicked (wxCommandEvent &)
+FilmViewer::play_clicked ()
 {
        check_play_state ();
 }
@@ -391,68 +336,30 @@ FilmViewer::play_clicked (wxCommandEvent &)
 void
 FilmViewer::check_play_state ()
 {
-       if (!_film) {
+       if (!_film || _film->video_frame_rate() == 0) {
                return;
        }
        
        if (_play_button->GetValue()) {
-               _timer.Start (1000 / _film->source_frame_rate());
+               _timer.Start (1000 / _film->video_frame_rate());
        } else {
                _timer.Stop ();
        }
 }
 
 void
-FilmViewer::process_video (shared_ptr<const Image> image, bool, shared_ptr<Subtitle> sub, double t)
-{
-       _raw_frame = image;
-       _raw_sub = sub;
-
-       raw_to_display ();
-
-       _got_frame = true;
-
-       double const fps = _decoders.video->frames_per_second ();
-       _frame->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps))));
-
-       double w = t;
-       int const h = (w / 3600);
-       w -= h * 3600;
-       int const m = (w / 60);
-       w -= m * 60;
-       int const s = floor (w);
-       w -= s;
-       int const f = rint (w * fps);
-       _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
-}
-
-void
-FilmViewer::get_frame ()
+FilmViewer::set_position_text ()
 {
-       /* Clear our raw frame in case we don't get a new one */
-       _raw_frame.reset ();
-
-       if (_decoders.video == 0) {
-               _display_frame.reset ();
+       if (!_film) {
+               _frame_number->SetLabel ("0");
+               _timecode->SetLabel ("0:0:0.0");
                return;
        }
-       
-       try {
-               _got_frame = false;
-               while (!_got_frame) {
-                       if (_decoders.video->pass ()) {
-                               /* We didn't get a frame before the decoder gave up,
-                                  so clear our display frame.
-                               */
-                               _display_frame.reset ();
-                               break;
-                       }
-               }
-       } catch (DecodeError& e) {
-               _play_button->SetValue (false);
-               check_play_state ();
-               error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
-       }
+               
+       double const fps = _film->video_frame_rate ();
+       /* Count frame number from 1 ... not sure if this is the best idea */
+       _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (_position.seconds() * fps)) + 1));
+       _timecode->SetLabel (time_to_timecode (_position, fps));
 }
 
 void
@@ -476,27 +383,51 @@ FilmViewer::active_jobs_changed (bool a)
 }
 
 void
-FilmViewer::back_clicked (wxCommandEvent &)
+FilmViewer::back_clicked ()
 {
-       if (!_decoders.video) {
-               return;
+       DCPTime p = _position - DCPTime::from_frames (1, _film->video_frame_rate ());
+       if (p < DCPTime ()) {
+               p = DCPTime ();
        }
-       
-       _decoders.video->seek_back ();
-       get_frame ();
-       _panel->Refresh ();
-       _panel->Update ();
+
+       get (p, true);
 }
 
 void
-FilmViewer::forward_clicked (wxCommandEvent &)
+FilmViewer::forward_clicked ()
 {
-       if (!_decoders.video) {
+       get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
+}
+
+void
+FilmViewer::player_changed (bool frequent)
+{
+       if (frequent) {
                return;
        }
 
-       _decoders.video->seek_forward ();
-       get_frame ();
-       _panel->Refresh ();
-       _panel->Update ();
+       calculate_sizes ();
+       get (_position, _last_get_accurate);
+}
+
+void
+FilmViewer::setup_sensitivity ()
+{
+       bool const c = _film && !_film->content().empty ();
+       
+       _slider->Enable (c);
+       _back_button->Enable (c);
+       _forward_button->Enable (c);
+       _play_button->Enable (c);
+       _outline_content->Enable (c);
+       _frame_number->Enable (c);
+       _timecode->Enable (c);
+}
+
+void
+FilmViewer::film_changed (Film::Property p)
+{
+       if (p == Film::CONTENT) {
+               setup_sensitivity ();
+       }
 }