Add some code to help with profiling the player.
[dcpomatic.git] / src / lib / butler.cc
index 63fe729aecea5f2c43557022e3a90769576e9c11..d50c461c8a1275ab1102665623a45270faa3d434 100644 (file)
@@ -54,6 +54,7 @@ Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping aud
        , _log (log)
        , _prepare_work (new boost::asio::io_service::work (_prepare_service))
        , _pending_seek_accurate (false)
+       , _suspended (0)
        , _finished (false)
        , _died (false)
        , _stop_thread (false)
@@ -62,8 +63,12 @@ Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping aud
        , _disable_audio (false)
 {
        _player_video_connection = _player->Video.connect (bind (&Butler::video, this, _1, _2));
-       _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1));
-       _player_changed_connection = _player->Changed.connect (bind (&Butler::player_changed, this, _1));
+       _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1, _2));
+       _player_text_connection = _player->Text.connect (bind (&Butler::text, this, _1, _2, _3, _4));
+       /* The butler must hear about things first, otherwise it might not sort out suspensions in time for
+          get_video() to be called in response to this signal.
+       */
+       _player_change_connection = _player->Change.connect (bind (&Butler::player_change, this, _1, _3), boost::signals2::at_front);
        _thread = new boost::thread (bind (&Butler::thread, this));
 #ifdef DCPOMATIC_LINUX
        pthread_setname_np (_thread->native_handle(), "butler");
@@ -73,7 +78,10 @@ Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping aud
           multi-thread JPEG2000 decoding.
        */
 
-       LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency());
+       if (_log) {
+               LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency());
+       }
+
        for (size_t i = 0; i < boost::thread::hardware_concurrency(); ++i) {
                _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
        }
@@ -115,15 +123,15 @@ Butler::should_run () const
                        (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size()));
        }
 
-       if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
+       if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2 && _log) {
                LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
        }
 
-       if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
+       if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2 && _log) {
                LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
        }
 
-       if (_stop_thread || _finished || _died) {
+       if (_stop_thread || _finished || _died || _suspended) {
                /* Definitely do not run */
                return false;
        }
@@ -185,17 +193,27 @@ try
 }
 
 pair<shared_ptr<PlayerVideo>, DCPTime>
-Butler::get_video ()
+Butler::get_video (Error* e)
 {
        boost::mutex::scoped_lock lm (_mutex);
 
+       if (_suspended) {
+               if (e) {
+                       *e = AGAIN;
+               }
+               return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
+       }
+
        /* Wait for data if we have none */
        while (_video.empty() && !_finished && !_died) {
                _arrived.wait (lm);
        }
 
        if (_video.empty()) {
-               return make_pair (shared_ptr<PlayerVideo>(), DCPTime());
+               if (e) {
+                       *e = NONE;
+               }
+               return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
        }
 
        pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
@@ -203,6 +221,13 @@ Butler::get_video ()
        return r;
 }
 
+optional<TextRingBuffers::Data>
+Butler::get_closed_caption ()
+{
+       boost::mutex::scoped_lock lm (_mutex);
+       return _closed_caption.get ();
+}
+
 void
 Butler::seek (DCPTime position, bool accurate)
 {
@@ -217,15 +242,17 @@ Butler::seek_unlocked (DCPTime position, bool accurate)
                return;
        }
 
+       _finished = false;
+       _pending_seek_position = position;
+       _pending_seek_accurate = accurate;
+
        {
-               boost::mutex::scoped_lock lm (_video_audio_mutex);
+               boost::mutex::scoped_lock lm (_buffers_mutex);
                _video.clear ();
                _audio.clear ();
+               _closed_caption.clear ();
        }
 
-       _finished = false;
-       _pending_seek_position = position;
-       _pending_seek_accurate = accurate;
        _summon.notify_all ();
 }
 
@@ -235,9 +262,15 @@ Butler::prepare (weak_ptr<PlayerVideo> weak_video) const
        shared_ptr<PlayerVideo> video = weak_video.lock ();
        /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
        if (video) {
-               LOG_TIMING("start-prepare in %1", thread_id());
+               if (_log) {
+                       LOG_TIMING("start-prepare in %1", thread_id());
+               }
+
                video->prepare ();
-               LOG_TIMING("finish-prepare in %1", thread_id());
+
+               if (_log) {
+                       LOG_TIMING("finish-prepare in %1", thread_id());
+               }
        }
 }
 
