src/dcp.h

   1 /*
   2     Copyright (C) 2012-2014 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 /** @file  src/dcp.h
  35  *  @brief DCP class.
  36  */
  37
  38 #ifndef LIBDCP_DCP_H
  39 #define LIBDCP_DCP_H
  40
  41 #include "types.h"
  42 #include "certificate.h"
  43 #include "metadata.h"
  44 #include "name_format.h"
  45 #include <boost/shared_ptr.hpp>
  46 #include <boost/signals2.hpp>
  47 #include <string>
  48 #include <vector>
  49
  50 namespace xmlpp {
  51         class Document;
  52         class Element;
  53 }
  54
  55 /** @brief Namespace for everything in libdcp */
  56 namespace dcp
  57 {
  58
  59 class Content;
  60 class Reel;
  61 class CPL;
  62 class XMLMetadata;
  63 class CertificateChain;
  64 class DecryptedKDM;
  65 class Asset;
  66 class DCPReadError;
  67
  68 /** @class DCP
  69  *  @brief A class to create or read a DCP.
  70  */
  71
  72 class DCP : public boost::noncopyable
  73 {
  74 public:
  75         /** Construct a DCP.  You can pass an existing DCP's directory
  76          *  as the parameter; alternatively, directory will be created
  77          *  if it does not exist.  Note that if you pass an existing DCP
  78          *  into this constructor it will not be read until you call ::read().
  79          *
  80          *  @param directory Directory containing the DCP's files.
  81          */
  82         explicit DCP (boost::filesystem::path directory);
  83
  84         typedef std::list<boost::shared_ptr<DCPReadError> > ReadErrors;
  85
  86         /** Read the DCP's structure into this object.
  87          *  @param keep_going true to try to keep going in the face of (some) errors.
  88          *  @param errors List of errors that will be added to if keep_going is true.
  89          *  @param ignore_incorrect_picture_mxf_type true to try loading MXF files marked as monoscopic
  90          *  as stereoscopic if the monoscopic load fails; fixes problems some 3D DCPs that (I think)
  91          *  have an incorrect descriptor in their MXF.
  92          */
  93         void read (bool keep_going = false, ReadErrors* errors = 0, bool ignore_incorrect_picture_mxf_type = false);
  94
  95         /** Compare this DCP with another, according to various options.
  96          *  @param other DCP to compare this one to.
  97          *  @param options Options to define what "equality" means.
  98          *  @param note Functor to handle notes made by the equality operation.
  99          *  @return true if the DCPs are equal according to EqualityOptions, otherwise false.
 100          */
 101         bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const;
 102
 103         void add (boost::shared_ptr<CPL> cpl);
 104
 105         std::list<boost::shared_ptr<CPL> > cpls () const;
 106         std::list<boost::shared_ptr<Asset> > assets () const;
 107
 108         bool encrypted () const;
 109
 110         void add (DecryptedKDM const &);
 111
 112         void write_xml (
 113                 Standard standard,
 114                 XMLMetadata metadata = XMLMetadata (),
 115                 boost::shared_ptr<const CertificateChain> signer = boost::shared_ptr<const CertificateChain> (),
 116                 NameFormat name_format = NameFormat("%t_%i")
 117         );
 118
 119         void resolve_refs (std::list<boost::shared_ptr<Asset> > assets);
 120
 121         /** @return Standard of a DCP that was read in */
 122         boost::optional<Standard> standard () const {
 123                 return _standard;
 124         }
 125
 126 private:
 127
 128         /** Write the PKL file.
 129          *  @param pkl_uuid UUID to use.
 130          */
 131         boost::filesystem::path write_pkl (
 132                 std::string file,
 133                 Standard standard,
 134                 std::string pkl_uuid,
 135                 XMLMetadata metadata,
 136                 boost::shared_ptr<const CertificateChain> signer
 137                 ) const;
 138
 139         void write_volindex (Standard standard) const;
 140
 141         /** Write the ASSETMAP file.
 142          *  @param pkl_uuid UUID of our PKL.
 143          *  @param pkl_path Pathname of our PKL file.
 144          */
 145         void write_assetmap (Standard standard, std::string pkl_uuid, boost::filesystem::path pkl_path, XMLMetadata metadata) const;
 146
 147         /** the directory that we are writing to */
 148         boost::filesystem::path _directory;
 149         /** the CPLs that make up this DCP */
 150         std::list<boost::shared_ptr<CPL> > _cpls;
 151
 152         /** Standard of DCP that was read in */
 153         boost::optional<Standard> _standard;
 154 };
 155
 156 }
 157
 158 #endif