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 "compose.hpp"
  26 #include <boost/weak_ptr.hpp>
  27 #include <boost/shared_ptr.hpp>
  28
  29 using std::cout;
  30 using std::pair;
  31 using std::make_pair;
  32 using std::string;
  33 using boost::weak_ptr;
  34 using boost::shared_ptr;
  35 using boost::bind;
  36 using boost::optional;
  37
  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)
  46
  47 #define LOG_WARNING(...) _log->log (String::compose(__VA_ARGS__), LogEntry::TYPE_WARNING);
  48
  49 Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping audio_mapping, int audio_channels)
  50         : _player (player)
  51         , _log (log)
  52         , _prepare_work (new boost::asio::io_service::work (_prepare_service))
  53         , _pending_seek_accurate (false)
  54         , _finished (false)
  55         , _died (false)
  56         , _stop_thread (false)
  57         , _audio_mapping (audio_mapping)
  58         , _audio_channels (audio_channels)
  59         , _disable_audio (false)
  60 {
  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
  65         /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
  66            multi-thread JPEG2000 decoding.
  67         */
  68         for (size_t i = 0; i < boost::thread::hardware_concurrency(); ++i) {
  69                 _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
  70         }
  71 }
  72
  73 Butler::~Butler ()
  74 {
  75         {
  76                 boost::mutex::scoped_lock lm (_mutex);
  77                 _stop_thread = true;
  78         }
  79
  80         _prepare_work.reset ();
  81         _prepare_pool.join_all ();
  82         _prepare_service.stop ();
  83
  84         _thread->interrupt ();
  85         try {
  86                 _thread->join ();
  87         } catch (boost::thread_interrupted& e) {
  88                 /* No problem */
  89         }
  90         delete _thread;
  91 }
  92
  93 /** Caller must hold a lock on _mutex */
  94 bool
  95 Butler::should_run () const
  96 {
  97         if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
  98                 LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
  99         }
 100
 101         if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
 102                 LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
 103         }
 104
 105         if (_stop_thread || _finished || _died) {
 106                 /* Definitely do not run */
 107                 return false;
 108         }
 109
 110         if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
 111                 /* Definitely do run: we need data */
 112                 return true;
 113         }
 114
 115         /* Run if we aren't full of video or audio */
 116         return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
 117 }
 118
 119 void
 120 Butler::thread ()
 121 try
 122 {
 123         while (true) {
 124                 boost::mutex::scoped_lock lm (_mutex);
 125
 126                 /* Wait until we have something to do */
 127                 while (!should_run() && !_pending_seek_position) {
 128                         _summon.wait (lm);
 129                 }
 130
 131                 /* Do any seek that has been requested */
 132                 if (_pending_seek_position) {
 133                         _finished = false;
 134                         _player->seek (*_pending_seek_position, _pending_seek_accurate);
 135                         _pending_seek_position = optional<DCPTime> ();
 136                 }
 137
 138                 /* Fill _video and _audio.  Don't try to carry on if a pending seek appears
 139                    while lm is unlocked, as in that state nothing will be added to
 140                    _video/_audio.
 141                 */
 142                 while (should_run() && !_pending_seek_position) {
 143                         lm.unlock ();
 144                         bool const r = _player->pass ();
 145                         lm.lock ();
 146                         if (r) {
 147                                 _finished = true;
 148                                 _arrived.notify_all ();
 149                                 break;
 150                         }
 151                         _arrived.notify_all ();
 152                 }
 153         }
 154 } catch (boost::thread_interrupted) {
 155         /* The butler thread is being terminated */
 156         boost::mutex::scoped_lock lm (_mutex);
 157         _finished = true;
 158         _arrived.notify_all ();
 159 } catch (...) {
 160         store_current ();
 161         boost::mutex::scoped_lock lm (_mutex);
 162         _died = true;
 163         _arrived.notify_all ();
 164 }
 165
 166 pair<shared_ptr<PlayerVideo>, DCPTime>
 167 Butler::get_video ()
 168 {
 169         boost::mutex::scoped_lock lm (_mutex);
 170
 171         /* Wait for data if we have none */
 172         while (_video.empty() && !_finished && !_died) {
 173                 _arrived.wait (lm);
 174         }
 175
 176         if (_video.empty()) {
 177                 return make_pair (shared_ptr<PlayerVideo>(), DCPTime());
 178         }
 179
 180         pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
 181         _summon.notify_all ();
 182         return r;
 183 }
 184
 185 void
 186 Butler::seek (DCPTime position, bool accurate)
 187 {
 188         boost::mutex::scoped_lock lm (_mutex);
 189         if (_died) {
 190                 return;
 191         }
 192
 193         _video.clear ();
 194         _audio.clear ();
 195         _finished = false;
 196         _pending_seek_position = position;
 197         _pending_seek_accurate = accurate;
 198         _summon.notify_all ();
 199 }
 200
 201 void
 202 Butler::prepare (weak_ptr<PlayerVideo> weak_video) const
 203 {
 204         shared_ptr<PlayerVideo> video = weak_video.lock ();
 205         /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
 206         if (video) {
 207                 video->prepare ();
 208         }
 209 }
 210
 211 void
 212 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
 213 {
 214         {
 215                 boost::mutex::scoped_lock lm (_mutex);
 216                 if (_pending_seek_position) {
 217                         /* Don't store any video while a seek is pending */
 218                         return;
 219                 }
 220         }
 221
 222         _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
 223         _video.put (video, time);
 224 }
 225
 226 void
 227 Butler::audio (shared_ptr<AudioBuffers> audio)
 228 {
 229         {
 230                 boost::mutex::scoped_lock lm (_mutex);
 231                 if (_pending_seek_position || _disable_audio) {
 232                         /* Don't store any audio while a seek is pending, or if audio is disabled */
 233                         return;
 234                 }
 235         }
 236
 237         _audio.put (remap (audio, _audio_channels, _audio_mapping));
 238 }
 239
 240 /** Try to get `frames' frames of audio and copy it into `out'.  Silence
 241  *  will be filled if no audio is available.
 242  *  @return true if there was a buffer underrun, otherwise false.
 243  */
 244 bool
 245 Butler::get_audio (float* out, Frame frames)
 246 {
 247         bool const underrun = _audio.get (out, _audio_channels, frames);
 248         _summon.notify_all ();
 249         return underrun;
 250 }
 251
 252 void
 253 Butler::disable_audio ()
 254 {
 255         boost::mutex::scoped_lock lm (_mutex);
 256         _disable_audio = true;
 257 }
 258
 259 pair<size_t, string>
 260 Butler::memory_used () const
 261 {
 262         /* XXX: should also look at _audio.memory_used() */
 263         return _video.memory_used();
 264 }