X-Git-Url: https://main.carlh.net/gitweb/?p=libdcp.git;a=blobdiff_plain;f=src%2Fdcp.h;h=403eea9ef8f3b049d6665bde70a32e0caf1229bd;hp=d4f6aff9aba9a64a377da1caed718eb789b4b1f8;hb=ceaf7bc52712cb60708ed5eb5c62c5e463dd8e89;hpb=ee7187c25d83a47a106493e66b89888eca6d4344 diff --git a/src/dcp.h b/src/dcp.h index d4f6aff9..403eea9e 100644 --- a/src/dcp.h +++ b/src/dcp.h @@ -1,189 +1,217 @@ /* - Copyright (C) 2012 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 A class to create a DCP. + * @brief DCP class */ + #ifndef LIBDCP_DCP_H #define LIBDCP_DCP_H + +#include "compose.hpp" +#include "types.h" +#include "util.h" +#include "certificate.h" +#include "metadata.h" +#include "name_format.h" +#include "verify.h" +#include "version.h" +#include +#include #include #include -#include -#include -#include "types.h" + namespace xmlpp { - class Node; + class Document; + class Element; } -/** @brief Namespace for everything in libdcp */ -namespace libdcp -{ - -class Asset; -class PictureAsset; -class SoundAsset; -class SubtitleAsset; -class Reel; -class AssetMap; -class CPL +/** @brief Namespace for everything in libdcp */ +namespace dcp { -public: - CPL (std::string directory, std::string name, ContentKind content_kind, int length, int frames_per_second); - CPL (std::string directory, std::string file, boost::shared_ptr asset_map, bool require_mxfs = true); - - void add_reel (boost::shared_ptr reel); - - /** @return the length in frames */ - int length () const { - return _length; - } - /** @return the type of the content, used by media servers - * to categorise things (e.g. feature, trailer, etc.) - */ - ContentKind content_kind () const { - return _content_kind; - } - std::list > reels () const { - return _reels; - } - - /** @return the CPL's name, as will be presented on projector - * media servers and theatre management systems. - */ - std::string name () const { - return _name; - } +class PKL; +class Content; +class Reel; +class CPL; +class CertificateChain; +class DecryptedKDM; +class Asset; +class ReadError; - /** @return the number of frames per second */ - int frames_per_second () const { - return _fps; - } - std::list > assets () const; - - bool equals (CPL const & other, EqualityOptions options, std::list& notes) const; - - void write_xml () const; - void write_to_assetmap (std::ostream& s) const; - void write_to_pkl (std::ostream& s) const; - -private: - std::string _directory; - /** the name of the DCP */ - std::string _name; - /** the content kind of the CPL */ - ContentKind _content_kind; - /** length in frames */ - mutable int _length; - /** frames per second */ - int _fps; - /** reels */ - std::list > _reels; - - std::string _uuid; - mutable std::string _digest; -}; - -/** @class DCP dcp.h libdcp/dcp.h - * @brief A class to create or read a DCP. +/** @class DCP + * @brief A class to create or read a DCP */ - class DCP { 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 (std::string directory); + explicit DCP (boost::filesystem::path directory); - /** Read an existing DCP's data. + DCP (DCP const&) = delete; + DCP& operator= (DCP const&) = delete; + + /** 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. * - * The DCP's XML metadata will be examined, and you can then look at the contents - * of the DCP. + * 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. * - * @param require_mxfs true to throw an exception if MXF files are missing; setting to false - * can be useful for testing, but normally it should be set to true. - */ - void read (bool require_mxfs = true); - - /** Write the required XML files to the directory that was - * passed into the constructor. + * 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 write_xml () const; + 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. - * @param options Options to define just what "equality" means. - * @param notes Filled in with notes about differences. + * @param options Options to define what "equality" means. + * @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, std::list& notes) const; + bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const; - void add_cpl (boost::shared_ptr cpl); + void add (std::shared_ptr cpl); - std::list > cpls () const { - return _cpls; - } + std::vector> cpls () const; - /** Emitted with a parameter between 0 and 1 to indicate progress - * for long jobs. + /** @param ignore_unresolved true to silently ignore unresolved assets, otherwise + * an exception is thrown if they are found. + * @return All assets (including CPLs). */ - boost::signals2::signal Progress; + std::vector> assets (bool ignore_unresolved = false) const; -private: + bool any_encrypted () const; + bool all_encrypted () const; - /** Write the PKL file. - * @param pkl_uuid UUID to use. + /** 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 &); + + /** Write all the XML files for this DCP + * @param standand INTEROP or SMPTE + * @param issuer Value for the PKL and AssetMap tags + * @param creator Value for the PKL and AssetMap tags + * @param issue_date Value for the CPL tags + * @param annotation_text Value for the CPL tags + * @param signer Signer to use + * @param name_format Name format to use for the CPL and PKL filenames */ - std::string write_pkl (std::string pkl_uuid) const; - - /** Write the VOLINDEX file */ - void write_volindex () const; + void write_xml ( + Standard standard, + 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") + ); + + void resolve_refs (std::vector> assets); + + /** @return Standard of a DCP that was read in */ + boost::optional standard () const { + return _standard; + } - /** Write the ASSETMAP file. - * @param pkl_uuid UUID of our PKL. - * @param pkl_length Length of our PKL in bytes. + 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 vector. */ - void write_assetmap (std::string pkl_uuid, int pkl_length) const; + std::vector> pkls () const { + return _pkls; + } + + boost::optional asset_map_path () { + return _asset_map; + } + + static std::vector directories_from_files (std::vector files); - std::list > assets () const; +private: - struct Files { - std::list cpls; - std::string pkl; - std::string asset_map; - }; + void write_volindex (Standard standard) const; - /** the directory that we are writing to */ - std::string _directory; - std::list > _cpls; + /** Write the ASSETMAP file. + * @param pkl_uuid UUID of our PKL. + * @param pkl_path Pathname of our PKL file. + */ + 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 */ + boost::filesystem::path _directory; + /** The CPLs that make up this DCP */ + std::vector> _cpls; + /** The PKLs that make up this DCP */ + std::vector> _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; }; + } + #endif