2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
6 libdcp 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 libdcp 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 libdcp. If not, see <http://www.gnu.org/licenses/>.
19 In addition, as a special exception, the copyright holders give
20 permission to link the code of portions of this program with the
21 OpenSSL library under certain conditions as described in each
22 individual source file, and distribute linked combinations
25 You must obey the GNU General Public License in all respects
26 for all of the code used other than OpenSSL. If you modify
27 file(s) with this exception, you may extend this exception to your
28 version of the file(s), but you are not obligated to do so. If you
29 do not wish to do so, delete this exception statement from your
30 version. If you delete this exception statement from all source
31 files in the program, then also delete it here.
44 #include "certificate.h"
45 #include "compose.hpp"
47 #include "name_format.h"
52 #include <boost/signals2.hpp>
64 /** @brief Namespace for everything in libdcp */
73 class CertificateChain;
80 * @brief A class to create or read a DCP
85 /** Construct a DCP. You can pass an existing DCP's directory
86 * as the parameter; alternatively, directory will be created
87 * if it does not exist. Note that if you pass an existing DCP
88 * into this constructor it will not be read until you call ::read().
90 * @param directory Directory containing the DCP's files.
92 explicit DCP (boost::filesystem::path directory);
94 DCP (DCP const&) = delete;
95 DCP& operator= (DCP const&) = delete;
97 /** Read a DCP. This method does not do any deep checking of the DCP's validity, but
98 * if it comes across any bad things it will do one of two things.
100 * Errors that are so serious that they prevent the method from working will result
101 * in an exception being thrown. For example, a missing ASSETMAP means that the DCP
102 * can't be read without a lot of guesswork, so this will throw.
104 * Errors that are not fatal will be added to notes, if it's non-null. For example,
105 * if the DCP contains a mixture of Interop and SMPTE elements this will result
106 * in a note being added to the vector.
108 * For more thorough checking of a DCP's contents, see dcp::verify().
110 * @param notes List of notes that will be added to if non-0.
111 * @param ignore_incorrect_picture_mxf_type true to try loading MXF files marked as monoscopic
112 * as stereoscopic if the monoscopic load fails; fixes problems some 3D DCPs that (I think)
113 * have an incorrect descriptor in their MXF.
115 void read (std::vector<VerificationNote>* notes = nullptr, bool ignore_incorrect_picture_mxf_type = false);
117 /** Compare this DCP with another, according to various options.
118 * @param other DCP to compare this one to.
119 * @param options Options to define what "equality" means.
120 * @param note Functor to handle notes made by the equality operation.
121 * @return true if the DCPs are equal according to EqualityOptions, otherwise false.
123 bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const;
125 void add (std::shared_ptr<CPL> cpl);
127 std::vector<std::shared_ptr<CPL>> cpls () const;
129 /** @param ignore_unresolved true to silently ignore unresolved assets, otherwise
130 * an exception is thrown if they are found.
131 * @return All assets (including CPLs).
133 std::vector<std::shared_ptr<Asset>> assets (bool ignore_unresolved = false) const;
135 bool any_encrypted () const;
136 bool all_encrypted () const;
138 /** Add a KDM to decrypt this DCP. This method must be called after DCP::read()
139 * or the KDM you specify will be ignored.
140 * @param kdm KDM to use.
142 void add (DecryptedKDM const &);
144 /** Write all the XML files for this DCP
145 * @param standand INTEROP or SMPTE
146 * @param issuer Value for the PKL and AssetMap <Issuer> tags
147 * @param creator Value for the PKL and AssetMap <Creator> tags
148 * @param issue_date Value for the PKL and AssetMap <IssueDate> tags
149 * @param annotation_text Value for the PKL and AssetMap <AnnotationText> tags
150 * @param signer Signer to use
151 * @param name_format Name format to use for the CPL and PKL filenames
154 std::string issuer = String::compose("libdcp %1", dcp::version),
155 std::string creator = String::compose("libdcp %1", dcp::version),
156 std::string issue_date = LocalTime().as_string(),
157 std::string annotation_text = String::compose("Created by libdcp %1", dcp::version),
158 std::shared_ptr<const CertificateChain> signer = std::shared_ptr<const CertificateChain>(),
159 NameFormat name_format = NameFormat("%t")
162 void resolve_refs (std::vector<std::shared_ptr<Asset>> assets);
164 /** @return Standard of a DCP that was read in */
165 boost::optional<Standard> standard () const {
169 boost::filesystem::path directory () const {
173 /** @return PKLs if this DCP was read from an existing one, or if write_xml() has been called on it.
174 * If neither is true, this method returns an empty vector.
176 std::vector<std::shared_ptr<PKL>> pkls () const {
180 boost::optional<boost::filesystem::path> asset_map_path () {
184 static std::vector<boost::filesystem::path> directories_from_files (std::vector<boost::filesystem::path> files);
188 void write_volindex (Standard standard) const;
190 /** Write the ASSETMAP file.
191 * @param pkl_uuid UUID of our PKL.
192 * @param pkl_path Pathname of our PKL file.
194 void write_assetmap (
195 Standard standard, std::string pkl_uuid, boost::filesystem::path pkl_path,
196 std::string issuer, std::string creator, std::string issue_date, std::string annotation_text
199 /** The directory that we are writing to */
200 boost::filesystem::path _directory;
201 /** The CPLs that make up this DCP */
202 std::vector<std::shared_ptr<CPL>> _cpls;
203 /** The PKLs that make up this DCP */
204 std::vector<std::shared_ptr<PKL>> _pkls;
205 /** File that the ASSETMAP was read from or last written to */
206 mutable boost::optional<boost::filesystem::path> _asset_map;
208 /** Standard of DCP that was read in */
209 boost::optional<Standard> _standard;