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_content.h"
31 #include "dcpomatic_time.h"
32 #include "content_subtitle.h"
33 #include "position_image.h"
35 #include "content_video.h"
45 class PlayerVideoFrame;
48 class PlayerStatistics
77 void dump (boost::shared_ptr<Log>) const;
81 * @brief A class which can `play' a Playlist.
83 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
86 Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
88 std::list<boost::shared_ptr<PlayerVideoFrame> > get_video (DCPTime time, bool accurate);
89 boost::shared_ptr<AudioBuffers> get_audio (DCPTime time, DCPTime length, bool accurate);
91 void set_video_container_size (dcp::Size);
92 void set_approximate_size ();
93 void set_burn_subtitles (bool burn) {
94 _burn_subtitles = burn;
97 PlayerStatistics const & statistics () const;
99 /** Emitted when something has changed such that if we went back and emitted
100 * the last frame again it would look different. This is not emitted after
103 * The parameter is true if these signals are currently likely to be frequent.
105 boost::signals2::signal<void (bool)> Changed;
108 friend class PlayerWrapper;
110 friend class player_overlaps_test;
112 void setup_pieces ();
113 void playlist_changed ();
114 void content_changed (boost::weak_ptr<Content>, int, bool);
116 void film_changed (Film::Property);
117 std::list<PositionImage> process_content_image_subtitles (
118 boost::shared_ptr<SubtitleContent>, std::list<boost::shared_ptr<ContentImageSubtitle> >
120 std::list<PositionImage> process_content_text_subtitles (std::list<boost::shared_ptr<ContentTextSubtitle> >) const;
121 void update_subtitle_from_text ();
122 VideoFrame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
123 AudioFrame dcp_to_content_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
124 ContentTime dcp_to_content_subtitle (boost::shared_ptr<const Piece> piece, DCPTime t) const;
125 boost::shared_ptr<PlayerVideoFrame> black_player_video_frame () const;
126 boost::shared_ptr<PlayerVideoFrame> content_to_player_video_frame (
127 boost::shared_ptr<VideoContent> content,
128 ContentVideo content_video,
129 std::list<boost::shared_ptr<Piece> > subs,
134 /** @return Pieces of content type C that overlap a specified time range in the DCP */
136 std::list<boost::shared_ptr<Piece> >
137 overlaps (DCPTime from, DCPTime to)
139 if (!_have_valid_pieces) {
143 std::list<boost::shared_ptr<Piece> > overlaps;
144 for (typename std::list<boost::shared_ptr<Piece> >::const_iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
145 if (!boost::dynamic_pointer_cast<C> ((*i)->content)) {
149 if ((*i)->content->position() <= to && (*i)->content->end() >= from) {
150 overlaps.push_back (*i);
157 boost::shared_ptr<const Film> _film;
158 boost::shared_ptr<const Playlist> _playlist;
160 /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
161 bool _have_valid_pieces;
162 std::list<boost::shared_ptr<Piece> > _pieces;
164 dcp::Size _video_container_size;
165 boost::shared_ptr<Image> _black_image;
167 bool _approximate_size;
168 bool _burn_subtitles;
170 PlayerStatistics _statistics;
172 boost::signals2::scoped_connection _playlist_changed_connection;
173 boost::signals2::scoped_connection _playlist_content_changed_connection;
174 boost::signals2::scoped_connection _film_changed_connection;