Various thread cleanups.
[dcpomatic.git] / src / lib / butler.cc
index e15cb9d3f6266f80dffc5223edfa020617e8c721..20180330e5f68d2a048402328ccc32d7da64fd7b 100644 (file)
@@ -38,14 +38,15 @@ using boost::shared_ptr;
 using boost::bind;
 using boost::optional;
 using boost::function;
+using namespace dcpomatic;
 
 /** Minimum video readahead in frames */
 #define MINIMUM_VIDEO_READAHEAD 10
-/** Maximum video readahead in frames; should never be reached unless there are bugs in Player */
+/** Maximum video readahead in frames; should never be exceeded (by much) unless there are bugs in Player */
 #define MAXIMUM_VIDEO_READAHEAD 48
 /** Minimum audio readahead in frames */
 #define MINIMUM_AUDIO_READAHEAD (48000 * MINIMUM_VIDEO_READAHEAD / 24)
-/** Minimum audio readahead in frames; should never be reached unless there are bugs in Player */
+/** Maximum audio readahead in frames; should never be exceeded (by much) unless there are bugs in Player */
 #define MAXIMUM_AUDIO_READAHEAD (48000 * MAXIMUM_VIDEO_READAHEAD / 24)
 
 /** @param pixel_format Pixel format functor that will be used when calling ::image on PlayerVideos coming out of this
@@ -81,10 +82,10 @@ Butler::Butler (
        /* The butler must hear about things first, otherwise it might not sort out suspensions in time for
           get_video() to be called in response to this signal.
        */
-       _player_change_connection = _player->Change.connect (bind (&Butler::player_change, this, _1, _3), boost::signals2::at_front);
-       _thread = new boost::thread (bind (&Butler::thread, this));
+       _player_change_connection = _player->Change.connect (bind (&Butler::player_change, this, _1), boost::signals2::at_front);
+       _thread = boost::thread (bind(&Butler::thread, this));
 #ifdef DCPOMATIC_LINUX
-       pthread_setname_np (_thread->native_handle(), "butler");
+       pthread_setname_np (_thread.native_handle(), "butler");
 #endif
 
        /* Create some threads to do work on the PlayerVideos we are creating; at present this is used to
@@ -109,13 +110,12 @@ Butler::~Butler ()
        _prepare_pool.join_all ();
        _prepare_service.stop ();
 
-       _thread->interrupt ();
+       _thread.interrupt ();
        try {
-               _thread->join ();
-       } catch (boost::thread_interrupted& e) {
-               /* No problem */
+               _thread.join ();
+       } catch (...) {
+
        }
-       delete _thread;
 }
 
 /** Caller must hold a lock on _mutex */
@@ -124,14 +124,26 @@ Butler::should_run () const
 {
        if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 10) {
                /* This is way too big */
-               throw ProgrammingError
-                       (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
+               optional<DCPTime> pos = _audio.peek();
+               if (pos) {
+                       throw ProgrammingError
+                               (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2 at %3)", _video.size(), _audio.size(), pos->get()));
+               } else {
+                       throw ProgrammingError
+                               (__FILE__, __LINE__, String::compose ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size()));
+               }
        }
 
        if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 10) {
                /* This is way too big */
-               throw ProgrammingError
-                       (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size()));
+               optional<DCPTime> pos = _audio.peek();
+               if (pos) {
+                       throw ProgrammingError
+                               (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames at %2 (video is %3)", _audio.size(), pos->get(), _video.size()));
+               } else {
+                       throw ProgrammingError
+                               (__FILE__, __LINE__, String::compose ("Butler audio buffers reached %1 frames (video is %3)", _audio.size(), _video.size()));
+               }
        }
 
        if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
@@ -203,12 +215,16 @@ try
        _arrived.notify_all ();
 }
 
+/** @param blocking true if we should block until video is available.  If blocking is false
+ *  and no video is immediately available the method will return a 0 PlayerVideo and the error AGAIN.
+ *  @param e if non-0 this is filled with an error code (if an error occurs) or is untouched if no error occurs.
+ */
 pair<shared_ptr<PlayerVideo>, DCPTime>
-Butler::get_video (Error* e)
+Butler::get_video (bool blocking, Error* e)
 {
        boost::mutex::scoped_lock lm (_mutex);
 
-       if (_suspended) {
+       if (_suspended || (_video.empty() && !blocking)) {
                if (e) {
                        *e = AGAIN;
                }
@@ -258,12 +274,9 @@ Butler::seek_unlocked (DCPTime position, bool accurate)
        _pending_seek_position = position;
        _pending_seek_accurate = accurate;
 
-       {
-               boost::mutex::scoped_lock lm (_buffers_mutex);
-               _video.clear ();
-               _audio.clear ();
-               _closed_caption.clear ();
-       }
+       _video.clear ();
+       _audio.clear ();
+       _closed_caption.clear ();
 
        _summon.notify_all ();
 }
@@ -299,22 +312,18 @@ Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
 
        _prepare_service.post (bind (&Butler::prepare, this, weak_ptr<PlayerVideo>(video)));
 
-       boost::mutex::scoped_lock lm2 (_buffers_mutex);
        _video.put (video, time);
 }
 
 void
 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate)
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               if (_pending_seek_position || _disable_audio) {
-                       /* Don't store any audio in these cases */
-                       return;
-               }
+       boost::mutex::scoped_lock lm (_mutex);
+       if (_pending_seek_position || _disable_audio) {
+               /* Don't store any audio in these cases */
+               return;
        }
 
-       boost::mutex::scoped_lock lm2 (_buffers_mutex);
        _audio.put (remap (audio, _audio_channels, _audio_mapping), time, frame_rate);
 }
 
@@ -345,7 +354,7 @@ Butler::memory_used () const
 }
 
 void
-Butler::player_change (ChangeType type, bool frequent)
+Butler::player_change (ChangeType type)
 {
        boost::mutex::scoped_lock lm (_mutex);
 
@@ -353,7 +362,7 @@ Butler::player_change (ChangeType type, bool frequent)
                ++_suspended;
        } else if (type == CHANGE_TYPE_DONE) {
                --_suspended;
-               if (_died || _pending_seek_position || frequent) {
+               if (_died || _pending_seek_position) {
                        lm.unlock ();
                        _summon.notify_all ();
                        return;
@@ -389,6 +398,5 @@ Butler::text (PlayerText pt, TextType type, optional<DCPTextTrack> track, DCPTim
 
        DCPOMATIC_ASSERT (track);
 
-       boost::mutex::scoped_lock lm2 (_buffers_mutex);
        _closed_caption.put (pt, *track, period);
 }