2 Copyright (C) 2013-2015 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"
27 #include "position_image.h"
29 #include "content_video.h"
30 #include "content_audio.h"
31 #include "content_subtitle.h"
32 #include "audio_stream.h"
33 #include "audio_merger.h"
34 #include <boost/shared_ptr.hpp>
35 #include <boost/enable_shared_from_this.hpp>
46 class ReferencedReelAsset;
50 * @brief A class which can `play' a Playlist.
52 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
55 Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
58 void seek (DCPTime time, bool accurate);
60 std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
61 std::list<ReferencedReelAsset> get_reel_assets ();
63 void set_video_container_size (dcp::Size);
64 void set_ignore_video ();
65 void set_enable_subtitles (bool enable);
66 void set_always_burn_subtitles (bool burn);
68 void set_play_referenced ();
70 /** Emitted when something has changed such that if we went back and emitted
71 * the last frame again it would look different. This is not emitted after
74 * The parameter is true if these signals are currently likely to be frequent.
76 boost::signals2::signal<void (bool)> Changed;
78 boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
79 boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
80 /** Emitted when a subtitle is ready. This signal may be emitted considerably
81 * after the corresponding Video.
83 boost::signals2::signal<void (PlayerSubtitles, DCPTimePeriod)> Subtitle;
86 friend class PlayerWrapper;
88 friend struct player_overlaps_test;
89 friend struct player_time_calculation_test1;
90 friend struct player_time_calculation_test2;
91 friend struct player_time_calculation_test3;
95 void film_changed (Film::Property);
96 void playlist_changed ();
97 void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
98 std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
99 Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
100 DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
101 Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
102 DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
103 ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
104 DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
105 boost::shared_ptr<PlayerVideo> black_player_video_frame () const;
106 std::list<boost::shared_ptr<Piece> > overlaps (DCPTime from, DCPTime to, boost::function<bool (Content *)> valid);
107 void video (boost::weak_ptr<Piece>, ContentVideo);
108 void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
109 void image_subtitle_start (boost::weak_ptr<Piece>, ContentImageSubtitle);
110 void text_subtitle_start (boost::weak_ptr<Piece>, ContentTextSubtitle);
111 void subtitle_stop (boost::weak_ptr<Piece>, ContentTime);
112 boost::shared_ptr<Resampler> resampler (boost::shared_ptr<const AudioContent> content, AudioStreamPtr stream, bool create);
113 DCPTime one_video_frame () const;
114 void fill_video (DCPTimePeriod period);
115 void fill_audio (DCPTimePeriod period);
116 void audio_flush (boost::shared_ptr<Piece>, AudioStreamPtr stream);
117 void audio_transform (boost::shared_ptr<AudioContent> content, AudioStreamPtr stream, ContentAudio content_audio, DCPTime time);
118 std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
119 boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
122 boost::shared_ptr<const Film> _film;
123 boost::shared_ptr<const Playlist> _playlist;
125 /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
126 bool _have_valid_pieces;
127 std::list<boost::shared_ptr<Piece> > _pieces;
129 /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
130 dcp::Size _video_container_size;
131 boost::shared_ptr<Image> _black_image;
133 /** true if the player should ignore all video; i.e. never produce any */
135 /** true if the player should ignore all audio; i.e. never produce any */
137 /** true if the player should always burn subtitles into the video regardless
140 bool _always_burn_subtitles;
141 /** true if we should try to be fast rather than high quality */
143 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
144 bool _play_referenced;
146 /** Last PlayerVideo that was emitted */
147 boost::shared_ptr<PlayerVideo> _last_video;
148 /** Time just after the last video frame we emitted, or the last seek time */
149 boost::optional<DCPTime> _last_video_time;
150 /** Time just after the last audio frame we emitted, or the last seek time */
151 boost::optional<DCPTime> _last_audio_time;
153 AudioMerger _audio_merger;
160 StreamState (boost::shared_ptr<Piece> p, DCPTime l)
165 boost::shared_ptr<Piece> piece;
166 DCPTime last_push_end;
168 std::map<AudioStreamPtr, StreamState> _stream_states;
170 std::list<DCPTimePeriod> _no_video;
171 std::list<DCPTimePeriod> _no_audio;
173 class ActiveSubtitles
176 ActiveSubtitles () {}
178 ActiveSubtitles (PlayerSubtitles s, DCPTime f)
183 PlayerSubtitles subs;
185 boost::optional<DCPTime> to;
187 typedef std::map<boost::weak_ptr<Piece>, ActiveSubtitles> ActiveSubtitlesMap;
188 ActiveSubtitlesMap _active_subtitles;
190 boost::shared_ptr<AudioProcessor> _audio_processor;
191 typedef std::map<std::pair<boost::shared_ptr<const AudioContent>, AudioStreamPtr>, boost::shared_ptr<Resampler> > ResamplerMap;
192 ResamplerMap _resamplers;
194 boost::signals2::scoped_connection _film_changed_connection;
195 boost::signals2::scoped_connection _playlist_changed_connection;
196 boost::signals2::scoped_connection _playlist_content_changed_connection;