X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.h;h=7d3d670aa891a4e35e20ea2736d059f70554d64d;hb=refs%2Ftags%2Fv1.8.63;hp=a723cebe988a87881f5b793d1b168961623080ed;hpb=ff896d5f5ec20e1371b423bb746c32fa55cc126a;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index a723cebe..7d3d670a 100644 --- a/src/dcp.h +++ b/src/dcp.h @@ -1,60 +1,86 @@ /* - Copyright (C) 2012-2014 Carl Hetherington + Copyright (C) 2012-2021 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 - * @brief DCP class. + * @brief DCP class */ + #ifndef LIBDCP_DCP_H #define LIBDCP_DCP_H -#include "types.h" + +#include "asset_map.h" #include "certificate.h" +#include "compose.hpp" #include "metadata.h" -#include +#include "name_format.h" +#include "types.h" +#include "util.h" +#include "verify.h" +#include "version.h" #include +#include #include #include + namespace xmlpp { class Document; class Element; } + /** @brief Namespace for everything in libdcp */ namespace dcp { + +class PKL; class Content; class Reel; class CPL; -class XMLMetadata; class CertificateChain; class DecryptedKDM; class Asset; -class DCPReadError; +class ReadError; + /** @class DCP - * @brief A class to create or read a DCP. + * @brief A class to create or read a DCP */ - -class DCP : public boost::noncopyable +class DCP { public: /** Construct a DCP. You can pass an existing DCP's directory @@ -64,15 +90,33 @@ public: * * @param directory Directory containing the DCP's files. */ - DCP (boost::filesystem::path directory); + explicit DCP (boost::filesystem::path directory); - typedef std::list > ReadErrors; + DCP (DCP const&) = delete; + DCP& operator= (DCP const&) = delete; - /** Read the DCP's structure into this object. - * @param keep_going true to try to keep going in the face of (some) errors. - * @param errors List of errors that will be added to if keep_going is true. + DCP (DCP &&); + DCP& operator= (DCP &&); + + /** Read a DCP. This method does not do any deep checking of the DCP's validity, but + * if it comes across any bad things it will do one of two things. + * + * Errors that are so serious that they prevent the method from working will result + * in an exception being thrown. For example, a missing ASSETMAP means that the DCP + * can't be read without a lot of guesswork, so this will throw. + * + * Errors that are not fatal will be added to notes, if it's non-null. For example, + * if the DCP contains a mixture of Interop and SMPTE elements this will result + * in a note being added to the vector. + * + * For more thorough checking of a DCP's contents, see dcp::verify(). + * + * @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 (bool keep_going = false, ReadErrors* errors = 0); + void read (std::vector* notes = nullptr, bool ignore_incorrect_picture_mxf_type = false); /** Compare this DCP with another, according to various options. * @param other DCP to compare this one to. @@ -82,49 +126,97 @@ public: */ bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const; - void add (boost::shared_ptr cpl); + void add (std::shared_ptr cpl); - std::list > cpls () const; - std::list > assets () const; + std::vector> cpls () const; - bool encrypted () const; + /** @param ignore_unresolved true to silently ignore unresolved assets, otherwise + * an exception is thrown if they are found. + * @return All assets (including CPLs). + */ + std::vector> assets (bool ignore_unresolved = false) const; + bool any_encrypted () const; + bool all_encrypted () const; + + /** Add a KDM to decrypt this DCP. This method must be called after DCP::read() + * or the KDM you specify will be ignored. + * @param kdm KDM to use. + */ void add (DecryptedKDM const &); + void set_issuer(std::string issuer); + void set_creator(std::string creator); + void set_issue_date(std::string issue_date); + void set_annotation_text(std::string annotation_text); + + /** Write all the XML files for this DCP. + * @param standand INTEROP or SMPTE + * @param signer Signer to use + * @param name_format Name format to use for the CPL and PKL filenames + */ void write_xml ( - Standard standard, - XMLMetadata metadata = XMLMetadata (), - boost::shared_ptr signer = boost::shared_ptr () + std::shared_ptr signer = std::shared_ptr(), + NameFormat name_format = NameFormat("%t") ); - void resolve_refs (std::list > assets); + void resolve_refs (std::vector> assets); -private: + /** @return Standard of a DCP that was read in */ + boost::optional standard () const { + if (!_asset_map) { + return {}; + } - /** Write the PKL file. - * @param pkl_uuid UUID to use. - */ - boost::filesystem::path write_pkl ( - Standard standard, - std::string pkl_uuid, - XMLMetadata metadata, - boost::shared_ptr signer - ) const; + return _asset_map->standard(); + } - void write_volindex (Standard standard) const; + boost::filesystem::path directory () const { + return _directory; + } - /** Write the ASSETMAP file. - * @param pkl_uuid UUID of our PKL. - * @param pkl_length Length of our PKL in bytes. + /** @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 vector. */ - void write_assetmap (Standard standard, std::string pkl_uuid, int pkl_length, XMLMetadata metadata) const; + std::vector> pkls () const { + return _pkls; + } + + boost::optional asset_map_file() const { + if (!_asset_map) { + return {}; + } + + return _asset_map->file(); + } - /** the directory that we are writing to */ + boost::optional asset_map() const { + return _asset_map; + } + + static std::vector directories_from_files (std::vector files); + +private: + + void write_volindex (Standard standard) const; + + /** The directory that we are writing to */ boost::filesystem::path _directory; - /** the CPLs that make up this DCP */ - std::list > _cpls; + /** The CPLs that make up this DCP */ + std::vector> _cpls; + /** The PKLs that make up this DCP */ + std::vector> _pkls; + boost::optional _asset_map; + + /* Metadata to use for newly created PKLs and AssetMaps */ + boost::optional _new_issuer; + boost::optional _new_creator; + boost::optional _new_issue_date; + boost::optional _new_annotation_text; }; + } + #endif