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"
37 #include "player_text.h"
38 #include "position_image.h"
40 #include <boost/atomic.hpp>
53 class ReferencedReelAsset;
59 static int const VIDEO_CONTAINER_SIZE;
60 static int const PLAYLIST;
61 static int const FILM_CONTAINER;
62 static int const FILM_VIDEO_FRAME_RATE;
63 static int const DCP_DECODE_REDUCTION;
64 static int const PLAYBACK_LENGTH;
69 * @brief A class which can play a Playlist.
71 class Player : public std::enable_shared_from_this<Player>
74 Player (std::shared_ptr<const Film>, Image::Alignment subtitle_alignment);
75 Player (std::shared_ptr<const Film>, std::shared_ptr<const Playlist> playlist);
77 Player (Player const& Player) = delete;
78 Player& operator= (Player const& Player) = delete;
81 void seek (dcpomatic::DCPTime time, bool accurate);
83 std::vector<std::shared_ptr<dcpomatic::Font>> get_subtitle_fonts ();
85 dcp::Size video_container_size () const {
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 (std::shared_ptr<const Content> content, dcpomatic::ContentTime t) const;
99 boost::optional<dcpomatic::ContentTime> dcp_to_content_time (std::shared_ptr<const Content> content, dcpomatic::DCPTime t) const;
101 boost::signals2::signal<void (ChangeType, int, bool)> Change;
103 /** Emitted when a video frame is ready. These emissions happen in the correct order. */
104 boost::signals2::signal<void (std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
105 /** Emitted when audio data is ready. First parameter is the audio data, second its time,
106 * third the frame rate.
108 boost::signals2::signal<void (std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
109 /** Emitted when a text is ready. This signal may be emitted considerably
110 * after the corresponding Video.
112 boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
113 boost::signals2::signal<void (std::shared_ptr<const dcp::AtmosFrame>, dcpomatic::DCPTime, AtmosMetadata)> Atmos;
116 friend class PlayerWrapper;
118 friend struct player_time_calculation_test1;
119 friend struct player_time_calculation_test2;
120 friend struct player_time_calculation_test3;
121 friend struct player_subframe_test;
122 friend struct empty_test1;
123 friend struct empty_test2;
124 friend struct check_reuse_old_data_test;
125 friend struct overlap_video_test1;
128 void setup_pieces ();
129 void film_change (ChangeType, Film::Property);
130 void playlist_change (ChangeType);
131 void playlist_content_change (ChangeType, int, bool);
132 Frame dcp_to_content_video (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
133 dcpomatic::DCPTime content_video_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
134 Frame dcp_to_resampled_audio (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
135 dcpomatic::DCPTime resampled_audio_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
136 dcpomatic::ContentTime dcp_to_content_time (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
137 dcpomatic::DCPTime content_time_to_dcp (std::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
138 std::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
140 void video (std::weak_ptr<Piece>, ContentVideo);
141 void audio (std::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
142 void bitmap_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentBitmapText);
143 void plain_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentStringText);
144 void subtitle_stop (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, dcpomatic::ContentTime);
145 void atmos (std::weak_ptr<Piece>, ContentAtmos);
147 dcpomatic::DCPTime one_video_frame () const;
148 void fill_audio (dcpomatic::DCPTimePeriod period);
149 std::pair<std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime> discard_audio (
150 std::shared_ptr<const AudioBuffers> audio, dcpomatic::DCPTime time, dcpomatic::DCPTime discard_to
152 boost::optional<PositionImage> open_subtitles_for_frame (dcpomatic::DCPTime time) const;
153 void emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
154 void do_emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
155 void emit_audio (std::shared_ptr<AudioBuffers> data, dcpomatic::DCPTime time);
156 std::shared_ptr<const Playlist> playlist () const;
158 /** Mutex to protect the whole Player state. When it's used for the preview we have
159 seek() and pass() called from the Butler thread and lots of other stuff called
162 mutable boost::mutex _mutex;
164 std::shared_ptr<const Film> const _film;
165 /** Playlist, or 0 if we are using the one from the _film */
166 std::shared_ptr<const Playlist> const _playlist;
168 /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
169 boost::atomic<int> _suspended;
170 std::list<std::shared_ptr<Piece>> _pieces;
172 /** Size of the image we are rendering to; this may be the DCP frame size, or
173 * the size of preview in a window.
175 boost::atomic<dcp::Size> _video_container_size;
176 /** Should be accessed using the std::atomic... methods */
177 std::shared_ptr<Image> _black_image;
179 /** true if the player should ignore all video; i.e. never produce any */
180 boost::atomic<bool> _ignore_video;
181 boost::atomic<bool> _ignore_audio;
182 /** true if the player should ignore all text; i.e. never produce any */
183 boost::atomic<bool> _ignore_text;
184 boost::atomic<bool> _always_burn_open_subtitles;
185 /** true if we should try to be fast rather than high quality */
186 boost::atomic<bool> _fast;
187 /** true if we should keep going in the face of `survivable' errors */
188 bool const _tolerant;
189 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
190 boost::atomic<bool> _play_referenced;
192 /** Time of the next video that we will emit, or the time of the last accurate seek */
193 boost::optional<dcpomatic::DCPTime> _next_video_time;
194 /** Eyes of the next video that we will emit */
195 boost::optional<Eyes> _next_video_eyes;
196 /** Time of the next audio that we will emit, or the time of the last accurate seek */
197 boost::optional<dcpomatic::DCPTime> _next_audio_time;
199 boost::atomic<boost::optional<int>> _dcp_decode_reduction;
201 typedef std::map<std::weak_ptr<Piece>, std::shared_ptr<PlayerVideo>, std::owner_less<std::weak_ptr<Piece>>> LastVideoMap;
202 LastVideoMap _last_video;
204 AudioMerger _audio_merger;
205 std::unique_ptr<Shuffler> _shuffler;
206 std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime>> _delay;
213 StreamState (std::shared_ptr<Piece> p, dcpomatic::DCPTime l)
218 std::shared_ptr<Piece> piece;
219 dcpomatic::DCPTime last_push_end;
221 std::map<AudioStreamPtr, StreamState> _stream_states;
226 ActiveText _active_texts[static_cast<int>(TextType::COUNT)];
227 std::shared_ptr<AudioProcessor> _audio_processor;
229 boost::atomic<dcpomatic::DCPTime> _playback_length;
231 /** Alignment for subtitle images that we create */
232 Image::Alignment const _subtitle_alignment = Image::Alignment::PADDED;
234 boost::signals2::scoped_connection _film_changed_connection;
235 boost::signals2::scoped_connection _playlist_change_connection;
236 boost::signals2::scoped_connection _playlist_content_change_connection;