summaryrefslogtreecommitdiff
path: root/src/lib/player.h
blob: 52dffec24656a1edadcefab42756ea73bb6844d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/*
    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef DCPOMATIC_PLAYER_H
#define DCPOMATIC_PLAYER_H

#include "playlist.h"
#include "content.h"
#include "film.h"
#include "rect.h"
#include "audio_content.h"
#include "dcpomatic_time.h"
#include "content_subtitle.h"
#include "position_image.h"
#include "piece.h"
#include "content_video.h"
#include "player_subtitles.h"
#include <boost/shared_ptr.hpp>
#include <boost/enable_shared_from_this.hpp>
#include <list>

class Job;
class Film;
class Playlist;
class AudioContent;
class Piece;
class Image;
class Decoder;
class Resampler;
class PlayerVideo;
class ImageProxy;
 
class PlayerStatistics
{
public:
	struct Video {
		Video ()
			: black (0)
			, repeat (0)
			, good (0)
			, skip (0)
		{}
		
		int black;
		int repeat;
		int good;
		int skip;
	} video;

	struct Audio {
		Audio ()
			: silence (0)
			, good (0)
			, skip (0)
		{}
		
		DCPTime silence;
		int64_t good;
		int64_t skip;
	} audio;

	void dump (boost::shared_ptr<Log>) const;
};

/** @class Player
 *  @brief A class which can `play' a Playlist.
 */
class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
{
public:
	Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);

	std::list<boost::shared_ptr<PlayerVideo> > get_video (DCPTime time, bool accurate);
	boost::shared_ptr<AudioBuffers> get_audio (DCPTime time, DCPTime length, bool accurate);
	PlayerSubtitles get_subtitles (DCPTime time, DCPTime length, bool starting);
	std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();

	void set_video_container_size (dcp::Size);
	void set_ignore_video ();
	void set_enable_subtitles (bool enable);
	void set_burn_subtitles (bool burn);

	PlayerStatistics const & statistics () const;
	
	/** Emitted when something has changed such that if we went back and emitted
	 *  the last frame again it would look different.  This is not emitted after
	 *  a seek.
	 *
	 *  The parameter is true if these signals are currently likely to be frequent.
	 */
	boost::signals2::signal<void (bool)> Changed;

private:
	friend class PlayerWrapper;
	friend class Piece;
	friend struct player_overlaps_test;

	void setup_pieces ();
	void playlist_changed ();
	void content_changed (boost::weak_ptr<Content>, int, bool);
	void flush ();
	void film_changed (Film::Property);
	std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
	void update_subtitle_from_text ();
	Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
	DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
	Frame dcp_to_content_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
	ContentTime dcp_to_content_subtitle (boost::shared_ptr<const Piece> piece, DCPTime t) const;
	boost::shared_ptr<PlayerVideo> black_player_video_frame (DCPTime) const;

	/** @return Pieces of content type C that overlap a specified time range in the DCP */
	template<class C>
	std::list<boost::shared_ptr<Piece> >
	overlaps (DCPTime from, DCPTime to)
	{
		if (!_have_valid_pieces) {
			setup_pieces ();
		}

		std::list<boost::shared_ptr<Piece> > overlaps;
		for (typename std::list<boost::shared_ptr<Piece> >::const_iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
			if (!boost::dynamic_pointer_cast<C> ((*i)->content)) {
				continue;
			}

			if ((*i)->content->position() <= to && (*i)->content->end() >= from) {
				overlaps.push_back (*i);
			}
		}
		
		return overlaps;
	}
	
	boost::shared_ptr<const Film> _film;
	boost::shared_ptr<const Playlist> _playlist;

	/** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
	bool _have_valid_pieces;
	std::list<boost::shared_ptr<Piece> > _pieces;

	/** Size of the image in the DCP (e.g. 1990x1080 for flat) */
	dcp::Size _video_container_size;
	boost::shared_ptr<Image> _black_image;

	/** true if the player should ignore all video; i.e. never produce any */
	bool _ignore_video;
	/** true if the player should burn subtitles into the video */
	bool _burn_subtitles;

	boost::shared_ptr<AudioProcessor> _audio_processor;

	PlayerStatistics _statistics;

	boost::signals2::scoped_connection _playlist_changed_connection;
	boost::signals2::scoped_connection _playlist_content_changed_connection;
	boost::signals2::scoped_connection _film_changed_connection;
};

#endif