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/>.
25 #include "compose.hpp"
26 #include <boost/weak_ptr.hpp>
27 #include <boost/shared_ptr.hpp>
33 using boost::weak_ptr;
34 using boost::shared_ptr;
36 using boost::optional;
38 /** Minimum video readahead in frames */
39 #define MINIMUM_VIDEO_READAHEAD 10
40 /** Maximum video readahead in frames; should never be reached unless there are bugs in Player */
41 #define MAXIMUM_VIDEO_READAHEAD 24
42 /** Minimum audio readahead in frames */
43 #define MINIMUM_AUDIO_READAHEAD (48000 * MINIMUM_VIDEO_READAHEAD / 24)
44 /** Minimum audio readahead in frames; should never be reached unless there are bugs in Player */
45 #define MAXIMUM_AUDIO_READAHEAD (48000 * MAXIMUM_VIDEO_READAHEAD / 24)
47 #define LOG_WARNING(...) _log->log (String::compose(__VA_ARGS__), LogEntry::TYPE_WARNING);
49 Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping audio_mapping, int audio_channels)
52 , _prepare_work (new boost::asio::io_service::work (_prepare_service))
53 , _pending_seek_accurate (false)
56 , _stop_thread (false)
57 , _audio_mapping (audio_mapping)
58 , _audio_channels (audio_channels)
59 , _disable_audio (false)
61 _player_video_connection = _player->Video.connect (bind (&Butler::video, this, _1, _2));
62 _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1));
63 _thread = new boost::thread (bind (&Butler::thread, this));
64 #ifdef DCPOMATIC_LINUX
65 pthread_setname_np (_thread->native_handle(), "butler");
68 /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
69 multi-thread JPEG2000 decoding.
71 for (size_t i = 0; i < boost::thread::hardware_concurrency(); ++i) {
72 _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
79 boost::mutex::scoped_lock lm (_mutex);
83 _prepare_work.reset ();
84 _prepare_pool.join_all ();
85 _prepare_service.stop ();
87 _thread->interrupt ();
90 } catch (boost::thread_interrupted& e) {
96 /** Caller must hold a lock on _mutex */
98 Butler::should_run () const
100 if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
101 LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
104 if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
105 LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
108 if (_stop_thread || _finished || _died) {
109 /* Definitely do not run */
113 if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
114 /* Definitely do run: we need data */
118 /* Run if we aren't full of video or audio */
119 return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
127 boost::mutex::scoped_lock lm (_mutex);
129 /* Wait until we have something to do */
130 while (!should_run() && !_pending_seek_position) {
134 /* Do any seek that has been requested */
135 if (_pending_seek_position) {
137 _player->seek (*_pending_seek_position, _pending_seek_accurate);
138 _pending_seek_position = optional<DCPTime> ();
141 /* Fill _video and _audio. Don't try to carry on if a pending seek appears
142 while lm is unlocked, as in that state nothing will be added to
145 while (should_run() && !_pending_seek_position) {
147 bool const r = _player->pass ();
151 _arrived.notify_all ();
154 _arrived.notify_all ();
157 } catch (boost::thread_interrupted) {
158 /* The butler thread is being terminated */
159 boost::mutex::scoped_lock lm (_mutex);
161 _arrived.notify_all ();
164 boost::mutex::scoped_lock lm (_mutex);
166 _arrived.notify_all ();
169 pair<shared_ptr<PlayerVideo>, DCPTime>
172 boost::mutex::scoped_lock lm (_mutex);
174 /* Wait for data if we have none */
175 while (_video.empty() && !_finished && !_died) {
179 if (_video.empty()) {
180 return make_pair (shared_ptr<PlayerVideo>(), DCPTime());
183 pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
184 _summon.notify_all ();
189 Butler::seek (DCPTime position, bool accurate)
191 boost::mutex::scoped_lock lm (_mutex);
199 _pending_seek_position = position;
200 _pending_seek_accurate = accurate;
201 _summon.notify_all ();
205 Butler::prepare (weak_ptr<PlayerVideo> weak_video) const
207 shared_ptr<PlayerVideo> video = weak_video.lock ();
208 /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
215 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
218 boost::mutex::scoped_lock lm (_mutex);
219 if (_pending_seek_position) {
220 /* Don't store any video while a seek is pending */
225 _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
226 _video.put (video, time);
230 Butler::audio (shared_ptr<AudioBuffers> audio)
233 boost::mutex::scoped_lock lm (_mutex);
234 if (_pending_seek_position || _disable_audio) {
235 /* Don't store any audio while a seek is pending, or if audio is disabled */
240 _audio.put (remap (audio, _audio_channels, _audio_mapping));
243 /** Try to get `frames' frames of audio and copy it into `out'. Silence
244 * will be filled if no audio is available.
245 * @return true if there was a buffer underrun, otherwise false.
248 Butler::get_audio (float* out, Frame frames)
250 bool const underrun = _audio.get (out, _audio_channels, frames);
251 _summon.notify_all ();
256 Butler::disable_audio ()
258 boost::mutex::scoped_lock lm (_mutex);
259 _disable_audio = true;
263 Butler::memory_used () const
265 /* XXX: should also look at _audio.memory_used() */
266 return _video.memory_used();