Name threads on Linux.
[dcpomatic.git] / src / lib / butler.cc
index b84dbc024d65d68592373aef2137b8a5bdf08964..81ddb1d44629fcb8b5706e5650978b491275de54 100644 (file)
 
 #include "butler.h"
 #include "player.h"
+#include "util.h"
+#include "log.h"
+#include "compose.hpp"
 #include <boost/weak_ptr.hpp>
 #include <boost/shared_ptr.hpp>
 
 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)
+#define LOG_WARNING(...) _log->log (String::compose(__VA_ARGS__), LogEntry::TYPE_WARNING);
+
+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)
+       , _stop_thread (false)
        , _audio_mapping (audio_mapping)
        , _audio_channels (audio_channels)
-       , _stop_thread (false)
        , _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, _2));
-       _player_changed_connection = _player->Changed.connect (bind (&Butler::player_changed, this));
+       _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, 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.
+       */
+       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 ()
 {
-       _stop_thread = true;
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _stop_thread = true;
+       }
+
+       _prepare_work.reset ();
+       _prepare_pool.join_all ();
+       _prepare_service.stop ();
+
        _thread->interrupt ();
        try {
                _thread->join ();
@@ -64,10 +93,30 @@ Butler::~Butler ()
        delete _thread;
 }
 
+/** Caller must hold a lock on _mutex */
 bool
 Butler::should_run () const
 {
-       return (_video.size() < VIDEO_READAHEAD || _audio.size() < AUDIO_READAHEAD) && !_stop_thread && !_finished;
+       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
@@ -84,6 +133,7 @@ try
 
                /* Do any seek that has been requested */
                if (_pending_seek_position) {
+                       _finished = false;
                        _player->seek (*_pending_seek_position, _pending_seek_accurate);
                        _pending_seek_position = optional<DCPTime> ();
                }
@@ -94,20 +144,25 @@ try
                */
                while (should_run() && !_pending_seek_position) {
                        lm.unlock ();
-                       if (_player->pass ()) {
+                       bool const r = _player->pass ();
+                       lm.lock ();
+                       if (r) {
                                _finished = true;
                                _arrived.notify_all ();
                                break;
                        }
-                       lm.lock ();
                        _arrived.notify_all ();
                }
        }
 } catch (boost::thread_interrupted) {
        /* The butler thread is being terminated */
+       boost::mutex::scoped_lock lm (_mutex);
+       _finished = true;
+       _arrived.notify_all ();
 } catch (...) {
        store_current ();
-       _finished = true;
+       boost::mutex::scoped_lock lm (_mutex);
+       _died = true;
        _arrived.notify_all ();
 }
 
@@ -117,11 +172,11 @@ Butler::get_video ()
        boost::mutex::scoped_lock lm (_mutex);
 
        /* Wait for data if we have none */
-       while (_video.empty() && !_finished) {
+       while (_video.empty() && !_finished && !_died) {
                _arrived.wait (lm);
        }
 
-       if (_video.empty() && _finished) {
+       if (_video.empty()) {
                return make_pair (shared_ptr<PlayerVideo>(), DCPTime());
        }
 
@@ -134,6 +189,10 @@ void
 Butler::seek (DCPTime position, bool accurate)
 {
        boost::mutex::scoped_lock lm (_mutex);
+       if (_died) {
+               return;
+       }
+
        _video.clear ();
        _audio.clear ();
        _finished = false;
@@ -142,6 +201,16 @@ Butler::seek (DCPTime position, bool 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) {
+               video->prepare ();
+       }
+}
+
 void
 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
 {
@@ -153,11 +222,12 @@ Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
                }
        }
 
+       _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
        _video.put (video, time);
 }
 
 void
-Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
+Butler::audio (shared_ptr<AudioBuffers> audio)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
@@ -167,32 +237,19 @@ Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
                }
        }
 
-       _audio.put (audio, time);
+       _audio.put (remap (audio, _audio_channels, _audio_mapping));
 }
 
-void
-Butler::player_changed ()
-{
-       optional<DCPTime> t;
-
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               t = _video.earliest ();
-       }
-
-       if (t) {
-               seek (*t, true);
-       } else {
-               _video.clear ();
-               _audio.clear ();
-       }
-}
-
-void
+/** 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)
 {
-       _audio.get (out, _audio_channels, frames);
+       bool const underrun = _audio.get (out, _audio_channels, frames);
        _summon.notify_all ();
+       return underrun;
 }
 
 void
@@ -201,3 +258,10 @@ Butler::disable_audio ()
        boost::mutex::scoped_lock lm (_mutex);
        _disable_audio = true;
 }
+
+pair<size_t, string>
+Butler::memory_used () const
+{
+       /* XXX: should also look at _audio.memory_used() */
+       return _video.memory_used();
+}