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_subtitles.h"
25 #include "active_subtitles.h"
28 #include "position_image.h"
30 #include "content_video.h"
31 #include "content_audio.h"
32 #include "content_subtitle.h"
33 #include "audio_stream.h"
34 #include "audio_merger.h"
37 #include <boost/shared_ptr.hpp>
38 #include <boost/enable_shared_from_this.hpp>
49 class ReferencedReelAsset;
53 * @brief A class which can `play' a Playlist.
55 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
58 Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
62 void seek (DCPTime time, bool accurate);
64 std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
65 std::list<ReferencedReelAsset> get_reel_assets ();
67 void set_video_container_size (dcp::Size);
68 void set_ignore_video ();
69 void set_ignore_subtitle ();
70 void set_always_burn_subtitles (bool burn);
72 void set_play_referenced ();
73 void set_dcp_decode_reduction (boost::optional<int> reduction);
75 /** Emitted when something has changed such that if we went back and emitted
76 * the last frame again it would look different. This is not emitted after
79 * The parameter is true if these signals are currently likely to be frequent.
81 boost::signals2::signal<void (bool)> Changed;
83 /** Emitted when a video frame is ready. These emissions happen in the correct order. */
84 boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
85 boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
86 /** Emitted when a subtitle is ready. This signal may be emitted considerably
87 * after the corresponding Video.
89 boost::signals2::signal<void (PlayerSubtitles, DCPTimePeriod)> Subtitle;
92 friend class PlayerWrapper;
94 friend struct player_time_calculation_test1;
95 friend struct player_time_calculation_test2;
96 friend struct player_time_calculation_test3;
97 friend struct player_subframe_test;
101 void film_changed (Film::Property);
102 void playlist_changed ();
103 void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
104 std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
105 Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
106 DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
107 Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
108 DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
109 ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
110 DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
111 boost::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
112 void video (boost::weak_ptr<Piece>, ContentVideo);
113 void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
114 void image_subtitle_start (boost::weak_ptr<Piece>, ContentImageSubtitle);
115 void text_subtitle_start (boost::weak_ptr<Piece>, ContentTextSubtitle);
116 void subtitle_stop (boost::weak_ptr<Piece>, ContentTime);
117 DCPTime one_video_frame () const;
118 void fill_audio (DCPTimePeriod period);
119 std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
120 boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
122 boost::optional<PositionImage> subtitles_for_frame (DCPTime time) const;
123 void emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
124 void emit_audio (boost::shared_ptr<AudioBuffers> data, DCPTime time);
126 boost::shared_ptr<const Film> _film;
127 boost::shared_ptr<const Playlist> _playlist;
129 /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
130 bool _have_valid_pieces;
131 std::list<boost::shared_ptr<Piece> > _pieces;
133 /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
134 dcp::Size _video_container_size;
135 boost::shared_ptr<Image> _black_image;
137 /** true if the player should ignore all video; i.e. never produce any */
139 /** true if the player should ignore all audio; i.e. never produce any */
140 bool _ignore_subtitle;
141 /** true if the player should always burn subtitles into the video regardless
144 bool _always_burn_subtitles;
145 /** true if we should try to be fast rather than high quality */
147 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
148 bool _play_referenced;
150 /** Time just after the last video frame we emitted, or the time of the last accurate seek */
151 boost::optional<DCPTime> _last_video_time;
152 boost::optional<Eyes> _last_video_eyes;
153 /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
154 boost::optional<DCPTime> _last_audio_time;
156 boost::optional<int> _dcp_decode_reduction;
158 typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
159 LastVideoMap _last_video;
161 AudioMerger _audio_merger;
170 StreamState (boost::shared_ptr<Piece> p, DCPTime l)
175 boost::shared_ptr<Piece> piece;
176 DCPTime last_push_end;
178 std::map<AudioStreamPtr, StreamState> _stream_states;
183 ActiveSubtitles _active_subtitles;
184 boost::shared_ptr<AudioProcessor> _audio_processor;
186 boost::signals2::scoped_connection _film_changed_connection;
187 boost::signals2::scoped_connection _playlist_changed_connection;
188 boost::signals2::scoped_connection _playlist_content_changed_connection;