2 Copyright (C) 2016-2020 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
25 #include "dcpomatic_log.h"
27 #include "compose.hpp"
28 #include "exceptions.h"
29 #include "video_content.h"
37 using std::shared_ptr;
39 using boost::optional;
40 using boost::function;
41 using namespace dcpomatic;
42 #if BOOST_VERSION >= 106100
43 using namespace boost::placeholders;
46 /** Minimum video readahead in frames */
47 #define MINIMUM_VIDEO_READAHEAD 10
48 /** Maximum video readahead in frames; should never be exceeded (by much) unless there are bugs in Player */
49 #define MAXIMUM_VIDEO_READAHEAD 48
50 /** Minimum audio readahead in frames */
51 #define MINIMUM_AUDIO_READAHEAD (48000 * MINIMUM_VIDEO_READAHEAD / 24)
52 /** Maximum audio readahead in frames; should never be exceeded (by much) unless there are bugs in Player */
53 #define MAXIMUM_AUDIO_READAHEAD (48000 * MAXIMUM_VIDEO_READAHEAD / 24)
55 /** @param pixel_format Pixel format functor that will be used when calling ::image on PlayerVideos coming out of this
56 * butler. This will be used (where possible) to prepare the PlayerVideos so that calling image() on them is quick.
57 * @param aligned Same as above for the `aligned' flag.
58 * @param fast Same as above for the `fast' flag.
61 weak_ptr<const Film> film,
62 shared_ptr<Player> player,
63 AudioMapping audio_mapping,
65 function<AVPixelFormat (AVPixelFormat)> pixel_format,
66 VideoRange video_range,
72 , _prepare_work (new boost::asio::io_service::work (_prepare_service))
73 , _pending_seek_accurate (false)
77 , _stop_thread (false)
78 , _audio_mapping (audio_mapping)
79 , _audio_channels (audio_channels)
80 , _disable_audio (false)
81 , _pixel_format (pixel_format)
82 , _video_range (video_range)
86 _player_video_connection = _player->Video.connect (bind (&Butler::video, this, _1, _2));
87 _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1, _2, _3));
88 _player_text_connection = _player->Text.connect (bind (&Butler::text, this, _1, _2, _3, _4));
89 /* The butler must hear about things first, otherwise it might not sort out suspensions in time for
90 get_video() to be called in response to this signal.
92 _player_change_connection = _player->Change.connect (bind (&Butler::player_change, this, _1, _2), boost::signals2::at_front);
93 _thread = boost::thread (bind(&Butler::thread, this));
94 #ifdef DCPOMATIC_LINUX
95 pthread_setname_np (_thread.native_handle(), "butler");
98 /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
99 multi-thread JPEG2000 decoding.
102 LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency() * 2);
104 for (size_t i = 0; i < boost::thread::hardware_concurrency() * 2; ++i) {
105 _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
111 boost::this_thread::disable_interruption dis;
114 boost::mutex::scoped_lock lm (_mutex);
118 _prepare_work.reset ();
119 _prepare_pool.join_all ();
120 _prepare_service.stop ();
122 _thread.interrupt ();
128 /** Caller must hold a lock on _mutex */
130 Butler::should_run () const
132 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
133 /* This is way too big */
134 optional<DCPTime> pos = _audio.peek();
136 throw ProgrammingError
137 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2 at %3)", _video.size(), _audio.size(), pos->get()));
139 throw ProgrammingError
140 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
144 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
145 /* This is way too big */
146 optional<DCPTime> pos = _audio.peek();
148 throw ProgrammingError
149 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames at %2 (video is %3)", _audio.size(), pos->get(), _video.size()));
151 throw ProgrammingError
152 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %3)", _audio.size(), _video.size()));
156 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
157 LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
160 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
161 LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
164 if (_stop_thread || _finished || _died || _suspended) {
165 /* Definitely do not run */
169 if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
170 /* Definitely do run: we need data */
174 /* Run if we aren't full of video or audio */
175 return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
182 start_of_thread ("Butler");
185 boost::mutex::scoped_lock lm (_mutex);
187 /* Wait until we have something to do */
188 while (!should_run() && !_pending_seek_position) {
192 /* Do any seek that has been requested */
193 if (_pending_seek_position) {
195 _player->seek (*_pending_seek_position, _pending_seek_accurate);
196 _pending_seek_position = optional<DCPTime> ();
199 /* Fill _video and _audio. Don't try to carry on if a pending seek appears
200 while lm is unlocked, as in that state nothing will be added to
203 while (should_run() && !_pending_seek_position) {
205 bool const r = _player->pass ();
209 _arrived.notify_all ();
212 _arrived.notify_all ();
215 } catch (boost::thread_interrupted) {
216 /* The butler thread is being terminated */
217 boost::mutex::scoped_lock lm (_mutex);
219 _arrived.notify_all ();
220 } catch (std::exception& e) {
222 boost::mutex::scoped_lock lm (_mutex);
224 _died_message = e.what ();
225 _arrived.notify_all ();
228 boost::mutex::scoped_lock lm (_mutex);
230 _arrived.notify_all ();
233 /** @param blocking true if we should block until video is available. If blocking is false
234 * and no video is immediately available the method will return a 0 PlayerVideo and the error AGAIN.
235 * @param e if non-0 this is filled with an error code (if an error occurs) or is untouched if no error occurs.
237 pair<shared_ptr<PlayerVideo>, DCPTime>
238 Butler::get_video (bool blocking, Error* e)
240 boost::mutex::scoped_lock lm (_mutex);
242 auto setup_error = [this](Error* e, Error::Code fallback) {
245 e->code = Error::DIED;
246 e->message = _died_message;
247 } else if (_finished) {
248 e->code = Error::FINISHED;
255 if (_video.empty() && (_finished || _died || (_suspended && !blocking))) {
256 setup_error (e, Error::AGAIN);
257 return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
260 /* Wait for data if we have none */
261 while (_video.empty() && !_finished && !_died) {
265 if (_video.empty()) {
266 setup_error (e, Error::NONE);
267 return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
270 auto const r = _video.get ();
271 _summon.notify_all ();
275 optional<TextRingBuffers::Data>
276 Butler::get_closed_caption ()
278 boost::mutex::scoped_lock lm (_mutex);
279 return _closed_caption.get ();
283 Butler::seek (DCPTime position, bool accurate)
285 boost::mutex::scoped_lock lm (_mutex);
286 _awaiting = optional<DCPTime>();
287 seek_unlocked (position, accurate);
291 Butler::seek_unlocked (DCPTime position, bool accurate)
298 _pending_seek_position = position;
299 _pending_seek_accurate = accurate;
303 _closed_caption.clear ();
305 _summon.notify_all ();
309 Butler::prepare (weak_ptr<PlayerVideo> weak_video)
312 auto video = weak_video.lock ();
313 /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
315 LOG_TIMING("start-prepare in %1", thread_id());
316 video->prepare (_pixel_format, _video_range, _aligned, _fast);
317 LOG_TIMING("finish-prepare in %1", thread_id());
320 catch (std::exception& e)
323 boost::mutex::scoped_lock lm (_mutex);
325 _died_message = e.what ();
330 boost::mutex::scoped_lock lm (_mutex);
335 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
337 boost::mutex::scoped_lock lm (_mutex);
339 if (_pending_seek_position) {
340 /* Don't store any video in this case */
344 _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
346 _video.put (video, time);
350 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate)
352 boost::mutex::scoped_lock lm (_mutex);
353 if (_pending_seek_position || _disable_audio) {
354 /* Don't store any audio in these cases */
358 _audio.put (remap (audio, _audio_channels, _audio_mapping), time, frame_rate);
361 /** Try to get `frames' frames of audio and copy it into `out'. Silence
362 * will be filled if no audio is available.
363 * @return time of this audio, or unset if there was a buffer underrun.
366 Butler::get_audio (float* out, Frame frames)
368 auto t = _audio.get (out, _audio_channels, frames);
369 _summon.notify_all ();
374 Butler::disable_audio ()
376 boost::mutex::scoped_lock lm (_mutex);
377 _disable_audio = true;
381 Butler::memory_used () const
383 /* XXX: should also look at _audio.memory_used() */
384 return _video.memory_used();
388 Butler::player_change (ChangeType type, int property)
390 if (property == VideoContentProperty::CROP) {
391 if (type == ChangeType::DONE) {
392 auto film = _film.lock();
394 _video.reset_metadata (film, _player->video_container_size());
400 boost::mutex::scoped_lock lm (_mutex);
402 if (type == ChangeType::PENDING) {
404 } else if (type == ChangeType::DONE) {
406 if (_died || _pending_seek_position) {
408 _summon.notify_all ();
413 auto next = _video.get().second;
414 if (_awaiting && _awaiting > next) {
415 /* We have recently done a player_changed seek and our buffers haven't been refilled yet,
416 so assume that we're seeking to the same place as last time.
418 seek_to = *_awaiting;
423 seek_unlocked (seek_to, true);
425 } else if (type == ChangeType::CANCELLED) {
430 _summon.notify_all ();
434 Butler::text (PlayerText pt, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
436 if (type != TextType::CLOSED_CAPTION) {
440 DCPOMATIC_ASSERT (track);
442 _closed_caption.put (pt, *track, period);
446 Butler::Error::summary () const
451 return "No error registered";
453 return "Butler not ready";
455 return String::compose("Butler died (%1)", message);
456 case Error::FINISHED:
457 return "Butler finished";