2 Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef DCPOMATIC_PLAYER_H
21 #define DCPOMATIC_PLAYER_H
24 #include <boost/shared_ptr.hpp>
25 #include <boost/enable_shared_from_this.hpp>
30 #include "audio_merger.h"
31 #include "audio_content.h"
41 /** @class PlayerImage
42 * @brief A wrapper for an Image which contains some pending operations; these may
43 * not be necessary if the receiver of the PlayerImage throws it away.
48 PlayerImage (boost::shared_ptr<const Image>, Crop, dcp::Size, dcp::Size, Scaler const *);
50 void set_subtitle (boost::shared_ptr<const Image>, Position<int>);
52 boost::shared_ptr<Image> image (AVPixelFormat, bool);
55 boost::shared_ptr<const Image> _in;
57 dcp::Size _inter_size;
59 Scaler const * _scaler;
60 boost::shared_ptr<const Image> _subtitle_image;
61 Position<int> _subtitle_position;
64 class PlayerStatistics
93 void dump (boost::shared_ptr<Log>) const;
97 * @brief A class which can `play' a Playlist; emitting its audio and video.
100 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
103 Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
105 void disable_video ();
106 void disable_audio ();
109 void seek (DCPTime, bool);
111 DCPTime video_position () const {
112 return _video_position;
115 void set_video_container_size (dcp::Size);
116 void set_approximate_size ();
118 bool repeat_last_video ();
120 PlayerStatistics const & statistics () const;
122 /** Emitted when a video frame is ready.
123 * First parameter is the video image.
124 * Second parameter is the eye(s) that should see this image.
125 * Third parameter is the colour conversion that should be used for this image.
126 * Fourth parameter is true if the image is the same as the last one that was emitted.
127 * Fifth parameter is the time.
129 boost::signals2::signal<void (boost::shared_ptr<PlayerImage>, Eyes, ColourConversion, bool, DCPTime)> Video;
131 /** Emitted when some audio data is ready */
132 boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, DCPTime)> Audio;
134 /** Emitted when something has changed such that if we went back and emitted
135 * the last frame again it would look different. This is not emitted after
138 * The parameter is true if these signals are currently likely to be frequent.
140 boost::signals2::signal<void (bool)> Changed;
143 friend class PlayerWrapper;
146 void setup_pieces ();
147 void playlist_changed ();
148 void content_changed (boost::weak_ptr<Content>, int, bool);
149 void do_seek (DCPTime, bool);
152 void emit_silence (DCPTime);
153 void film_changed (Film::Property);
154 void update_subtitle_from_image ();
155 void update_subtitle_from_text ();
156 void emit_video (boost::weak_ptr<Piece>, boost::shared_ptr<DecodedVideo>);
157 void emit_audio (boost::weak_ptr<Piece>, boost::shared_ptr<DecodedAudio>);
158 void step_video_position (boost::shared_ptr<DecodedVideo>);
160 boost::shared_ptr<const Film> _film;
161 boost::shared_ptr<const Playlist> _playlist;
166 /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
167 bool _have_valid_pieces;
168 std::list<boost::shared_ptr<Piece> > _pieces;
170 /** The time after the last video that we emitted */
171 DCPTime _video_position;
172 /** The time after the last audio that we emitted */
173 DCPTime _audio_position;
175 AudioMerger _audio_merger;
177 dcp::Size _video_container_size;
178 boost::shared_ptr<PlayerImage> _black_frame;
181 boost::weak_ptr<Piece> piece;
182 boost::shared_ptr<DecodedImageSubtitle> subtitle;
186 boost::weak_ptr<Piece> piece;
187 boost::shared_ptr<DecodedTextSubtitle> subtitle;
191 Position<int> position;
192 boost::shared_ptr<Image> image;
197 #ifdef DCPOMATIC_DEBUG
198 boost::shared_ptr<Content> _last_video;
201 bool _last_emit_was_black;
204 boost::weak_ptr<Piece> weak_piece;
205 boost::shared_ptr<DecodedVideo> video;
206 } _last_incoming_video;
208 bool _just_did_inaccurate_seek;
209 bool _approximate_size;
211 PlayerStatistics _statistics;
213 boost::signals2::scoped_connection _playlist_changed_connection;
214 boost::signals2::scoped_connection _playlist_content_changed_connection;
215 boost::signals2::scoped_connection _film_changed_connection;