A variety of changes to improve (but not entirely fix) behaviour
[dcpomatic.git] / src / lib / butler.cc
index fde8e459b5372777cccc72f3330f155d11cddc55..63fe729aecea5f2c43557022e3a90769576e9c11 100644 (file)
 #include "butler.h"
 #include "player.h"
 #include "util.h"
+#include "log.h"
+#include "cross.h"
+#include "compose.hpp"
+#include "exceptions.h"
 #include <boost/weak_ptr.hpp>
 #include <boost/shared_ptr.hpp>
 
+#define LOG_TIMING(...)  _log->log (String::compose(__VA_ARGS__), LogEntry::TYPE_TIMING);
+#define LOG_WARNING(...) _log->log (String::compose(__VA_ARGS__), LogEntry::TYPE_WARNING);
+
 using std::cout;
 using std::pair;
 using std::make_pair;
+using std::string;
 using boost::weak_ptr;
 using boost::shared_ptr;
 using boost::bind;
 using boost::optional;
 
-/** Video readahead in frames */
-#define VIDEO_READAHEAD 10
-/** Audio readahead in frames */
-#define AUDIO_READAHEAD (48000*5)
+/** Minimum video readahead in frames */
+#define MINIMUM_VIDEO_READAHEAD 10
+/** Maximum video readahead in frames; should never be reached unless there are bugs in Player */
+#define MAXIMUM_VIDEO_READAHEAD 24
+/** Minimum audio readahead in frames */
+#define MINIMUM_AUDIO_READAHEAD (48000 * MINIMUM_VIDEO_READAHEAD / 24)
+/** Minimum audio readahead in frames; should never be reached unless there are bugs in Player */
+#define MAXIMUM_AUDIO_READAHEAD (48000 * MAXIMUM_VIDEO_READAHEAD / 24)
 
-Butler::Butler (weak_ptr<const Film> film, shared_ptr<Player> player, AudioMapping audio_mapping, int audio_channels)
-       : _film (film)
-       , _player (player)
+Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping audio_mapping, int audio_channels)
+       : _player (player)
+       , _log (log)
+       , _prepare_work (new boost::asio::io_service::work (_prepare_service))
        , _pending_seek_accurate (false)
        , _finished (false)
        , _died (false)
@@ -50,8 +63,20 @@ Butler::Butler (weak_ptr<const Film> film, shared_ptr<Player> player, AudioMappi
 {
        _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));
+       _player_changed_connection = _player->Changed.connect (bind (&Butler::player_changed, this, _1));
        _thread = new boost::thread (bind (&Butler::thread, this));
+#ifdef DCPOMATIC_LINUX
+       pthread_setname_np (_thread->native_handle(), "butler");
+#endif
+
+       /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
+          multi-thread JPEG2000 decoding.
+       */
+
+       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));
+       }
 }
 
 Butler::~Butler ()
@@ -61,6 +86,10 @@ Butler::~Butler ()
                _stop_thread = true;
        }
 
+       _prepare_work.reset ();
+       _prepare_pool.join_all ();
+       _prepare_service.stop ();
+
        _thread->interrupt ();
        try {
                _thread->join ();
@@ -74,7 +103,38 @@ Butler::~Butler ()
 bool
 Butler::should_run () const
 {
-       return (_video.size() < VIDEO_READAHEAD || (!_disable_audio && _audio.size() < AUDIO_READAHEAD)) && !_stop_thread && !_finished && !_died;
+       if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
+               /* This is way too big */
+               throw ProgrammingError
+                       (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
+       }
+
+       if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
+               /* This is way too big */
+               throw ProgrammingError
+                       (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size()));
+       }
+
+       if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
+               LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
+       }
+
+       if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
+               LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
+       }
+
+       if (_stop_thread || _finished || _died) {
+               /* Definitely do not run */
+               return false;
+       }
+
+       if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
+               /* Definitely do run: we need data */
+               return true;
+       }
+
+       /* Run if we aren't full of video or audio */
+       return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
 }
 
 void
@@ -147,29 +207,53 @@ void
 Butler::seek (DCPTime position, bool accurate)
 {
        boost::mutex::scoped_lock lm (_mutex);
+       seek_unlocked (position, accurate);
+}
+
+void
+Butler::seek_unlocked (DCPTime position, bool accurate)
+{
        if (_died) {
                return;
        }
 
-       _video.clear ();
-       _audio.clear ();
+       {
+               boost::mutex::scoped_lock lm (_video_audio_mutex);
+               _video.clear ();
+               _audio.clear ();
+       }
+
        _finished = false;
        _pending_seek_position = position;
        _pending_seek_accurate = accurate;
        _summon.notify_all ();
 }
 
+void
+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());
+               video->prepare ();
+               LOG_TIMING("finish-prepare in %1", thread_id());
+       }
+}
+
 void
 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 */
-                       return;
-               }
+       boost::mutex::scoped_lock lm (_mutex);
+
+       if (_pending_seek_position) {
+               /* Don't store any video while a seek is pending */
+               return;
        }
 
+       _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
+
+       boost::mutex::scoped_lock lm2 (_video_audio_mutex);
        _video.put (video, time);
 }
 
@@ -184,37 +268,64 @@ Butler::audio (shared_ptr<AudioBuffers> audio)
                }
        }
 
+       boost::mutex::scoped_lock lm2 (_video_audio_mutex);
        _audio.put (remap (audio, _audio_channels, _audio_mapping));
 }
 
+/** 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.
+ */
+bool
+Butler::get_audio (float* out, Frame frames)
+{
+       bool const underrun = _audio.get (out, _audio_channels, frames);
+       _summon.notify_all ();
+       return underrun;
+}
+
 void
-Butler::player_changed ()
+Butler::disable_audio ()
 {
-       optional<DCPTime> t;
+       boost::mutex::scoped_lock lm (_mutex);
+       _disable_audio = true;
+}
 
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               t = _video.earliest ();
+pair<size_t, string>
+Butler::memory_used () const
+{
+       /* XXX: should also look at _audio.memory_used() */
+       return _video.memory_used();
+}
+
+void
+Butler::player_changed (int what)
+{
+       boost::mutex::scoped_lock lm (_mutex);
+       if (_died || _pending_seek_position) {
+               return;
        }
 
-       if (t) {
-               seek (*t, true);
+       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;
+       }
+
+       {
+               boost::mutex::scoped_lock lm (_video_audio_mutex);
                _video.clear ();
                _audio.clear ();
        }
-}
 
-void
-Butler::get_audio (float* out, Frame frames)
-{
-       _audio.get (out, _audio_channels, frames);
+       _finished = false;
        _summon.notify_all ();
-}
 
-void
-Butler::disable_audio ()
-{
-       boost::mutex::scoped_lock lm (_mutex);
-       _disable_audio = true;
+       seek_unlocked (seek_to, true);
+       _awaiting = seek_to;
 }