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));
66 _player_changed_connection = _player->Changed.connect (bind (&Butler::player_changed, this, _1));
67 _thread = new boost::thread (bind (&Butler::thread, this));
68 #ifdef DCPOMATIC_LINUX
69 pthread_setname_np (_thread->native_handle(), "butler");
72 /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
73 multi-thread JPEG2000 decoding.
76 LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency());
77 for (size_t i = 0; i < boost::thread::hardware_concurrency(); ++i) {
78 _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
85 boost::mutex::scoped_lock lm (_mutex);
89 _prepare_work.reset ();
90 _prepare_pool.join_all ();
91 _prepare_service.stop ();
93 _thread->interrupt ();
96 } catch (boost::thread_interrupted& e) {
102 /** Caller must hold a lock on _mutex */
104 Butler::should_run () const
106 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
107 /* This is way too big */
108 throw ProgrammingError
109 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
112 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
113 /* This is way too big */
114 throw ProgrammingError
115 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size()));
118 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
119 LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
122 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
123 LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
126 if (_stop_thread || _finished || _died) {
127 /* Definitely do not run */
131 if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
132 /* Definitely do run: we need data */
136 /* Run if we aren't full of video or audio */
137 return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
145 boost::mutex::scoped_lock lm (_mutex);
147 /* Wait until we have something to do */
148 while (!should_run() && !_pending_seek_position) {
152 /* Do any seek that has been requested */
153 if (_pending_seek_position) {
155 _player->seek (*_pending_seek_position, _pending_seek_accurate);
156 _pending_seek_position = optional<DCPTime> ();
159 /* Fill _video and _audio. Don't try to carry on if a pending seek appears
160 while lm is unlocked, as in that state nothing will be added to
163 while (should_run() && !_pending_seek_position) {
165 bool const r = _player->pass ();
169 _arrived.notify_all ();
172 _arrived.notify_all ();
175 } catch (boost::thread_interrupted) {
176 /* The butler thread is being terminated */
177 boost::mutex::scoped_lock lm (_mutex);
179 _arrived.notify_all ();
182 boost::mutex::scoped_lock lm (_mutex);
184 _arrived.notify_all ();
187 pair<shared_ptr<PlayerVideo>, DCPTime>
190 boost::mutex::scoped_lock lm (_mutex);
192 /* Wait for data if we have none */
193 while (_video.empty() && !_finished && !_died) {
197 if (_video.empty()) {
198 return make_pair (shared_ptr<PlayerVideo>(), DCPTime());
201 pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
202 _summon.notify_all ();
207 Butler::seek (DCPTime position, bool accurate)
209 boost::mutex::scoped_lock lm (_mutex);
210 seek_unlocked (position, accurate);
214 Butler::seek_unlocked (DCPTime position, bool accurate)
221 boost::mutex::scoped_lock lm (_video_audio_mutex);
227 _pending_seek_position = position;
228 _pending_seek_accurate = accurate;
229 _summon.notify_all ();
233 Butler::prepare (weak_ptr<PlayerVideo> weak_video) const
235 shared_ptr<PlayerVideo> video = weak_video.lock ();
236 /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
238 LOG_TIMING("start-prepare in %1", thread_id());
240 LOG_TIMING("finish-prepare in %1", thread_id());
245 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
247 boost::mutex::scoped_lock lm (_mutex);
249 if (_pending_seek_position) {
250 /* Don't store any video while a seek is pending */
254 _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
256 boost::mutex::scoped_lock lm2 (_video_audio_mutex);
257 _video.put (video, time);
261 Butler::audio (shared_ptr<AudioBuffers> audio)
264 boost::mutex::scoped_lock lm (_mutex);
265 if (_pending_seek_position || _disable_audio) {
266 /* Don't store any audio while a seek is pending, or if audio is disabled */
271 boost::mutex::scoped_lock lm2 (_video_audio_mutex);
272 _audio.put (remap (audio, _audio_channels, _audio_mapping));
275 /** Try to get `frames' frames of audio and copy it into `out'. Silence
276 * will be filled if no audio is available.
277 * @return true if there was a buffer underrun, otherwise false.
280 Butler::get_audio (float* out, Frame frames)
282 bool const underrun = _audio.get (out, _audio_channels, frames);
283 _summon.notify_all ();
288 Butler::disable_audio ()
290 boost::mutex::scoped_lock lm (_mutex);
291 _disable_audio = true;
295 Butler::memory_used () const
297 /* XXX: should also look at _audio.memory_used() */
298 return _video.memory_used();
302 Butler::player_changed (int what)
304 boost::mutex::scoped_lock lm (_mutex);
305 if (_died || _pending_seek_position) {
310 DCPTime next = _video.get().second;
311 if (_awaiting && _awaiting > next) {
312 /* We have recently done a player_changed seek and our buffers haven't been refilled yet,
313 so assume that we're seeking to the same place as last time.
315 seek_to = *_awaiting;
321 boost::mutex::scoped_lock lm (_video_audio_mutex);
327 _summon.notify_all ();
329 seek_unlocked (seek_to, true);