src/dcp.h

   1 /*
   2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/dcp.h
  36  *  @brief DCP class
  37  */
  38
  39
  40 #ifndef LIBDCP_DCP_H
  41 #define LIBDCP_DCP_H
  42
  43
  44 #include "asset_map.h"
  45 #include "certificate.h"
  46 #include "compose.hpp"
  47 #include "metadata.h"
  48 #include "name_format.h"
  49 #include "types.h"
  50 #include "util.h"
  51 #include "verify.h"
  52 #include "version.h"
  53 #include <boost/signals2.hpp>
  54 #include <memory>
  55 #include <string>
  56 #include <vector>
  57
  58
  59 namespace xmlpp {
  60         class Document;
  61         class Element;
  62 }
  63
  64
  65 /** @brief Namespace for everything in libdcp */
  66 namespace dcp
  67 {
  68
  69
  70 class PKL;
  71 class Content;
  72 class Reel;
  73 class CPL;
  74 class CertificateChain;
  75 class DecryptedKDM;
  76 class Asset;
  77 class ReadError;
  78
  79
  80 /** @class DCP
  81  *  @brief A class to create or read a DCP
  82  */
  83 class DCP
  84 {
  85 public:
  86         /** Construct a DCP.  You can pass an existing DCP's directory
  87          *  as the parameter; alternatively, directory will be created
  88          *  if it does not exist.  Note that if you pass an existing DCP
  89          *  into this constructor it will not be read until you call ::read().
  90          *
  91          *  @param directory Directory containing the DCP's files.
  92          */
  93         explicit DCP (boost::filesystem::path directory);
  94
  95         DCP (DCP const&) = delete;
  96         DCP& operator= (DCP const&) = delete;
  97
  98         DCP (DCP &&);
  99         DCP& operator= (DCP &&);
 100
 101         /** Read a DCP.  This method does not do any deep checking of the DCP's validity, but
 102          *  if it comes across any bad things it will do one of two things.
 103          *
 104          *  Errors that are so serious that they prevent the method from working will result
 105          *  in an exception being thrown.  For example, a missing ASSETMAP means that the DCP
 106          *  can't be read without a lot of guesswork, so this will throw.
 107          *
 108          *  Errors that are not fatal will be added to notes, if it's non-null.  For example,
 109          *  if the DCP contains a mixture of Interop and SMPTE elements this will result
 110          *  in a note being added to the vector.
 111          *
 112          *  For more thorough checking of a DCP's contents, see dcp::verify().
 113          *
 114          *  @param notes List of notes that will be added to if non-0.
 115          *  @param ignore_incorrect_picture_mxf_type true to try loading MXF files marked as monoscopic
 116          *  as stereoscopic if the monoscopic load fails; fixes problems some 3D DCPs that (I think)
 117          *  have an incorrect descriptor in their MXF.
 118          */
 119         void read (std::vector<VerificationNote>* notes = nullptr, bool ignore_incorrect_picture_mxf_type = false);
 120
 121         /** Compare this DCP with another, according to various options.
 122          *  @param other DCP to compare this one to.
 123          *  @param options Options to define what "equality" means.
 124          *  @param note Functor to handle notes made by the equality operation.
 125          *  @return true if the DCPs are equal according to EqualityOptions, otherwise false.
 126          */
 127         bool equals(DCP const & other, EqualityOptions const& options, NoteHandler note) const;
 128
 129         void add (std::shared_ptr<CPL> cpl);
 130
 131         std::vector<std::shared_ptr<CPL>> cpls () const;
 132
 133         /** @param ignore_unresolved true to silently ignore unresolved assets, otherwise
 134          *  an exception is thrown if they are found.
 135          *  @return All assets (including CPLs).
 136          */
 137         std::vector<std::shared_ptr<Asset>> assets (bool ignore_unresolved = false) const;
 138
 139         bool any_encrypted () const;
 140         bool all_encrypted () const;
 141
 142         /** Add a KDM to decrypt this DCP.  This method must be called after DCP::read()
 143          *  or the KDM you specify will be ignored.
 144          *  @param kdm KDM to use.
 145          */
 146         void add (DecryptedKDM const &);
 147
 148         void set_issuer(std::string issuer);
 149         void set_creator(std::string creator);
 150         void set_issue_date(std::string issue_date);
 151         void set_annotation_text(std::string annotation_text);
 152
 153         /** Write all the XML files for this DCP.
 154          *  @param signer Signer to use
 155          *  @param include_mca_subdescriptors true to write MCA subdescriptors to CPLs.
 156          *  @param name_format Name format to use for the CPL and PKL filenames
 157          */
 158         void write_xml(
 159                 std::shared_ptr<const CertificateChain> signer = std::shared_ptr<const CertificateChain>(),
 160                 bool include_mca_subdescriptors = true,
 161                 NameFormat name_format = NameFormat("%t")
 162         );
 163
 164         void resolve_refs (std::vector<std::shared_ptr<Asset>> assets);
 165
 166         /** @return Standard of a DCP that was read in */
 167         boost::optional<Standard> standard () const {
 168                 if (!_asset_map) {
 169                         return {};
 170                 }
 171
 172                 return _asset_map->standard();
 173         }
 174
 175         boost::filesystem::path directory () const {
 176                 return _directory;
 177         }
 178
 179         /** @return PKLs if this DCP was read from an existing one, or if write_xml() has been called on it.
 180          *  If neither is true, this method returns an empty vector.
 181          */
 182         std::vector<std::shared_ptr<PKL>> pkls () const {
 183                 return _pkls;
 184         }
 185
 186         boost::optional<boost::filesystem::path> asset_map_file() const {
 187                 if (!_asset_map) {
 188                         return {};
 189                 }
 190
 191                 return _asset_map->file();
 192         }
 193
 194         boost::optional<AssetMap> asset_map() const {
 195                 return _asset_map;
 196         }
 197
 198         static std::vector<boost::filesystem::path> directories_from_files (std::vector<boost::filesystem::path> files);
 199
 200 private:
 201
 202         void write_volindex (Standard standard) const;
 203
 204         /** The directory that we are writing to */
 205         boost::filesystem::path _directory;
 206         /** The CPLs that make up this DCP */
 207         std::vector<std::shared_ptr<CPL>> _cpls;
 208         /** The PKLs that make up this DCP */
 209         std::vector<std::shared_ptr<PKL>> _pkls;
 210         boost::optional<AssetMap> _asset_map;
 211
 212         /* Metadata to use for newly created PKLs and AssetMaps */
 213         boost::optional<std::string> _new_issuer;
 214         boost::optional<std::string> _new_creator;
 215         boost::optional<std::string> _new_issue_date;
 216         boost::optional<std::string> _new_annotation_text;
 217 };
 218
 219
 220 }
 221
 222
 223 #endif