2 Copyright (C) 2016-2017 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/>.
26 #include "compose.hpp"
27 #include "exceptions.h"
28 #include <boost/weak_ptr.hpp>
29 #include <boost/shared_ptr.hpp>
31 #define LOG_TIMING(...) _log->log (String::compose(__VA_ARGS__), LogEntry::TYPE_TIMING);
32 #define LOG_WARNING(...) _log->log (String::compose(__VA_ARGS__), LogEntry::TYPE_WARNING);
38 using boost::weak_ptr;
39 using boost::shared_ptr;
41 using boost::optional;
43 /** Minimum video readahead in frames */
44 #define MINIMUM_VIDEO_READAHEAD 10
45 /** Maximum video readahead in frames; should never be reached unless there are bugs in Player */
46 #define MAXIMUM_VIDEO_READAHEAD 24
47 /** Minimum audio readahead in frames */
48 #define MINIMUM_AUDIO_READAHEAD (48000 * MINIMUM_VIDEO_READAHEAD / 24)
49 /** Minimum audio readahead in frames; should never be reached unless there are bugs in Player */
50 #define MAXIMUM_AUDIO_READAHEAD (48000 * MAXIMUM_VIDEO_READAHEAD / 24)
52 Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping audio_mapping, int audio_channels)
55 , _prepare_work (new boost::asio::io_service::work (_prepare_service))
56 , _pending_seek_accurate (false)
59 , _stop_thread (false)
60 , _audio_mapping (audio_mapping)
61 , _audio_channels (audio_channels)
62 , _disable_audio (false)
64 _player_video_connection = _player->Video.connect (bind (&Butler::video, this, _1, _2));
65 _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1, _2));
66 _player_text_connection = _player->Text.connect (bind (&Butler::text, this, _1, _2, _3));
67 _player_changed_connection = _player->Changed.connect (bind (&Butler::player_changed, this));
68 _thread = new boost::thread (bind (&Butler::thread, this));
69 #ifdef DCPOMATIC_LINUX
70 pthread_setname_np (_thread->native_handle(), "butler");
73 /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
74 multi-thread JPEG2000 decoding.
77 LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency());
78 for (size_t i = 0; i < boost::thread::hardware_concurrency(); ++i) {
79 _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
86 boost::mutex::scoped_lock lm (_mutex);
90 _prepare_work.reset ();
91 _prepare_pool.join_all ();
92 _prepare_service.stop ();
94 _thread->interrupt ();
97 } catch (boost::thread_interrupted& e) {
103 /** Caller must hold a lock on _mutex */
105 Butler::should_run () const
107 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
108 /* This is way too big */
109 throw ProgrammingError
110 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
113 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
114 /* This is way too big */
115 throw ProgrammingError
116 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size()));
119 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
120 LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
123 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
124 LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
127 if (_stop_thread || _finished || _died) {
128 /* Definitely do not run */
132 if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
133 /* Definitely do run: we need data */
137 /* Run if we aren't full of video or audio */
138 return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
146 boost::mutex::scoped_lock lm (_mutex);
148 /* Wait until we have something to do */
149 while (!should_run() && !_pending_seek_position) {
153 /* Do any seek that has been requested */
154 if (_pending_seek_position) {
156 _player->seek (*_pending_seek_position, _pending_seek_accurate);
157 _pending_seek_position = optional<DCPTime> ();
160 /* Fill _video and _audio. Don't try to carry on if a pending seek appears
161 while lm is unlocked, as in that state nothing will be added to
164 while (should_run() && !_pending_seek_position) {
166 bool const r = _player->pass ();
170 _arrived.notify_all ();
173 _arrived.notify_all ();
176 } catch (boost::thread_interrupted) {
177 /* The butler thread is being terminated */
178 boost::mutex::scoped_lock lm (_mutex);
180 _arrived.notify_all ();
183 boost::mutex::scoped_lock lm (_mutex);
185 _arrived.notify_all ();
188 pair<shared_ptr<PlayerVideo>, DCPTime>
191 boost::mutex::scoped_lock lm (_mutex);
193 /* Wait for data if we have none */
194 while (_video.empty() && !_finished && !_died) {
198 if (_video.empty()) {
199 return make_pair (shared_ptr<PlayerVideo>(), DCPTime());
202 pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
203 _summon.notify_all ();
207 optional<pair<PlayerText, DCPTimePeriod> >
208 Butler::get_closed_caption ()
210 boost::mutex::scoped_lock lm (_mutex);
211 return _closed_caption.get ();
215 Butler::seek (DCPTime position, bool accurate)
217 boost::mutex::scoped_lock lm (_mutex);
218 seek_unlocked (position, accurate);
222 Butler::seek_unlocked (DCPTime position, bool accurate)
229 boost::mutex::scoped_lock lm (_buffers_mutex);
232 _closed_caption.clear ();
236 _pending_seek_position = position;
237 _pending_seek_accurate = accurate;
238 _summon.notify_all ();
242 Butler::prepare (weak_ptr<PlayerVideo> weak_video) const
244 shared_ptr<PlayerVideo> video = weak_video.lock ();
245 /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
247 LOG_TIMING("start-prepare in %1", thread_id());
249 LOG_TIMING("finish-prepare in %1", thread_id());
254 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
256 boost::mutex::scoped_lock lm (_mutex);
258 if (_pending_seek_position) {
259 /* Don't store any video while a seek is pending */
263 _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
265 boost::mutex::scoped_lock lm2 (_buffers_mutex);
266 _video.put (video, time);
270 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
273 boost::mutex::scoped_lock lm (_mutex);
274 if (_pending_seek_position || _disable_audio) {
275 /* Don't store any audio while a seek is pending, or if audio is disabled */
280 boost::mutex::scoped_lock lm2 (_buffers_mutex);
281 _audio.put (remap (audio, _audio_channels, _audio_mapping), time);
284 /** Try to get `frames' frames of audio and copy it into `out'. Silence
285 * will be filled if no audio is available.
286 * @return time of this audio, or unset if there was a buffer underrun.
289 Butler::get_audio (float* out, Frame frames)
291 optional<DCPTime> t = _audio.get (out, _audio_channels, frames);
292 _summon.notify_all ();
297 Butler::disable_audio ()
299 boost::mutex::scoped_lock lm (_mutex);
300 _disable_audio = true;
304 Butler::memory_used () const
306 /* XXX: should also look at _audio.memory_used() */
307 return _video.memory_used();
311 Butler::player_changed ()
313 boost::mutex::scoped_lock lm (_mutex);
314 if (_died || _pending_seek_position) {
319 DCPTime next = _video.get().second;
320 if (_awaiting && _awaiting > next) {
321 /* We have recently done a player_changed seek and our buffers haven't been refilled yet,
322 so assume that we're seeking to the same place as last time.
324 seek_to = *_awaiting;
330 boost::mutex::scoped_lock lm (_buffers_mutex);
333 _closed_caption.clear ();
337 _summon.notify_all ();
339 seek_unlocked (seek_to, true);
344 Butler::text (PlayerText pt, TextType type, DCPTimePeriod period)
346 if (type != TEXT_CLOSED_CAPTION) {
350 boost::mutex::scoped_lock lm2 (_buffers_mutex);
351 _closed_caption.put (make_pair(pt, period));