src/lib/butler.cc

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