X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.h;h=3eab743ec8453560dd3e825ee786640a6932e9d0;hb=3034388f30732db8d748da96ee66fcdde0626c52;hp=d6275037c1582ce4719639b98ae4b4237c87c72f;hpb=ac265d3d008328b9bdaf00c39ebcd86f263605c7;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index d6275037..3eab743e 100644 --- a/src/dcp.h +++ b/src/dcp.h @@ -1,20 +1,34 @@ /* - Copyright (C) 2012-2014 Carl Hetherington + Copyright (C) 2012-2020 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ /** @file src/dcp.h @@ -24,10 +38,15 @@ #ifndef LIBDCP_DCP_H #define LIBDCP_DCP_H +#include "compose.hpp" #include "types.h" -#include "certificates.h" +#include "util.h" +#include "certificate.h" #include "metadata.h" -#include +#include "name_format.h" +#include "verify.h" +#include "version.h" +#include #include #include #include @@ -41,34 +60,38 @@ namespace xmlpp { namespace dcp { -class Content; +class PKL; +class Content; class Reel; class CPL; -class XMLMetadata; -class Signer; -class KDM; +class CertificateChain; +class DecryptedKDM; class Asset; - -namespace parse { - class AssetMap; -} +class ReadError; /** @class DCP * @brief A class to create or read a DCP. */ - + class DCP : public boost::noncopyable { public: /** Construct a DCP. You can pass an existing DCP's directory - * as the parameter, or a non-existant folder to create a new - * DCP in. + * as the parameter; alternatively, directory will be created + * if it does not exist. Note that if you pass an existing DCP + * into this constructor it will not be read until you call ::read(). * * @param directory Directory containing the DCP's files. */ - DCP (boost::filesystem::path directory); + explicit DCP (boost::filesystem::path directory); - void read (); + /** Read the DCP's structure into this object. + * @param notes List of notes that will be added to if non-0. + * @param ignore_incorrect_picture_mxf_type true to try loading MXF files marked as monoscopic + * as stereoscopic if the monoscopic load fails; fixes problems some 3D DCPs that (I think) + * have an incorrect descriptor in their MXF. + */ + void read (std::list* notes = 0, bool ignore_incorrect_picture_mxf_type = false); /** Compare this DCP with another, according to various options. * @param other DCP to compare this one to. @@ -76,51 +99,75 @@ public: * @param note Functor to handle notes made by the equality operation. * @return true if the DCPs are equal according to EqualityOptions, otherwise false. */ - bool equals (DCP const & other, EqualityOptions options, boost::function note) const; + bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const; - void add (boost::shared_ptr asset); + void add (std::shared_ptr cpl); - std::list > cpls () const; - - /** @return All this DCP's assets (note that CPLs are assets) */ - std::list > assets () const { - return _assets; - } + std::list > cpls () const; + std::list > assets (bool ignore_unresolved = false) const; bool encrypted () const; - void add (KDM const &); + void add (DecryptedKDM const &); void write_xml ( Standard standard, - XMLMetadata metadata = XMLMetadata (), - boost::shared_ptr signer = boost::shared_ptr () + std::string issuer = String::compose("libdcp %1", dcp::version), + std::string creator = String::compose("libdcp %1", dcp::version), + std::string issue_date = LocalTime().as_string(), + std::string annotation_text = String::compose("Created by libdcp %1", dcp::version), + std::shared_ptr signer = std::shared_ptr (), + NameFormat name_format = NameFormat("%t") ); -private: + void resolve_refs (std::list > assets); - /** Write the PKL file. - * @param pkl_uuid UUID to use. + /** @return Standard of a DCP that was read in */ + boost::optional standard () const { + return _standard; + } + + boost::filesystem::path directory () const { + return _directory; + } + + /** @return PKLs if this DCP was read from an existing one, or if write_xml() has been called on it. + * If neither is true, this method returns an empty list. */ - boost::filesystem::path write_pkl ( - Standard standard, - std::string pkl_uuid, - XMLMetadata metadata, - boost::shared_ptr signer - ) const; - + std::list > pkls () const { + return _pkls; + } + + boost::optional asset_map_path () { + return _asset_map; + } + + static std::vector directories_from_files (std::vector files); + +private: + void write_volindex (Standard standard) const; /** Write the ASSETMAP file. * @param pkl_uuid UUID of our PKL. - * @param pkl_length Length of our PKL in bytes. + * @param pkl_path Pathname of our PKL file. */ - void write_assetmap (Standard standard, std::string pkl_uuid, int pkl_length, XMLMetadata metadata) const; + void write_assetmap ( + Standard standard, std::string pkl_uuid, boost::filesystem::path pkl_path, + std::string issuer, std::string creator, std::string issue_date, std::string annotation_text + ) const; - /** the directory that we are writing to */ + /** The directory that we are writing to */ boost::filesystem::path _directory; - /** the assets that make up this DCP */ - std::list > _assets; + /** The CPLs that make up this DCP */ + std::list > _cpls; + /** The PKLs that make up this DCP */ + std::list > _pkls; + /** File that the ASSETMAP was read from or last written to */ + mutable boost::optional _asset_map; + + /** Standard of DCP that was read in */ + boost::optional _standard; }; }