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