BOOST_FOREACH.
[dcpomatic.git] / src / wx / film_viewer.cc
index 9623aef7991c8b7be129c04bde13bbc09b490cf8..6e5b486d59ac59d75d60076835c469f3dee03dbd 100644 (file)
@@ -47,6 +47,7 @@
 #include "lib/config.h"
 #include "lib/compose.hpp"
 #include "lib/dcpomatic_log.h"
+#include "lib/text_content.h"
 extern "C" {
 #include <libavutil/pixfmt.h>
 }
@@ -64,10 +65,13 @@ using std::list;
 using std::bad_alloc;
 using std::make_pair;
 using std::exception;
-using boost::shared_ptr;
-using boost::dynamic_pointer_cast;
-using boost::weak_ptr;
+using std::shared_ptr;
+using std::dynamic_pointer_cast;
+using std::weak_ptr;
 using boost::optional;
+#if BOOST_VERSION >= 106100
+using namespace boost::placeholders;
+#endif
 using dcp::Size;
 using namespace dcpomatic;
 
@@ -84,17 +88,12 @@ 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
-       , _background_image (false)
-#endif
-       , _state_timer ("viewer")
-       , _gets (0)
+       , _idle_get (false)
 {
        switch (Config::instance()->video_view_type()) {
        case Config::VIDEO_VIEW_OPENGL:
@@ -106,7 +105,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> ());
 
@@ -119,6 +117,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) == VideoView::AGAIN) {
+               /* get() could not complete quickly so we'll try again later */
+               signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
+       } else {
+               _idle_get = false;
+       }
+}
+
 void
 FilmViewer::set_film (shared_ptr<Film> film)
 {
@@ -127,22 +153,19 @@ FilmViewer::set_film (shared_ptr<Film> film)
        }
 
        _film = film;
-       _video_position = DCPTime ();
-       _player_video.first.reset ();
-       _player_video.second = DCPTime ();
 
-       _video_view->set_image (shared_ptr<Image>());
+       _video_view->clear ();
        _closed_captions_dialog->clear ();
 
        if (!_film) {
                _player.reset ();
                recreate_butler ();
-               refresh_view ();
+               _video_view->update ();
                return;
        }
 
        try {
-               _player.reset (new Player (_film, _film->playlist ()));
+               _player.reset (new Player(_film));
                _player->set_fast ();
                if (_dcp_decode_reduction) {
                        _player->set_dcp_decode_reduction (_dcp_decode_reduction);
@@ -157,11 +180,19 @@ FilmViewer::set_film (shared_ptr<Film> film)
        _player->set_play_referenced ();
 
        _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
+       _film->ContentChange.connect (boost::bind(&FilmViewer::content_change, this, _1, _3));
+       _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
        _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
 
+       film_change (CHANGE_TYPE_DONE, Film::VIDEO_FRAME_RATE);
+       film_change (CHANGE_TYPE_DONE, Film::THREE_D);
+       film_length_change ();
+
        /* Keep about 1 second's worth of history samples */
        _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
 
+       _closed_captions_dialog->update_tracks (_film);
+
        recreate_butler ();
 
        calculate_sizes ();
@@ -171,174 +202,56 @@ 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);
-
-       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(
+                       _film,
+                       _player,
+                       Config::instance()->audio_mapping(_audio_channels),
+                       _audio_channels,
+                       bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24),
+                       VIDEO_RANGE_FULL,
+                       false,
+                       true
+                       )
+               );
 
-       _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);
+       _closed_captions_dialog->set_butler (_butler);
 
-       if (was_running) {
-               start ();
-       }
+       resume ();
 }
 
 void
-FilmViewer::refresh_view ()
+FilmViewer::set_outline_content (bool o)
 {
-       _state_timer.set ("update-view");
+       _outline_content = o;
        _video_view->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
-               );
-
-       try {
-               _butler->rethrow ();
-       } catch (DecodeError& e) {
-               error_dialog (_video_view->get(), e.what());
-       }
-
-       display_player_video ();
-}
 
 void
-FilmViewer::display_player_video ()
+FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double> > rect)
 {
-       if (!_player_video.first) {
-               _video_view->set_image (shared_ptr<Image>());
-               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");
-
-       _video_view->set_image (
-               _player_video.first->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true)
-               );
-
-       _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 ();
-       }
+       _outline_subtitles = rect;
+       _video_view->update ();
 }
 
-void
-FilmViewer::set_outline_content (bool o)
-{
-       _outline_content = o;
-       refresh_view ();
-}
 
 void
 FilmViewer::set_eyes (Eyes e)
 {
-       _eyes = e;
+       _video_view->set_eyes (e);
        slow_refresh ();
 }
 
@@ -349,7 +262,6 @@ FilmViewer::video_view_sized ()
        if (!quick_refresh()) {
                slow_refresh ();
        }
-       PositionChanged ();
 }
 
 void
@@ -381,6 +293,29 @@ FilmViewer::calculate_sizes ()
        _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 ()
 {
@@ -394,15 +329,28 @@ FilmViewer::start ()
                return;
        }
 
+       /* We are about to set up the audio stream from the position of the video view.
+          If there is `lazy' seek in progress we need to wait for it to go through so that
+          _video_view->position() gives us a sensible answer.
+        */
+       while (_idle_get) {
+               idle_handler ();
+       }
+
+       /* Take the video view's idea of position as our `playhead' and start the
+          audio stream (which is the timing reference) there.
+         */
        if (_audio.isStreamOpen()) {
-               _audio.setStreamTime (_video_position.seconds());
+               _audio.setStreamTime (_video_view->position().seconds());
                _audio.startStream ();
        }
 
        _playing = true;
