Add assert.
[dcpomatic.git] / src / wx / film_viewer.cc
index c83db56dec89279b75aab65e0ef24ea51df958e4..17573b4388053fe1ea09539510d8632a7770cffa 100644 (file)
@@ -84,22 +84,19 @@ FilmViewer::FilmViewer (wxWindow* p)
        , _audio_channels (0)
        , _audio_block_size (1024)
        , _playing (false)
+       , _suspended (0)
        , _latency_history_count (0)
-       , _dropped (0)
        , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
        , _outline_content (false)
-       , _eyes (EYES_LEFT)
        , _pad_black (false)
 #ifdef DCPOMATIC_VARIANT_SWAROOP
-       , _in_watermark (false)
        , _background_image (false)
 #endif
-       , _state_timer ("viewer")
-       , _gets (0)
+       , _idle_get (false)
 {
        switch (Config::instance()->video_view_type()) {
        case Config::VIDEO_VIEW_OPENGL:
-               _video_view = new GLVideoView (p);
+               _video_view = new GLVideoView (this, p);
                break;
        case Config::VIDEO_VIEW_SIMPLE:
                _video_view = new SimpleVideoView (this, p);
@@ -107,7 +104,6 @@ FilmViewer::FilmViewer (wxWindow* p)
        }
 
        _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
-       _timer.Bind (wxEVT_TIMER, boost::bind(&FilmViewer::timer, this));
 
        set_film (shared_ptr<Film> ());
 
@@ -120,6 +116,34 @@ FilmViewer::~FilmViewer ()
        stop ();
 }
 
+/** Ask for ::get() to be called next time we are idle */
+void
+FilmViewer::request_idle_display_next_frame ()
+{
+       if (_idle_get) {
+               return;
+       }
+
+       _idle_get = true;
+       DCPOMATIC_ASSERT (signal_manager);
+       signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
+}
+
+void
+FilmViewer::idle_handler ()
+{
+       if (!_idle_get) {
+               return;
+       }
+
+       if (_video_view->display_next_frame(true)) {
+               _idle_get = false;
+       } else {
+               /* get() could not complete quickly so we'll try again later */
+               signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
+       }
+}
+
 void
 FilmViewer::set_film (shared_ptr<Film> film)
 {
@@ -128,18 +152,14 @@ FilmViewer::set_film (shared_ptr<Film> film)
        }
 
        _film = film;
-       _video_position = DCPTime ();
-       _player_video.first.reset ();
-       _player_video.second = DCPTime ();
 
-       _frame.reset ();
+       _video_view->clear ();
        _closed_captions_dialog->clear ();
 
        if (!_film) {
                _player.reset ();
                recreate_butler ();
-               _frame.reset ();
-               refresh_view ();
+               _video_view->update ();
                return;
        }
 
@@ -159,6 +179,7 @@ FilmViewer::set_film (shared_ptr<Film> film)
        _player->set_play_referenced ();
 
        _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
+       _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
        _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
 
        /* Keep about 1 second's worth of history samples */
@@ -173,193 +194,45 @@ FilmViewer::set_film (shared_ptr<Film> film)
 void
 FilmViewer::recreate_butler ()
 {
-       bool const was_running = stop ();
+       suspend ();
        _butler.reset ();
 
        if (!_film) {
+               resume ();
                return;
        }
 
-       AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
+       _butler.reset(
+               new Butler(
+                       _player,
+                       Config::instance()->audio_mapping(_audio_channels),
+                       _audio_channels,
+                       bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24),
+                       false,
+                       true
+                       )
+               );
 
