X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fbutler.cc;h=ce35b1f39aff61da043aa71e0a3d5fad0e963f11;hp=f04b324cdea4cc29e02bbac2a964d5c27c898c4b;hb=HEAD;hpb=9a27d60ea7888d300a5a2414a477091428589b82

diff --git a/src/lib/butler.cc b/src/lib/butler.cc
index f04b324cd..b2fbc6c60 100644
--- a/src/lib/butler.cc
+++ b/src/lib/butler.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2016-2017 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2016-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -18,73 +18,105 @@
 
 */
 
+
 #include "butler.h"
-#include "player.h"
-#include "util.h"
-#include "log.h"
-#include "cross.h"
 #include "compose.hpp"
+#include "cross.h"
+#include "dcpomatic_log.h"
 #include "exceptions.h"
-#include <boost/weak_ptr.hpp>
-#include <boost/shared_ptr.hpp>
+#include "log.h"
+#include "player.h"
+#include "util.h"
+#include "video_content.h"
 
-#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::function;
 using std::make_pair;
+using std::pair;
+using std::shared_ptr;
 using std::string;
-using boost::weak_ptr;
-using boost::shared_ptr;
+using std::weak_ptr;
 using boost::bind;
 using boost::optional;
+using namespace dcpomatic;
+#if BOOST_VERSION >= 106100
+using namespace boost::placeholders;
+#endif
+
 
 /** 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
+/** Maximum video readahead in frames; should never be exceeded (by much) unless there are bugs in Player */
+#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 */
+/** 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)
 
-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))
+
+/** @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 alignment Same as above for the `alignment' value.
+ *  @param fast Same as above for the `fast' flag.
+ */
+Butler::Butler (
+	weak_ptr<const Film> film,
+	Player& player,
+	AudioMapping audio_mapping,
+	int audio_channels,
+	function<AVPixelFormat (AVPixelFormat)> pixel_format,
+	VideoRange video_range,
+	Image::Alignment alignment,
+	bool fast,
+	bool prepare_only_proxy,
+	Audio audio
+	)
+	: _film (film)
+	, _player (player)
+	, _prepare_work (new boost::asio::io_service::work(_prepare_service))
 	, _pending_seek_accurate (false)
-	, _suspended (false)
+	, _suspended (0)
 	, _finished (false)
 	, _died (false)
 	, _stop_thread (false)
 	, _audio_mapping (audio_mapping)
 	, _audio_channels (audio_channels)
-	, _disable_audio (false)
+	, _disable_audio (audio == Audio::DISABLED)
+	, _pixel_format (pixel_format)
+	, _video_range (video_range)
+	, _alignment (alignment)
+	, _fast (fast)
+	, _prepare_only_proxy (prepare_only_proxy)
 {
-	_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_text_connection = _player->Text.connect (bind (&Butler::text, this, _1, _2, _3));
-	_player_may_change_connection = _player->MayChange.connect (bind (&Butler::suspend, this));
-	_player_changed_connection = _player->Changed.connect (bind (&Butler::return_seek, this, _2));
-	_player_not_changed_connection = _player->NotChanged.connect (bind (&Butler::return_seek, this, false));
-	_thread = new boost::thread (bind (&Butler::thread, this));
+	_player_video_connection = _player.Video.connect(bind(&Butler::video, this, _1, _2));
+	_player_audio_connection = _player.Audio.connect(bind(&Butler::audio, this, _1, _2, _3));
+	_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, _2), boost::signals2::at_front);
+	_thread = boost::thread (bind(&Butler::thread, this));
 #ifdef DCPOMATIC_LINUX
-	pthread_setname_np (_thread->native_handle(), "butler");
+	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.
 	*/
 
-	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));
 	}
 }
 
