Try to tidy up behaviour of seek during playback in the preview;
[dcpomatic.git] / src / wx / film_viewer.cc
index 2b7f73e68328763c85e608617cb8df358269f4a4..b160d775388e08fca3caab87406c5675f6eacb35 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -75,11 +75,12 @@ rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamS
 FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected)
        : wxPanel (p)
        , _panel (new wxPanel (this))
-       , _outline_content (new wxCheckBox (this, wxID_ANY, _("Outline content")))
+       , _outline_content (0)
        , _left_eye (new wxRadioButton (this, wxID_ANY, _("Left eye"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP))
        , _right_eye (new wxRadioButton (this, wxID_ANY, _("Right eye")))
-       , _jump_to_selected (new wxCheckBox (this, wxID_ANY, _("Jump to selected content")))
+       , _jump_to_selected (0)
        , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
+       , _rewind_button (new wxButton (this, wxID_ANY, wxT("|<")))
        , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
        , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
        , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
@@ -87,12 +88,14 @@ FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected
        , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
        , _coalesce_player_changes (false)
        , _pending_player_change (false)
-       , _last_seek_accurate (true)
+       , _slider_being_moved (false)
+       , _was_running_before_slider (false)
        , _audio (DCPOMATIC_RTAUDIO_API)
        , _audio_channels (0)
        , _audio_block_size (1024)
        , _playing (false)
        , _latency_history_count (0)
+       , _dropped (0)
 {
 #ifndef __WXOSX__
        _panel->SetDoubleBuffered (true);
@@ -107,11 +110,13 @@ FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected
 
        wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
        if (outline_content) {
+               _outline_content = new wxCheckBox (this, wxID_ANY, _("Outline content"));
                view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
        }
        view_options->Add (_left_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
        view_options->Add (_right_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
        if (jump_to_selected) {
+               _jump_to_selected = new wxCheckBox (this, wxID_ANY, _("Jump to selected content"));
                view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
        }
        _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
@@ -122,6 +127,7 @@ FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected
        time_sizer->Add (_frame_number, 0, wxEXPAND);
        time_sizer->Add (_timecode, 0, wxEXPAND);
 
+       h_sizer->Add (_rewind_button, 0, wxALL, 2);
        h_sizer->Add (_back_button, 0, wxALL, 2);
        h_sizer->Add (time_sizer, 0, wxEXPAND);
        h_sizer->Add (_forward_button, 0, wxALL, 2);
@@ -131,27 +137,32 @@ FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected
        _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
 
        _frame_number->SetMinSize (wxSize (84, -1));
+       _rewind_button->SetMinSize (wxSize (32, -1));
        _back_button->SetMinSize (wxSize (32, -1));
        _forward_button->SetMinSize (wxSize (32, -1));
 
        _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_CHECKBOX,          boost::bind (&FilmViewer::refresh_panel,   this));
+       if (_outline_content) {
+               _outline_content->Bind  (wxEVT_CHECKBOX, boost::bind (&FilmViewer::refresh_panel,   this));
+       }
        _left_eye->Bind         (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
        _right_eye->Bind        (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
        _slider->Bind           (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved,    this, false));
-       _slider->Bind           (wxEVT_SCROLL_PAGEUP,     boost::bind (&FilmViewer::slider_moved,    this, false));
-       _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,   boost::bind (&FilmViewer::slider_moved,    this, false));
-       _slider->Bind           (wxEVT_SCROLL_CHANGED,    boost::bind (&FilmViewer::slider_moved,    this, true));
+       _slider->Bind           (wxEVT_SCROLL_PAGEUP,     boost::bind (&FilmViewer::slider_moved,    this, true));
+       _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,   boost::bind (&FilmViewer::slider_moved,    this, true));
+       _slider->Bind           (wxEVT_SCROLL_THUMBRELEASE, boost::bind (&FilmViewer::slider_released, this));
        _play_button->Bind      (wxEVT_TOGGLEBUTTON,      boost::bind (&FilmViewer::play_clicked,    this));
        _timer.Bind             (wxEVT_TIMER,             boost::bind (&FilmViewer::timer,           this));
+       _rewind_button->Bind    (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::rewind_clicked,  this, _1));
        _back_button->Bind      (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::back_clicked,    this, _1));
        _forward_button->Bind   (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::forward_clicked, this, _1));
        _frame_number->Bind     (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::frame_number_clicked, this));
        _timecode->Bind         (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::timecode_clicked, this));