-       _dropped = 0;
-       timer ();
+       /* Calling start() below may directly result in Stopped being emitted, and if that
+        * happens we want it to come after the Started signal, so do that first.
+        */
        Started (position());
+       _video_view->start ();
 }
 
 bool
@@ -418,7 +366,10 @@ FilmViewer::stop ()
        }
 
        _playing = false;
+       _video_view->stop ();
        Stopped (position());
+
+       _video_view->rethrow ();
        return true;
 }
 
@@ -451,22 +402,37 @@ 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());
+       } else if (p == Film::CONTENT) {
+               _closed_captions_dialog->update_tracks (_film);
        }
 }
 
+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
@@ -476,16 +442,10 @@ FilmViewer::slow_refresh ()
 bool
 FilmViewer::quick_refresh ()
 {
-       if (!_player_video.first) {
-               return false;
+       if (!_video_view || !_film || !_player) {
+               return true;
        }
-
-       if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
-               return false;
-       }
-
-       display_player_video ();
-       return true;
+       return _video_view->reset_metadata (_film, _player->video_container_size());
 }
 
 void
@@ -503,7 +463,7 @@ FilmViewer::set_coalesce_player_changes (bool c)
        _coalesce_player_changes = c;
 
        if (!c) {
-               BOOST_FOREACH (int i, _pending_player_changes) {
+               for (auto i: _pending_player_changes) {
                        player_change (CHANGE_TYPE_DONE, i, false);
                }
                _pending_player_changes.clear ();
@@ -522,31 +482,36 @@ FilmViewer::seek (DCPTime t, bool accurate)
        }
 
        if (t >= _film->length ()) {
-               t = _film->length ();
+               t = _film->length() - one_video_frame();
        }
 
-       bool const was_running = stop ();
+       suspend ();
 
        _closed_captions_dialog->clear ();
        _butler->seek (t, accurate);
-       get ();
 
-       if (was_running) {
-               start ();
+       if (!_playing) {
+               /* We're not playing, so let the GUI thread get on and
+                  come back later to get the next frame after the seek.
+               */
+               request_idle_display_next_frame ();
+       } else {
+               /* We're going to start playing again straight away
+                  so wait for the seek to finish.
+               */
+               while (_video_view->display_next_frame(false) == VideoView::AGAIN) {}
        }
 
-       PositionChanged ();
+       resume ();
 }
 
 void
 FilmViewer::config_changed (Config::Property p)
 {
-#ifdef DCPOMATIC_VARIANT_SWAROOP
-       if (p == Config::PLAYER_BACKGROUND_IMAGE) {
-               refresh_view ();
+       if (p == Config::AUDIO_MAPPING) {
+               recreate_butler ();
                return;
        }
-#endif
 
        if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
                return;
@@ -560,8 +525,12 @@ FilmViewer::config_changed (Config::Property p)
                unsigned int st = 0;
                if (Config::instance()->sound_output()) {
                        while (st < _audio.getDeviceCount()) {
-                               if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
-                                       break;
+                               try {
+                                       if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
+                                               break;
+                                       }
+                               } catch (RtAudioError&) {
+                                       /* Something went wrong with that device so we don't want to use it anyway */
                                }
                                ++st;
                        }
@@ -572,19 +541,15 @@ FilmViewer::config_changed (Config::Property p)
                        st = _audio.getDefaultOutputDevice();
                }
 
-               _audio_channels = _audio.getDeviceInfo(st).outputChannels;
-
-               RtAudio::StreamParameters sp;
-               sp.deviceId = st;
-               sp.nChannels = _audio_channels;
-               sp.firstChannel = 0;
                try {
+                       _audio_channels = _audio.getDeviceInfo(st).outputChannels;
+                       RtAudio::StreamParameters sp;
+                       sp.deviceId = st;
+                       sp.nChannels = _audio_channels;
+                       sp.firstChannel = 0;
                        _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
-#ifdef DCPOMATIC_USE_RTERROR
-               } catch (RtError& e) {
-#else
                } catch (RtAudioError& e) {
-#endif
+                       _audio_channels = 0;
                        error_dialog (
                                _video_view->get(),
                                _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
@@ -605,18 +570,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
@@ -651,7 +622,7 @@ FilmViewer::average_latency () const
         }
 
         Frame total = 0;
-        BOOST_FOREACH (Frame i, _latency_history) {
+        for (auto i: _latency_history) {
                 total += i;
         }
 
@@ -676,7 +647,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 */
@@ -689,7 +660,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
@@ -697,3 +668,61 @@ 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::errored () const
+{
+       return _video_view->errored ();
+}
+
+
+int
+FilmViewer::gets () const
+{
+       return _video_view->gets ();
+}
+
+
+void
+FilmViewer::content_change (ChangeType type, int property)
+{
+       if (type != CHANGE_TYPE_DONE) {
+               return;
+       }
+
+       if (property == TextContentProperty::USE || property == TextContentProperty::TYPE || property == TextContentProperty::DCP_TRACK) {
+               _closed_captions_dialog->update_tracks (_film);
+       }
+}
+
+
+void
+FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
+{
+       emit (boost::bind(boost::ref(ImageChanged), pv));
+}
+