src/cpl.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 #ifndef LIBDCP_CPL_H
  21 #define LIBDCP_CPL_H
  22
  23 #include <list>
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/function.hpp>
  26 #include <boost/date_time/posix_time/posix_time.hpp>
  27 #include <boost/optional.hpp>
  28 #include <libxml++/libxml++.h>
  29 #include "types.h"
  30 #include "certificates.h"
  31
  32 namespace libdcp {
  33
  34 namespace parse {
  35         class AssetMap;
  36         class AssetMapAsset;
  37 }
  38
  39 class Asset;
  40 class Reel;
  41 class XMLMetadata;
  42 class MXFMetadata;
  43 class Encryption;
  44 class KDM;
  45
  46 /** @brief A CPL within a DCP */
  47 class CPL
  48 {
  49 public:
  50         CPL (std::string directory, std::string name, ContentKind content_kind, int length, int frames_per_second);
  51         CPL (std::string directory, std::string file, std::list<PathAssetMap> asset_maps, bool require_mxfs = true);
  52
  53         void add_reel (boost::shared_ptr<Reel> reel);
  54
  55         /** @return the length in frames */
  56         int length () const {
  57                 return _length;
  58         }
  59
  60         /** @return the type of the content, used by media servers
  61          *  to categorise things (e.g. feature, trailer, etc.)
  62          */
  63         ContentKind content_kind () const {
  64                 return _content_kind;
  65         }
  66
  67         std::list<boost::shared_ptr<Reel> > reels () const {
  68                 return _reels;
  69         }
  70
  71         /** @return the CPL's name, as will be presented on projector
  72          *  media servers and theatre management systems.
  73          */
  74         std::string name () const {
  75                 return _name;
  76         }
  77
  78         /** @return the number of frames per second */
  79         int frames_per_second () const {
  80                 return _fps;
  81         }
  82
  83         std::list<boost::shared_ptr<const Asset> > assets () const;
  84
  85         bool encrypted () const;
  86
  87         std::string id () const {
  88                 return _id;
  89         }
  90
  91         bool equals (CPL const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
  92
  93         void write_xml (bool, XMLMetadata const &, boost::shared_ptr<Encryption>) const;
  94         void write_to_assetmap (xmlpp::Node *) const;
  95         void write_to_pkl (xmlpp::Node *) const;
  96
  97         boost::shared_ptr<xmlpp::Document> make_kdm (
  98                 CertificateChain const &,
  99                 std::string const &,
 100                 boost::shared_ptr<const Certificate>,
 101                 boost::posix_time::ptime from,
 102                 boost::posix_time::ptime until,
 103                 bool,
 104                 MXFMetadata const &,
 105                 XMLMetadata const &
 106                 ) const;
 107
 108         void add_kdm (KDM const &);
 109
 110 private:
 111         std::pair<std::string, boost::shared_ptr<const parse::AssetMapAsset> > asset_from_id (std::list<PathAssetMap>, std::string id) const;
 112
 113         std::string _directory;
 114         /** the name of the DCP */
 115         std::string _name;
 116         /** the content kind of the CPL */
 117         ContentKind _content_kind;
 118         /** length in frames */
 119         mutable int _length;
 120         /** frames per second */
 121         int _fps;
 122         /** reels */
 123         std::list<boost::shared_ptr<Reel> > _reels;
 124
 125         /** our UUID */
 126         std::string _id;
 127         /** a SHA1 digest of our XML */
 128         mutable std::string _digest;
 129 };
 130
 131 }
 132
 133 #endif