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);
94 std::vector<std::shared_ptr<dcpomatic::Font>> get_subtitle_fonts ();
96 dcp::Size video_container_size () const {
97 return _video_container_size;
100 void set_video_container_size (dcp::Size);
101 void set_ignore_video ();
102 void set_ignore_audio ();
103 void set_ignore_text ();
104 void set_always_burn_open_subtitles ();
106 void set_play_referenced ();
107 void set_dcp_decode_reduction (boost::optional<int> reduction);
108 void set_disable_audio_processor();
110 boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<const Content> content, dcpomatic::ContentTime t) const;
111 boost::optional<dcpomatic::ContentTime> dcp_to_content_time (std::shared_ptr<const Content> content, dcpomatic::DCPTime t) const;
113 void signal_change(ChangeType type, int property);
115 /** First parameter is PENDING, DONE or CANCELLED.
116 * Second parameter is the property.
117 * Third parameter is true if these signals are currently likely to be frequent.
119 boost::signals2::signal<void (ChangeType, int, bool)> Change;
121 /** Emitted when a video frame is ready. These emissions happen in the correct order. */
122 boost::signals2::signal<void (std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
123 /** Emitted when audio data is ready. First parameter is the audio data, second its time,
124 * third the frame rate.
126 boost::signals2::signal<void (std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
127 /** Emitted when a text is ready. This signal may be emitted considerably
128 * after the corresponding Video.
130 boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
131 boost::signals2::signal<void (std::shared_ptr<const dcp::AtmosFrame>, dcpomatic::DCPTime, AtmosMetadata)> Atmos;
134 friend class PlayerWrapper;
136 friend struct player_time_calculation_test1;
137 friend struct player_time_calculation_test2;
138 friend struct player_time_calculation_test3;
139 friend struct player_subframe_test;
140 friend struct empty_test1;
141 friend struct empty_test2;
142 friend struct check_reuse_old_data_test;
143 friend struct overlap_video_test1;
147 void setup_pieces ();
148 void film_change(ChangeType, FilmProperty);
149 void playlist_change (ChangeType);
150 void playlist_content_change (ChangeType, int, bool);
151 Frame dcp_to_content_video (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
152 dcpomatic::DCPTime content_video_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
153 Frame dcp_to_resampled_audio (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
154 dcpomatic::DCPTime resampled_audio_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
155 dcpomatic::ContentTime dcp_to_content_time (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
156 dcpomatic::DCPTime content_time_to_dcp (std::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
157 std::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
159 void video (std::weak_ptr<Piece>, ContentVideo);
160 void audio (std::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
161 void bitmap_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentBitmapText);
162 void plain_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentStringText);
163 void subtitle_stop (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, dcpomatic::ContentTime);
164 void atmos (std::weak_ptr<Piece>, ContentAtmos);
166 dcpomatic::DCPTime one_video_frame () const;
167 void fill_audio (dcpomatic::DCPTimePeriod period);
168 std::pair<std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime> discard_audio (
169 std::shared_ptr<const AudioBuffers> audio, dcpomatic::DCPTime time, dcpomatic::DCPTime discard_to
171 boost::optional<PositionImage> open_subtitles_for_frame (dcpomatic::DCPTime time) const;
172 void emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
173 void do_emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
174 void emit_audio (std::shared_ptr<AudioBuffers> data, dcpomatic::DCPTime time);
175 std::shared_ptr<const Playlist> playlist () const;
177 /** Mutex to protect the most of the Player state. When it's used for the preview we have
178 seek() and pass() called from the Butler thread and lots of other stuff called
181 mutable boost::mutex _mutex;
183 std::weak_ptr<const Film> _film;
184 /** Playlist, or 0 if we are using the one from the _film */
185 std::shared_ptr<const Playlist> _playlist;
187 /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
188 boost::atomic<int> _suspended;
189 std::vector<std::shared_ptr<Piece>> _pieces;
191 /** Size of the image we are rendering to; this may be the DCP frame size, or
192 * the size of preview in a window.
194 boost::atomic<dcp::Size> _video_container_size;
196 mutable boost::mutex _black_image_mutex;
197 std::shared_ptr<Image> _black_image;
199 /** true if the player should ignore all video; i.e. never produce any */
200 boost::atomic<bool> _ignore_video;
201 boost::atomic<bool> _ignore_audio;
202 /** true if the player should ignore all text; i.e. never produce any */
203 boost::atomic<bool> _ignore_text;
204 boost::atomic<bool> _always_burn_open_subtitles;
205 /** true if we should try to be fast rather than high quality */
206 boost::atomic<bool> _fast;
207 /** true if we should keep going in the face of `survivable' errors */
209 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
210 boost::atomic<bool> _play_referenced;
212 /** Time of the next video that we will emit, or the time of the last accurate seek */
213 boost::optional<dcpomatic::DCPTime> _next_video_time;
214 /** Eyes of the next video that we will emit */
215 boost::optional<Eyes> _next_video_eyes;
216 /** Time of the next audio that we will emit, or the time of the last accurate seek */
217 boost::optional<dcpomatic::DCPTime> _next_audio_time;
219 boost::atomic<boost::optional<int>> _dcp_decode_reduction;
221 typedef std::map<std::weak_ptr<Piece>, std::shared_ptr<PlayerVideo>, std::owner_less<std::weak_ptr<Piece>>> LastVideoMap;
222 LastVideoMap _last_video;
224 AudioMerger _audio_merger;
225 std::unique_ptr<Shuffler> _shuffler;
226 std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime>> _delay;
233 explicit StreamState(std::shared_ptr<Piece> p)
237 std::shared_ptr<Piece> piece;
238 boost::optional<dcpomatic::DCPTime> last_push_end;
240 std::map<AudioStreamPtr, StreamState> _stream_states;
245 EnumIndexedVector<ActiveText, TextType> _active_texts;
246 std::shared_ptr<AudioProcessor> _audio_processor;
247 bool _disable_audio_processor = false;
249 boost::atomic<dcpomatic::DCPTime> _playback_length;
251 /** Alignment for subtitle images that we create */
252 Image::Alignment _subtitle_alignment = Image::Alignment::PADDED;
254 boost::signals2::scoped_connection _film_changed_connection;
255 boost::signals2::scoped_connection _playlist_change_connection;
256 boost::signals2::scoped_connection _playlist_content_change_connection;