-       _jump_to_selected->Bind (wxEVT_CHECKBOX,          boost::bind (&FilmViewer::jump_to_selected_clicked, this));
-
-       _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
+       if (_jump_to_selected) {
+               _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::jump_to_selected_clicked, this));
+               _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
+       }
 
        set_film (shared_ptr<Film> ());
 
@@ -162,7 +173,7 @@ FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected
        setup_sensitivity ();
 
        _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
-       config_changed (Config::PREVIEW_SOUND_OUTPUT);
+       config_changed (Config::SOUND_OUTPUT);
 }
 
 FilmViewer::~FilmViewer ()
@@ -185,12 +196,19 @@ FilmViewer::set_film (shared_ptr<Film> film)
        update_position_label ();
 
        if (!_film) {
+               _player.reset ();
+               recreate_butler ();
+               _frame.reset ();
+               refresh_panel ();
                return;
        }
 
        try {
                _player.reset (new Player (_film, _film->playlist ()));
                _player->set_fast ();
+               if (_dcp_decode_reduction) {
+                       _player->set_dcp_decode_reduction (_dcp_decode_reduction);
+               }
        } catch (bad_alloc) {
                error_dialog (this, _("There is not enough free memory to do that."));
                _film.reset ();
@@ -244,7 +262,7 @@ FilmViewer::recreate_butler ()
        }
 
        _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
-       if (!Config::instance()->preview_sound()) {
+       if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
                _butler->disable_audio ();
        }
 
@@ -281,6 +299,15 @@ FilmViewer::get ()
                return;
        }
 
+       if (_playing && (time() - video.second) > one_video_frame()) {
+               /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
+                  part if this frame is J2K).
+               */
+               _video_position = video.second;
+               ++_dropped;
+               return;
+       }
+
        /* In an ideal world, what we would do here is:
         *
         * 1. convert to XYZ exactly as we do in the DCP creation path.
@@ -324,7 +351,7 @@ FilmViewer::timer ()
        get ();
        update_position_label ();
        update_position_slider ();
-       DCPTime const next = _video_position + DCPTime::from_frames (1, _film->video_frame_rate ());
+       DCPTime const next = _video_position + one_video_frame();
 
        if (next >= _film->length()) {
                stop ();
@@ -367,7 +394,7 @@ FilmViewer::paint_panel ()
                dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
        }
 
-       if (_outline_content->GetValue ()) {
+       if (_outline_content && _outline_content->GetValue ()) {
                wxPen p (wxColour (255, 0, 0), 2);
                dc.SetPen (p);
                dc.SetBrush (*wxTRANSPARENT_BRUSH);
@@ -375,23 +402,37 @@ FilmViewer::paint_panel ()
        }
 }
 
+/** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
 void
-FilmViewer::slider_moved (bool update_slider)
+FilmViewer::slider_moved (bool page)
 {
        if (!_film) {
                return;
        }
 
+       if (!page && !_slider_being_moved) {
+               /* This is the first event of a drag; stop playback for the duration of the drag */
+               _was_running_before_slider = stop ();
+               _slider_being_moved = true;
+       }
+
        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 ());
+               t = _film->length() - one_video_frame();
        }
        seek (t, false);
        update_position_label ();
-       if (update_slider) {
-               update_position_slider ();
+}
+
+void
+FilmViewer::slider_released ()
+{
+       if (_was_running_before_slider) {
+               /* Restart after a drag */
+               start ();
        }
+       _slider_being_moved = false;
 }
 
 void
@@ -464,14 +505,16 @@ FilmViewer::start ()
        }
 
        _playing = true;
+       _dropped = 0;
        timer ();
