Tidy and fix logging.
[dcpomatic.git] / src / lib / butler.cc
index aee5846542d977586bae2d65f04466deedafc7a8..94230d0942b7b65dd910766495d94c850cb0392f 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2016-2017 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2016-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "player.h"
 #include "util.h"
 #include "log.h"
+#include "dcpomatic_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;
@@ -39,31 +37,51 @@ using boost::weak_ptr;
 using boost::shared_ptr;
 using boost::bind;
 using boost::optional;
+using boost::function;
 
 /** 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
+#define MAXIMUM_VIDEO_READAHEAD 48
 /** 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 (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping audio_mapping, int audio_channels)
+/** @param pixel_format Pixel format functor that will be used when calling ::image on PlayerVideos coming out of this
+ *  butler.  This will be used (where possible) to prepare the PlayerVideos so that calling image() on them is quick().
+ *  @param aligned Same as above for the `aligned' flag.
+ *  @param fast Same as above for the `fast' flag.
+ */
+Butler::Butler (
+       shared_ptr<Player> player,
+       AudioMapping audio_mapping,
+       int audio_channels,
+       function<AVPixelFormat (AVPixelFormat)> pixel_format,
+       bool aligned,
+       bool fast
+       )
        : _player (player)
-       , _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)
        , _audio_mapping (audio_mapping)
        , _audio_channels (audio_channels)
        , _disable_audio (false)
+       , _pixel_format (pixel_format)
+       , _aligned (aligned)
+       , _fast (fast)
 {
        _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, _1));
+       _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,8 +91,9 @@ 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());
-       for (size_t i = 0; i < boost::thread::hardware_concurrency(); ++i) {
+       LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency() * 2);
+
+       for (size_t i = 0; i < boost::thread::hardware_concurrency() * 2; ++i) {
                _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
        }
 }
@@ -123,7 +142,7 @@ Butler::should_run () const
                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 +204,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 +232,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 +253,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 ();
 }
 
@@ -236,7 +274,7 @@ Butler::prepare (weak_ptr<PlayerVideo> weak_video) const
        /* 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 ();
+               video->prepare (_pixel_format, _aligned, _fast);
                LOG_TIMING("finish-prepare in %1", thread_id());
        }
 }
@@ -247,13 +285,13 @@ 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);
 }
 
@@ -263,12 +301,12 @@ 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);
+       boost::mutex::scoped_lock lm2 (_buffers_mutex);
        _audio.put (remap (audio, _audio_channels, _audio_mapping), time);
 }
 
@@ -299,33 +337,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);
 }