Fix copy-and-paste error in manual.
[dcpomatic.git] / src / lib / butler.cc
index df23580863a800e41c2f5c2561719822605966a3..56acbd8a0817aa4809741aea234a3589a9d9162c 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2016-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2016-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #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 namespace dcpomatic;
+#if BOOST_VERSION >= 106100
+using namespace boost::placeholders;
+#endif
 
 /** Minimum video readahead in frames */
 #define MINIMUM_VIDEO_READAHEAD 10
@@ -55,14 +58,17 @@ using namespace dcpomatic;
  *  @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)
+       : _film (film)
+       , _player (player)
        , _prepare_work (new boost::asio::io_service::work (_prepare_service))
        , _pending_seek_accurate (false)
        , _suspended (0)
@@ -73,6 +79,7 @@ Butler::Butler (
        , _audio_channels (audio_channels)
        , _disable_audio (false)
        , _pixel_format (pixel_format)
+       , _video_range (video_range)
        , _aligned (aligned)
        , _fast (fast)
 {
@@ -82,7 +89,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");
@@ -208,6 +215,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);
@@ -226,7 +239,7 @@ Butler::get_video (bool blocking, Error* e)
 
        if (_suspended || (_video.empty() && !blocking)) {
                if (e) {
-                       *e = AGAIN;
+                       e->code = Error::AGAIN;
                }
                return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
        }
@@ -239,11 +252,12 @@ Butler::get_video (bool blocking, Error* e)
        if (_video.empty()) {
                if (e) {
                        if (_died) {
-                               *e = DIED;
+                               e->code = Error::DIED;
+                               e->message = _died_message;
                        } else if (_finished) {
-                               *e = FINISHED;
+                               e->code = Error::FINISHED;
                        } else {
-                               *e = NONE;
+                               e->code = Error::NONE;
                        }
                }
                return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
@@ -295,10 +309,17 @@ try
        /* 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 ();
@@ -360,13 +381,23 @@ Butler::memory_used () const
 }
 
 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 +406,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 +418,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;
        }
 
@@ -398,7 +429,7 @@ Butler::player_change (ChangeType type)
 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 +437,22 @@ 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 "";
+}
+