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 = 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 (...) {
 117
 118         }
 119 }
 120
 121 /** Caller must hold a lock on _mutex */
 122 bool
 123 Butler::should_run () const
 124 {
 125         if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
 126                 /* This is way too big */
 127                 optional<DCPTime> pos = _audio.peek();
 128                 if (pos) {
 129                         throw ProgrammingError
 130                                 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2 at %3)", _video.size(), _audio.size(), pos->get()));
 131                 } else {
 132                         throw ProgrammingError
 133                                 (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
 134                 }
 135         }
 136
 137         if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
 138                 /* This is way too big */
 139                 optional<DCPTime> pos = _audio.peek();
 140                 if (pos) {
 141                         throw ProgrammingError
 142                                 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames at %2 (video is %3)", _audio.size(), pos->get(), _video.size()));
 143                 } else {
 144                         throw ProgrammingError
 145                                 (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %3)", _audio.size(), _video.size()));
 146                 }
 147         }
 148
 149         if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
 150                 LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
 151         }
 152
 153         if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
 154                 LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
 155         }
 156
 157         if (_stop_thread || _finished || _died || _suspended) {
 158                 /* Definitely do not run */
 159                 return false;
 160         }
 161
 162         if (_video.size() < MINIMUM_VIDEO_READAHEAD || (!_disable_audio && _audio.size() < MINIMUM_AUDIO_READAHEAD)) {
 163                 /* Definitely do run: we need data */
 164                 return true;
 165         }
 166
 167         /* Run if we aren't full of video or audio */
 168         return (_video.size() < MAXIMUM_VIDEO_READAHEAD) && (_audio.size() < MAXIMUM_AUDIO_READAHEAD);
 169 }
 170
 171 void
 172 Butler::thread ()
 173 try
 174 {
 175         while (true) {
 176                 boost::mutex::scoped_lock lm (_mutex);
 177
 178                 /* Wait until we have something to do */
 179                 while (!should_run() && !_pending_seek_position) {
 180                         _summon.wait (lm);
 181                 }
 182
 183                 /* Do any seek that has been requested */
 184                 if (_pending_seek_position) {
 185                         _finished = false;
 186                         _player->seek (*_pending_seek_position, _pending_seek_accurate);
 187                         _pending_seek_position = optional<DCPTime> ();
 188                 }
 189
 190                 /* Fill _video and _audio.  Don't try to carry on if a pending seek appears
 191                    while lm is unlocked, as in that state nothing will be added to
 192                    _video/_audio.
 193                 */
 194                 while (should_run() && !_pending_seek_position) {
 195                         lm.unlock ();
 196                         bool const r = _player->pass ();
 197                         lm.lock ();
 198                         if (r) {
 199                                 _finished = true;
 200                                 _arrived.notify_all ();
 201                                 break;
 202                         }
 203                         _arrived.notify_all ();
 204                 }
 205         }
 206 } catch (boost::thread_interrupted) {
 207         /* The butler thread is being terminated */
 208         boost::mutex::scoped_lock lm (_mutex);
 209         _finished = true;
 210         _arrived.notify_all ();
 211 } catch (...) {
 212         store_current ();
 213         boost::mutex::scoped_lock lm (_mutex);
 214         _died = true;
 215         _arrived.notify_all ();
 216 }
 217
 218 /** @param blocking true if we should block until video is available.  If blocking is false
 219  *  and no video is immediately available the method will return a 0 PlayerVideo and the error AGAIN.
 220  *  @param e if non-0 this is filled with an error code (if an error occurs) or is untouched if no error occurs.
 221  */
 222 pair<shared_ptr<PlayerVideo>, DCPTime>
 223 Butler::get_video (bool blocking, Error* e)
 224 {
 225         boost::mutex::scoped_lock lm (_mutex);
 226
 227         if (_suspended || (_video.empty() && !blocking)) {
 228                 if (e) {
 229                         *e = AGAIN;
 230                 }
 231                 return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
 232         }
 233
 234         /* Wait for data if we have none */
 235         while (_video.empty() && !_finished && !_died) {
 236                 _arrived.wait (lm);
 237         }
 238
 239         if (_video.empty()) {
 240                 if (e) {
 241                         *e = NONE;
 242                 }
 243                 return make_pair(shared_ptr<PlayerVideo>(), DCPTime());
 244         }
 245
 246         pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
 247         _summon.notify_all ();
 248         return r;
 249 }
 250
 251 optional<TextRingBuffers::Data>
 252 Butler::get_closed_caption ()
 253 {
 254         boost::mutex::scoped_lock lm (_mutex);
 255         return _closed_caption.get ();
 256 }
 257
 258 void
 259 Butler::seek (DCPTime position, bool accurate)
 260 {
 261         boost::mutex::scoped_lock lm (_mutex);
 262         _awaiting = optional<DCPTime>();
 263         seek_unlocked (position, accurate);
 264 }
 265
 266 void
 267 Butler::seek_unlocked (DCPTime position, bool accurate)
 268 {
 269         if (_died) {
 270                 return;
 271         }
 272
 273         _finished = false;
 274         _pending_seek_position = position;
 275         _pending_seek_accurate = accurate;
 276
 277         _video.clear ();
 278         _audio.clear ();
 279         _closed_caption.clear ();
 280
 281         _summon.notify_all ();
 282 }
 283
 284 void
 285 Butler::prepare (weak_ptr<PlayerVideo> weak_video)
 286 try
 287 {
 288         shared_ptr<PlayerVideo> video = weak_video.lock ();
 289         /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
 290         if (video) {
 291                 LOG_TIMING("start-prepare in %1", thread_id());
 292                 video->prepare (_pixel_format, _aligned, _fast);
 293                 LOG_TIMING("finish-prepare in %1", thread_id());
 294         }
 295 }
 296 catch (...)
 297 {
 298         store_current ();
 299         boost::mutex::scoped_lock lm (_mutex);
 300         _died = true;
 301 }
 302
 303 void
 304 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
 305 {
 306         boost::mutex::scoped_lock lm (_mutex);
 307
 308         if (_pending_seek_position) {
 309                 /* Don't store any video in this case */
 310                 return;
 311         }
 312
 313         _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
 314
 315         _video.put (video, time);
 316 }
 317
 318 void
 319 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate)
 320 {
 321         boost::mutex::scoped_lock lm (_mutex);
 322         if (_pending_seek_position || _disable_audio) {
 323                 /* Don't store any audio in these cases */
 324                 return;
 325         }
 326
 327         _audio.put (remap (audio, _audio_channels, _audio_mapping), time, frame_rate);
 328 }
 329
 330 /** Try to get `frames' frames of audio and copy it into `out'.  Silence
 331  *  will be filled if no audio is available.
 332  *  @return time of this audio, or unset if there was a buffer underrun.
 333  */
 334 optional<DCPTime>
 335 Butler::get_audio (float* out, Frame frames)
 336 {
 337         optional<DCPTime> t = _audio.get (out, _audio_channels, frames);
 338         _summon.notify_all ();
 339         return t;
 340 }
 341
 342 void
 343 Butler::disable_audio ()
 344 {
 345         boost::mutex::scoped_lock lm (_mutex);
 346         _disable_audio = true;
 347 }
 348
 349 pair<size_t, string>
 350 Butler::memory_used () const
 351 {
 352         /* XXX: should also look at _audio.memory_used() */
 353         return _video.memory_used();
 354 }
 355
 356 void
 357 Butler::player_change (ChangeType type)
 358 {
 359         boost::mutex::scoped_lock lm (_mutex);
 360
 361         if (type == CHANGE_TYPE_PENDING) {
 362                 ++_suspended;
 363         } else if (type == CHANGE_TYPE_DONE) {
 364                 --_suspended;
 365                 if (_died || _pending_seek_position) {
 366                         lm.unlock ();
 367                         _summon.notify_all ();
 368                         return;
 369                 }
 370
 371                 DCPTime seek_to;
 372                 DCPTime next = _video.get().second;
 373                 if (_awaiting && _awaiting > next) {
 374                         /* We have recently done a player_changed seek and our buffers haven't been refilled yet,
 375                            so assume that we're seeking to the same place as last time.
 376                         */
 377                         seek_to = *_awaiting;
 378                 } else {
 379                         seek_to = next;
 380                 }
 381
 382                 seek_unlocked (seek_to, true);
 383                 _awaiting = seek_to;
 384         } else if (type == CHANGE_TYPE_CANCELLED) {
 385                 --_suspended;
 386         }
 387
 388         lm.unlock ();
 389         _summon.notify_all ();
 390 }
 391
 392 void
 393 Butler::text (PlayerText pt, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
 394 {
 395         if (type != TEXT_CLOSED_CAPTION) {
 396                 return;
 397         }
 398
 399         DCPOMATIC_ASSERT (track);
 400
 401         _closed_caption.put (pt, *track, period);
 402 }