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_ignore_audio ();
66 void set_enable_subtitles (bool enable);
67 void set_always_burn_subtitles (bool burn);
69 void set_play_referenced ();
71 /** Emitted when something has changed such that if we went back and emitted
72 * the last frame again it would look different. This is not emitted after
75 * The parameter is true if these signals are currently likely to be frequent.
77 boost::signals2::signal<void (bool)> Changed;
79 boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
80 boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
81 boost::signals2::signal<void (PlayerSubtitles, DCPTimePeriod)> Subtitle;
84 friend class PlayerWrapper;
86 friend struct player_overlaps_test;
87 friend struct player_time_calculation_test1;
88 friend struct player_time_calculation_test2;
89 friend struct player_time_calculation_test3;
93 void film_changed (Film::Property);
94 void playlist_changed ();
95 void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
96 std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
97 Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
98 DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
99 Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
100 DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
101 ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
102 DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
103 boost::shared_ptr<PlayerVideo> black_player_video_frame () const;
104 std::list<boost::shared_ptr<Piece> > overlaps (DCPTime from, DCPTime to, boost::function<bool (Content *)> valid);
105 void video (boost::weak_ptr<Piece>, ContentVideo);
106 void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
107 void image_subtitle (boost::weak_ptr<Piece>, ContentImageSubtitle);
108 void text_subtitle (boost::weak_ptr<Piece>, ContentTextSubtitle);
109 boost::shared_ptr<Resampler> resampler (boost::shared_ptr<const AudioContent> content, AudioStreamPtr stream, bool create);
110 DCPTime one_video_frame () const;
111 void fill_video (DCPTimePeriod period);
112 void fill_audio (DCPTimePeriod period);
113 void audio_flush (boost::shared_ptr<Piece>, AudioStreamPtr stream);
114 void audio_transform (boost::shared_ptr<AudioContent> content, AudioStreamPtr stream, ContentAudio content_audio, DCPTime time);
116 boost::shared_ptr<const Film> _film;
117 boost::shared_ptr<const Playlist> _playlist;
119 /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
120 bool _have_valid_pieces;
121 std::list<boost::shared_ptr<Piece> > _pieces;
123 /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
124 dcp::Size _video_container_size;
125 boost::shared_ptr<Image> _black_image;
127 /** true if the player should ignore all video; i.e. never produce any */
129 /** true if the player should ignore all audio; i.e. never produce any */
131 /** true if the player should always burn subtitles into the video regardless
134 bool _always_burn_subtitles;
135 /** true if we should try to be fast rather than high quality */
137 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
138 bool _play_referenced;
140 /** Last PlayerVideo that was emitted */
141 boost::shared_ptr<PlayerVideo> _last_video;
142 /** Time of the last video we emitted, or the last seek time */
143 boost::optional<DCPTime> _last_video_time;
145 AudioMerger _audio_merger;
146 boost::optional<DCPTime> _last_audio_time;
152 StreamState (boost::shared_ptr<Piece> p, DCPTime l)
157 boost::shared_ptr<Piece> piece;
158 DCPTime last_push_end;
160 std::map<AudioStreamPtr, StreamState> _stream_states;
162 std::list<DCPTimePeriod> _no_video;
163 std::list<DCPTimePeriod> _no_audio;
165 std::list<std::pair<PlayerSubtitles, DCPTimePeriod> > _subtitles;
167 boost::shared_ptr<AudioProcessor> _audio_processor;
168 typedef std::map<std::pair<boost::shared_ptr<const AudioContent>, AudioStreamPtr>, boost::shared_ptr<Resampler> > ResamplerMap;
169 ResamplerMap _resamplers;
171 boost::signals2::scoped_connection _film_changed_connection;
172 boost::signals2::scoped_connection _playlist_changed_connection;
173 boost::signals2::scoped_connection _playlist_content_changed_connection;