@@ -247,41 +280,41 @@ Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
        boost::mutex::scoped_lock lm (_mutex);
 
        if (_pending_seek_position) {
-               /* Don't store any video while a seek is pending */
+               /* Don't store any video in this case */
                return;
        }
 
        _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
 
-       boost::mutex::scoped_lock lm2 (_video_audio_mutex);
+       boost::mutex::scoped_lock lm2 (_buffers_mutex);
        _video.put (video, time);
 }
 
 void
-Butler::audio (shared_ptr<AudioBuffers> audio)
+Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
                if (_pending_seek_position || _disable_audio) {
-                       /* Don't store any audio while a seek is pending, or if audio is disabled */
+                       /* Don't store any audio in these cases */
                        return;
                }
        }
 
-       boost::mutex::scoped_lock lm2 (_video_audio_mutex);
-       _audio.put (remap (audio, _audio_channels, _audio_mapping));
+       boost::mutex::scoped_lock lm2 (_buffers_mutex);
+       _audio.put (remap (audio, _audio_channels, _audio_mapping), time);
 }
 
 /** Try to get `frames' frames of audio and copy it into `out'.  Silence
  *  will be filled if no audio is available.
- *  @return true if there was a buffer underrun, otherwise false.
+ *  @return time of this audio, or unset if there was a buffer underrun.
  */
-bool
+optional<DCPTime>
 Butler::get_audio (float* out, Frame frames)
 {
-       bool const underrun = _audio.get (out, _audio_channels, frames);
+       optional<DCPTime> t = _audio.get (out, _audio_channels, frames);
        _summon.notify_all ();
-       return underrun;
+       return t;
 }
 
 void
@@ -299,33 +332,50 @@ Butler::memory_used () const
 }
 
 void
-Butler::player_changed (int what)
+Butler::player_change (ChangeType type, bool frequent)
 {
        boost::mutex::scoped_lock lm (_mutex);
-       if (_died || _pending_seek_position) {
-               return;
-       }
 
-       DCPTime seek_to;
-       DCPTime next = _video.get().second;
-       if (_awaiting && _awaiting > next) {
-               /* We have recently done a player_changed seek and our buffers haven't been refilled yet,
-                  so assume that we're seeking to the same place as last time.
-               */
-               seek_to = *_awaiting;
-       } else {
-               seek_to = next;
-       }
+       if (type == CHANGE_TYPE_PENDING) {
+               ++_suspended;
+       } else if (type == CHANGE_TYPE_DONE) {
+               --_suspended;
+               if (_died || _pending_seek_position || frequent) {
+                       lm.unlock ();
+                       _summon.notify_all ();
+                       return;
+               }
 
-       {
-               boost::mutex::scoped_lock lm (_video_audio_mutex);
-               _video.clear ();
-               _audio.clear ();
+               DCPTime seek_to;
+               DCPTime next = _video.get().second;
+               if (_awaiting && _awaiting > next) {
+                       /* We have recently done a player_changed seek and our buffers haven't been refilled yet,
+                          so assume that we're seeking to the same place as last time.
+                       */
+                       seek_to = *_awaiting;
+               } else {
+                       seek_to = next;
+               }
+
+               seek_unlocked (seek_to, true);
+               _awaiting = seek_to;
+       } else if (type == CHANGE_TYPE_CANCELLED) {
+               --_suspended;
        }
 
-       _finished = false;
+       lm.unlock ();
        _summon.notify_all ();
+}
+
+void
+Butler::text (PlayerText pt, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
+{
+       if (type != TEXT_CLOSED_CAPTION) {
+               return;
+       }
+
+       DCPOMATIC_ASSERT (track);
 
-       seek_unlocked (seek_to, true);
-       _awaiting = seek_to;
+       boost::mutex::scoped_lock lm2 (_buffers_mutex);
+       _closed_caption.put (pt, *track, period);
 }