2 Copyright (C) 2012-2014 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.
43 #include "certificate.h"
45 #include "name_format.h"
46 #include <boost/shared_ptr.hpp>
47 #include <boost/signals2.hpp>
56 /** @brief Namespace for everything in libdcp */
65 class CertificateChain;
71 * @brief A class to create or read a DCP.
74 class DCP : public boost::noncopyable
77 /** Construct a DCP. You can pass an existing DCP's directory
78 * as the parameter; alternatively, directory will be created
79 * if it does not exist. Note that if you pass an existing DCP
80 * into this constructor it will not be read until you call ::read().
82 * @param directory Directory containing the DCP's files.
84 explicit DCP (boost::filesystem::path directory);
86 typedef std::list<boost::shared_ptr<DCPReadError> > ReadErrors;
88 /** Read the DCP's structure into this object.
89 * @param keep_going true to try to keep going in the face of (some) errors.
90 * @param errors List of errors that will be added to if keep_going is true.
91 * @param ignore_incorrect_picture_mxf_type true to try loading MXF files marked as monoscopic
92 * as stereoscopic if the monoscopic load fails; fixes problems some 3D DCPs that (I think)
93 * have an incorrect descriptor in their MXF.
95 void read (bool keep_going = false, ReadErrors* errors = 0, bool ignore_incorrect_picture_mxf_type = false);
97 /** Compare this DCP with another, according to various options.
98 * @param other DCP to compare this one to.
99 * @param options Options to define what "equality" means.
100 * @param note Functor to handle notes made by the equality operation.
101 * @return true if the DCPs are equal according to EqualityOptions, otherwise false.
103 bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const;
105 void add (boost::shared_ptr<CPL> cpl);
107 std::list<boost::shared_ptr<CPL> > cpls () const;
108 std::list<boost::shared_ptr<Asset> > assets (bool ignore_unresolved = false) const;
110 bool encrypted () const;
112 void add (DecryptedKDM const &);
116 XMLMetadata metadata = XMLMetadata (),
117 boost::shared_ptr<const CertificateChain> signer = boost::shared_ptr<const CertificateChain> (),
118 NameFormat name_format = NameFormat("%t")
121 void resolve_refs (std::list<boost::shared_ptr<Asset> > assets);
123 /** @return Standard of a DCP that was read in */
124 boost::optional<Standard> standard () const {
128 boost::filesystem::path directory () const {
132 /** @return PKL if this DCP was read from an existing one, or if write_xml() has been called on it.
133 * If neither is true, this method returns 0.
135 boost::shared_ptr<PKL> pkl () const {
139 static std::vector<boost::filesystem::path> directories_from_files (std::vector<boost::filesystem::path> files);
143 void write_volindex (Standard standard) const;
145 /** Write the ASSETMAP file.
146 * @param pkl_uuid UUID of our PKL.
147 * @param pkl_path Pathname of our PKL file.
149 void write_assetmap (Standard standard, std::string pkl_uuid, boost::filesystem::path pkl_path, XMLMetadata metadata) const;
151 /** the directory that we are writing to */
152 boost::filesystem::path _directory;
153 /** the CPLs that make up this DCP */
154 std::list<boost::shared_ptr<CPL> > _cpls;
155 boost::shared_ptr<PKL> _pkl;
157 /** Standard of DCP that was read in */
158 boost::optional<Standard> _standard;