2 Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include "certificates.h"
30 #include <boost/shared_ptr.hpp>
31 #include <boost/signals2.hpp>
40 /** @brief Namespace for everything in libdcp */
58 * @brief A class to create or read a DCP.
61 class DCP : public boost::noncopyable
64 /** Construct a DCP. You can pass an existing DCP's directory
65 * as the parameter; alternatively, directory will be created
66 * if it does not exist. Note that if you pass an existing DCP
67 * into this constructor it will not be read until you call ::read().
69 * @param directory Directory containing the DCP's files.
71 DCP (boost::filesystem::path directory);
73 typedef std::list<boost::shared_ptr<DCPReadError> > ReadErrors;
75 /** Read the DCP's structure into this object.
76 * @param keep_going true to try to keep going in the face of (some) errors.
77 * @param errors List of errors that will be added to if keep_going is true.
79 void read (bool keep_going = false, ReadErrors* errors = 0);
81 /** Compare this DCP with another, according to various options.
82 * @param other DCP to compare this one to.
83 * @param options Options to define what "equality" means.
84 * @param note Functor to handle notes made by the equality operation.
85 * @return true if the DCPs are equal according to EqualityOptions, otherwise false.
87 bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const;
89 void add (boost::shared_ptr<Asset> asset);
91 std::list<boost::shared_ptr<CPL> > cpls () const;
93 /** @return All this DCP's assets (note that CPLs are assets) */
94 std::list<boost::shared_ptr<Asset> > assets () const {
98 bool encrypted () const;
100 void add (DecryptedKDM const &);
104 XMLMetadata metadata = XMLMetadata (),
105 boost::shared_ptr<const Signer> signer = boost::shared_ptr<const Signer> ()
110 /** Write the PKL file.
111 * @param pkl_uuid UUID to use.
113 boost::filesystem::path write_pkl (
115 std::string pkl_uuid,
116 XMLMetadata metadata,
117 boost::shared_ptr<const Signer> signer
120 void write_volindex (Standard standard) const;
122 /** Write the ASSETMAP file.
123 * @param pkl_uuid UUID of our PKL.
124 * @param pkl_length Length of our PKL in bytes.
126 void write_assetmap (Standard standard, std::string pkl_uuid, int pkl_length, XMLMetadata metadata) const;
128 /** the directory that we are writing to */
129 boost::filesystem::path _directory;
130 /** the assets that make up this DCP */
131 std::list<boost::shared_ptr<Asset> > _assets;