More fixes for errors / crashes / misbehaviour with content changes
[dcpomatic.git] / src / lib / butler.h
index 1e8947f9d2d554f4e58af0bdc4f6cdef0474e77a..56374deeb31a9c904b7f2dd175e64b82463ceffc 100644 (file)
@@ -20,6 +20,7 @@
 
 #include "video_ring_buffers.h"
 #include "audio_ring_buffers.h"
+#include "text_ring_buffers.h"
 #include "audio_mapping.h"
 #include "exception_store.h"
 #include <boost/shared_ptr.hpp>
 #include <boost/signals2.hpp>
 #include <boost/asio.hpp>
 
-class Film;
 class Player;
 class PlayerVideo;
+class Log;
 
 class Butler : public ExceptionStore, public boost::noncopyable
 {
 public:
-       Butler (boost::weak_ptr<const Film> film, boost::shared_ptr<Player> player, AudioMapping map, int audio_channels);
+       Butler (boost::shared_ptr<Player> player, boost::shared_ptr<Log> log, AudioMapping map, int audio_channels);
        ~Butler ();
 
        void seek (DCPTime position, bool accurate);
        std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> get_video ();
-       bool get_audio (float* out, Frame frames);
+       boost::optional<DCPTime> get_audio (float* out, Frame frames);
+       boost::optional<std::pair<PlayerText, DCPTimePeriod> > get_closed_caption ();
 
        void disable_audio ();
 
+       std::pair<size_t, std::string> memory_used () const;
+
 private:
        void thread ();
        void video (boost::shared_ptr<PlayerVideo> video, DCPTime time);
-       void audio (boost::shared_ptr<AudioBuffers> audio);
-       void player_changed ();
+       void audio (boost::shared_ptr<AudioBuffers> audio, DCPTime time);
+       void text (PlayerText pt, TextType type, DCPTimePeriod period);
        bool should_run () const;
        void prepare (boost::weak_ptr<PlayerVideo> video) const;
+       void return_seek (bool frequent);
+       void seek_unlocked (DCPTime position, bool accurate);
 
-       boost::weak_ptr<const Film> _film;
        boost::shared_ptr<Player> _player;
+       boost::shared_ptr<Log> _log;
        boost::thread* _thread;
 
+       /** mutex to protect _video, _audio and _closed_caption for when we are clearing them and they all need to be
+           cleared together without any data being inserted in the interim;
+           XXX: is this necessary now that all butler output data is timestamped? Perhaps the locked clear-out
+           is only required if we guarantee that get_video() and get_audio() calls are in sync.
+       */
+       boost::mutex _buffers_mutex;
        VideoRingBuffers _video;
        AudioRingBuffers _audio;
+       TextRingBuffers _closed_caption;
 
        boost::thread_group _prepare_pool;
        boost::asio::io_service _prepare_service;
@@ -79,7 +92,14 @@ private:
 
        bool _disable_audio;
 
+       /** If we are waiting to be refilled following a seek, this is the time we were
+           seeking to.
+       */
+       boost::optional<DCPTime> _awaiting;
+
        boost::signals2::scoped_connection _player_video_connection;
        boost::signals2::scoped_connection _player_audio_connection;
+       boost::signals2::scoped_connection _player_text_connection;
        boost::signals2::scoped_connection _player_changed_connection;
+       boost::signals2::scoped_connection _player_not_changed_connection;
 };