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.
32 #include <libcxml/cxml.h>
33 #include <dcp/encrypted_kdm.h>
34 #include <dcp/rating.h>
37 class DCPContentProperty
40 static int const NEEDS_KDM;
41 static int const NEEDS_ASSETS;
42 static int const REFERENCE_VIDEO;
43 static int const REFERENCE_AUDIO;
44 static int const REFERENCE_TEXT;
45 static int const NAME;
46 static int const TEXTS;
52 * @brief An existing DCP used as input.
54 class DCPContent : public Content
57 DCPContent (boost::filesystem::path p);
58 DCPContent (cxml::ConstNodePtr, int version);
60 std::shared_ptr<DCPContent> shared_from_this () {
61 return std::dynamic_pointer_cast<DCPContent> (Content::shared_from_this ());
64 std::shared_ptr<const DCPContent> shared_from_this () const {
65 return std::dynamic_pointer_cast<const DCPContent> (Content::shared_from_this ());
68 dcpomatic::DCPTime full_length (std::shared_ptr<const Film> film) const override;
69 dcpomatic::DCPTime approximate_length () const override;
71 void examine (std::shared_ptr<const Film> film, std::shared_ptr<Job>) override;
72 std::string summary () const override;
73 std::string technical_summary () const override;
74 void as_xml (xmlpp::Node *, bool with_paths) const override;
75 std::string identifier () const override;
76 void take_settings_from (std::shared_ptr<const Content> c) override;
78 void set_default_colour_conversion ();
79 std::list<dcpomatic::DCPTime> reel_split_points (std::shared_ptr<const Film> film) const override;
81 std::vector<boost::filesystem::path> directories () const;
83 bool encrypted () const {
84 boost::mutex::scoped_lock lm (_mutex);
88 void add_kdm (dcp::EncryptedKDM);
89 void add_ov (boost::filesystem::path ov);
91 boost::optional<dcp::EncryptedKDM> kdm () const {
95 bool can_be_played () const;
96 bool needs_kdm () const;
97 bool needs_assets () const;
99 void set_reference_video (bool r);
101 bool reference_video () const {
102 boost::mutex::scoped_lock lm (_mutex);
103 return _reference_video;
106 bool can_reference_video (std::shared_ptr<const Film> film, std::string &) const;
108 void set_reference_audio (bool r);
110 bool reference_audio () const {
111 boost::mutex::scoped_lock lm (_mutex);
112 return _reference_audio;
115 bool can_reference_audio (std::shared_ptr<const Film> film, std::string &) const;
117 void set_reference_text (TextType type, bool r);
119 /** @param type Original type of texts in the DCP.
120 * @return true if these texts are to be referenced.
122 bool reference_text (TextType type) const {
123 boost::mutex::scoped_lock lm (_mutex);
124 return _reference_text[static_cast<int>(type)];
127 bool can_reference_text (std::shared_ptr<const Film> film, TextType type, std::string &) const;
129 void set_cpl (std::string id);
131 boost::optional<std::string> cpl () const {
132 boost::mutex::scoped_lock lm (_mutex);
136 std::string name () const {
137 boost::mutex::scoped_lock lm (_mutex);
141 bool three_d () const {
142 boost::mutex::scoped_lock lm (_mutex);
146 boost::optional<dcp::ContentKind> content_kind () const {
147 boost::mutex::scoped_lock lm (_mutex);
148 return _content_kind;
151 dcp::Standard standard () const {
152 boost::mutex::scoped_lock lm (_mutex);
153 DCPOMATIC_ASSERT (_standard);
154 return _standard.get ();
157 std::map<dcp::Marker, dcpomatic::ContentTime> markers () const {
161 bool kdm_timing_window_valid () const;
163 Resolution resolution () const;
165 std::vector<dcp::Rating> ratings () const {
169 std::vector<std::string> content_versions () const {
170 return _content_versions;
174 friend struct reels_test5;
176 void add_properties (std::shared_ptr<const Film> film, std::list<UserProperty>& p) const override;
178 void read_directory (boost::filesystem::path);
179 void read_sub_directory (boost::filesystem::path);
180 std::list<dcpomatic::DCPTimePeriod> reels (std::shared_ptr<const Film> film) const;
182 std::shared_ptr<const Film> film,
183 std::function <bool (std::shared_ptr<const Content>)>,
184 std::string overlapping,
189 /** true if our DCP is encrypted */
191 /** true if this DCP needs more assets before it can be played */
193 boost::optional<dcp::EncryptedKDM> _kdm;
194 /** true if _kdm successfully decrypts the first frame of our DCP */
196 /** true if the video in this DCP should be included in the output by reference
197 * rather than by rewrapping.
199 bool _reference_video;
200 /** true if the audio in this DCP should be included in the output by reference
201 * rather than by rewrapping.
203 bool _reference_audio;
204 /** true if the texts in this DCP should be included in the output by reference
205 * rather than by rewrapping. The types here are the original text types,
206 * not what they are being used for.
208 bool _reference_text[static_cast<int>(TextType::COUNT)];
210 boost::optional<dcp::Standard> _standard;
211 boost::optional<dcp::ContentKind> _content_kind;
213 /** ID of the CPL to use; older metadata might not specify this: in that case
214 * just use the only CPL.
216 boost::optional<std::string> _cpl;
217 /** List of the lengths of the reels in this DCP */
218 std::list<int64_t> _reel_lengths;
219 std::map<dcp::Marker, dcpomatic::ContentTime> _markers;
220 std::vector<dcp::Rating> _ratings;
221 std::vector<std::string> _content_versions;