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 <boost/shared_ptr.hpp>
30 #include <boost/enable_shared_from_this.hpp>
41 class ReferencedReelAsset;
44 * @brief A class which can `play' a Playlist.
46 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
49 Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
51 std::list<boost::shared_ptr<PlayerVideo> > get_video (DCPTime time, bool accurate);
52 boost::shared_ptr<AudioBuffers> get_audio (DCPTime time, DCPTime length, bool accurate);
53 PlayerSubtitles get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt, bool accurate);
54 std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
55 std::list<ReferencedReelAsset> get_reel_assets ();
57 void set_video_container_size (dcp::Size);
58 void set_ignore_video ();
59 void set_ignore_audio ();
60 void set_enable_subtitles (bool enable);
61 void set_always_burn_subtitles (bool burn);
63 void set_play_referenced ();
65 /** Emitted when something has changed such that if we went back and emitted
66 * the last frame again it would look different. This is not emitted after
69 * The parameter is true if these signals are currently likely to be frequent.
71 boost::signals2::signal<void (bool)> Changed;
74 friend class PlayerWrapper;
76 friend struct player_overlaps_test;
77 friend struct player_time_calculation_test1;
78 friend struct player_time_calculation_test2;
79 friend struct player_time_calculation_test3;
83 void film_changed (Film::Property);
84 void playlist_changed ();
85 void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
86 std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
87 void update_subtitle_from_text ();
88 Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
89 DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
90 Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
91 ContentTime dcp_to_content_subtitle (boost::shared_ptr<const Piece> piece, DCPTime t) const;
92 DCPTime content_subtitle_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
93 boost::shared_ptr<PlayerVideo> black_player_video_frame (DCPTime) const;
94 std::list<boost::shared_ptr<Piece> > overlaps (DCPTime from, DCPTime to, boost::function<bool (Content *)> valid);
96 boost::shared_ptr<const Film> _film;
97 boost::shared_ptr<const Playlist> _playlist;
99 /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
100 bool _have_valid_pieces;
101 std::list<boost::shared_ptr<Piece> > _pieces;
103 /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
104 dcp::Size _video_container_size;
105 boost::shared_ptr<Image> _black_image;
107 /** true if the player should ignore all video; i.e. never produce any */
109 /** true if the player should ignore all audio; i.e. never produce any */
111 /** true if the player should always burn subtitles into the video regardless
114 bool _always_burn_subtitles;
115 /** true if we should try to be fast rather than high quality */
117 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
118 bool _play_referenced;
120 boost::shared_ptr<AudioProcessor> _audio_processor;
122 boost::signals2::scoped_connection _film_changed_connection;
123 boost::signals2::scoped_connection _playlist_changed_connection;
124 boost::signals2::scoped_connection _playlist_content_changed_connection;