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"
30 #include <boost/weak_ptr.hpp>
31 #include <boost/shared_ptr.hpp>
37 using boost::weak_ptr;
38 using boost::shared_ptr;
40 using boost::optional;
41 using boost::function;
42 using namespace dcpomatic;
43 #if BOOST_VERSION >= 106100
44 using namespace boost::placeholders;
47 /** Minimum video readahead in frames */
48 #define MINIMUM_VIDEO_READAHEAD 10
49 /** Maximum video readahead in frames; should never be exceeded (by much) unless there are bugs in Player */
50 #define MAXIMUM_VIDEO_READAHEAD 48
51 /** Minimum audio readahead in frames */
52 #define MINIMUM_AUDIO_READAHEAD (48000 * MINIMUM_VIDEO_READAHEAD / 24)
53 /** Maximum audio readahead in frames; should never be exceeded (by much) unless there are bugs in Player */
54 #define MAXIMUM_AUDIO_READAHEAD (48000 * MAXIMUM_VIDEO_READAHEAD / 24)
56 /** @param pixel_format Pixel format functor that will be used when calling ::image on PlayerVideos coming out of this
57 * butler. This will be used (where possible) to prepare the PlayerVideos so that calling image() on them is quick.
58 * @param aligned Same as above for the `aligned' flag.
59 * @param fast Same as above for the `fast' flag.
62 weak_ptr<const Film> film,
63 shared_ptr<Player> player,
64 AudioMapping audio_mapping,
66 function<AVPixelFormat (AVPixelFormat)> pixel_format,
67 VideoRange video_range,
73 , _prepare_work (new boost::asio::io_service::work (_prepare_service))
74 , _pending_seek_accurate (false)
78 , _stop_thread (false)
79 , _audio_mapping (audio_mapping)
80 , _audio_channels (audio_channels)
81 , _disable_audio (false)
82 , _pixel_format (pixel_format)
83 , _video_range (video_range)
87 _player_video_connection = _player->Video.connect (bind (&Butler::video, this, _1, _2));
88 _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1, _2, _3));
89 _player_text_connection = _player->Text.connect (bind (&Butler::text, this, _1, _2, _3, _4));
90 /* The butler must hear about things first, otherwise it might not sort out suspensions in time for
91 get_video() to be called in response to this signal.
93 _player_change_connection = _player->Change.connect (bind (&Butler::player_change, this, _1, _2), boost::signals2::at_front);
94 _thread = boost::thread (bind(&Butler::thread, this));
95 #ifdef DCPOMATIC_LINUX
96 pthread_setname_np (_thread.native_handle(), "butler");
99 /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
100 multi-thread JPEG2000 decoding.
103 LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency() * 2);
105 for (size_t i = 0; i < boost::thread::hardware_concurrency() * 2; ++i) {
106 _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
112 boost::this_thread::disable_interruption dis;
115 boost::mutex::scoped_lock lm (_mutex);
119 _prepare_work.reset ();
120 _prepare_pool.join_all ();
121 _prepare_service.stop ();
123 _thread.interrupt ();
129 /** Caller must hold a lock on _mutex */
131 Butler::should_run () const
133 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
134 /* This is way too big */
135 optional<DCPTime> pos = _audio.peek();
137 throw ProgrammingError
138 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2 at %3)", _video.size(), _audio.size(), pos->get()));
140 throw ProgrammingError
141 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
145 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
146 /* This is way too big */
147 optional<DCPTime> pos = _audio.peek();
149 throw ProgrammingError
150 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames at %2 (video is %3)", _audio.size(), pos->get(), _video.size()));
152 throw ProgrammingError
153 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %3)", _audio.size(), _video.size()));
157 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
158 LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
161 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
162 LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
165 if (_stop_thread || _finished || _died || _suspended) {
166 /* Definitely do not run */
170 if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
171 /* Definitely do run: we need data */
175 /* Run if we aren't full of video or audio */
176 return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
184 boost::mutex::scoped_lock lm (_mutex);
186 /* Wait until we have something to do */
187 while (!should_run() && !_pending_seek_position) {
191 /* Do any seek that has been requested */
192 if (_pending_seek_position) {
194 _player->seek (*_pending_seek_position, _pending_seek_accurate);
195 _pending_seek_position = optional<DCPTime> ();
198 /* Fill _video and _audio. Don't try to carry on if a pending seek appears
199 while lm is unlocked, as in that state nothing will be added to
202 while (should_run() && !_pending_seek_position) {
204 bool const r = _player->pass ();
208 _arrived.notify_all ();
211 _arrived.notify_all ();
214 } catch (boost::thread_interrupted) {
215 /* The butler thread is being terminated */
216 boost::mutex::scoped_lock lm (_mutex);
218 _arrived.notify_all ();
219 } catch (std::exception& e) {
221 boost::mutex::scoped_lock lm (_mutex);
223 _died_message = e.what ();
224 _arrived.notify_all ();
227 boost::mutex::scoped_lock lm (_mutex);
229 _arrived.notify_all ();
232 /** @param blocking true if we should block until video is available. If blocking is false
233 * and no video is immediately available the method will return a 0 PlayerVideo and the error AGAIN.
234 * @param e if non-0 this is filled with an error code (if an error occurs) or is untouched if no error occurs.
236 pair<shared_ptr<PlayerVideo>, DCPTime>
237 Butler::get_video (bool blocking, Error* e)
239 boost::mutex::scoped_lock lm (_mutex);
241 if (_suspended || (_video.empty() && !blocking)) {
243 e->code = Error::AGAIN;
245 return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
248 /* Wait for data if we have none */
249 while (_video.empty() && !_finished && !_died) {
253 if (_video.empty()) {
256 e->code = Error::DIED;
257 e->message = _died_message;
258 } else if (_finished) {
259 e->code = Error::FINISHED;
261 e->code = Error::NONE;
264 return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
267 pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
268 _summon.notify_all ();
272 optional<TextRingBuffers::Data>
273 Butler::get_closed_caption ()
275 boost::mutex::scoped_lock lm (_mutex);
276 return _closed_caption.get ();
280 Butler::seek (DCPTime position, bool accurate)
282 boost::mutex::scoped_lock lm (_mutex);
283 _awaiting = optional<DCPTime>();
284 seek_unlocked (position, accurate);
288 Butler::seek_unlocked (DCPTime position, bool accurate)
295 _pending_seek_position = position;
296 _pending_seek_accurate = accurate;
300 _closed_caption.clear ();
302 _summon.notify_all ();
306 Butler::prepare (weak_ptr<PlayerVideo> weak_video)
309 shared_ptr<PlayerVideo> video = weak_video.lock ();
310 /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
312 LOG_TIMING("start-prepare in %1", thread_id());
313 video->prepare (_pixel_format, _video_range, _aligned, _fast);
314 LOG_TIMING("finish-prepare in %1", thread_id());
317 catch (std::exception& e)
320 boost::mutex::scoped_lock lm (_mutex);
322 _died_message = e.what ();
327 boost::mutex::scoped_lock lm (_mutex);
332 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
334 boost::mutex::scoped_lock lm (_mutex);
336 if (_pending_seek_position) {
337 /* Don't store any video in this case */
341 _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
343 _video.put (video, time);
347 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate)
349 boost::mutex::scoped_lock lm (_mutex);
350 if (_pending_seek_position || _disable_audio) {
351 /* Don't store any audio in these cases */
355 _audio.put (remap (audio, _audio_channels, _audio_mapping), time, frame_rate);
358 /** Try to get `frames' frames of audio and copy it into `out'. Silence
359 * will be filled if no audio is available.
360 * @return time of this audio, or unset if there was a buffer underrun.
363 Butler::get_audio (float* out, Frame frames)
365 optional<DCPTime> t = _audio.get (out, _audio_channels, frames);
366 _summon.notify_all ();
371 Butler::disable_audio ()
373 boost::mutex::scoped_lock lm (_mutex);
374 _disable_audio = true;
378 Butler::memory_used () const
380 /* XXX: should also look at _audio.memory_used() */
381 return _video.memory_used();
385 Butler::player_change (ChangeType type, int property)
387 if (property == VideoContentProperty::CROP) {
388 if (type == CHANGE_TYPE_DONE) {
389 shared_ptr<const Film> film = _film.lock();
391 _video.reset_metadata (film, _player->video_container_size());
397 boost::mutex::scoped_lock lm (_mutex);
399 if (type == CHANGE_TYPE_PENDING) {
401 } else if (type == CHANGE_TYPE_DONE) {
403 if (_died || _pending_seek_position) {
405 _summon.notify_all ();
410 DCPTime next = _video.get().second;
411 if (_awaiting && _awaiting > next) {
412 /* We have recently done a player_changed seek and our buffers haven't been refilled yet,
413 so assume that we're seeking to the same place as last time.
415 seek_to = *_awaiting;
420 seek_unlocked (seek_to, true);
422 } else if (type == CHANGE_TYPE_CANCELLED) {
427 _summon.notify_all ();
431 Butler::text (PlayerText pt, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
433 if (type != TEXT_CLOSED_CAPTION) {
437 DCPOMATIC_ASSERT (track);
439 _closed_caption.put (pt, *track, period);
443 Butler::Error::summary () const
448 return "No error registered";
450 return "Butler not ready";
452 return String::compose("Butler died (%1)", message);
453 case Error::FINISHED:
454 return "Butler finished";