2 Copyright (C) 2013-2015 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
23 #include "player_subtitles.h"
26 #include "position_image.h"
28 #include <boost/shared_ptr.hpp>
29 #include <boost/enable_shared_from_this.hpp>
42 * @brief A class which can `play' a Playlist.
44 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
47 Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
49 std::list<boost::shared_ptr<PlayerVideo> > get_video (DCPTime time, bool accurate);
50 boost::shared_ptr<AudioBuffers> get_audio (DCPTime time, DCPTime length, bool accurate);
51 PlayerSubtitles get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt);
52 std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
53 std::list<boost::shared_ptr<dcp::ReelAsset> > get_reel_assets ();
55 void set_video_container_size (dcp::Size);
56 void set_ignore_video ();
57 void set_ignore_audio ();
58 void set_enable_subtitles (bool enable);
59 void set_always_burn_subtitles (bool burn);
61 void set_play_referenced ();
63 /** Emitted when something has changed such that if we went back and emitted
64 * the last frame again it would look different. This is not emitted after
67 * The parameter is true if these signals are currently likely to be frequent.
69 boost::signals2::signal<void (bool)> Changed;
72 friend class PlayerWrapper;
74 friend struct player_overlaps_test;
75 friend struct player_time_calculation_test1;
76 friend struct player_time_calculation_test2;
77 friend struct player_time_calculation_test3;
81 void film_changed (Film::Property);
82 void playlist_changed ();
83 void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
84 std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
85 void update_subtitle_from_text ();
86 Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
87 DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
88 Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
89 ContentTime dcp_to_content_subtitle (boost::shared_ptr<const Piece> piece, DCPTime t) const;
90 boost::shared_ptr<PlayerVideo> black_player_video_frame (DCPTime) const;
92 /** @return Pieces of content type C that overlap a specified time range in the DCP */
94 std::list<boost::shared_ptr<Piece> >
95 overlaps (DCPTime from, DCPTime to)
97 if (!_have_valid_pieces) {
101 std::list<boost::shared_ptr<Piece> > overlaps;
102 for (typename std::list<boost::shared_ptr<Piece> >::const_iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
103 if (!boost::dynamic_pointer_cast<C> ((*i)->content)) {
107 if ((*i)->content->position() <= to && (*i)->content->end() >= from) {
108 overlaps.push_back (*i);
115 boost::shared_ptr<const Film> _film;
116 boost::shared_ptr<const Playlist> _playlist;
118 /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
119 bool _have_valid_pieces;
120 std::list<boost::shared_ptr<Piece> > _pieces;
122 /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
123 dcp::Size _video_container_size;
124 boost::shared_ptr<Image> _black_image;
126 /** true if the player should ignore all video; i.e. never produce any */
128 /** true if the player should ignore all audio; i.e. never produce any */
130 /** true if the player should always burn subtitles into the video regardless
133 bool _always_burn_subtitles;
134 /** true if we should try to be fast rather than high quality */
136 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
137 bool _play_referenced;
139 boost::shared_ptr<AudioProcessor> _audio_processor;
141 boost::signals2::scoped_connection _film_changed_connection;
142 boost::signals2::scoped_connection _playlist_changed_connection;
143 boost::signals2::scoped_connection _playlist_content_changed_connection;