X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.h;h=3eab743ec8453560dd3e825ee786640a6932e9d0;hb=f11ff8d4d961d92e994ef0f9beb456aa8ec7c4cb;hp=7e9b4edcba20fcf2b96a6d94f73b386c772cb82d;hpb=6322c72a13d7be2e991a8e0421414c0af8187b88;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index 7e9b4edc..3eab743e 100644 --- a/src/dcp.h +++ b/src/dcp.h @@ -1,195 +1,173 @@ /* - Copyright (C) 2012 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 - * @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 +namespace dcp { -class Asset; -class PictureAsset; -class SoundAsset; -class SubtitleAsset; +class PKL; +class Content; class Reel; -class AssetMap; - -/** @brief A CPL within a DCP */ -class CPL -{ -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; - } - - /** @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, boost::function note) 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; - - /** our UUID */ - std::string _uuid; - /** a SHA1 digest of our XML */ - mutable std::string _digest; -}; +class CPL; +class CertificateChain; +class DecryptedKDM; +class Asset; +class ReadError; -/** @class DCP dcp.h libdcp/dcp.h +/** @class DCP * @brief A class to create or read a DCP. */ - -class 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 (std::string directory); - - /** Read an existing DCP's data. - * - * The DCP's XML metadata will be examined, and you can then look at the contents - * of the DCP. - * - * @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); + explicit DCP (boost::filesystem::path directory); - /** Write the required XML files to the directory that was - * passed into the constructor. + /** 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 write_xml () const; + 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. * @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, boost::function note) const; + bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const; - /** Add a CPL to this DCP. - * @param cpl CPL to add. - */ - void add_cpl (boost::shared_ptr cpl); + void add (std::shared_ptr cpl); + + std::list > cpls () const; + std::list > assets (bool ignore_unresolved = false) const; + + bool encrypted () const; + + void add (DecryptedKDM 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") + ); - /** @return The list of CPLs in this DCP */ - std::list > cpls () const { - return _cpls; + void resolve_refs (std::list > assets); + + /** @return Standard of a DCP that was read in */ + boost::optional standard () const { + return _standard; + } + + boost::filesystem::path directory () const { + return _directory; } - /** Emitted with a parameter between 0 and 1 to indicate progress - * for long jobs. + /** @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::signals2::signal Progress; + std::list > pkls () const { + return _pkls; + } + + boost::optional asset_map_path () { + return _asset_map; + } + + static std::vector directories_from_files (std::vector files); private: - /** Write the PKL file. - * @param pkl_uuid UUID to use. - */ - std::string write_pkl (std::string pkl_uuid) const; - - /** Write the VOLINDEX file */ - void write_volindex () const; + 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 (std::string pkl_uuid, int pkl_length) const; - - /** @return Assets in all this CPLs in this DCP */ - std::list > assets () const; - - struct Files { - std::list cpls; - std::string pkl; - std::string asset_map; - }; - - /** the directory that we are writing to */ - std::string _directory; - /** our CPLs */ - std::list > _cpls; + 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::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; }; }