src/cpl.h

   1 /*
   2     Copyright (C) 2014-2020 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
  35 /** @file  src/cpl.h
  36  *  @brief CPL class.
  37  */
  38
  39
  40 #ifndef LIBDCP_CPL_H
  41 #define LIBDCP_CPL_H
  42
  43
  44 #include "asset.h"
  45 #include "certificate.h"
  46 #include "key.h"
  47 #include "types.h"
  48 #include <boost/filesystem.hpp>
  49 #include <boost/function.hpp>
  50 #include <boost/optional.hpp>
  51 #include <boost/shared_ptr.hpp>
  52 #include <list>
  53
  54
  55 namespace dcp {
  56
  57
  58 class ReelMXF;
  59 class Reel;
  60 class MXFMetadata;
  61 class CertificateChain;
  62 class DecryptedKDM;
  63
  64
  65 /** @class CPL
  66  *  @brief A Composition Playlist.
  67  */
  68 class CPL : public Asset
  69 {
  70 public:
  71         CPL (std::string annotation_text, ContentKind content_kind);
  72         explicit CPL (boost::filesystem::path file);
  73
  74         bool equals (
  75                 boost::shared_ptr<const Asset> other,
  76                 EqualityOptions options,
  77                 NoteHandler note
  78                 ) const;
  79
  80         void add (boost::shared_ptr<Reel> reel);
  81         void add (DecryptedKDM const &);
  82
  83         /** @return the reels in this CPL */
  84         std::list<boost::shared_ptr<Reel> > reels () const {
  85                 return _reels;
  86         }
  87
  88         /** @return the ReelMXFs in this CPL in all reels */
  89         std::list<boost::shared_ptr<const ReelMXF> > reel_mxfs () const;
  90         std::list<boost::shared_ptr<ReelMXF> > reel_mxfs ();
  91
  92         bool encrypted () const;
  93
  94         void write_xml (
  95                 boost::filesystem::path file,
  96                 Standard standard,
  97                 boost::shared_ptr<const CertificateChain>
  98                 ) const;
  99
 100         void resolve_refs (std::list<boost::shared_ptr<Asset> >);
 101
 102         int64_t duration () const;
 103
 104         void set_issuer (std::string issuer) {
 105                 _issuer = issuer;
 106         }
 107
 108         void set_creator (std::string creator) {
 109                 _creator = creator;
 110         }
 111
 112         void set_issue_date (std::string issue_date) {
 113                 _issue_date = issue_date;
 114         }
 115
 116         /** @return contents of the &lt;AnnotationText&gt; node */
 117         std::string annotation_text () const {
 118                 return _annotation_text;
 119         }
 120
 121         void set_annotation_text (std::string at) {
 122                 _annotation_text = at;
 123         }
 124
 125         /** @return contents of the &lt;ContentTitleText&gt; node */
 126         std::string content_title_text () const {
 127                 return _content_title_text;
 128         }
 129
 130         void set_content_title_text (std::string ct) {
 131                 _content_title_text = ct;
 132         }
 133
 134         /** @return the type of the content, used by media servers
 135          *  to categorise things (e.g. feature, trailer, etc.)
 136          */
 137         ContentKind content_kind () const {
 138                 return _content_kind;
 139         }
 140
 141         ContentVersion content_version () const {
 142                 return _content_version;
 143         }
 144
 145         /** Set the contents of the ContentVersion tag */
 146         void set_content_version (ContentVersion v) {
 147                 _content_version = v;
 148         }
 149
 150         std::list<Rating> ratings () const {
 151                 return _ratings;
 152         }
 153
 154         void set_ratings (std::list<Rating> r) {
 155                 _ratings = r;
 156         }
 157
 158         boost::optional<Standard> standard () const {
 159                 return _standard;
 160         }
 161
 162         static std::string static_pkl_type (Standard standard);
 163
 164 protected:
 165         /** @return type string for PKLs for this asset */
 166         std::string pkl_type (Standard standard) const;
 167
 168 private:
 169         std::string _issuer;
 170         std::string _creator;
 171         std::string _issue_date;
 172         std::string _annotation_text;
 173         std::string _content_title_text;            ///< &lt;ContentTitleText&gt;
 174         ContentKind _content_kind;                  ///< &lt;ContentKind&gt;
 175         ContentVersion _content_version;            ///< &lt;ContentVersion&gt;
 176         std::list<Rating> _ratings;
 177
 178         std::list<boost::shared_ptr<Reel> > _reels;
 179
 180         /** Standard of CPL that was read in */
 181         boost::optional<Standard> _standard;
 182 };
 183
 184
 185 }
 186
 187
 188 #endif