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