2 Copyright (C) 2014-2022 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/>.
22 #ifndef DCPOMATIC_DCP_CONTENT_H
23 #define DCPOMATIC_DCP_CONTENT_H
26 /** @file src/lib/dcp_content.h
27 * @brief DCPContent class.
33 #include <libcxml/cxml.h>
34 #include <dcp/encrypted_kdm.h>
35 #include <dcp/rating.h>
38 class DCPContentProperty
41 static int const NEEDS_KDM;
42 static int const NEEDS_ASSETS;
43 static int const REFERENCE_VIDEO;
44 static int const REFERENCE_AUDIO;
45 static int const REFERENCE_TEXT;
46 static int const NAME;
47 static int const TEXTS;
53 * @brief An existing DCP used as input.
55 class DCPContent : public Content
58 DCPContent (boost::filesystem::path p);
59 DCPContent (cxml::ConstNodePtr, int version);
61 std::shared_ptr<DCPContent> shared_from_this () {
62 return std::dynamic_pointer_cast<DCPContent> (Content::shared_from_this ());
65 std::shared_ptr<const DCPContent> shared_from_this () const {
66 return std::dynamic_pointer_cast<const DCPContent> (Content::shared_from_this ());
69 dcpomatic::DCPTime full_length (std::shared_ptr<const Film> film) const override;
70 dcpomatic::DCPTime approximate_length () const override;
72 void examine (std::shared_ptr<const Film> film, std::shared_ptr<Job>) override;
73 std::string summary () const override;
74 std::string technical_summary () const override;
75 void as_xml (xmlpp::Node *, bool with_paths) const override;
76 std::string identifier () const override;
77 void take_settings_from (std::shared_ptr<const Content> c) override;
79 void set_default_colour_conversion ();
80 std::list<dcpomatic::DCPTime> reel_split_points (std::shared_ptr<const Film> film) const override;
82 std::vector<boost::filesystem::path> directories () const;
84 bool encrypted () const {
85 boost::mutex::scoped_lock lm (_mutex);
89 void add_kdm (dcp::EncryptedKDM);
90 void add_ov (boost::filesystem::path ov);
92 boost::optional<dcp::EncryptedKDM> kdm () const {
96 bool can_be_played () const override;
97 bool needs_kdm () const;
98 bool needs_assets () const;
100 void set_reference_video (bool r);
102 bool reference_video () const {
103 boost::mutex::scoped_lock lm (_mutex);
104 return _reference_video;
107 bool can_reference_video (std::shared_ptr<const Film> film, std::string &) const;
109 void set_reference_audio (bool r);
111 bool reference_audio () const {
112 boost::mutex::scoped_lock lm (_mutex);
113 return _reference_audio;
116 bool can_reference_audio (std::shared_ptr<const Film> film, std::string &) const;
118 void set_reference_text (TextType type, bool r);
120 /** @param type Original type of texts in the DCP.
121 * @return true if these texts are to be referenced.
123 bool reference_text (TextType type) const {
124 boost::mutex::scoped_lock lm (_mutex);
125 return _reference_text[static_cast<int>(type)];
128 bool can_reference_text (std::shared_ptr<const Film> film, TextType type, std::string &) const;
130 void set_cpl (std::string id);
132 boost::optional<std::string> cpl () const {
133 boost::mutex::scoped_lock lm (_mutex);
137 std::string name () const {
138 boost::mutex::scoped_lock lm (_mutex);
142 bool three_d () const {
143 boost::mutex::scoped_lock lm (_mutex);
147 boost::optional<dcp::ContentKind> content_kind () const {
148 boost::mutex::scoped_lock lm (_mutex);
149 return _content_kind;
152 dcp::Standard standard () const {
153 boost::mutex::scoped_lock lm (_mutex);
154 DCPOMATIC_ASSERT (_standard);
155 return _standard.get ();
158 std::map<dcp::Marker, dcpomatic::ContentTime> markers () const {
162 bool kdm_timing_window_valid () const;
164 Resolution resolution () const;
166 std::vector<dcp::Rating> ratings () const {
170 std::vector<std::string> content_versions () const {
171 return _content_versions;
174 void check_font_ids();
177 friend struct reels_test5;
179 void add_properties (std::shared_ptr<const Film> film, std::list<UserProperty>& p) const override;
181 void read_directory (boost::filesystem::path);
182 void read_sub_directory (boost::filesystem::path);
183 std::list<dcpomatic::DCPTimePeriod> reels (std::shared_ptr<const Film> film) const;
185 std::shared_ptr<const Film> film,
186 std::function <bool (std::shared_ptr<const Content>)>,
187 std::string overlapping,
192 /** true if our DCP is encrypted */
194 /** true if this DCP needs more assets before it can be played */
196 boost::optional<dcp::EncryptedKDM> _kdm;
197 /** true if _kdm successfully decrypts the first frame of our DCP */
199 /** true if the video in this DCP should be included in the output by reference
200 * rather than by rewrapping.
202 bool _reference_video;
203 /** true if the audio in this DCP should be included in the output by reference
204 * rather than by rewrapping.
206 bool _reference_audio;
207 /** true if the texts in this DCP should be included in the output by reference
208 * rather than by rewrapping. The types here are the original text types,
209 * not what they are being used for.
211 bool _reference_text[static_cast<int>(TextType::COUNT)];
213 boost::optional<dcp::Standard> _standard;
214 boost::optional<dcp::ContentKind> _content_kind;
216 /** ID of the CPL to use; older metadata might not specify this: in that case
217 * just use the only CPL.
219 boost::optional<std::string> _cpl;
220 /** List of the lengths of the reels in this DCP */
221 std::list<int64_t> _reel_lengths;
222 std::map<dcp::Marker, dcpomatic::ContentTime> _markers;
223 std::vector<dcp::Rating> _ratings;
224 std::vector<std::string> _content_versions;
228 extern std::string id_for_font_in_reel(std::string id, int reel);
229 extern void add_fonts_from_examiner(std::shared_ptr<TextContent> text, std::vector<std::vector<std::shared_ptr<dcpomatic::Font>>> const& fonts);