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 ();
84 std::list<ReferencedReelAsset> get_reel_assets ();
85 dcp::Size video_container_size () const {
86 boost::mutex::scoped_lock lm (_mutex);
87 return _video_container_size;
90 void set_video_container_size (dcp::Size);
91 void set_ignore_video ();
92 void set_ignore_audio ();
93 void set_ignore_text ();
94 void set_always_burn_open_subtitles ();
96 void set_play_referenced ();
97 void set_dcp_decode_reduction (boost::optional<int> reduction);
99 boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<const Content> content, dcpomatic::ContentTime t);
100 boost::optional<dcpomatic::ContentTime> dcp_to_content_time (std::shared_ptr<const Content> content, dcpomatic::DCPTime t);
102 boost::signals2::signal<void (ChangeType, int, bool)> Change;
104 /** Emitted when a video frame is ready. These emissions happen in the correct order. */
105 boost::signals2::signal<void (std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
106 /** Emitted when audio data is ready. First parameter is the audio data, second its time,
107 * third the frame rate.
109 boost::signals2::signal<void (std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
110 /** Emitted when a text is ready. This signal may be emitted considerably
111 * after the corresponding Video.
113 boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
114 boost::signals2::signal<void (std::shared_ptr<const dcp::AtmosFrame>, dcpomatic::DCPTime, AtmosMetadata)> Atmos;
117 friend class PlayerWrapper;
119 friend struct player_time_calculation_test1;
120 friend struct player_time_calculation_test2;
121 friend struct player_time_calculation_test3;
122 friend struct player_subframe_test;
123 friend struct empty_test1;
124 friend struct empty_test2;
125 friend struct check_reuse_old_data_test;
126 friend struct overlap_video_test1;
129 void setup_pieces ();
130 void setup_pieces_unlocked ();
131 void film_change (ChangeType, Film::Property);
132 void playlist_change (ChangeType);
133 void playlist_content_change (ChangeType, int, bool);
134 Frame dcp_to_content_video (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
135 dcpomatic::DCPTime content_video_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
136 Frame dcp_to_resampled_audio (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
137 dcpomatic::DCPTime resampled_audio_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
138 dcpomatic::ContentTime dcp_to_content_time (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
139 dcpomatic::DCPTime content_time_to_dcp (std::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
140 std::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
142 void video (std::weak_ptr<Piece>, ContentVideo);
143 void audio (std::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
144 void bitmap_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentBitmapText);
145 void plain_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentStringText);
146 void subtitle_stop (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, dcpomatic::ContentTime);
147 void atmos (std::weak_ptr<Piece>, ContentAtmos);
149 dcpomatic::DCPTime one_video_frame () const;
150 void fill_audio (dcpomatic::DCPTimePeriod period);
151 std::pair<std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime> discard_audio (
152 std::shared_ptr<const AudioBuffers> audio, dcpomatic::DCPTime time, dcpomatic::DCPTime discard_to
154 boost::optional<PositionImage> open_subtitles_for_frame (dcpomatic::DCPTime time) const;
155 void emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
156 void do_emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
157 void emit_audio (std::shared_ptr<AudioBuffers> data, dcpomatic::DCPTime time);
158 std::shared_ptr<const Playlist> playlist () const;
160 /** Mutex to protect the whole Player state. When it's used for the preview we have
161 seek() and pass() called from the Butler thread and lots of other stuff called
164 mutable boost::mutex _mutex;
166 std::shared_ptr<const Film> const _film;
167 /** Playlist, or 0 if we are using the one from the _film */
168 std::shared_ptr<const Playlist> const _playlist;
170 /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
171 boost::atomic<int> _suspended;
172 std::list<std::shared_ptr<Piece>> _pieces;
174 /** Size of the image we are rendering to; this may be the DCP frame size, or
175 * the size of preview in a window.
177 dcp::Size _video_container_size;
178 std::shared_ptr<Image> _black_image;
180 /** true if the player should ignore all video; i.e. never produce any */
181 bool _ignore_video = false;
182 bool _ignore_audio = false;
183 /** true if the player should ignore all text; i.e. never produce any */
184 bool _ignore_text = false;
185 bool _always_burn_open_subtitles = false;
186 /** true if we should try to be fast rather than high quality */
188 /** true if we should keep going in the face of `survivable' errors */
189 bool const _tolerant;
190 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
191 bool _play_referenced = false;
193 /** Time of the next video that we will emit, or the time of the last accurate seek */
194 boost::optional<dcpomatic::DCPTime> _next_video_time;
195 /** Eyes of the next video that we will emit */
196 boost::optional<Eyes> _next_video_eyes;
197 /** Time of the next audio that we will emit, or the time of the last accurate seek */
198 boost::optional<dcpomatic::DCPTime> _next_audio_time;
200 boost::optional<int> _dcp_decode_reduction;
202 typedef std::map<std::weak_ptr<Piece>, std::shared_ptr<PlayerVideo>, std::owner_less<std::weak_ptr<Piece>>> LastVideoMap;
203 LastVideoMap _last_video;
205 AudioMerger _audio_merger;
206 std::unique_ptr<Shuffler> _shuffler;
207 std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime>> _delay;
214 StreamState (std::shared_ptr<Piece> p, dcpomatic::DCPTime l)
219 std::shared_ptr<Piece> piece;
220 dcpomatic::DCPTime last_push_end;
222 std::map<AudioStreamPtr, StreamState> _stream_states;
227 ActiveText _active_texts[static_cast<int>(TextType::COUNT)];
228 std::shared_ptr<AudioProcessor> _audio_processor;
230 dcpomatic::DCPTime _playback_length;
232 /** Alignment for subtitle images that we create */
233 Image::Alignment const _subtitle_alignment = Image::Alignment::PADDED;
235 boost::signals2::scoped_connection _film_changed_connection;
236 boost::signals2::scoped_connection _playlist_change_connection;
237 boost::signals2::scoped_connection _playlist_content_change_connection;