2 Copyright (C) 2013-2019 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/>.
21 #ifndef DCPOMATIC_PLAYER_H
22 #define DCPOMATIC_PLAYER_H
24 #include "player_text.h"
25 #include "active_text.h"
26 #include "content_text.h"
29 #include "position_image.h"
31 #include "content_video.h"
32 #include "content_audio.h"
33 #include "audio_stream.h"
34 #include "audio_merger.h"
36 #include <boost/shared_ptr.hpp>
37 #include <boost/enable_shared_from_this.hpp>
51 class ReferencedReelAsset;
57 static int const VIDEO_CONTAINER_SIZE;
58 static int const PLAYLIST;
59 static int const FILM_CONTAINER;
60 static int const FILM_VIDEO_FRAME_RATE;
61 static int const DCP_DECODE_REDUCTION;
65 * @brief A class which can play a Playlist.
67 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
70 Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
74 void seek (dcpomatic::DCPTime time, bool accurate);
76 std::list<boost::shared_ptr<dcpomatic::Font> > get_subtitle_fonts ();
77 std::list<ReferencedReelAsset> get_reel_assets ();
78 dcp::Size video_container_size () const {
79 boost::mutex::scoped_lock lm (_mutex);
80 return _video_container_size;
83 void set_video_container_size (dcp::Size);
84 void set_ignore_video ();
85 void set_ignore_audio ();
86 void set_ignore_text ();
87 void set_always_burn_open_subtitles ();
89 void set_play_referenced ();
90 void set_dcp_decode_reduction (boost::optional<int> reduction);
92 boost::optional<dcpomatic::DCPTime> content_time_to_dcp (boost::shared_ptr<Content> content, dcpomatic::ContentTime t);
94 boost::signals2::signal<void (ChangeType, int, bool)> Change;
96 /** Emitted when a video frame is ready. These emissions happen in the correct order. */
97 boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
98 boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
99 /** Emitted when a text is ready. This signal may be emitted considerably
100 * after the corresponding Video.
102 boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
105 friend class PlayerWrapper;
107 friend struct player_time_calculation_test1;
108 friend struct player_time_calculation_test2;
109 friend struct player_time_calculation_test3;
110 friend struct player_subframe_test;
111 friend struct empty_test1;
112 friend struct empty_test2;
113 friend struct check_reuse_old_data_test;
115 void setup_pieces ();
116 void setup_pieces_unlocked ();
118 void film_change (ChangeType, Film::Property);
119 void playlist_change (ChangeType);
120 void playlist_content_change (ChangeType, int, bool);
121 Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
122 dcpomatic::DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
123 Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
124 dcpomatic::DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
125 dcpomatic::ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
126 dcpomatic::DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
127 boost::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
128 void video (boost::weak_ptr<Piece>, ContentVideo);
129 void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
130 void bitmap_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentBitmapText);
131 void plain_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentStringText);
132 void subtitle_stop (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, dcpomatic::ContentTime);
133 dcpomatic::DCPTime one_video_frame () const;
134 void fill_audio (dcpomatic::DCPTimePeriod period);
135 std::pair<boost::shared_ptr<AudioBuffers>, dcpomatic::DCPTime> discard_audio (
136 boost::shared_ptr<const AudioBuffers> audio, dcpomatic::DCPTime time, dcpomatic::DCPTime discard_to
138 boost::optional<PositionImage> open_subtitles_for_frame (dcpomatic::DCPTime time) const;
139 void emit_video (boost::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
140 void do_emit_video (boost::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
141 void emit_audio (boost::shared_ptr<AudioBuffers> data, dcpomatic::DCPTime time);
143 /** Mutex to protect the whole Player state. When it's used for the preview we have
144 seek() and pass() called from the Butler thread and lots of other stuff called
147 mutable boost::mutex _mutex;
149 boost::shared_ptr<const Film> _film;
150 boost::shared_ptr<const Playlist> _playlist;
152 /** true if we are suspended (i.e. pass() and seek() do nothing) */
154 std::list<boost::shared_ptr<Piece> > _pieces;
156 /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
157 dcp::Size _video_container_size;
158 boost::shared_ptr<Image> _black_image;
160 /** true if the player should ignore all video; i.e. never produce any */
163 /** true if the player should ignore all text; i.e. never produce any */
165 bool _always_burn_open_subtitles;
166 /** true if we should try to be fast rather than high quality */
168 /** true if we should keep going in the face of `survivable' errors */
170 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
171 bool _play_referenced;
173 /** Time just after the last video frame we emitted, or the time of the last accurate seek */
174 boost::optional<dcpomatic::DCPTime> _last_video_time;
175 boost::optional<Eyes> _last_video_eyes;
176 /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
177 boost::optional<dcpomatic::DCPTime> _last_audio_time;
179 boost::optional<int> _dcp_decode_reduction;
181 typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
182 LastVideoMap _last_video;
184 AudioMerger _audio_merger;
186 std::list<std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> > _delay;
193 StreamState (boost::shared_ptr<Piece> p, dcpomatic::DCPTime l)
198 boost::shared_ptr<Piece> piece;
199 dcpomatic::DCPTime last_push_end;
201 std::map<AudioStreamPtr, StreamState> _stream_states;
206 ActiveText _active_texts[TEXT_COUNT];
207 boost::shared_ptr<AudioProcessor> _audio_processor;
209 boost::signals2::scoped_connection _film_changed_connection;
210 boost::signals2::scoped_connection _playlist_change_connection;
211 boost::signals2::scoped_connection _playlist_content_change_connection;