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)
60 , _stop_thread (false)
61 , _audio_mapping (audio_mapping)
62 , _audio_channels (audio_channels)
63 , _disable_audio (false)
65 _player_video_connection = _player->Video.connect (bind (&Butler::video, this, _1, _2));
66 _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1, _2));
67 _player_text_connection = _player->Text.connect (bind (&Butler::text, this, _1, _2, _3));
68 _player_change_connection = _player->Change.connect (bind (&Butler::player_change, this, _1, _3));
69 _thread = new boost::thread (bind (&Butler::thread, this));
70 #ifdef DCPOMATIC_LINUX
71 pthread_setname_np (_thread->native_handle(), "butler");
74 /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
75 multi-thread JPEG2000 decoding.
78 LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency());
79 for (size_t i = 0; i < boost::thread::hardware_concurrency(); ++i) {
80 _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
87 boost::mutex::scoped_lock lm (_mutex);
91 _prepare_work.reset ();
92 _prepare_pool.join_all ();
93 _prepare_service.stop ();
95 _thread->interrupt ();
98 } catch (boost::thread_interrupted& e) {
104 /** Caller must hold a lock on _mutex */
106 Butler::should_run () const
108 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
109 /* This is way too big */
110 throw ProgrammingError
111 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
114 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
115 /* This is way too big */
116 throw ProgrammingError
117 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size()));
120 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
121 LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
124 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
125 LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
128 if (_stop_thread || _finished || _died || _suspended) {
129 /* Definitely do not run */
133 if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
134 /* Definitely do run: we need data */
138 /* Run if we aren't full of video or audio */
139 return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
147 boost::mutex::scoped_lock lm (_mutex);
149 /* Wait until we have something to do */
150 while (!should_run() && !_pending_seek_position) {
154 /* Do any seek that has been requested */
155 if (_pending_seek_position) {
157 _player->seek (*_pending_seek_position, _pending_seek_accurate);
158 _pending_seek_position = optional<DCPTime> ();
161 /* Fill _video and _audio. Don't try to carry on if a pending seek appears
162 while lm is unlocked, as in that state nothing will be added to
165 while (should_run() && !_pending_seek_position) {
167 bool const r = _player->pass ();
171 _arrived.notify_all ();
174 _arrived.notify_all ();
177 } catch (boost::thread_interrupted) {
178 /* The butler thread is being terminated */
179 boost::mutex::scoped_lock lm (_mutex);
181 _arrived.notify_all ();
184 boost::mutex::scoped_lock lm (_mutex);
186 _arrived.notify_all ();
189 pair<shared_ptr<PlayerVideo>, DCPTime>
192 boost::mutex::scoped_lock lm (_mutex);
194 /* Wait for data if we have none */
195 while (_video.empty() && !_finished && !_died && !_suspended) {
199 if (_video.empty()) {
200 return make_pair (shared_ptr<PlayerVideo>(), DCPTime());
203 pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
204 _summon.notify_all ();
208 optional<pair<PlayerText, DCPTimePeriod> >
209 Butler::get_closed_caption ()
211 boost::mutex::scoped_lock lm (_mutex);
212 return _closed_caption.get ();
216 Butler::seek (DCPTime position, bool accurate)
218 boost::mutex::scoped_lock lm (_mutex);
219 seek_unlocked (position, accurate);
223 Butler::seek_unlocked (DCPTime position, bool accurate)
230 _pending_seek_position = position;
231 _pending_seek_accurate = accurate;
234 boost::mutex::scoped_lock lm (_buffers_mutex);
237 _closed_caption.clear ();
240 _summon.notify_all ();
244 Butler::prepare (weak_ptr<PlayerVideo> weak_video) const
246 shared_ptr<PlayerVideo> video = weak_video.lock ();
247 /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
249 LOG_TIMING("start-prepare in %1", thread_id());
251 LOG_TIMING("finish-prepare in %1", thread_id());
256 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
258 boost::mutex::scoped_lock lm (_mutex);
260 if (_pending_seek_position || _suspended) {
261 /* Don't store any video in these cases */
265 _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
267 boost::mutex::scoped_lock lm2 (_buffers_mutex);
268 _video.put (video, time);
272 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
275 boost::mutex::scoped_lock lm (_mutex);
276 if (_pending_seek_position || _disable_audio || _suspended) {
277 /* Don't store any audio in these cases */
282 boost::mutex::scoped_lock lm2 (_buffers_mutex);
283 _audio.put (remap (audio, _audio_channels, _audio_mapping), time);
286 /** Try to get `frames' frames of audio and copy it into `out'. Silence
287 * will be filled if no audio is available.
288 * @return time of this audio, or unset if there was a buffer underrun.
291 Butler::get_audio (float* out, Frame frames)
293 optional<DCPTime> t = _audio.get (out, _audio_channels, frames);
294 _summon.notify_all ();
299 Butler::disable_audio ()
301 boost::mutex::scoped_lock lm (_mutex);
302 _disable_audio = true;
306 Butler::memory_used () const
308 /* XXX: should also look at _audio.memory_used() */
309 return _video.memory_used();
313 Butler::player_change (ChangeType type, bool frequent)
315 boost::mutex::scoped_lock lm (_mutex);
317 if (type == CHANGE_TYPE_PENDING) {
319 } else if (type == CHANGE_TYPE_DONE) {
321 if (_died || _pending_seek_position || frequent) {
326 DCPTime next = _video.get().second;
327 if (_awaiting && _awaiting > next) {
328 /* We have recently done a player_changed seek and our buffers haven't been refilled yet,
329 so assume that we're seeking to the same place as last time.
331 seek_to = *_awaiting;
336 seek_unlocked (seek_to, true);
338 } else if (type == CHANGE_TYPE_CANCELLED) {
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));