/*
- Copyright (C) 2016-2017 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2016-2021 Carl Hetherington <cth@carlh.net>
This file is part of DCP-o-matic.
*/
-#include "video_ring_buffers.h"
-#include "audio_ring_buffers.h"
-#include "text_ring_buffers.h"
+
+#ifndef DCPOMATIC_BUTLER_H
+#define DCPOMATIC_BUTLER_H
+
+
#include "audio_mapping.h"
+#include "audio_ring_buffers.h"
+#include "change_signaller.h"
#include "exception_store.h"
-#include <boost/shared_ptr.hpp>
-#include <boost/weak_ptr.hpp>
+#include "text_ring_buffers.h"
+#include "text_type.h"
+#include "video_ring_buffers.h"
+#include <boost/asio.hpp>
+#include <boost/signals2.hpp>
#include <boost/thread.hpp>
#include <boost/thread/condition.hpp>
-#include <boost/signals2.hpp>
-#include <boost/asio.hpp>
+
class Player;
class PlayerVideo;
-class Log;
-class Butler : public ExceptionStore, public boost::noncopyable
+
+class Butler : public ExceptionStore
{
public:
- Butler (boost::shared_ptr<Player> player, boost::shared_ptr<Log> log, AudioMapping map, int audio_channels);
+ enum class Audio
+ {
+ ENABLED,
+ DISABLED
+ };
+
+ Butler (
+ std::weak_ptr<const Film> film,
+ Player& player,
+ AudioMapping map,
+ int audio_channels,
+ std::function<AVPixelFormat (AVPixelFormat)> pixel_format,
+ VideoRange video_range,
+ Image::Alignment alignment,
+ bool fast,
+ bool prepare_only_proxy,
+ Audio audio
+ );
+
~Butler ();
- void seek (DCPTime position, bool accurate);
- std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> get_video ();
- boost::optional<DCPTime> get_audio (float* out, Frame frames);
- boost::optional<std::pair<PlayerText, DCPTimePeriod> > get_closed_caption ();
+ Butler (Butler const&) = delete;
+ Butler& operator= (Butler const&) = delete;
+
+ void seek (dcpomatic::DCPTime position, bool accurate);
+
+ class Error {
+ public:
+ enum class Code {
+ NONE,
+ AGAIN,
+ DIED,
+ FINISHED
+ };
+
+ Code code = Code::NONE;
+ std::string message;
- void disable_audio ();
+ std::string summary () const;
+ };
+
+ enum class Behaviour {
+ BLOCKING,
+ NON_BLOCKING
+ };
+
+ std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> get_video (Behaviour behaviour, Error* e = nullptr);
+ boost::optional<dcpomatic::DCPTime> get_audio (Behaviour behaviour, float* out, Frame frames);
+ boost::optional<TextRingBuffers::Data> get_closed_caption ();
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, DCPTime time);
- void text (PlayerText pt, TextType type, DCPTimePeriod period);
+ void video (std::shared_ptr<PlayerVideo> video, dcpomatic::DCPTime time);
+ void audio (std::shared_ptr<AudioBuffers> audio, dcpomatic::DCPTime time, int frame_rate);
+ void text (PlayerText pt, TextType type, boost::optional<DCPTextTrack> track, dcpomatic::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::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;
+ void prepare (std::weak_ptr<PlayerVideo> video);
+ void player_change (ChangeType type, int property);
+ void seek_unlocked (dcpomatic::DCPTime position, bool accurate);
+
+ std::weak_ptr<const Film> _film;
+ Player& _player;
+ boost::thread _thread;
+
VideoRingBuffers _video;
AudioRingBuffers _audio;
TextRingBuffers _closed_caption;
boost::thread_group _prepare_pool;
boost::asio::io_service _prepare_service;
- boost::shared_ptr<boost::asio::io_service::work> _prepare_work;
+ std::shared_ptr<boost::asio::io_service::work> _prepare_work;
- /** mutex to protect _pending_seek_position, _pending_seek_acurate, _finished, _died, _stop_thread */
+ /** mutex to protect _pending_seek_position, _pending_seek_accurate, _finished, _died, _stop_thread */
boost::mutex _mutex;
boost::condition _summon;
boost::condition _arrived;
- boost::optional<DCPTime> _pending_seek_position;
+ boost::optional<dcpomatic::DCPTime> _pending_seek_position;
bool _pending_seek_accurate;
+ int _suspended;
bool _finished;
bool _died;
+ std::string _died_message;
bool _stop_thread;
AudioMapping _audio_mapping;
bool _disable_audio;
+ std::function<AVPixelFormat (AVPixelFormat)> _pixel_format;
+ VideoRange _video_range;
+ Image::Alignment _alignment;
+ bool _fast;
+
+ /** true to ask PlayerVideo::prepare to only prepare the ImageProxy and not also
+ * the final image. We want to do this when the viewer is intending to call
+ * PlayerVideo::raw_image() and do the things in PlayerVideo::make_image() itself:
+ * this is the case for the GLVideoView which can do scale, pixfmt conversion etc.
+ * in the shader.
+ */
+ bool _prepare_only_proxy = false;
+
/** If we are waiting to be refilled following a seek, this is the time we were
seeking to.
*/
- boost::optional<DCPTime> _awaiting;
+ boost::optional<dcpomatic::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;
+ boost::signals2::scoped_connection _player_change_connection;
};
+
+
+#endif
+