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/>.
22 #ifndef DCPOMATIC_PLAYER_H
23 #define DCPOMATIC_PLAYER_H
26 #include "active_text.h"
27 #include "atmos_metadata.h"
28 #include "audio_merger.h"
29 #include "audio_stream.h"
30 #include "content_atmos.h"
31 #include "content_audio.h"
32 #include "content_text.h"
33 #include "content_video.h"
34 #include "dcp_text_track.h"
36 #include "enum_indexed_vector.h"
37 #include "film_property.h"
39 #include "player_text.h"
40 #include "position_image.h"
42 #include <boost/atomic.hpp>
56 class ReferencedReelAsset;
62 static int const VIDEO_CONTAINER_SIZE;
63 static int const PLAYLIST;
64 static int const FILM_CONTAINER;
65 static int const FILM_VIDEO_FRAME_RATE;
66 static int const DCP_DECODE_REDUCTION;
67 static int const PLAYBACK_LENGTH;
68 static int const IGNORE_VIDEO;
69 static int const IGNORE_AUDIO;
70 static int const IGNORE_TEXT;
71 static int const ALWAYS_BURN_OPEN_SUBTITLES;
72 static int const PLAY_REFERENCED;
77 * @brief A class which can play a Playlist.
82 Player (std::shared_ptr<const Film>, Image::Alignment subtitle_alignment);
83 Player (std::shared_ptr<const Film>, std::shared_ptr<const Playlist> playlist);
85 Player (Player const&) = delete;
86 Player& operator= (Player const&) = delete;
88 Player(Player&& other);
89 Player& operator=(Player&& other);
92 void seek (dcpomatic::DCPTime time, bool accurate);
93 Frame frames_done() const;
94 float progress() const;
96 std::vector<std::shared_ptr<dcpomatic::Font>> get_subtitle_fonts ();
98 dcp::Size video_container_size () const {
99 return _video_container_size;
102 void set_video_container_size (dcp::Size);
103 void set_ignore_video ();
104 void set_ignore_audio ();
105 void set_ignore_text ();
106 void set_always_burn_open_subtitles ();
108 void set_play_referenced ();
109 void set_dcp_decode_reduction (boost::optional<int> reduction);
110 void set_disable_audio_processor();
112 boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<const Content> content, dcpomatic::ContentTime t) const;
113 boost::optional<dcpomatic::ContentTime> dcp_to_content_time (std::shared_ptr<const Content> content, dcpomatic::DCPTime t) const;
115 void signal_change(ChangeType type, int property);
117 /** First parameter is PENDING, DONE or CANCELLED.
118 * Second parameter is the property.
119 * Third parameter is true if these signals are currently likely to be frequent.
121 boost::signals2::signal<void (ChangeType, int, bool)> Change;
123 /** Emitted when a video frame is ready. These emissions happen in the correct order. */
124 boost::signals2::signal<void (std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
125 /** Emitted when audio data is ready. First parameter is the audio data, second its time,
126 * third the frame rate.
128 boost::signals2::signal<void (std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
129 /** Emitted when a text is ready. This signal may be emitted considerably
130 * after the corresponding Video.
132 boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
133 boost::signals2::signal<void (std::shared_ptr<const dcp::AtmosFrame>, dcpomatic::DCPTime, AtmosMetadata)> Atmos;
136 friend class PlayerWrapper;
138 friend struct player_time_calculation_test1;
139 friend struct player_time_calculation_test2;
140 friend struct player_time_calculation_test3;
141 friend struct player_subframe_test;
142 friend struct empty_test1;
143 friend struct empty_test2;
144 friend struct check_reuse_old_data_test;
145 friend struct overlap_video_test1;
149 void setup_pieces ();
150 void film_change(ChangeType, FilmProperty);
151 void playlist_change (ChangeType);
152 void playlist_content_change (ChangeType, int, bool);
153 Frame dcp_to_content_video (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
154 dcpomatic::DCPTime content_video_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
155 Frame dcp_to_resampled_audio (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
156 dcpomatic::DCPTime resampled_audio_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
157 dcpomatic::ContentTime dcp_to_content_time (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
158 dcpomatic::DCPTime content_time_to_dcp (std::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
159 std::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
160 void emit_video_until(dcpomatic::DCPTime time);
161 void insert_video(std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time, dcpomatic::DCPTime end);
162 std::pair<std::shared_ptr<Piece>, boost::optional<dcpomatic::DCPTime>> earliest_piece_and_time() const;
164 void video (std::weak_ptr<Piece>, ContentVideo);
165 void audio (std::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
166 void bitmap_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentBitmapText);
167 void plain_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentStringText);
168 void subtitle_stop (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, dcpomatic::ContentTime);
169 void atmos (std::weak_ptr<Piece>, ContentAtmos);
171 dcpomatic::DCPTime one_video_frame () const;
172 void fill_audio (dcpomatic::DCPTimePeriod period);
173 std::pair<std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime> discard_audio (
174 std::shared_ptr<const AudioBuffers> audio, dcpomatic::DCPTime time, dcpomatic::DCPTime discard_to
176 boost::optional<PositionImage> open_subtitles_for_frame (dcpomatic::DCPTime time) const;
177 void emit_video(std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
178 void use_video(std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time, dcpomatic::DCPTime end);
179 void emit_audio (std::shared_ptr<AudioBuffers> data, dcpomatic::DCPTime time);
180 std::shared_ptr<const Playlist> playlist () const;
182 /** Mutex to protect the most of the Player state. When it's used for the preview we have
183 seek() and pass() called from the Butler thread and lots of other stuff called
186 mutable boost::mutex _mutex;
188 std::weak_ptr<const Film> _film;
189 /** Playlist, or 0 if we are using the one from the _film */
190 std::shared_ptr<const Playlist> _playlist;
192 /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
193 boost::atomic<int> _suspended;
194 std::vector<std::shared_ptr<Piece>> _pieces;
196 /** Size of the image we are rendering to; this may be the DCP frame size, or
197 * the size of preview in a window.
199 boost::atomic<dcp::Size> _video_container_size;
201 mutable boost::mutex _black_image_mutex;
202 std::shared_ptr<Image> _black_image;
204 /** true if the player should ignore all video; i.e. never produce any */
205 boost::atomic<bool> _ignore_video;
206 boost::atomic<bool> _ignore_audio;
207 /** true if the player should ignore all text; i.e. never produce any */
208 boost::atomic<bool> _ignore_text;
209 boost::atomic<bool> _always_burn_open_subtitles;
210 /** true if we should try to be fast rather than high quality */
211 boost::atomic<bool> _fast;
212 /** true if we should keep going in the face of `survivable' errors */
214 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
215 boost::atomic<bool> _play_referenced;
217 /** Time of the next video that we will emit, or the time of the last accurate seek */
218 boost::optional<dcpomatic::DCPTime> _next_video_time;
219 /** Time of the next audio that we will emit, or the time of the last accurate seek */
220 boost::optional<dcpomatic::DCPTime> _next_audio_time;
222 boost::atomic<boost::optional<int>> _dcp_decode_reduction;
224 EnumIndexedVector<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime>, Eyes> _last_video;
226 AudioMerger _audio_merger;
227 std::unique_ptr<Shuffler> _shuffler;
228 std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime>> _delay;
235 explicit StreamState(std::shared_ptr<Piece> p)
239 std::shared_ptr<Piece> piece;
240 boost::optional<dcpomatic::DCPTime> last_push_end;
242 std::map<AudioStreamPtr, StreamState> _stream_states;
247 EnumIndexedVector<ActiveText, TextType> _active_texts;
248 std::shared_ptr<AudioProcessor> _audio_processor;
249 bool _disable_audio_processor = false;
251 boost::atomic<dcpomatic::DCPTime> _playback_length;
253 /** Alignment for subtitle images that we create */
254 Image::Alignment _subtitle_alignment = Image::Alignment::PADDED;
256 boost::signals2::scoped_connection _film_changed_connection;
257 boost::signals2::scoped_connection _playlist_change_connection;
258 boost::signals2::scoped_connection _playlist_content_change_connection;