2 Copyright (C) 2016-2018 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 <boost/weak_ptr.hpp>
30 #include <boost/shared_ptr.hpp>
36 using boost::weak_ptr;
37 using boost::shared_ptr;
39 using boost::optional;
40 using boost::function;
42 /** Minimum video readahead in frames */
43 #define MINIMUM_VIDEO_READAHEAD 10
44 /** Maximum video readahead in frames; should never be exceeded (by much) unless there are bugs in Player */
45 #define MAXIMUM_VIDEO_READAHEAD 48
46 /** Minimum audio readahead in frames */
47 #define MINIMUM_AUDIO_READAHEAD (48000 * MINIMUM_VIDEO_READAHEAD / 24)
48 /** Maximum audio readahead in frames; should never be exceeded (by much) unless there are bugs in Player */
49 #define MAXIMUM_AUDIO_READAHEAD (48000 * MAXIMUM_VIDEO_READAHEAD / 24)
51 /** @param pixel_format Pixel format functor that will be used when calling ::image on PlayerVideos coming out of this
52 * butler. This will be used (where possible) to prepare the PlayerVideos so that calling image() on them is quick.
53 * @param aligned Same as above for the `aligned' flag.
54 * @param fast Same as above for the `fast' flag.
57 shared_ptr<Player> player,
58 AudioMapping audio_mapping,
60 function<AVPixelFormat (AVPixelFormat)> pixel_format,
65 , _prepare_work (new boost::asio::io_service::work (_prepare_service))
66 , _pending_seek_accurate (false)
70 , _stop_thread (false)
71 , _audio_mapping (audio_mapping)
72 , _audio_channels (audio_channels)
73 , _disable_audio (false)
74 , _pixel_format (pixel_format)
78 _player_video_connection = _player->Video.connect (bind (&Butler::video, this, _1, _2));
79 _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1, _2, _3));
80 _player_text_connection = _player->Text.connect (bind (&Butler::text, this, _1, _2, _3, _4));
81 /* The butler must hear about things first, otherwise it might not sort out suspensions in time for
82 get_video() to be called in response to this signal.
84 _player_change_connection = _player->Change.connect (bind (&Butler::player_change, this, _1, _3), boost::signals2::at_front);
85 _thread = new boost::thread (bind (&Butler::thread, this));
86 #ifdef DCPOMATIC_LINUX
87 pthread_setname_np (_thread->native_handle(), "butler");
90 /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
91 multi-thread JPEG2000 decoding.
94 LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency() * 2);
96 for (size_t i = 0; i < boost::thread::hardware_concurrency() * 2; ++i) {
97 _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
104 boost::mutex::scoped_lock lm (_mutex);
108 _prepare_work.reset ();
109 _prepare_pool.join_all ();
110 _prepare_service.stop ();
112 _thread->interrupt ();
115 } catch (boost::thread_interrupted& e) {
121 /** Caller must hold a lock on _mutex */
123 Butler::should_run () const
125 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
126 /* This is way too big */
127 optional<DCPTime> pos = _audio.peek();
129 throw ProgrammingError
130 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2 at %3)", _video.size(), _audio.size(), pos->get()));
132 throw ProgrammingError
133 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
137 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
138 /* This is way too big */
139 optional<DCPTime> pos = _audio.peek();
141 throw ProgrammingError
142 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames at %2 (video is %3)", _audio.size(), pos->get(), _video.size()));
144 throw ProgrammingError
145 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %3)", _audio.size(), _video.size()));
149 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
150 LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
153 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
154 LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
157 if (_stop_thread || _finished || _died || _suspended) {
158 /* Definitely do not run */
162 if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
163 /* Definitely do run: we need data */
167 /* Run if we aren't full of video or audio */
168 return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
176 boost::mutex::scoped_lock lm (_mutex);
178 /* Wait until we have something to do */
179 while (!should_run() && !_pending_seek_position) {
183 /* Do any seek that has been requested */
184 if (_pending_seek_position) {
186 _player->seek (*_pending_seek_position, _pending_seek_accurate);
187 _pending_seek_position = optional<DCPTime> ();
190 /* Fill _video and _audio. Don't try to carry on if a pending seek appears
191 while lm is unlocked, as in that state nothing will be added to
194 while (should_run() && !_pending_seek_position) {
196 bool const r = _player->pass ();
200 _arrived.notify_all ();
203 _arrived.notify_all ();
206 } catch (boost::thread_interrupted) {
207 /* The butler thread is being terminated */
208 boost::mutex::scoped_lock lm (_mutex);
210 _arrived.notify_all ();
213 boost::mutex::scoped_lock lm (_mutex);
215 _arrived.notify_all ();
218 pair<shared_ptr<PlayerVideo>, DCPTime>
219 Butler::get_video (Error* e)
221 boost::mutex::scoped_lock lm (_mutex);
227 return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
230 /* Wait for data if we have none */
231 while (_video.empty() && !_finished && !_died) {
235 if (_video.empty()) {
239 return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
242 pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
243 _summon.notify_all ();
247 optional<TextRingBuffers::Data>
248 Butler::get_closed_caption ()
250 boost::mutex::scoped_lock lm (_mutex);
251 return _closed_caption.get ();
255 Butler::seek (DCPTime position, bool accurate)
257 boost::mutex::scoped_lock lm (_mutex);
258 _awaiting = optional<DCPTime>();
259 seek_unlocked (position, accurate);
263 Butler::seek_unlocked (DCPTime position, bool accurate)
270 _pending_seek_position = position;
271 _pending_seek_accurate = accurate;
274 boost::mutex::scoped_lock lm (_buffers_mutex);
277 _closed_caption.clear ();
280 _summon.notify_all ();
284 Butler::prepare (weak_ptr<PlayerVideo> weak_video)
287 shared_ptr<PlayerVideo> video = weak_video.lock ();
288 /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
290 LOG_TIMING("start-prepare in %1", thread_id());
291 video->prepare (_pixel_format, _aligned, _fast);
292 LOG_TIMING("finish-prepare in %1", thread_id());
298 boost::mutex::scoped_lock lm (_mutex);
303 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
305 boost::mutex::scoped_lock lm (_mutex);
307 if (_pending_seek_position) {
308 /* Don't store any video in this case */
312 _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
314 boost::mutex::scoped_lock lm2 (_buffers_mutex);
315 _video.put (video, time);
319 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate)
322 boost::mutex::scoped_lock lm (_mutex);
323 if (_pending_seek_position || _disable_audio) {
324 /* Don't store any audio in these cases */
329 boost::mutex::scoped_lock lm2 (_buffers_mutex);
330 _audio.put (remap (audio, _audio_channels, _audio_mapping), time, frame_rate);
333 /** Try to get `frames' frames of audio and copy it into `out'. Silence
334 * will be filled if no audio is available.
335 * @return time of this audio, or unset if there was a buffer underrun.
338 Butler::get_audio (float* out, Frame frames)
340 optional<DCPTime> t = _audio.get (out, _audio_channels, frames);
341 _summon.notify_all ();
346 Butler::disable_audio ()
348 boost::mutex::scoped_lock lm (_mutex);
349 _disable_audio = true;
353 Butler::memory_used () const
355 /* XXX: should also look at _audio.memory_used() */
356 return _video.memory_used();
360 Butler::player_change (ChangeType type, bool frequent)
362 boost::mutex::scoped_lock lm (_mutex);
364 if (type == CHANGE_TYPE_PENDING) {
366 } else if (type == CHANGE_TYPE_DONE) {
368 if (_died || _pending_seek_position || frequent) {
370 _summon.notify_all ();
375 DCPTime next = _video.get().second;
376 if (_awaiting && _awaiting > next) {
377 /* We have recently done a player_changed seek and our buffers haven't been refilled yet,
378 so assume that we're seeking to the same place as last time.
380 seek_to = *_awaiting;
385 seek_unlocked (seek_to, true);
387 } else if (type == CHANGE_TYPE_CANCELLED) {
392 _summon.notify_all ();
396 Butler::text (PlayerText pt, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
398 if (type != TEXT_CLOSED_CAPTION) {
402 DCPOMATIC_ASSERT (track);
404 boost::mutex::scoped_lock lm2 (_buffers_mutex);
405 _closed_caption.put (pt, *track, period);