2 Copyright (C) 2013-2020 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 #ifndef DCPOMATIC_PLAYER_H
22 #define DCPOMATIC_PLAYER_H
24 #include "atmos_metadata.h"
25 #include "player_text.h"
26 #include "active_text.h"
27 #include "content_text.h"
30 #include "content_atmos.h"
31 #include "position_image.h"
33 #include "content_video.h"
34 #include "content_audio.h"
35 #include "audio_stream.h"
36 #include "audio_merger.h"
38 #include <boost/shared_ptr.hpp>
39 #include <boost/enable_shared_from_this.hpp>
40 #include <boost/atomic.hpp>
55 class ReferencedReelAsset;
61 static int const VIDEO_CONTAINER_SIZE;
62 static int const PLAYLIST;
63 static int const FILM_CONTAINER;
64 static int const FILM_VIDEO_FRAME_RATE;
65 static int const DCP_DECODE_REDUCTION;
66 static int const PLAYBACK_LENGTH;
70 * @brief A class which can play a Playlist.
72 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
75 Player (boost::shared_ptr<const Film>);
76 Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
80 void seek (dcpomatic::DCPTime time, bool accurate);
82 std::list<boost::shared_ptr<dcpomatic::Font> > get_subtitle_fonts ();
83 std::list<ReferencedReelAsset> get_reel_assets ();
84 dcp::Size video_container_size () const {
85 boost::mutex::scoped_lock lm (_mutex);
86 return _video_container_size;
89 void set_video_container_size (dcp::Size);
90 void set_ignore_video ();
91 void set_ignore_audio ();
92 void set_ignore_text ();
93 void set_always_burn_open_subtitles ();
95 void set_play_referenced ();
96 void set_dcp_decode_reduction (boost::optional<int> reduction);
98 boost::optional<dcpomatic::DCPTime> content_time_to_dcp (boost::shared_ptr<Content> content, dcpomatic::ContentTime t);
100 boost::signals2::signal<void (ChangeType, int, bool)> Change;
102 /** Emitted when a video frame is ready. These emissions happen in the correct order. */
103 boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
104 boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
105 /** Emitted when a text is ready. This signal may be emitted considerably
106 * after the corresponding Video.
108 boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
109 boost::signals2::signal<void (boost::shared_ptr<const dcp::AtmosFrame>, dcpomatic::DCPTime, AtmosMetadata)> Atmos;
112 friend class PlayerWrapper;
114 friend struct player_time_calculation_test1;
115 friend struct player_time_calculation_test2;
116 friend struct player_time_calculation_test3;
117 friend struct player_subframe_test;
118 friend struct empty_test1;
119 friend struct empty_test2;
120 friend struct check_reuse_old_data_test;
123 void setup_pieces ();
124 void setup_pieces_unlocked ();
126 void film_change (ChangeType, Film::Property);
127 void playlist_change (ChangeType);
128 void playlist_content_change (ChangeType, int, bool);
129 Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
130 dcpomatic::DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
131 Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
132 dcpomatic::DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
133 dcpomatic::ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
134 dcpomatic::DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
135 boost::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
137 void video (boost::weak_ptr<Piece>, ContentVideo);
138 void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
139 void bitmap_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentBitmapText);
140 void plain_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentStringText);
141 void subtitle_stop (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, dcpomatic::ContentTime);
142 void atmos (boost::weak_ptr<Piece>, ContentAtmos);
144 dcpomatic::DCPTime one_video_frame () const;
145 void fill_audio (dcpomatic::DCPTimePeriod period);
146 std::pair<boost::shared_ptr<AudioBuffers>, dcpomatic::DCPTime> discard_audio (
147 boost::shared_ptr<const AudioBuffers> audio, dcpomatic::DCPTime time, dcpomatic::DCPTime discard_to
149 boost::optional<PositionImage> open_subtitles_for_frame (dcpomatic::DCPTime time) const;
150 void emit_video (boost::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
151 void do_emit_video (boost::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
152 void emit_audio (boost::shared_ptr<AudioBuffers> data, dcpomatic::DCPTime time);
153 boost::shared_ptr<const Playlist> playlist () const;
155 /** Mutex to protect the whole Player state. When it's used for the preview we have
156 seek() and pass() called from the Butler thread and lots of other stuff called
159 mutable boost::mutex _mutex;
161 boost::shared_ptr<const Film> _film;
162 /** Playlist, or 0 if we are using the one from the _film */
163 boost::shared_ptr<const Playlist> _playlist;
165 /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
166 boost::atomic<int> _suspended;
167 std::list<boost::shared_ptr<Piece> > _pieces;
169 /** Size of the image we are rendering to; this may be the DCP frame size, or
170 * the size of preview in a window.
172 dcp::Size _video_container_size;
173 boost::shared_ptr<Image> _black_image;
175 /** true if the player should ignore all video; i.e. never produce any */
178 /** true if the player should ignore all text; i.e. never produce any */
180 bool _always_burn_open_subtitles;
181 /** true if we should try to be fast rather than high quality */
183 /** true if we should keep going in the face of `survivable' errors */
185 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
186 bool _play_referenced;
188 /** Time just after the last video frame we emitted, or the time of the last accurate seek */
189 boost::optional<dcpomatic::DCPTime> _last_video_time;
190 boost::optional<Eyes> _last_video_eyes;
191 /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
192 boost::optional<dcpomatic::DCPTime> _last_audio_time;
194 boost::optional<int> _dcp_decode_reduction;
196 typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
197 LastVideoMap _last_video;
199 AudioMerger _audio_merger;
201 std::list<std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> > _delay;
208 StreamState (boost::shared_ptr<Piece> p, dcpomatic::DCPTime l)
213 boost::shared_ptr<Piece> piece;
214 dcpomatic::DCPTime last_push_end;
216 std::map<AudioStreamPtr, StreamState> _stream_states;
221 ActiveText _active_texts[TEXT_COUNT];
222 boost::shared_ptr<AudioProcessor> _audio_processor;
224 dcpomatic::DCPTime _playback_length;
226 boost::signals2::scoped_connection _film_changed_connection;
227 boost::signals2::scoped_connection _playlist_change_connection;
228 boost::signals2::scoped_connection _playlist_content_change_connection;