src/dcp.h

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/dcp.h
  21  *  @brief DCP class.
  22  */
  23
  24 #ifndef LIBDCP_DCP_H
  25 #define LIBDCP_DCP_H
  26
  27 #include "types.h"
  28 #include "certificates.h"
  29 #include "metadata.h"
  30 #include <boost/shared_ptr.hpp>
  31 #include <boost/signals2.hpp>
  32 #include <string>
  33 #include <vector>
  34
  35 namespace xmlpp {
  36         class Document;
  37         class Element;
  38 }
  39
  40 /** @brief Namespace for everything in libdcp */
  41 namespace dcp
  42 {
  43
  44 class Content;
  45 class Reel;
  46 class CPL;
  47 class XMLMetadata;
  48 class Signer;
  49 class DecryptedKDM;
  50 class Asset;
  51 class DCPReadError;
  52
  53 namespace parse {
  54         class AssetMap;
  55 }
  56
  57 /** @class DCP
  58  *  @brief A class to create or read a DCP.
  59  */
  60
  61 class DCP : public boost::noncopyable
  62 {
  63 public:
  64         /** Construct a DCP.  You can pass an existing DCP's directory
  65          *  as the parameter, or a non-existant folder to create a new
  66          *  DCP in.
  67          *
  68          *  @param directory Directory containing the DCP's files.
  69          */
  70         DCP (boost::filesystem::path directory);
  71
  72         typedef std::list<boost::shared_ptr<DCPReadError> > ReadErrors;
  73
  74         /** Read the DCP's structure into this object.
  75          *  @param keep_going true to try to keep going in the face of (some) errors.
  76          *  @param errors List of errors that will be added to if keep_going is true.
  77          */
  78         void read (bool keep_going = false, ReadErrors* errors = 0);
  79
  80         /** Compare this DCP with another, according to various options.
  81          *  @param other DCP to compare this one to.
  82          *  @param options Options to define what "equality" means.
  83          *  @param note Functor to handle notes made by the equality operation.
  84          *  @return true if the DCPs are equal according to EqualityOptions, otherwise false.
  85          */
  86         bool equals (DCP const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
  87
  88         void add (boost::shared_ptr<Asset> asset);
  89
  90         std::list<boost::shared_ptr<CPL> > cpls () const;
  91
  92         /** @return All this DCP's assets (note that CPLs are assets) */
  93         std::list<boost::shared_ptr<Asset> > assets () const {
  94                 return _assets;
  95         }
  96
  97         bool encrypted () const;
  98
  99         void add (DecryptedKDM const &);
 100
 101         void write_xml (
 102                 Standard standard,
 103                 XMLMetadata metadata = XMLMetadata (),
 104                 boost::shared_ptr<const Signer> signer = boost::shared_ptr<const Signer> ()
 105         );
 106
 107 private:
 108
 109         /** Write the PKL file.
 110          *  @param pkl_uuid UUID to use.
 111          */
 112         boost::filesystem::path write_pkl (
 113                 Standard standard,
 114                 std::string pkl_uuid,
 115                 XMLMetadata metadata,
 116                 boost::shared_ptr<const Signer> signer
 117                 ) const;
 118
 119         void write_volindex (Standard standard) const;
 120
 121         /** Write the ASSETMAP file.
 122          *  @param pkl_uuid UUID of our PKL.
 123          *  @param pkl_length Length of our PKL in bytes.
 124          */
 125         void write_assetmap (Standard standard, std::string pkl_uuid, int pkl_length, XMLMetadata metadata) const;
 126
 127         /** the directory that we are writing to */
 128         boost::filesystem::path _directory;
 129         /** the assets that make up this DCP */
 130         std::list<boost::shared_ptr<Asset> > _assets;
 131 };
 132
 133 }
 134
 135 #endif