+
 Butler::~Butler ()
 {
+	boost::this_thread::disable_interruption dis;
+
 	{
 		boost::mutex::scoped_lock lm (_mutex);
 		_stop_thread = true;
@@ -94,33 +126,38 @@ Butler::~Butler ()
 	_prepare_pool.join_all ();
 	_prepare_service.stop ();
 
-	_thread->interrupt ();
+	_thread.interrupt ();
 	try {
-		_thread->join ();
-	} catch (boost::thread_interrupted& e) {
-		/* No problem */
-	}
-	delete _thread;
+		_thread.join ();
+	} catch (...) {}
 }
 
 /** Caller must hold a lock on _mutex */
 bool
 Butler::should_run () const
 {
-	if (_suspended) {
-		return false;
-	}
-
 	if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
 		/* This is way too big */
-		throw ProgrammingError
-			(__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
+		optional<DCPTime> pos = _audio.peek();
+		if (pos) {
+			throw ProgrammingError
+				(__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2 at %3)", _video.size(), _audio.size(), pos->get()));
+		} else {
+			throw ProgrammingError
+				(__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
+		}
 	}
 
 	if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
 		/* This is way too big */
-		throw ProgrammingError
-			(__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size()));
+		auto pos = _audio.peek();
+		if (pos) {
+			throw ProgrammingError
+				(__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames at %2 (video is %3)", _audio.size(), pos->get(), _video.size()));
+		} else {
+			throw ProgrammingError
+				(__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %3)", _audio.size(), _video.size()));
+		}
 	}
 
 	if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
@@ -131,7 +168,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;
 	}
@@ -145,10 +182,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);
 
@@ -160,7 +200,7 @@ try
 		/* Do any seek that has been requested */
 		if (_pending_seek_position) {
 			_finished = false;
-			_player->seek (*_pending_seek_position, _pending_seek_accurate);
+			_player.seek(*_pending_seek_position, _pending_seek_accurate);
 			_pending_seek_position = optional<DCPTime> ();
 		}
 
@@ -170,7 +210,7 @@ try
 		*/
 		while (should_run() && !_pending_seek_position) {
 			lm.unlock ();
-			bool const r = _player->pass ();
+			bool const r = _player.pass();
 			lm.lock ();
 			if (r) {
 				_finished = true;
@@ -185,6 +225,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);
@@ -192,39 +238,67 @@ try
 	_arrived.notify_all ();
 }
 
+
+/** @param behaviour BLOCKING if we should block until video is available.  If behaviour is NON_BLOCKING
+ *  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.
+ */
 pair<shared_ptr<PlayerVideo>, DCPTime>
