191bb0a5b68b52b006d8e300bb1002d40fb7f49f
[dcpomatic.git] / src / lib / butler.cc
1 /*
2     Copyright (C) 2016-2017 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
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.
10
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.
15
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/>.
18
19 */
20
21 #include "butler.h"
22 #include "player.h"
23 #include "util.h"
24 #include "log.h"
25 #include "cross.h"
26 #include "compose.hpp"
27 #include "exceptions.h"
28 #include <boost/weak_ptr.hpp>
29 #include <boost/shared_ptr.hpp>
30
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);
33
34 using std::cout;
35 using std::pair;
36 using std::make_pair;
37 using std::string;
38 using boost::weak_ptr;
39 using boost::shared_ptr;
40 using boost::bind;
41 using boost::optional;
42
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)
51
52 Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping audio_mapping, int audio_channels)
53         : _player (player)
54         , _log (log)
55         , _prepare_work (new boost::asio::io_service::work (_prepare_service))
56         , _pending_seek_accurate (false)
57         , _suspended (0)
58         , _finished (false)
59         , _died (false)
60         , _stop_thread (false)
61         , _audio_mapping (audio_mapping)
62         , _audio_channels (audio_channels)
63         , _disable_audio (false)
64 {
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, _4));
68         /* The butler must here about things first, otherwise it might not sort out suspensions in time for
69            get_video() to be called in response to this signal.
70         */
71         _player_change_connection = _player->Change.connect (bind (&Butler::player_change, this, _1, _3), boost::signals2::at_front);
72         _thread = new boost::thread (bind (&Butler::thread, this));
73 #ifdef DCPOMATIC_LINUX
74         pthread_setname_np (_thread->native_handle(), "butler");
75 #endif
76
77         /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
78            multi-thread JPEG2000 decoding.
79         */
80
81         LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency());
82         for (size_t i = 0; i < boost::thread::hardware_concurrency(); ++i) {
83                 _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
84         }
85 }
86
87 Butler::~Butler ()
88 {
89         {
90                 boost::mutex::scoped_lock lm (_mutex);
91                 _stop_thread = true;
92         }
93
94         _prepare_work.reset ();
95         _prepare_pool.join_all ();
96         _prepare_service.stop ();
97
98         _thread->interrupt ();
99         try {
100                 _thread->join ();
101         } catch (boost::thread_interrupted& e) {
102                 /* No problem */
103         }
104         delete _thread;
105 }
106
107 /** Caller must hold a lock on _mutex */
108 bool
109 Butler::should_run () const
110 {
111         if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
112                 /* This is way too big */
113                 throw ProgrammingError
114                         (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
115         }
116
117         if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
118                 /* This is way too big */
119                 throw ProgrammingError
120                         (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size()));
121         }
122
123         if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
124                 LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
125         }
126
127         if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
128                 LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
129         }
130
131         if (_stop_thread || _finished || _died || _suspended) {
132                 /* Definitely do not run */
133                 return false;
134         }
135
136         if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
137                 /* Definitely do run: we need data */
138                 return true;
139         }
140
141         /* Run if we aren't full of video or audio */
142         return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
143 }
144
145 void
146 Butler::thread ()
147 try
148 {
149         while (true) {
150                 boost::mutex::scoped_lock lm (_mutex);
151
152                 /* Wait until we have something to do */
153                 while (!should_run() && !_pending_seek_position) {
154                         _summon.wait (lm);
155                 }
156
157                 /* Do any seek that has been requested */
158                 if (_pending_seek_position) {
159                         _finished = false;
160                         _player->seek (*_pending_seek_position, _pending_seek_accurate);
161                         _pending_seek_position = optional<DCPTime> ();
162                 }
163
164                 /* Fill _video and _audio.  Don't try to carry on if a pending seek appears
165                    while lm is unlocked, as in that state nothing will be added to
166                    _video/_audio.
167                 */
168                 while (should_run() && !_pending_seek_position) {
169                         lm.unlock ();
170                         bool const r = _player->pass ();
171                         lm.lock ();
172                         if (r) {
173                                 _finished = true;
174                                 _arrived.notify_all ();
175                                 break;
176                         }
177                         _arrived.notify_all ();
178                 }
179         }
180 } catch (boost::thread_interrupted) {
181         /* The butler thread is being terminated */
182         boost::mutex::scoped_lock lm (_mutex);
183         _finished = true;
184         _arrived.notify_all ();
185 } catch (...) {
186         store_current ();
187         boost::mutex::scoped_lock lm (_mutex);
188         _died = true;
189         _arrived.notify_all ();
190 }
191
192 pair<shared_ptr<PlayerVideo>, DCPTime>
193 Butler::get_video (Error* e)
194 {
195         boost::mutex::scoped_lock lm (_mutex);
196
197         if (_suspended) {
198                 if (e) {
199                         *e = AGAIN;
200                 }
201                 return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
202         }
203
204         /* Wait for data if we have none */
205         while (_video.empty() && !_finished && !_died) {
206                 _arrived.wait (lm);
207         }
208
209         if (_video.empty()) {
210                 if (e) {
211                         *e = NONE;
212                 }
213                 return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
214         }
215
216         pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
217         _summon.notify_all ();
218         return r;
219 }
220
221 optional<TextRingBuffers::Data>
222 Butler::get_closed_caption ()
223 {
224         boost::mutex::scoped_lock lm (_mutex);
225         return _closed_caption.get ();
226 }
227
228 void
229 Butler::seek (DCPTime position, bool accurate)
230 {
231         boost::mutex::scoped_lock lm (_mutex);
232         seek_unlocked (position, accurate);
233 }
234
235 void
236 Butler::seek_unlocked (DCPTime position, bool accurate)
237 {
238         if (_died) {
239                 return;
240         }
241
242         _finished = false;
243         _pending_seek_position = position;
244         _pending_seek_accurate = accurate;
245
246         {
247                 boost::mutex::scoped_lock lm (_buffers_mutex);
248                 _video.clear ();
249                 _audio.clear ();
250                 _closed_caption.clear ();
251         }
252
253         _summon.notify_all ();
254 }
255
256 void
257 Butler::prepare (weak_ptr<PlayerVideo> weak_video) const
258 {
259         shared_ptr<PlayerVideo> video = weak_video.lock ();
260         /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
261         if (video) {
262                 LOG_TIMING("start-prepare in %1", thread_id());
263                 video->prepare ();
264                 LOG_TIMING("finish-prepare in %1", thread_id());
265         }
266 }
267
268 void
269 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
270 {
271         boost::mutex::scoped_lock lm (_mutex);
272
273         if (_pending_seek_position) {
274                 /* Don't store any video in this case */
275                 return;
276         }
277
278         _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
279
280         boost::mutex::scoped_lock lm2 (_buffers_mutex);
281         _video.put (video, time);
282 }
283
284 void
285 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
286 {
287         {
288                 boost::mutex::scoped_lock lm (_mutex);
289                 if (_pending_seek_position || _disable_audio) {
290                         /* Don't store any audio in these cases */
291                         return;
292                 }
293         }
294
295         boost::mutex::scoped_lock lm2 (_buffers_mutex);
296         _audio.put (remap (audio, _audio_channels, _audio_mapping), time);
297 }
298
299 /** Try to get `frames' frames of audio and copy it into `out'.  Silence
300  *  will be filled if no audio is available.
301  *  @return time of this audio, or unset if there was a buffer underrun.
302  */
303 optional<DCPTime>
304 Butler::get_audio (float* out, Frame frames)
305 {
306         optional<DCPTime> t = _audio.get (out, _audio_channels, frames);
307         _summon.notify_all ();
308         return t;
309 }
310
311 void
312 Butler::disable_audio ()
313 {
314         boost::mutex::scoped_lock lm (_mutex);
315         _disable_audio = true;
316 }
317
318 pair<size_t, string>
319 Butler::memory_used () const
320 {
321         /* XXX: should also look at _audio.memory_used() */
322         return _video.memory_used();
323 }
324
325 void
326 Butler::player_change (ChangeType type, bool frequent)
327 {
328         boost::mutex::scoped_lock lm (_mutex);
329
330         if (type == CHANGE_TYPE_PENDING) {
331                 ++_suspended;
332         } else if (type == CHANGE_TYPE_DONE) {
333                 --_suspended;
334                 if (_died || _pending_seek_position || frequent) {
335                         lm.unlock ();
336                         _summon.notify_all ();
337                         return;
338                 }
339
340                 DCPTime seek_to;
341                 DCPTime next = _video.get().second;
342                 if (_awaiting && _awaiting > next) {
343                         /* We have recently done a player_changed seek and our buffers haven't been refilled yet,
344                            so assume that we're seeking to the same place as last time.
345                         */
346                         seek_to = *_awaiting;
347                 } else {
348                         seek_to = next;
349                 }
350
351                 seek_unlocked (seek_to, true);
352                 _awaiting = seek_to;
353         } else if (type == CHANGE_TYPE_CANCELLED) {
354                 --_suspended;
355         }
356
357         lm.unlock ();
358         _summon.notify_all ();
359 }
360
361 void
362 Butler::text (PlayerText pt, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
363 {
364         if (type != TEXT_CLOSED_CAPTION) {
365                 return;
366         }
367
368         DCPOMATIC_ASSERT (track);
369
370         boost::mutex::scoped_lock lm2 (_buffers_mutex);
371         _closed_caption.put (pt, *track, period);
372 }