C++11 tidying.
[dcpomatic.git] / src / lib / butler.cc
index df23580863a800e41c2f5c2561719822605966a3..5a8e646aa4635556fca90f8791f23e46b6468a9e 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2016-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2016-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -18,6 +18,7 @@
 
 */
 
+
 #include "butler.h"
 #include "player.h"
 #include "util.h"
 #include "cross.h"
 #include "compose.hpp"
 #include "exceptions.h"
-#include <boost/weak_ptr.hpp>
-#include <boost/shared_ptr.hpp>
+#include "video_content.h"
+
 
 using std::cout;
 using std::pair;
 using std::make_pair;
 using std::string;
-using boost::weak_ptr;
-using boost::shared_ptr;
+using std::weak_ptr;
+using std::shared_ptr;
 using boost::bind;
 using boost::optional;
-using boost::function;
+using std::function;
 using namespace dcpomatic;
+#if BOOST_VERSION >= 106100
+using namespace boost::placeholders;
+#endif
+
 
 /** Minimum video readahead in frames */
 #define MINIMUM_VIDEO_READAHEAD 10
@@ -49,21 +54,25 @@ using namespace dcpomatic;
 /** Maximum audio readahead in frames; should never be exceeded (by much) unless there are bugs in Player */
 #define MAXIMUM_AUDIO_READAHEAD (48000 * MAXIMUM_VIDEO_READAHEAD / 24)
 
