2 Copyright (C) 2016-2017 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/>.
21 #include "video_ring_buffers.h"
22 #include "audio_ring_buffers.h"
23 #include "text_ring_buffers.h"
24 #include "audio_mapping.h"
25 #include "exception_store.h"
26 #include <boost/shared_ptr.hpp>
27 #include <boost/weak_ptr.hpp>
28 #include <boost/thread.hpp>
29 #include <boost/thread/condition.hpp>
30 #include <boost/signals2.hpp>
31 #include <boost/asio.hpp>
37 class Butler : public ExceptionStore, public boost::noncopyable
40 Butler (boost::shared_ptr<Player> player, boost::shared_ptr<Log> log, AudioMapping map, int audio_channels);
43 void seek (DCPTime position, bool accurate);
50 std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> get_video (Error* e = 0);
51 boost::optional<DCPTime> get_audio (float* out, Frame frames);
52 boost::optional<TextRingBuffers::Data> get_closed_caption ();
54 void disable_audio ();
56 std::pair<size_t, std::string> memory_used () const;
60 void video (boost::shared_ptr<PlayerVideo> video, DCPTime time);
61 void audio (boost::shared_ptr<AudioBuffers> audio, DCPTime time);
62 void text (PlayerText pt, TextType type, boost::optional<DCPTextTrack> track, DCPTimePeriod period);
63 bool should_run () const;
64 void prepare (boost::weak_ptr<PlayerVideo> video) const;
65 void player_change (ChangeType type, bool frequent);
66 void seek_unlocked (DCPTime position, bool accurate);
68 boost::shared_ptr<Player> _player;
69 boost::shared_ptr<Log> _log;
70 boost::thread* _thread;
72 /** mutex to protect _video, _audio and _closed_caption for when we are clearing them and they all need to be
73 cleared together without any data being inserted in the interim;
74 XXX: is this necessary now that all butler output data is timestamped? Perhaps the locked clear-out
75 is only required if we guarantee that get_video() and get_audio() calls are in sync.
77 boost::mutex _buffers_mutex;
78 VideoRingBuffers _video;
79 AudioRingBuffers _audio;
80 TextRingBuffers _closed_caption;
82 boost::thread_group _prepare_pool;
83 boost::asio::io_service _prepare_service;
84 boost::shared_ptr<boost::asio::io_service::work> _prepare_work;
86 /** mutex to protect _pending_seek_position, _pending_seek_acurate, _finished, _died, _stop_thread */
88 boost::condition _summon;
89 boost::condition _arrived;
90 boost::optional<DCPTime> _pending_seek_position;
91 bool _pending_seek_accurate;
97 AudioMapping _audio_mapping;
102 /** If we are waiting to be refilled following a seek, this is the time we were
105 boost::optional<DCPTime> _awaiting;
107 boost::signals2::scoped_connection _player_video_connection;
108 boost::signals2::scoped_connection _player_audio_connection;
109 boost::signals2::scoped_connection _player_text_connection;
110 boost::signals2::scoped_connection _player_change_connection;