X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fdcp.h;h=bf9b3aaf03da832ec938d8497ce80e4048a1a582;hb=2da55dbe6da21975612584365db17db2ae9935b8;hp=6170896b8df36f1fd01d89fd1f3f9f278c13bfd3;hpb=4709b2fe88040f3678560997726f3a209eacc660;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index 6170896b..bf9b3aaf 100644 --- a/src/dcp.h +++ b/src/dcp.h @@ -1,88 +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 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 + + +namespace xmlpp { + class Document; + class Element; +} + -namespace libdcp +/** @brief Namespace for everything in libdcp */ +namespace dcp { -class Asset; -/** A class to create a DCP */ +class PKL; +class Content; +class Reel; +class CPL; +class CertificateChain; +class DecryptedKDM; +class Asset; +class ReadError; + + +/** @class DCP + * @brief A class to create or read a DCP + */ class DCP { public: - enum ContentType - { - FEATURE, - SHORT, - TRAILER, - TEST, - TRANSITIONAL, - RATING, - TEASER, - POLICY, - PUBLIC_SERVICE_ANNOUNCEMENT, - ADVERTISEMENT - }; - - DCP (std::string, std::string, ContentType, int, int); - - void add_sound_asset (std::list const &); - void add_picture_asset (std::list const &, int, int); - - void write_xml () const; - - /** Emitted with a parameter between 0 and 1 to indicate progress - * for long jobs. + /** 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 containing the DCP's files. + */ + explicit DCP (boost::filesystem::path directory); + + DCP (DCP const&) = delete; + DCP& operator= (DCP const&) = delete; + + 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 (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. + */ + bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const; + + void add (std::shared_ptr cpl); + + 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). */ - sigc::signal1 Progress; + 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 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 + */ + 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(); + } + + 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. + */ + std::vector> pkls () const { + return _pkls; + } + + boost::optional asset_map_file() const { + if (!_asset_map) { + return {}; + } + + return _asset_map->file(); + } + + boost::optional asset_map() const { + return _asset_map; + } + + static std::vector directories_from_files (std::vector files); private: - std::string write_cpl (std::string) const; - std::string write_pkl (std::string, std::string, std::string, int) const; - void write_volindex () const; - void write_assetmap (std::string, int, std::string, int) const; - - static std::string content_type_string (ContentType); - - /** the directory that we are writing to */ - std::string _directory; - /** the name of the DCP */ - std::string _name; - /** the content type of the DCP */ - ContentType _content_type; - /** frames per second */ - int _fps; - /** length in frames */ - int _length; - /** assets */ - std::list > _assets; + 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