src/dcp.h

   1 /*
   2     Copyright (C) 2012 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 A class to create or read a DCP.
  22  */
  23
  24 #ifndef LIBDCP_DCP_H
  25 #define LIBDCP_DCP_H
  26
  27 #include <string>
  28 #include <vector>
  29 #include <boost/shared_ptr.hpp>
  30 #include <boost/signals2.hpp>
  31 #include "types.h"
  32 #include "certificates.h"
  33
  34 namespace xmlpp {
  35         class Document;
  36         class Element;
  37 }
  38
  39 /** @brief Namespace for everything in libdcp */
  40 namespace dcp
  41 {
  42
  43 class Asset;
  44 class PictureAsset;
  45 class SoundAsset;
  46 class SubtitleAsset;
  47 class Reel;
  48 class CPL;
  49 class XMLMetadata;
  50 class Signer;
  51 class KDM;
  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         void read (bool require_mxfs = true);
  73
  74         /** Read an existing DCP's assets.
  75          *
  76          *  The DCP's XML metadata will be examined, and you can then look at the contents
  77          *  of the DCP.
  78          */
  79         void read_assets ();
  80
  81         void read_cpls (bool require_mxfs = true);
  82
  83         /** Write the required XML files to the directory that was
  84          *  passed into the constructor.
  85          */
  86         void write_xml (bool interop, XMLMetadata const &, boost::shared_ptr<const Signer> signer = boost::shared_ptr<const Signer> ()) const;
  87
  88         /** Compare this DCP with another, according to various options.
  89          *  @param other DCP to compare this one to.
  90          *  @param options Options to define what "equality" means.
  91          *  @return true if the DCPs are equal according to EqualityOptions, otherwise false.
  92          */
  93         bool equals (DCP const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
  94
  95         /** Add a CPL to this DCP.
  96          *  @param cpl CPL to add.
  97          */
  98         void add_cpl (boost::shared_ptr<CPL> cpl);
  99
 100         /** @return The list of CPLs in this DCP */
 101         std::list<boost::shared_ptr<CPL> > cpls () const {
 102                 return _cpls;
 103         }
 104
 105         /** Add another DCP as a source of assets for this DCP.  This should be called before
 106          *  ::read() on the DCP that needs the extra assets.  For example
 107          *
 108          *  DCP original_version ("my_dcp_OV");
 109          *  DCP supplemental ("my_dcp_VF");
 110          *  supplemental.add_assets_from (original_version);
 111          *  supplemental.read ();
 112          */
 113         void add_assets_from (DCP const &);
 114
 115         bool encrypted () const;
 116
 117         void add_kdm (KDM const &);
 118
 119         /** Emitted with a parameter between 0 and 1 to indicate progress
 120          *  for long jobs.
 121          */
 122         boost::signals2::signal<void (float)> Progress;
 123
 124 private:
 125
 126         /** Write the PKL file.
 127          *  @param pkl_uuid UUID to use.
 128          */
 129         std::string write_pkl (std::string pkl_uuid, bool, XMLMetadata const &, boost::shared_ptr<const Signer>) const;
 130
 131         /** Write the VOLINDEX file */
 132         void write_volindex (bool) const;
 133
 134         /** Write the ASSETMAP file.
 135          *  @param pkl_uuid UUID of our PKL.
 136          *  @param pkl_length Length of our PKL in bytes.
 137          */
 138         void write_assetmap (std::string pkl_uuid, int pkl_length, bool, XMLMetadata const &) const;
 139
 140         /** @return Assets in all the CPLs in this DCP */
 141         std::list<boost::shared_ptr<const Asset> > assets () const;
 142
 143         struct Files {
 144                 std::list<std::string> cpls;
 145                 std::string pkl;
 146                 std::string asset_map;
 147         };
 148
 149         Files _files;
 150
 151         /** the directory that we are writing to */
 152         boost::filesystem::path _directory;
 153         /** our CPLs */
 154         std::list<boost::shared_ptr<CPL> > _cpls;
 155
 156         std::list<PathAssetMap> _asset_maps;
 157 };
 158
 159 }
 160
 161 #endif