-       if (_audio_channels != 2 || _film->audio_channels() < 3) {
-               for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
-                       map.set (i, i, 1);
-               }
-       } else {
-               /* Special case: stereo output, at least 3 channel input.
-                  Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
-                              Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
-               */
-               map.set (dcp::LEFT,   0, 1 / sqrt(2)); // L -> Lt
-               map.set (dcp::RIGHT,  1, 1 / sqrt(2)); // R -> Rt
-               map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
-               map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
-               map.set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
-               map.set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
-               map.set (dcp::LS,     0, 1 / sqrt(2)); // Ls -> Lt
-               map.set (dcp::RS,     1, 1 / sqrt(2)); // Rs -> Rt
-       }
-
-       _butler.reset (new Butler(_player, map, _audio_channels, bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
        if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
                _butler->disable_audio ();
        }
 
        _closed_captions_dialog->set_film_and_butler (_film, _butler);
 
-       if (was_running) {
-               start ();
-       }
-}
-
-void
-FilmViewer::refresh_view ()
-{
-       _state_timer.set ("refresh-view");
-       _video_view->get()->Refresh ();
-       _video_view->get()->Update ();
-       _state_timer.unset ();
-}
-
-void
-FilmViewer::get ()
-{
-       DCPOMATIC_ASSERT (_butler);
-       ++_gets;
-
-       do {
-               Butler::Error e;
-               _player_video = _butler->get_video (&e);
-               if (!_player_video.first && e == Butler::AGAIN) {
-                       signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
-                       return;
-               }
-       } while (
-               _player_video.first &&
-               _film->three_d() &&
-               _eyes != _player_video.first->eyes() &&
-               _player_video.first->eyes() != EYES_BOTH
-               );
-
-       _butler->rethrow ();
-
-       display_player_video ();
-}
-
-void
-FilmViewer::display_player_video ()
-{
-       if (!_player_video.first) {
-               _frame.reset ();
-               refresh_view ();
-               return;
-       }
-
-       if (_playing && (time() - _player_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 = _player_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.
-        * 2. convert back to RGB for the preview display, compensating
-        *    for the monitor etc. etc.
-        *
-        * but this is inefficient if the source is RGB.  Since we don't
-        * (currently) care too much about the precise accuracy of the preview's
-        * colour mapping (and we care more about its speed) we try to short-
-        * circuit this "ideal" situation in some cases.
-        *
-        * The content's specified colour conversion indicates the colourspace
-        * which the content is in (according to the user).
-        *
-        * PlayerVideo::image (bound to PlayerVideo::force) will take the source
-        * image and convert it (from whatever the user has said it is) to RGB.
-        */
-
-       _state_timer.set ("get image");
-
-       /* XXX: do we need to store _frame? */
-       _frame = _player_video.first->image (bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true);
-       _video_view->set_image (_frame);
-
-       _state_timer.set ("ImageChanged");
-       ImageChanged (_player_video.first);
-       _state_timer.unset ();
-
-       _video_position = _player_video.second;
-       _inter_position = _player_video.first->inter_position ();
-       _inter_size = _player_video.first->inter_size ();
-
-       refresh_view ();
-
-       _closed_captions_dialog->update (time());
-}
-
-void
-FilmViewer::timer ()
-{
-       if (!_film || !_playing) {
-               return;
-       }
-
-       get ();
-       PositionChanged ();
-       DCPTime const next = _video_position + one_video_frame();
-
-       if (next >= _film->length()) {
-               stop ();
-               Finished ();
-               return;
-       }
-
-       LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
-       _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
-
-       if (_butler) {
-               _butler->rethrow ();
-       }
-}
-
-bool
-#ifdef DCPOMATIC_VARIANT_SWAROOP
-XXX
-FilmViewer::maybe_draw_background_image (wxPaintDC& dc)
-{
-       optional<boost::filesystem::path> bg = Config::instance()->player_background_image();
-       if (bg) {
-               wxImage image (std_to_wx(bg->string()));
-               wxBitmap bitmap (image);
-               dc.DrawBitmap (bitmap, max(0, (_panel_size.width - image.GetSize().GetWidth()) / 2), max(0, (_panel_size.height - image.GetSize().GetHeight()) / 2));
-               return true;
-       }
-
-       return false;
-}
-#else
-FilmViewer::maybe_draw_background_image (wxPaintDC &)
-{
-       return false;
+       resume ();
 }
-#endif
 
 void
 FilmViewer::set_outline_content (bool o)
 {
        _outline_content = o;
-       refresh_view ();
+       _video_view->update ();
 }
 
 void
 FilmViewer::set_eyes (Eyes e)
 {
-       _eyes = e;
+       _video_view->set_eyes (e);
        slow_refresh ();
 }
 
@@ -370,7 +243,6 @@ FilmViewer::video_view_sized ()
        if (!quick_refresh()) {
                slow_refresh ();
        }
-       PositionChanged ();
 }
 
 void
@@ -399,13 +271,32 @@ FilmViewer::calculate_sizes ()
        _out_size.width = max (64, _out_size.width);
        _out_size.height = max (64, _out_size.height);
 
-       /* Make OpenGL happy; XXX: only do this in GLVideoView? Is the round-to-4 constraint a thing? */
-       _out_size.width &= ~3;
-       _out_size.height &= ~3;
-
        _player->set_video_container_size (_out_size);
 }
 
+void
+FilmViewer::suspend ()
+{
+       ++_suspended;
+       if (_audio.isStreamRunning()) {
+               _audio.abortStream();
+       }
+}
+
+void
+FilmViewer::resume ()
+{
+       DCPOMATIC_ASSERT (_suspended > 0);
+       --_suspended;
+       if (_playing && !_suspended) {
+               if (_audio.isStreamOpen()) {
+                       _audio.setStreamTime (_video_view->position().seconds());
+                       _audio.startStream ();
+               }
+               _video_view->start ();
+       }
+}
+
 void
 FilmViewer::start ()
 {
@@ -420,13 +311,12 @@ FilmViewer::start ()
        }
 
        if (_audio.isStreamOpen()) {
-               _audio.setStreamTime (_video_position.seconds());
+               _audio.setStreamTime (_video_view->position().seconds());
                _audio.startStream ();
        }
 
        _playing = true;
