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"
31 #include "content_atmos.h"
32 #include "content_audio.h"
33 #include "content_text.h"
34 #include "content_video.h"
39 #include "player_text.h"
40 #include "position_image.h"
42 #include <boost/atomic.hpp>
58 class ReferencedReelAsset;
65 static int const VIDEO_CONTAINER_SIZE;
66 static int const PLAYLIST;
67 static int const FILM_CONTAINER;
68 static int const FILM_VIDEO_FRAME_RATE;
69 static int const DCP_DECODE_REDUCTION;
70 static int const PLAYBACK_LENGTH;
75 * @brief A class which can play a Playlist.
77 class Player : public std::enable_shared_from_this<Player>
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& Player) = delete;
84 Player& operator= (Player const& Player) = delete;
87 void seek (dcpomatic::DCPTime time, bool accurate);
89 std::vector<dcpomatic::FontData> get_subtitle_fonts ();
90 std::list<ReferencedReelAsset> get_reel_assets ();
91 dcp::Size video_container_size () const {
92 boost::mutex::scoped_lock lm (_mutex);
93 return _video_container_size;
96 void set_video_container_size (dcp::Size);
97 void set_ignore_video ();
98 void set_ignore_audio ();
99 void set_ignore_text ();
100 void set_always_burn_open_subtitles ();
102 void set_play_referenced ();
103 void set_dcp_decode_reduction (boost::optional<int> reduction);
105 boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<Content> content, dcpomatic::ContentTime t);
107 boost::signals2::signal<void (ChangeType, int, bool)> Change;
109 /** Emitted when a video frame is ready. These emissions happen in the correct order. */
110 boost::signals2::signal<void (std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
111 /** Emitted when audio data is ready. First parameter is the audio data, second its time,
112 * third the frame rate.
114 boost::signals2::signal<void (std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
115 /** Emitted when a text is ready. This signal may be emitted considerably
116 * after the corresponding Video.
118 boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
119 boost::signals2::signal<void (std::shared_ptr<const dcp::AtmosFrame>, dcpomatic::DCPTime, AtmosMetadata)> Atmos;
122 friend class PlayerWrapper;
124 friend struct player_time_calculation_test1;
125 friend struct player_time_calculation_test2;
126 friend struct player_time_calculation_test3;
127 friend struct player_subframe_test;
128 friend struct empty_test1;
129 friend struct empty_test2;
130 friend struct check_reuse_old_data_test;
131 friend struct overlap_video_test1;
134 void setup_pieces ();
135 void setup_pieces_unlocked ();
136 void film_change (ChangeType, Film::Property);
137 void playlist_change (ChangeType);
138 void playlist_content_change (ChangeType, int, bool);
139 Frame dcp_to_content_video (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
140 dcpomatic::DCPTime content_video_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
141 Frame dcp_to_resampled_audio (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
142 dcpomatic::DCPTime resampled_audio_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
143 dcpomatic::ContentTime dcp_to_content_time (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
144 dcpomatic::DCPTime content_time_to_dcp (std::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
145 std::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
147 void video (std::weak_ptr<Piece>, ContentVideo);
148 void audio (std::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
149 void bitmap_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentBitmapText);
150 void plain_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentStringText);
151 void subtitle_stop (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, dcpomatic::ContentTime);
152 void atmos (std::weak_ptr<Piece>, ContentAtmos);
154 dcpomatic::DCPTime one_video_frame () const;
155 void fill_audio (dcpomatic::DCPTimePeriod period);
156 std::pair<std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime> discard_audio (
157 std::shared_ptr<const AudioBuffers> audio, dcpomatic::DCPTime time, dcpomatic::DCPTime discard_to
159 boost::optional<PositionImage> open_subtitles_for_frame (dcpomatic::DCPTime time) const;
160 void emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
161 void do_emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
162 void emit_audio (std::shared_ptr<AudioBuffers> data, dcpomatic::DCPTime time);
163 std::shared_ptr<const Playlist> playlist () const;
165 /** Mutex to protect the whole Player state. When it's used for the preview we have
166 seek() and pass() called from the Butler thread and lots of other stuff called
169 mutable boost::mutex _mutex;
171 std::shared_ptr<const Film> _film;
172 /** Playlist, or 0 if we are using the one from the _film */
173 std::shared_ptr<const Playlist> _playlist;
175 /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
176 boost::atomic<int> _suspended;
177 std::list<std::shared_ptr<Piece> > _pieces;
179 /** Size of the image we are rendering to; this may be the DCP frame size, or
180 * the size of preview in a window.
182 dcp::Size _video_container_size;
183 std::shared_ptr<Image> _black_image;
185 /** true if the player should ignore all video; i.e. never produce any */
186 bool _ignore_video = false;
187 bool _ignore_audio = false;
188 /** true if the player should ignore all text; i.e. never produce any */
189 bool _ignore_text = false;
190 bool _always_burn_open_subtitles = false;
191 /** true if we should try to be fast rather than high quality */
193 /** true if we should keep going in the face of `survivable' errors */
194 bool _tolerant = false;
195 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
196 bool _play_referenced = false;
198 /** Time just after the last video frame we emitted, or the time of the last accurate seek */
199 boost::optional<dcpomatic::DCPTime> _last_video_time;
200 boost::optional<Eyes> _last_video_eyes;
201 /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
202 boost::optional<dcpomatic::DCPTime> _last_audio_time;
204 boost::optional<int> _dcp_decode_reduction;
206 typedef std::map<std::weak_ptr<Piece>, std::shared_ptr<PlayerVideo>, std::owner_less<std::weak_ptr<Piece>>> LastVideoMap;
207 LastVideoMap _last_video;
209 AudioMerger _audio_merger;
210 std::unique_ptr<Shuffler> _shuffler;
211 std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> > _delay;
218 StreamState (std::shared_ptr<Piece> p, dcpomatic::DCPTime l)
223 std::shared_ptr<Piece> piece;
224 dcpomatic::DCPTime last_push_end;
226 std::map<AudioStreamPtr, StreamState> _stream_states;
231 ActiveText _active_texts[static_cast<int>(TextType::COUNT)];
232 std::shared_ptr<AudioProcessor> _audio_processor;
234 dcpomatic::DCPTime _playback_length;
236 /** Alignment for subtitle images that we create */
237 Image::Alignment _subtitle_alignment = Image::Alignment::PADDED;
239 boost::signals2::scoped_connection _film_changed_connection;
240 boost::signals2::scoped_connection _playlist_change_connection;
241 boost::signals2::scoped_connection _playlist_content_change_connection;