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;
49 * @brief A class which can `play' a Playlist.
51 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
54 Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
57 void seek (DCPTime time, bool accurate);
59 std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
60 std::list<ReferencedReelAsset> get_reel_assets ();
62 void set_video_container_size (dcp::Size);
63 void set_ignore_video ();
64 void set_ignore_audio ();
65 void set_enable_subtitles (bool enable);
66 void set_always_burn_subtitles (bool burn);
68 void set_play_referenced ();
70 /** Emitted when something has changed such that if we went back and emitted
71 * the last frame again it would look different. This is not emitted after
74 * The parameter is true if these signals are currently likely to be frequent.
76 boost::signals2::signal<void (bool)> Changed;
78 boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>)> Video;
79 boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
80 boost::signals2::signal<void (PlayerSubtitles)> Subtitle;
83 friend class PlayerWrapper;
85 friend struct player_overlaps_test;
86 friend struct player_time_calculation_test1;
87 friend struct player_time_calculation_test2;
88 friend struct player_time_calculation_test3;
92 void film_changed (Film::Property);
93 void playlist_changed ();
94 void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
95 std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
96 void update_subtitle_from_text ();
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 (DCPTime) 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);
110 boost::shared_ptr<const Film> _film;
111 boost::shared_ptr<const Playlist> _playlist;
113 /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
114 bool _have_valid_pieces;
115 std::list<boost::shared_ptr<Piece> > _pieces;
117 /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
118 dcp::Size _video_container_size;
119 boost::shared_ptr<Image> _black_image;
121 /** true if the player should ignore all video; i.e. never produce any */
123 /** true if the player should ignore all audio; i.e. never produce any */
125 /** true if the player should always burn subtitles into the video regardless
128 bool _always_burn_subtitles;
129 /** true if we should try to be fast rather than high quality */
131 /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
132 bool _play_referenced;
134 boost::shared_ptr<PlayerVideo> _last_video;
135 boost::optional<DCPTime> _last_video_time;
137 AudioMerger _audio_merger;
138 DCPTime _last_audio_time;
140 std::list<PlayerSubtitles> _subtitles;
142 boost::shared_ptr<AudioProcessor> _audio_processor;
144 boost::signals2::scoped_connection _film_changed_connection;
145 boost::signals2::scoped_connection _playlist_changed_connection;
146 boost::signals2::scoped_connection _playlist_content_changed_connection;