Put Time types in dcpomatic namespace.
[dcpomatic.git] / src / lib / butler.cc
index 018334c7e3db12022bb6742176620d93b232c3d6..0218c1fb30d198b494d05b466f778de8509324bf 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2016-2017 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2016-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "player.h"
 #include "util.h"
 #include "log.h"
+#include "dcpomatic_log.h"
 #include "cross.h"
 #include "compose.hpp"
 #include "exceptions.h"
 #include <boost/weak_ptr.hpp>
 #include <boost/shared_ptr.hpp>
 
-#define LOG_TIMING(...)  _log->log (String::compose(__VA_ARGS__), LogEntry::TYPE_TIMING);
-#define LOG_WARNING(...) _log->log (String::compose(__VA_ARGS__), LogEntry::TYPE_WARNING);
-
 using std::cout;
 using std::pair;
 using std::make_pair;
@@ -39,19 +37,32 @@ using boost::weak_ptr;
 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)
 
-Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping audio_mapping, int audio_channels)
+/** @param pixel_format Pixel format functor that will be used when calling ::image on PlayerVideos coming out of this
+ *  butler.  This will be used (where possible) to prepare the PlayerVideos so that calling image() on them is quick.
+ *  @param aligned Same as above for the `aligned' flag.
+ *  @param fast Same as above for the `fast' flag.
+ */
+Butler::Butler (
+       shared_ptr<Player> player,
+       AudioMapping audio_mapping,
+       int audio_channels,
+       function<AVPixelFormat (AVPixelFormat)> pixel_format,
+       bool aligned,
+       bool fast
+       )
        : _player (player)
-       , _log (log)
        , _prepare_work (new boost::asio::io_service::work (_prepare_service))
        , _pending_seek_accurate (false)
        , _suspended (0)
@@ -61,9 +72,12 @@ Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping aud
        , _audio_mapping (audio_mapping)
        , _audio_channels (audio_channels)
        , _disable_audio (false)
+       , _pixel_format (pixel_format)
+       , _aligned (aligned)
+       , _fast (fast)
 {
        _player_video_connection = _player->Video.connect (bind (&Butler::video, this, _1, _2));
-       _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1, _2));
+       _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1, _2, _3));
        _player_text_connection = _player->Text.connect (bind (&Butler::text, this, _1, _2, _3, _4));
        /* 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.
@@ -78,9 +92,7 @@ Butler::Butler (shared_ptr<Player> player, shared_ptr<Log> log, AudioMapping aud
           multi-thread JPEG2000 decoding.
        */
 
-       if (_log) {
-               LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency() * 2);
-       }
+       LOG_TIMING("start-prepare-threads %1", boost::thread::hardware_concurrency() * 2);
 
        for (size_t i = 0; i < boost::thread::hardware_concurrency() * 2; ++i) {
                _prepare_pool.create_thread (bind (&boost::asio::io_service::run, &_prepare_service));
@@ -113,21 +125,33 @@ 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 && _log) {
+       if (_video.size() >= MAXIMUM_VIDEO_READAHEAD * 2) {
                LOG_WARNING ("Butler video buffers reached %1 frames (audio is %2)", _video.size(), _audio.size());
        }
 
-       if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2 && _log) {
+       if (_audio.size() >= MAXIMUM_AUDIO_READAHEAD * 2) {
                LOG_WARNING ("Butler audio buffers reached %1 frames (video is %2)", _audio.size(), _video.size());
        }
 
@@ -232,6 +256,7 @@ void
 Butler::seek (DCPTime position, bool accurate)
 {
        boost::mutex::scoped_lock lm (_mutex);
+       _awaiting = optional<DCPTime>();
        seek_unlocked (position, accurate);
 }
 
@@ -257,22 +282,23 @@ Butler::seek_unlocked (DCPTime position, bool accurate)
 }
 
 void
-Butler::prepare (weak_ptr<PlayerVideo> weak_video) const
+Butler::prepare (weak_ptr<PlayerVideo> weak_video)
+try
 {
        shared_ptr<PlayerVideo> video = weak_video.lock ();
        /* If the weak_ptr cannot be locked the video obviously no longer requires any work */
        if (video) {
-               if (_log) {
-                       LOG_TIMING("start-prepare in %1", thread_id());
-               }
-
-               video->prepare ();
-
-               if (_log) {
-                       LOG_TIMING("finish-prepare in %1", thread_id());
-               }
+               LOG_TIMING("start-prepare in %1", thread_id());
+               video->prepare (_pixel_format, _aligned, _fast);
+               LOG_TIMING("finish-prepare in %1", thread_id());
        }
 }
+catch (...)
+{
+       store_current ();
+       boost::mutex::scoped_lock lm (_mutex);
+       _died = true;
+}
 
 void
 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
@@ -291,7 +317,7 @@ Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
 }
 
 void
-Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
+Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
@@ -302,7 +328,7 @@ Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
        }
 
        boost::mutex::scoped_lock lm2 (_buffers_mutex);
-       _audio.put (remap (audio, _audio_channels, _audio_mapping), time);
+       _audio.put (remap (audio, _audio_channels, _audio_mapping), time, frame_rate);
 }
 
 /** Try to get `frames' frames of audio and copy it into `out'.  Silence