-Butler::get_video ()
+Butler::get_video (Behaviour behaviour, Error* e)
 {
 	boost::mutex::scoped_lock lm (_mutex);
 
+	auto setup_error = [this](Error* e, Error::Code fallback) {
+		if (e) {
+			if (_died) {
+				e->code = Error::Code::DIED;
+				e->message = _died_message;
+			} else if (_finished) {
+				e->code = Error::Code::FINISHED;
+			} else {
+				e->code = fallback;
+			}
+		}
+	};
+
+	if (_video.empty() && (_finished || _died || (_suspended && behaviour == Behaviour::NON_BLOCKING))) {
+		setup_error (e, Error::Code::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());
+		setup_error (e, Error::Code::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<pair<PlayerText, DCPTimePeriod> >
+
+optional<TextRingBuffers::Data>
 Butler::get_closed_caption ()
 {
 	boost::mutex::scoped_lock lm (_mutex);
 	return _closed_caption.get ();
 }
 
+
 void
 Butler::seek (DCPTime position, bool accurate)
 {
 	boost::mutex::scoped_lock lm (_mutex);
+	_awaiting = optional<DCPTime>();
 	seek_unlocked (position, accurate);
 }
 
+
 void
 Butler::seek_unlocked (DCPTime position, bool accurate)
 {
@@ -236,77 +310,90 @@ Butler::seek_unlocked (DCPTime position, bool accurate)
 	_pending_seek_position = position;
 	_pending_seek_accurate = accurate;
 
-	{
-		boost::mutex::scoped_lock lm (_buffers_mutex);
-		_video.clear ();
-		_audio.clear ();
-		_closed_caption.clear ();
-	}
+	_video.clear ();
+	_audio.clear ();
+	_closed_caption.clear ();
 
 	_summon.notify_all ();
 }
 
+
 void
-Butler::prepare (weak_ptr<PlayerVideo> weak_video) const
+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 ();
+		video->prepare (_pixel_format, _video_range, _alignment, _fast, _prepare_only_proxy);
 		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 ();
+	boost::mutex::scoped_lock lm (_mutex);
+	_died = true;
+}
+
 
 void
 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
 {
 	boost::mutex::scoped_lock lm (_mutex);
 
-	if (_pending_seek_position || _suspended) {
-		/* Don't store any video in these cases */
+	if (_pending_seek_position) {
+		/* Don't store any video in this case */
 		return;
 	}
 
-	_prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
+	_prepare_service.post (bind(&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
 
-	boost::mutex::scoped_lock lm2 (_buffers_mutex);
 	_video.put (video, time);
 }
 
+
 void
-Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
+Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate)
 {
-	{
-		boost::mutex::scoped_lock lm (_mutex);
-		if (_pending_seek_position || _disable_audio || _suspended) {
-			/* Don't store any audio in these cases */
-			return;
-		}
+	boost::mutex::scoped_lock lm (_mutex);
+	if (_pending_seek_position || _disable_audio) {
+		/* Don't store any audio in these cases */
+		return;
 	}
 
-	boost::mutex::scoped_lock lm2 (_buffers_mutex);
-	_audio.put (remap (audio, _audio_channels, _audio_mapping), time);
+	_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.
+
+/** Try to get `frames' frames of audio and copy it into `out'.
+ *  @param behaviour BLOCKING if we should block until audio is available.  If behaviour is NON_BLOCKING
+ *  and no audio is immediately available the buffer will be filled with silence and boost::none
+ *  will be returned.
+ *  @return time of this audio, or unset if blocking was false and no data was available.
  */
 optional<DCPTime>
-Butler::get_audio (float* out, Frame frames)
+Butler::get_audio (Behaviour behaviour, float* out, Frame frames)
 {
-	optional<DCPTime> t = _audio.get (out, _audio_channels, frames);
+	boost::mutex::scoped_lock lm (_mutex);
+
+	while (behaviour == Behaviour::BLOCKING && !_finished && !_died && _audio.size() < frames) {
+		_arrived.wait (lm);
+	}
+
+	auto t = _audio.get (out, _audio_channels, frames);
 	_summon.notify_all ();
 	return t;
 }
 
-void
-Butler::disable_audio ()
-{
-	boost::mutex::scoped_lock lm (_mutex);
-	_disable_audio = true;
-}
 
 pair<size_t, string>
 Butler::memory_used () const
@@ -315,44 +402,82 @@ Butler::memory_used () const
 	return _video.memory_used();
 }
 
+
 void
-Butler::return_seek (bool frequent)
+Butler::player_change (ChangeType type, int property)
 {
-	boost::mutex::scoped_lock lm (_mutex);
-	if (_died || _pending_seek_position || frequent) {
+	if (property == VideoContentProperty::CROP) {
+		if (type == ChangeType::DONE) {
+			auto film = _film.lock();
+			if (film) {
+				_video.reset_metadata(film, _player.video_container_size());
+			}
+		}
 		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;
+	boost::mutex::scoped_lock lm (_mutex);
+
+	if (type == ChangeType::PENDING) {
+		++_suspended;
+	} else if (type == ChangeType::DONE) {
+		--_suspended;
+		if (_died || _pending_seek_position) {
+			lm.unlock ();
+			_summon.notify_all ();
+			return;
+		}
+
+		DCPTime seek_to;
+		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.
+			*/
+			seek_to = *_awaiting;
+		} else {
+			seek_to = next;
+		}
+
+		seek_unlocked (seek_to, true);
+		_awaiting = seek_to;
+	} else if (type == ChangeType::CANCELLED) {
+		--_suspended;
 	}
 
-	seek_unlocked (seek_to, true);
-	_suspended = false;
-	_awaiting = seek_to;
+	lm.unlock ();
+	_summon.notify_all ();
 }
 
+
 void
-Butler::text (PlayerText pt, TextType type, DCPTimePeriod period)
+Butler::text (PlayerText pt, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
 {
-	if (type != TEXT_CLOSED_CAPTION) {
+	if (type != TextType::CLOSED_CAPTION) {
 		return;
 	}
 
-	boost::mutex::scoped_lock lm2 (_buffers_mutex);
-	_closed_caption.put (make_pair(pt, period));
+	DCPOMATIC_ASSERT (track);
+
+	_closed_caption.put (pt, *track, period);
 }
 
-void
-Butler::suspend ()
+
+string
+Butler::Error::summary () const
 {
-	boost::mutex::scoped_lock lm (_mutex);
-	_suspended = true;
+	switch (code)
+	{
+		case Error::Code::NONE:
+			return "No error registered";
+		case Error::Code::AGAIN:
+			return "Butler not ready";
+		case Error::Code::DIED:
+			return String::compose("Butler died (%1)", message);
+		case Error::Code::FINISHED:
+			return "Butler finished";
+	}
+
+	return "";
 }
+