+
 /** @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 (
+       weak_ptr<const Film> film,
        shared_ptr<Player> player,
        AudioMapping audio_mapping,
        int audio_channels,
        function<AVPixelFormat (AVPixelFormat)> pixel_format,
+       VideoRange video_range,
        bool aligned,
        bool fast
        )
-       : _player (player)
-       , _prepare_work (new boost::asio::io_service::work (_prepare_service))
+       : _film (film)
+       , _player (player)
+       , _prepare_work (new boost::asio::io_service::work(_prepare_service))
        , _pending_seek_accurate (false)
        , _suspended (0)
        , _finished (false)
@@ -73,6 +82,7 @@ Butler::Butler (
        , _audio_channels (audio_channels)
        , _disable_audio (false)
        , _pixel_format (pixel_format)
+       , _video_range (video_range)
        , _aligned (aligned)
        , _fast (fast)
 {
@@ -82,7 +92,7 @@ Butler::Butler (
        /* 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), boost::signals2::at_front);
+       _player_change_connection = _player->Change.connect (bind (&Butler::player_change, this, _1, _2), boost::signals2::at_front);
        _thread = boost::thread (bind(&Butler::thread, this));
 #ifdef DCPOMATIC_LINUX
        pthread_setname_np (_thread.native_handle(), "butler");
@@ -99,6 +109,7 @@ Butler::Butler (
        }
 }
 
+
 Butler::~Butler ()
 {
        boost::this_thread::disable_interruption dis;
@@ -168,10 +179,13 @@ Butler::should_run () const
        return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
 }
 
+
 void
 Butler::thread ()
 try
 {
+       start_of_thread ("Butler");
+
        while (true) {
                boost::mutex::scoped_lock lm (_mutex);
 
@@ -208,6 +222,12 @@ try
        boost::mutex::scoped_lock lm (_mutex);
        _finished = true;
        _arrived.notify_all ();
+} catch (std::exception& e) {
+       store_current ();
+       boost::mutex::scoped_lock lm (_mutex);
+       _died = true;
+       _died_message = e.what ();
+       _arrived.notify_all ();
 } catch (...) {
        store_current ();
        boost::mutex::scoped_lock lm (_mutex);
@@ -215,6 +235,7 @@ try
        _arrived.notify_all ();
 }
 
+
 /** @param blocking true if we should block until video is available.  If blocking is false
  *  and no video is immediately available the method will return a 0 PlayerVideo and the error AGAIN.
  *  @param e if non-0 this is filled with an error code (if an error occurs) or is untouched if no error occurs.
@@ -224,10 +245,21 @@ Butler::get_video (bool blocking, Error* e)
 {
        boost::mutex::scoped_lock lm (_mutex);
 
-       if (_suspended || (_video.empty() && !blocking)) {
+       auto setup_error = [this](Error* e, Error::Code fallback) {
                if (e) {
-                       *e = AGAIN;
+                       if (_died) {
+                               e->code = Error::DIED;
+                               e->message = _died_message;
+                       } else if (_finished) {
+                               e->code = Error::FINISHED;
+                       } else {
+                               e->code = fallback;
+                       }
                }
+       };
+
+       if (_video.empty() && (_finished || _died || (_suspended && !blocking))) {
+               setup_error (e, Error::AGAIN);
                return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
        }
 
@@ -237,23 +269,16 @@ Butler::get_video (bool blocking, Error* e)
        }
 
        if (_video.empty()) {
-               if (e) {
-                       if (_died) {
-                               *e = DIED;
-                       } else if (_finished) {
-                               *e = FINISHED;
-                       } else {
-                               *e = NONE;
-                       }
-               }
+               setup_error (e, Error::NONE);
                return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
        }
 
-       pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
+       auto const r = _video.get ();
        _summon.notify_all ();
        return r;
 }
 
+
 optional<TextRingBuffers::Data>
 Butler::get_closed_caption ()
 {
@@ -261,6 +286,7 @@ Butler::get_closed_caption ()
        return _closed_caption.get ();
 }
 
+
 void
 Butler::seek (DCPTime position, bool accurate)
 {
@@ -269,6 +295,7 @@ Butler::seek (DCPTime position, bool accurate)
        seek_unlocked (position, accurate);
 }
 
+
 void
 Butler::seek_unlocked (DCPTime position, bool accurate)
 {
@@ -287,18 +314,26 @@ Butler::seek_unlocked (DCPTime position, bool accurate)
        _summon.notify_all ();
 }
 
+
 void
 Butler::prepare (weak_ptr<PlayerVideo> weak_video)
 try
 {
-       shared_ptr<PlayerVideo> video = weak_video.lock ();
+       auto 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 (_pixel_format, _aligned, _fast);
+               video->prepare (_pixel_format, _video_range, _aligned, _fast);
                LOG_TIMING("finish-prepare in %1", thread_id());
        }
 }
+catch (std::exception& e)
+{
+       store_current ();
+       boost::mutex::scoped_lock lm (_mutex);
+       _died = true;
+       _died_message = e.what ();
+}
 catch (...)
 {
        store_current ();
@@ -306,6 +341,7 @@ catch (...)
        _died = true;
 }
 
+
 void
 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
 {
@@ -316,11 +352,12 @@ Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
                return;
        }
 
-       _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
+       _prepare_service.post (bind(&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
 
        _video.put (video, time);
 }
 
+
 void
 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate)
 {
@@ -330,9 +367,10 @@ Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate)
                return;
        }
 
-       _audio.put (remap (audio, _audio_channels, _audio_mapping), time, frame_rate);
+       _audio.put (remap(audio, _audio_channels, _audio_mapping), time, frame_rate);
 }
 
+
 /** Try to get `frames' frames of audio and copy it into `out'.  Silence
  *  will be filled if no audio is available.
  *  @return time of this audio, or unset if there was a buffer underrun.
@@ -340,11 +378,12 @@ Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate)
 optional<DCPTime>
 Butler::get_audio (float* out, Frame frames)
 {
-       optional<DCPTime> t = _audio.get (out, _audio_channels, frames);
+       auto t = _audio.get (out, _audio_channels, frames);
        _summon.notify_all ();
        return t;
 }
 
+
 void
 Butler::disable_audio ()
 {
@@ -352,6 +391,7 @@ Butler::disable_audio ()
        _disable_audio = true;
 }
 
+
 pair<size_t, string>
 Butler::memory_used () const
 {
@@ -359,14 +399,25 @@ Butler::memory_used () const
        return _video.memory_used();
 }
 
+
 void
-Butler::player_change (ChangeType type)
+Butler::player_change (ChangeType type, int property)
 {
+       if (property == VideoContentProperty::CROP) {
+               if (type == ChangeType::DONE) {
+                       auto film = _film.lock();
+                       if (film) {
+                               _video.reset_metadata (film, _player->video_container_size());
+                       }
+               }
+               return;
+       }
+
        boost::mutex::scoped_lock lm (_mutex);
 
-       if (type == CHANGE_TYPE_PENDING) {
+       if (type == ChangeType::PENDING) {
                ++_suspended;
-       } else if (type == CHANGE_TYPE_DONE) {
+       } else if (type == ChangeType::DONE) {
                --_suspended;
                if (_died || _pending_seek_position) {
                        lm.unlock ();
@@ -375,7 +426,7 @@ Butler::player_change (ChangeType type)
                }
 
                DCPTime seek_to;
-               DCPTime next = _video.get().second;
+               auto 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.
@@ -387,7 +438,7 @@ Butler::player_change (ChangeType type)
 
                seek_unlocked (seek_to, true);
                _awaiting = seek_to;
-       } else if (type == CHANGE_TYPE_CANCELLED) {
+       } else if (type == ChangeType::CANCELLED) {
                --_suspended;
        }
 
@@ -395,10 +446,11 @@ Butler::player_change (ChangeType type)
        _summon.notify_all ();
 }
 
+
 void
 Butler::text (PlayerText pt, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
 {
-       if (type != TEXT_CLOSED_CAPTION) {
+       if (type != TextType::CLOSED_CAPTION) {
                return;
        }
 
@@ -406,3 +458,23 @@ Butler::text (PlayerText pt, TextType type, optional<DCPTextTrack> track, DCPTim
 
        _closed_caption.put (pt, *track, period);
 }
+
+
+string
+Butler::Error::summary () const
+{
+       switch (code)
+       {
+               case Error::NONE:
+                       return "No error registered";
+               case Error::AGAIN:
+                       return "Butler not ready";
+               case Error::DIED:
+                       return String::compose("Butler died (%1)", message);
+               case Error::FINISHED:
+                       return "Butler finished";
+       }
+
+       return "";
+}
+