-       _dropped = 0;
-       timer ();
+       _video_view->start ();
        Started (position());
 }
 
@@ -443,7 +333,10 @@ FilmViewer::stop ()
        }
 
        _playing = false;
+       _video_view->stop ();
        Stopped (position());
+
+       _video_view->rethrow ();
        return true;
 }
 
@@ -476,22 +369,35 @@ FilmViewer::player_change (ChangeType type, int property, bool frequent)
        if (!refreshed) {
                slow_refresh ();
        }
-       PositionChanged ();
 }
 
 void
 FilmViewer::film_change (ChangeType type, Film::Property p)
 {
-       if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
+       if (type != CHANGE_TYPE_DONE) {
+               return;
+       }
+
+       if (p == Film::AUDIO_CHANNELS) {
                recreate_butler ();
+       } else if (p == Film::VIDEO_FRAME_RATE) {
+               _video_view->set_video_frame_rate (_film->video_frame_rate());
+       } else if (p == Film::THREE_D) {
+               _video_view->set_three_d (_film->three_d());
        }
 }
 
+void
+FilmViewer::film_length_change ()
+{
+       _video_view->set_length (_film->length());
+}
+
 /** Re-get the current frame slowly by seeking */
 void
 FilmViewer::slow_refresh ()
 {
-       seek (_video_position, true);
+       seek (_video_view->position(), true);
 }
 
 /** Try to re-get the current frame quickly by resetting the metadata
@@ -501,16 +407,10 @@ FilmViewer::slow_refresh ()
 bool
 FilmViewer::quick_refresh ()
 {
-       if (!_player_video.first) {
-               return false;
-       }
-
-       if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
-               return false;
+       if (!_video_view || !_film) {
+               return true;
        }
-
-       display_player_video ();
-       return true;
+       return _video_view->refresh_metadata (_film, _player->video_container_size(), _film->frame_size());
 }
 
 void
@@ -550,17 +450,18 @@ FilmViewer::seek (DCPTime t, bool accurate)
                t = _film->length ();
        }
 
-       bool const was_running = stop ();
+       suspend ();
 
        _closed_captions_dialog->clear ();
        _butler->seek (t, accurate);
-       get ();
 
-       if (was_running) {
-               start ();
+       if (!_playing) {
+               request_idle_display_next_frame ();
+       } else {
+               while (!_video_view->display_next_frame(false)) {}
        }
 
-       PositionChanged ();
+       resume ();
 }
 
 void
@@ -568,11 +469,16 @@ FilmViewer::config_changed (Config::Property p)
 {
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        if (p == Config::PLAYER_BACKGROUND_IMAGE) {
-               refresh_view ();
+               _video_view->update ();
                return;
        }
 #endif
 
+       if (p == Config::AUDIO_MAPPING) {
+               recreate_butler ();
+               return;
+       }
+
        if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
                return;
        }
@@ -630,18 +536,24 @@ FilmViewer::uncorrected_time () const
                return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
        }
 
-       return _video_position;
+       return _video_view->position();
 }
 
-DCPTime
-FilmViewer::time () const
+optional<DCPTime>
+FilmViewer::audio_time () const
 {
-       if (_audio.isStreamRunning ()) {
-               return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
-                       DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
+       if (!_audio.isStreamRunning()) {
+               return optional<DCPTime>();
        }
 
-       return _video_position;
+       return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
+               DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
+}
+
+DCPTime
+FilmViewer::time () const
+{
+       return audio_time().get_value_or(_video_view->position());
 }
 
 int
@@ -701,7 +613,7 @@ FilmViewer::dcp_decode_reduction () const
 DCPTime
 FilmViewer::one_video_frame () const
 {
-       return DCPTime::from_frames (1, _film->video_frame_rate());
+       return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
 }
 
 /** Open a dialog box showing our film's closed captions */
@@ -714,7 +626,7 @@ FilmViewer::show_closed_captions ()
 void
 FilmViewer::seek_by (DCPTime by, bool accurate)
 {
-       seek (_video_position + by, accurate);
+       seek (_video_view->position() + by, accurate);
 }
 
 void
@@ -722,3 +634,34 @@ FilmViewer::set_pad_black (bool p)
 {
        _pad_black = p;
 }
+
+/** Called when a player has finished the current film.
+ *  May be called from a non-UI thread.
+ */
+void
+FilmViewer::finished ()
+{
+       emit (boost::bind(&FilmViewer::ui_finished, this));
+}
+
+/** Called by finished() in the UI thread */
+void
+FilmViewer::ui_finished ()
+{
+       stop ();
+       Finished ();
+}
+
+int
+FilmViewer::dropped () const
+{
+       return _video_view->dropped ();
+}
+
+int
+FilmViewer::gets () const
+{
+       return _video_view->gets ();
+}
+
+