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