Mark .exr as a valid image file.

[dcpomatic.git] / src / lib / butler.cc

diff --git a/src/lib/butler.cc b/src/lib/butler.cc
index b9aa0a5db42c0a1944f8212347b63be119f8c863..a78a3b71b22db06998c8ac7073ef4093272c9065 100644 (file)
--- a/src/lib/butler.cc
+++ b/src/lib/butler.cc
@@ -20,6 +20,9 @@
 
 #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>
 
@@ -31,31 +34,52 @@ 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 240
+/** Minimum audio readahead in frames */
+#define MINIMUM_AUDIO_READAHEAD (48000*5)
+/** Minimum audio readahead in frames; should never be reached unless there are bugs in Player */
+#define MAXIMUM_AUDIO_READAHEAD (48000*60)
 
-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));
+
+       /* 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 ();
@@ -65,10 +89,30 @@ Butler::~Butler ()
        delete _thread;
 }
 
+/** Caller must hold a lock on _mutex */
 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) {
+               LOG_WARNING ("Butler video buffers reached %1 frames", _video.size());
+       }
+
+       if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD) {
+               LOG_WARNING ("Butler audio buffers reached %1 frames", _audio.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
@@ -85,6 +129,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> ();
                }
@@ -152,6 +197,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)
 {
@@ -163,11 +218,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);
@@ -177,32 +233,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