src/cpl.h

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