summaryrefslogtreecommitdiff
path: root/src/lib/dcp_content.h
blob: 16c546e96c122a224c57b5d0019fc8361b08366c (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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*
    Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>

    This file is part of DCP-o-matic.

    DCP-o-matic 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.

    DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef DCPOMATIC_DCP_CONTENT_H
#define DCPOMATIC_DCP_CONTENT_H

/** @file  src/lib/dcp_content.h
 *  @brief DCPContent class.
 */

#include "content.h"
#include <libcxml/cxml.h>
#include <dcp/encrypted_kdm.h>

class DCPContentProperty
{
public:
	static int const NEEDS_KDM;
	static int const NEEDS_ASSETS;
	static int const REFERENCE_VIDEO;
	static int const REFERENCE_AUDIO;
	static int const REFERENCE_TEXT;
	static int const NAME;
	static int const TEXTS;
	static int const CPL;
};

class ContentPart;

/** @class DCPContent
 *  @brief An existing DCP used as input.
 */
class DCPContent : public Content
{
public:
	DCPContent (boost::filesystem::path p);
	DCPContent (cxml::ConstNodePtr, int version);

	boost::shared_ptr<DCPContent> shared_from_this () {
		return boost::dynamic_pointer_cast<DCPContent> (Content::shared_from_this ());
	}

	boost::shared_ptr<const DCPContent> shared_from_this () const {
		return boost::dynamic_pointer_cast<const DCPContent> (Content::shared_from_this ());
	}

	dcpomatic::DCPTime full_length (boost::shared_ptr<const Film> film) const;
	dcpomatic::DCPTime approximate_length () const;

	void examine (boost::shared_ptr<const Film> film, boost::shared_ptr<Job>);
	std::string summary () const;
	std::string technical_summary () const;
	void as_xml (xmlpp::Node *, bool with_paths) const;
	std::string identifier () const;
	void take_settings_from (boost::shared_ptr<const Content> c);

	void set_default_colour_conversion ();
	std::list<dcpomatic::DCPTime> reel_split_points (boost::shared_ptr<const Film> film) const;

	std::string video_processing_description (boost::shared_ptr<const Film> film) const;

	std::vector<boost::filesystem::path> directories () const;

	bool encrypted () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _encrypted;
	}

	void add_kdm (dcp::EncryptedKDM);
	void add_ov (boost::filesystem::path ov);

	boost::optional<dcp::EncryptedKDM> kdm () const {
		return _kdm;
	}

	bool can_be_played () const;
	bool needs_kdm () const;
	bool needs_assets () const;

	void set_reference_video (bool r);

	bool reference_video () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _reference_video;
	}

	bool can_reference_video (boost::shared_ptr<const Film> film, std::string &) const;

	void set_reference_audio (bool r);

	bool reference_audio () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _reference_audio;
	}

	bool can_reference_audio (boost::shared_ptr<const Film> film, std::string &) const;

	void set_reference_text (TextType type, bool r);

	/** @param type Original type of texts in the DCP.
	 *  @return true if these texts are to be referenced.
	 */
	bool reference_text (TextType type) const {
		boost::mutex::scoped_lock lm (_mutex);
		return _reference_text[type];
	}

	bool can_reference_text (boost::shared_ptr<const Film> film, TextType type, std::string &) const;

	void set_cpl (std::string id);

	boost::optional<std::string> cpl () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _cpl;
	}

	std::string name () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _name;
	}

	bool three_d () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _three_d;
	}

	boost::optional<dcp::ContentKind> content_kind () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _content_kind;
	}

	dcp::Standard standard () const {
		boost::mutex::scoped_lock lm (_mutex);
		DCPOMATIC_ASSERT (_standard);
		return _standard.get ();
	}

	std::map<dcp::Marker, dcpomatic::ContentTime> markers () const {
		return _markers;
	}

	bool kdm_timing_window_valid () const;

	Resolution resolution () const;

	std::vector<dcp::Rating> ratings () const {
		return _ratings;
	}

	std::string content_version () const {
		return _content_version;
	}

private:
	friend class reels_test5;

	void add_properties (boost::shared_ptr<const Film> film, std::list<UserProperty>& p) const;

	void read_directory (boost::filesystem::path);
	void read_sub_directory (boost::filesystem::path);
	std::list<dcpomatic::DCPTimePeriod> reels (boost::shared_ptr<const Film> film) const;
	bool can_reference (
		boost::shared_ptr<const Film> film,
		boost::function <bool (boost::shared_ptr<const Content>)>,
		std::string overlapping,
		std::string& why_not
		) const;

	std::string _name;
	/** true if our DCP is encrypted */
	bool _encrypted;
	/** true if this DCP needs more assets before it can be played */
	bool _needs_assets;
	boost::optional<dcp::EncryptedKDM> _kdm;
	/** true if _kdm successfully decrypts the first frame of our DCP */
	bool _kdm_valid;
	/** true if the video in this DCP should be included in the output by reference
	 *  rather than by rewrapping.
	 */
	bool _reference_video;
	/** true if the audio in this DCP should be included in the output by reference
	 *  rather than by rewrapping.
	 */
	bool _reference_audio;
	/** true if the texts in this DCP should be included in the output by reference
	 *  rather than by rewrapping.  The types here are the original text types,
	 *  not what they are being used for.
	 */
	bool _reference_text[TEXT_COUNT];

	boost::optional<dcp::Standard> _standard;
	boost::optional<dcp::ContentKind> _content_kind;
	bool _three_d;
	/** ID of the CPL to use; older metadata might not specify this: in that case
	 *  just use the only CPL.
	 */
	boost::optional<std::string> _cpl;
	/** List of the lengths of the reels in this DCP */
	std::list<int64_t> _reel_lengths;
	std::map<dcp::Marker, dcpomatic::ContentTime> _markers;
	std::vector<dcp::Rating> _ratings;
	std::string _content_version;
};

#endif