2 Copyright (C) 2016-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 #include "audio_mapping.h"
23 #include "audio_ring_buffers.h"
24 #include "change_signaller.h"
25 #include "exception_store.h"
26 #include "text_ring_buffers.h"
27 #include "video_ring_buffers.h"
28 #include <boost/asio.hpp>
29 #include <boost/signals2.hpp>
30 #include <boost/thread.hpp>
31 #include <boost/thread/condition.hpp>
38 class Butler : public ExceptionStore
48 std::weak_ptr<const Film> film,
49 std::shared_ptr<Player> player,
52 std::function<AVPixelFormat (AVPixelFormat)> pixel_format,
53 VideoRange video_range,
54 Image::Alignment alignment,
56 bool prepare_only_proxy,
62 Butler (Butler const&) = delete;
63 Butler& operator= (Butler const&) = delete;
65 void seek (dcpomatic::DCPTime position, bool accurate);
76 Code code = Code::NONE;
79 std::string summary () const;
82 enum class Behaviour {
87 std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> get_video (Behaviour behaviour, Error* e = nullptr);
88 boost::optional<dcpomatic::DCPTime> get_audio (Behaviour behaviour, float* out, Frame frames);
89 boost::optional<TextRingBuffers::Data> get_closed_caption ();
91 std::pair<size_t, std::string> memory_used () const;
95 void video (std::shared_ptr<PlayerVideo> video, dcpomatic::DCPTime time);
96 void audio (std::shared_ptr<AudioBuffers> audio, dcpomatic::DCPTime time, int frame_rate);
97 void text (PlayerText pt, TextType type, boost::optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period);
98 bool should_run () const;
99 void prepare (std::weak_ptr<PlayerVideo> video);
100 void player_change (ChangeType type, int property);
101 void seek_unlocked (dcpomatic::DCPTime position, bool accurate);
103 std::weak_ptr<const Film> _film;
104 std::shared_ptr<Player> _player;
105 boost::thread _thread;
107 VideoRingBuffers _video;
108 AudioRingBuffers _audio;
109 TextRingBuffers _closed_caption;
111 boost::thread_group _prepare_pool;
112 boost::asio::io_service _prepare_service;
113 std::shared_ptr<boost::asio::io_service::work> _prepare_work;
115 /** mutex to protect _pending_seek_position, _pending_seek_accurate, _finished, _died, _stop_thread */
117 boost::condition _summon;
118 boost::condition _arrived;
119 boost::optional<dcpomatic::DCPTime> _pending_seek_position;
120 bool _pending_seek_accurate;
124 std::string _died_message;
127 AudioMapping _audio_mapping;
132 std::function<AVPixelFormat (AVPixelFormat)> _pixel_format;
133 VideoRange _video_range;
134 Image::Alignment _alignment;
137 /** true to ask PlayerVideo::prepare to only prepare the ImageProxy and not also
138 * the final image. We want to do this when the viewer is intending to call
139 * PlayerVideo::raw_image() and do the things in PlayerVideo::make_imgae() itself:
140 * this is the case for the GLVideoView which can do scale, pixfmt conversion etc.
143 bool _prepare_only_proxy = false;
145 /** If we are waiting to be refilled following a seek, this is the time we were
148 boost::optional<dcpomatic::DCPTime> _awaiting;
150 boost::signals2::scoped_connection _player_video_connection;
151 boost::signals2::scoped_connection _player_audio_connection;
152 boost::signals2::scoped_connection _player_text_connection;
153 boost::signals2::scoped_connection _player_change_connection;