+       _play_button->SetValue (true);
 }
 
 bool
 FilmViewer::stop ()
 {
        if (_audio.isStreamRunning()) {
-               /* stop stream and discard any remainig queued samples */
+               /* stop stream and discard any remaining queued samples */
                _audio.abortStream ();
        }
 
@@ -529,7 +572,7 @@ FilmViewer::active_jobs_changed (optional<string> j)
 DCPTime
 FilmViewer::nudge_amount (wxMouseEvent& ev)
 {
-       DCPTime amount = DCPTime::from_frames (1, _film->video_frame_rate ());
+       DCPTime amount = one_video_frame ();
 
        if (ev.ShiftDown() && !ev.ControlDown()) {
                amount = DCPTime::from_seconds (1);
@@ -558,6 +601,13 @@ FilmViewer::go_to (DCPTime t)
        update_position_slider ();
 }
 
+void
+FilmViewer::rewind_clicked (wxMouseEvent& ev)
+{
+       go_to(DCPTime());
+       ev.Skip();
+}
+
 void
 FilmViewer::back_clicked (wxMouseEvent& ev)
 {
@@ -596,13 +646,18 @@ FilmViewer::setup_sensitivity ()
        bool const c = _film && !_film->content().empty ();
 
        _slider->Enable (c);
+       _rewind_button->Enable (c);
        _back_button->Enable (c);
        _forward_button->Enable (c);
        _play_button->Enable (c);
-       _outline_content->Enable (c);
+       if (_outline_content) {
+               _outline_content->Enable (c);
+       }
        _frame_number->Enable (c);
        _timecode->Enable (c);
-       _jump_to_selected->Enable (c);
+       if (_jump_to_selected) {
+               _jump_to_selected->Enable (c);
+       }
 
        _left_eye->Enable (c && _film->three_d ());
        _right_eye->Enable (c && _film->three_d ());
@@ -620,7 +675,7 @@ FilmViewer::film_changed (Film::Property p)
 void
 FilmViewer::refresh ()
 {
-       seek (_video_position, _last_seek_accurate);
+       seek (_video_position, true);
 }
 
 void
@@ -682,7 +737,6 @@ FilmViewer::seek (DCPTime t, bool accurate)
        bool const was_running = stop ();
 
        _butler->seek (t, accurate);
-       _last_seek_accurate = accurate;
        get ();
 
        if (was_running) {
@@ -693,7 +747,7 @@ FilmViewer::seek (DCPTime t, bool accurate)
 void
 FilmViewer::config_changed (Config::Property p)
 {
-       if (p != Config::PREVIEW_SOUND && p != Config::PREVIEW_SOUND_OUTPUT) {
+       if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
                return;
        }
 
@@ -701,11 +755,11 @@ FilmViewer::config_changed (Config::Property p)
                _audio.closeStream ();
        }
 
-       if (Config::instance()->preview_sound()) {
+       if (Config::instance()->sound()) {
                unsigned int st = 0;
-               if (Config::instance()->preview_sound_output()) {
+               if (Config::instance()->sound_output()) {
                        while (st < _audio.getDeviceCount()) {
-                               if (_audio.getDeviceInfo(st).name == Config::instance()->preview_sound_output().get()) {
+                               if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
                                        break;
                                }
                                ++st;
@@ -719,8 +773,6 @@ FilmViewer::config_changed (Config::Property p)
 
                _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 
-               recreate_butler ();
-
                RtAudio::StreamParameters sp;
                sp.deviceId = st;
                sp.nChannels = _audio_channels;
@@ -734,9 +786,10 @@ FilmViewer::config_changed (Config::Property p)
 #endif
                        error_dialog (
                                this,
-                               wxString::Format (_("Could not set up audio output (%s).  There will be no audio during the preview."), e.what())
+                               _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
                                );
                }
+               recreate_butler ();
 
        } else {
                _audio_channels = 0;
@@ -790,5 +843,20 @@ FilmViewer::average_latency () const
 void
 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 {
-       _player->set_dcp_decode_reduction (reduction);
+       _dcp_decode_reduction = reduction;
+       if (_player) {
+               _player->set_dcp_decode_reduction (reduction);
+       }
+}
+
+optional<int>
+FilmViewer::dcp_decode_reduction () const
+{
+       return _dcp_decode_reduction;
+}
+
+DCPTime
+FilmViewer::one_video_frame () const
+{
+       return DCPTime::from_frames (1, _film->video_frame_rate());
 }