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"
35 #include "enum_indexed_vector.h"
38 #include "player_text.h"
39 #include "position_image.h"
41 #include <boost/atomic.hpp>
54 class ReferencedReelAsset;
60 static int const VIDEO_CONTAINER_SIZE;
61 static int const PLAYLIST;
62 static int const FILM_CONTAINER;
63 static int const FILM_VIDEO_FRAME_RATE;
64 static int const DCP_DECODE_REDUCTION;
65 static int const PLAYBACK_LENGTH;
66 static int const IGNORE_VIDEO;
67 static int const IGNORE_AUDIO;
68 static int const IGNORE_TEXT;
69 static int const ALWAYS_BURN_OPEN_SUBTITLES;
70 static int const PLAY_REFERENCED;
75 * @brief A class which can play a Playlist.
80 Player (std::shared_ptr<const Film>, Image::Alignment subtitle_alignment);
81 Player (std::shared_ptr<const Film>, std::shared_ptr<const Playlist> playlist);
83 Player (Player const&) = delete;
84 Player& operator= (Player const&) = delete;
86 Player(Player&& other);
87 Player& operator=(Player&& other);
90 void seek (dcpomatic::DCPTime time, bool accurate);
92 std::vector<std::shared_ptr<dcpomatic::Font>> get_subtitle_fonts ();
94 dcp::Size video_container_size () const {
95 return _video_container_size;
98 void set_video_container_size (dcp::Size);
99 void set_ignore_video ();
100 void set_ignore_audio ();
101 void set_ignore_text ();
102 void set_always_burn_open_subtitles ();
104 void set_play_referenced ();
105 void set_dcp_decode_reduction (boost::optional<int> reduction);
107 boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<const Content> content, dcpomatic::ContentTime t) const;
108 boost::optional<dcpomatic::ContentTime> dcp_to_content_time (std::shared_ptr<const Content> content, dcpomatic::DCPTime t) const;
110 void signal_change(ChangeType type, int property);
112 /** First parameter is PENDING, DONE or CANCELLED.
113 * Second parameter is the property.
114 * Third parameter is true if these signals are currently likely to be frequent.
116 boost::signals2::signal<void (ChangeType, int, bool)> Change;
118 /** Emitted when a video frame is ready. These emissions happen in the correct order. */
119 boost::signals2::signal<void (std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
120 /** Emitted when audio data is ready. First parameter is the audio data, second its time,
121 * third the frame rate.
123 boost::signals2::signal<void (std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
124 /** Emitted when a text is ready. This signal may be emitted considerably
125 * after the corresponding Video.
127 boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
128 boost::signals2::signal<void (std::shared_ptr<const dcp::AtmosFrame>, dcpomatic::DCPTime, AtmosMetadata)> Atmos;
131 friend class PlayerWrapper;
133 friend struct player_time_calculation_test1;
134 friend struct player_time_calculation_test2;
135 friend struct player_time_calculation_test3;
136 friend struct player_subframe_test;
137 friend struct empty_test1;
138 friend struct empty_test2;
139 friend struct check_reuse_old_data_test;
140 friend struct overlap_video_test1;
144 void setup_pieces ();
145 void film_change (ChangeType, Film::Property);
146 void playlist_change (ChangeType);
147 void playlist_content_change (ChangeType, int, bool);
148 Frame dcp_to_content_video (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
149 dcpomatic::DCPTime content_video_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
150 Frame dcp_to_resampled_audio (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
151 dcpomatic::DCPTime resampled_audio_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
152 dcpomatic::ContentTime dcp_to_content_time (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
153 dcpomatic::DCPTime content_time_to_dcp (std::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
154 std::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
156 void video (std::weak_ptr<Piece>, ContentVideo);
157 void audio (std::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
158 void bitmap_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentBitmapText);
159 void plain_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentStringText);
160 void subtitle_stop (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, dcpomatic::ContentTime);
161 void atmos (std::weak_ptr<Piece>, ContentAtmos);
163 dcpomatic::DCPTime one_video_frame () const;
164 void fill_audio (dcpomatic::DCPTimePeriod period);
165 std::pair<std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime> discard_audio (
166 std::shared_ptr<const AudioBuffers> audio, dcpomatic::DCPTime time, dcpomatic::DCPTime discard_to
168 boost::optional<PositionImage> open_subtitles_for_frame (dcpomatic::DCPTime time) const;
169 void emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
170 void do_emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
171 void emit_audio (std::shared_ptr<AudioBuffers> data, dcpomatic::DCPTime time);
172 std::shared_ptr<const Playlist> playlist () const;
174 /** Mutex to protect the most of the Player state. When it's used for the preview we have
175 seek() and pass() called from the Butler thread and lots of other stuff called
178 mutable boost::mutex _mutex;
180 std::weak_ptr<const Film> _film;
181 /** Playlist, or 0 if we are using the one from the _film */
182 std::shared_ptr<const Playlist> _playlist;
184 /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
185 boost::atomic<int> _suspended;
186 std::list<std::shared_ptr<Piece>> _pieces;
188 /** Size of the image we are rendering to; this may be the DCP frame size, or
189 * the size of preview in a window.
191 boost::atomic<dcp::Size> _video_container_size;
193 mutable boost::mutex _black_image_mutex;
194 std::shared_ptr<Image> _black_image;
196 /** true if the player should ignore all video; i.e. never produce any */
197 boost::atomic<bool> _ignore_video;
198 boost::atomic<bool> _ignore_audio;
199 /** true if the player should ignore all text; i.e. never produce any */
200 boost::atomic<bool> _ignore_text;
201 boost::atomic<bool> _always_burn_open_subtitles;
202 /** true if we should try to be fast rather than high quality */
203 boost::atomic<bool> _fast;
204 /** true if we should keep going in the face of `survivable' errors */
206 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
207 boost::atomic<bool> _play_referenced;
209 /** Time of the next video that we will emit, or the time of the last accurate seek */
210 boost::optional<dcpomatic::DCPTime> _next_video_time;
211 /** Eyes of the next video that we will emit */
212 boost::optional<Eyes> _next_video_eyes;
213 /** Time of the next audio that we will emit, or the time of the last accurate seek */
214 boost::optional<dcpomatic::DCPTime> _next_audio_time;
216 boost::atomic<boost::optional<int>> _dcp_decode_reduction;
218 typedef std::map<std::weak_ptr<Piece>, std::shared_ptr<PlayerVideo>, std::owner_less<std::weak_ptr<Piece>>> LastVideoMap;
219 LastVideoMap _last_video;
221 AudioMerger _audio_merger;
222 std::unique_ptr<Shuffler> _shuffler;
223 std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime>> _delay;
230 explicit StreamState(std::shared_ptr<Piece> p)
234 std::shared_ptr<Piece> piece;
235 boost::optional<dcpomatic::DCPTime> last_push_end;
237 std::map<AudioStreamPtr, StreamState> _stream_states;
242 EnumIndexedVector<ActiveText, TextType> _active_texts;
243 std::shared_ptr<AudioProcessor> _audio_processor;
245 boost::atomic<dcpomatic::DCPTime> _playback_length;
247 /** Alignment for subtitle images that we create */
248 Image::Alignment _subtitle_alignment = Image::Alignment::PADDED;
250 boost::signals2::scoped_connection _film_changed_connection;
251 boost::signals2::scoped_connection _playlist_change_connection;
252 boost::signals2::scoped_connection _playlist_content_change_connection;