2 Copyright (C) 2013-2018 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>
38 #include <boost/atomic.hpp>
49 class ReferencedReelAsset;
55 static int const VIDEO_CONTAINER_SIZE;
56 static int const PLAYLIST;
57 static int const FILM_CONTAINER;
58 static int const FILM_VIDEO_FRAME_RATE;
59 static int const DCP_DECODE_REDUCTION;
63 * @brief A class which can play a Playlist.
65 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
68 Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
72 void seek (DCPTime time, bool accurate);
74 std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
75 std::list<ReferencedReelAsset> get_reel_assets ();
76 dcp::Size video_container_size () const {
77 boost::mutex::scoped_lock lm (_mutex);
78 return _video_container_size;
81 void set_video_container_size (dcp::Size);
82 void set_ignore_video ();
83 void set_ignore_audio ();
84 void set_ignore_text ();
85 void set_always_burn_open_subtitles ();
87 void set_play_referenced ();
88 void set_dcp_decode_reduction (boost::optional<int> reduction);
90 boost::optional<DCPTime> content_time_to_dcp (boost::shared_ptr<Content> content, ContentTime t);
92 boost::signals2::signal<void (ChangeType, int, bool)> Change;
94 /** Emitted when a video frame is ready. These emissions happen in the correct order. */
95 boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
96 boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime, int)> Audio;
97 /** Emitted when a text is ready. This signal may be emitted considerably
98 * after the corresponding Video.
100 boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, DCPTimePeriod)> Text;
103 friend class PlayerWrapper;
105 friend struct player_time_calculation_test1;
106 friend struct player_time_calculation_test2;
107 friend struct player_time_calculation_test3;
108 friend struct player_subframe_test;
109 friend struct empty_test1;
110 friend struct empty_test2;
112 void setup_pieces ();
113 void setup_pieces_unlocked ();
115 void film_change (ChangeType, Film::Property);
116 void playlist_change (ChangeType);
117 void playlist_content_change (ChangeType, int, bool);
118 Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
119 DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
120 Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
121 DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
122 ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
123 DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
124 boost::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
125 void video (boost::weak_ptr<Piece>, ContentVideo);
126 void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
127 void bitmap_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentBitmapText);
128 void plain_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentStringText);
129 void subtitle_stop (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentTime);
130 DCPTime one_video_frame () const;
131 void fill_audio (DCPTimePeriod period);
132 std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
133 boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
135 boost::optional<PositionImage> open_subtitles_for_frame (DCPTime time) const;
136 void emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
137 void do_emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
138 void emit_audio (boost::shared_ptr<AudioBuffers> data, DCPTime time);
140 /** Mutex to protect the whole Player state. When it's used for the preview we have
141 seek() and pass() called from the Butler thread and lots of other stuff called
144 mutable boost::mutex _mutex;
146 boost::shared_ptr<const Film> _film;
147 boost::shared_ptr<const Playlist> _playlist;
149 /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
150 boost::atomic<int> _suspended;
151 std::list<boost::shared_ptr<Piece> > _pieces;
153 /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
154 dcp::Size _video_container_size;
155 boost::shared_ptr<Image> _black_image;
157 /** true if the player should ignore all video; i.e. never produce any */
160 /** true if the player should ignore all text; i.e. never produce any */
162 bool _always_burn_open_subtitles;
163 /** true if we should try to be fast rather than high quality */
165 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
166 bool _play_referenced;
168 /** Time just after the last video frame we emitted, or the time of the last accurate seek */
169 boost::optional<DCPTime> _last_video_time;
170 boost::optional<Eyes> _last_video_eyes;
171 /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
172 boost::optional<DCPTime> _last_audio_time;
174 boost::optional<int> _dcp_decode_reduction;
176 typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
177 LastVideoMap _last_video;
179 AudioMerger _audio_merger;
181 std::list<std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> > _delay;
188 StreamState (boost::shared_ptr<Piece> p, DCPTime l)
193 boost::shared_ptr<Piece> piece;
194 DCPTime last_push_end;
196 std::map<AudioStreamPtr, StreamState> _stream_states;
201 ActiveText _active_texts[TEXT_COUNT];
202 boost::shared_ptr<AudioProcessor> _audio_processor;
204 boost::signals2::scoped_connection _film_changed_connection;
205 boost::signals2::scoped_connection _playlist_change_connection;
206 boost::signals2::scoped_connection _playlist_content_change_connection;