X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.h;h=f4b6961580a0c36ec4349b818f17ba0873dea7bb;hb=a1e7f77e8fcfd71cc8bf94d13ceb2decbacc3b50;hp=8dd7a412a2287f87319112ab6e29c75c557553d2;hpb=d406283ff669a33973b43839da6200d972d25f2a;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index 8dd7a412..f4b69615 100644 --- a/src/dcp.h +++ b/src/dcp.h @@ -1,175 +1,223 @@ /* - 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 "asset_map.h" +#include "certificate.h" +#include "compose.hpp" +#include "metadata.h" +#include "name_format.h" +#include "types.h" +#include "util.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 CPL; +class CertificateChain; +class DecryptedKDM; +class Asset; +class ReadError; -/** @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. - * - * This is for making a new DCP that you are going to add assets to. + /** Construct a DCP. You can pass an existing DCP's directory + * 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 to write files to. - * @param name Name. - * @param content_kind Content kind. - * @param fps Frames per second. - * @param length Length in frames. + * @param directory Directory containing the DCP's files. */ - DCP (std::string directory, std::string name, ContentKind content_kind, int fps, int length); + explicit DCP (boost::filesystem::path directory); + + DCP (DCP const&) = delete; + DCP& operator= (DCP const&) = delete; - /** Construct a DCP object for an existing DCP. + 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. * - * The DCP's XML metadata will be examined, and you can then look at the contents - * of the DCP. + * 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. * - * @param directory Existing DCP's directory. - * @param read_mxfs true to read MXF files; setting to false can be useful for testing, but - * normally it should be set to true. + * 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 (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 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. */ - DCP (std::string directory, bool read_mxfs = true); + bool equals(DCP const & other, EqualityOptions const& options, NoteHandler note) const; - void add_reel (boost::shared_ptr reel); + void add (std::shared_ptr cpl); - /** Write the required XML files to the directory that was - * passed into the constructor. + std::vector> cpls () const; + + /** @param ignore_unresolved true to silently ignore unresolved assets, otherwise + * an exception is thrown if they are found. + * @return All assets (including CPLs). */ - void write_xml () const; + std::vector> assets (bool ignore_unresolved = false) const; + + bool any_encrypted () const; + bool all_encrypted () const; - /** @return the DCP's name, as will be presented on projector - * media servers and theatre management systems. + /** 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. */ - std::string name () const { - return _name; - } + void add (DecryptedKDM const &); - /** @return the type of the content, used by media servers - * to categorise things (e.g. feature, trailer, etc.) + 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 signer Signer to use + * @param include_mca_subdescriptors true to write MCA subdescriptors to CPLs. + * @param name_format Name format to use for the CPL and PKL filenames */ - ContentKind content_kind () const { - return _content_kind; + void write_xml( + std::shared_ptr signer = std::shared_ptr(), + bool include_mca_subdescriptors = true, + NameFormat name_format = NameFormat("%t") + ); + + void resolve_refs (std::vector> assets); + + /** @return Standard of a DCP that was read in */ + boost::optional standard () const { + if (!_asset_map) { + return {}; + } + + return _asset_map->standard(); } - /** @return the number of frames per second */ - int frames_per_second () const { - return _fps; + boost::filesystem::path directory () const { + return _directory; } - /** @return the length in frames */ - int length () const { - return _length; + /** @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. + */ + std::vector> pkls () const { + return _pkls; } - std::list > reels () const { - return _reels; + boost::optional asset_map_file() const { + if (!_asset_map) { + return {}; + } + + return _asset_map->file(); } - /** 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. - * @return An empty list if the DCPs are equal; otherwise a list of messages - * which explain the ways in which they differ. - */ - std::list equals (DCP const & other, EqualityOptions options) const; + boost::optional asset_map() const { + return _asset_map; + } - /** Emitted with a parameter between 0 and 1 to indicate progress - * for long jobs. - */ - sigc::signal1 Progress; + static std::vector directories_from_files (std::vector files); private: - /** Write the CPL file. - * @param cpl_uuid UUID to use. - * @return CPL pathname. - */ - std::string write_cpl (std::string cpl_uuid) const; - - /** Write the PKL file. - * @param pkl_uuid UUID to use. - * @param cpl_uuid UUID of the CPL file. - * @param cpl_digest SHA digest of the CPL file. - * @param cpl_length Length of the CPL file in bytes. - */ - std::string write_pkl (std::string pkl_uuid, std::string cpl_uuid, std::string cpl_digest, int cpl_length) const; - - /** Write the VOLINDEX file */ - void write_volindex () const; - - /** Write the ASSETMAP file. - * @param cpl_uuid UUID of our CPL. - * @param cpl_length Length of our CPL in bytes. - * @param pkl_uuid UUID of our PKL. - * @param pkl_length Length of our PKL in bytes. - */ - void write_assetmap (std::string cpl_uuid, int cpl_length, std::string pkl_uuid, int pkl_length) const; - - struct Files { - std::string cpl; - std::string pkl; - std::string asset_map; - std::list subtitles; - }; - - /** the directory that we are writing to */ - std::string _directory; - /** the name of the DCP */ - std::string _name; - /** the content kind of the DCP */ - ContentKind _content_kind; - /** frames per second */ - int _fps; - /** length in frames */ - int _length; - /** reels */ - std::list > _reels; + 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::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