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 "metadata.h"
  46 #include <boost/shared_ptr.hpp>
  47 #include <boost/function.hpp>
  48 #include <boost/optional.hpp>
  49 #include <boost/filesystem.hpp>
  50 #include <list>
  51
  52 namespace dcp {
  53
  54 class ReelMXF;
  55 class Reel;
  56 class XMLMetadata;
  57 class MXFMetadata;
  58 class CertificateChain;
  59 class DecryptedKDM;
  60
  61 /** @class CPL
  62  *  @brief A Composition Playlist.
  63  */
  64 class CPL : public Asset
  65 {
  66 public:
  67         CPL (std::string annotation_text, ContentKind content_kind);
  68         explicit CPL (boost::filesystem::path file);
  69
  70         bool equals (
  71                 boost::shared_ptr<const Asset> other,
  72                 EqualityOptions options,
  73                 NoteHandler note
  74                 ) const;
  75
  76         void add (boost::shared_ptr<Reel> reel);
  77         void add (DecryptedKDM const &);
  78
  79         /** @return contents of the &lt;AnnotationText&gt; node */
  80         std::string annotation_text () const {
  81                 return _metadata.annotation_text;
  82         }
  83
  84         void set_annotation_text (std::string at) {
  85                 _metadata.annotation_text = at;
  86         }
  87
  88         /** @return contents of the &lt;ContentTitleText&gt; node */
  89         std::string content_title_text () const {
  90                 return _content_title_text;
  91         }
  92
  93         void set_content_title_text (std::string ct) {
  94                 _content_title_text = ct;
  95         }
  96
  97         /** @return contents of the &lt;Id&gt; node within &lt;ContentVersion&gt; */
  98         void set_content_version_id (std::string id) {
  99                 _content_version_id = id;
 100         }
 101
 102         /** @return contents of the &lt;LabelText&gt; node within &lt;ContentVersion&gt; */
 103         void set_content_version_label_text (std::string text) {
 104                 _content_version_label_text = text;
 105         }
 106
 107         /** @return the type of the content, used by media servers
 108          *  to categorise things (e.g. feature, trailer, etc.)
 109          */
 110         ContentKind content_kind () const {
 111                 return _content_kind;
 112         }
 113
 114         /** @return the reels in this CPL */
 115         std::list<boost::shared_ptr<Reel> > reels () const {
 116                 return _reels;
 117         }
 118
 119         /** @return the ReelMXFs in this CPL in all reels.
 120          */
 121         std::list<boost::shared_ptr<const ReelMXF> > reel_mxfs () const;
 122         std::list<boost::shared_ptr<ReelMXF> > reel_mxfs ();
 123
 124         bool encrypted () const;
 125
 126         void set_metadata (XMLMetadata m) {
 127                 _metadata = m;
 128         }
 129
 130         void write_xml (
 131                 boost::filesystem::path file,
 132                 Standard standard,
 133                 boost::shared_ptr<const CertificateChain>
 134                 ) const;
 135
 136         void resolve_refs (std::list<boost::shared_ptr<Asset> >);
 137
 138         int64_t duration () const;
 139
 140         boost::optional<Standard> standard () const {
 141                 return _standard;
 142         }
 143
 144         std::list<Rating> ratings () const {
 145                 return _ratings;
 146         }
 147
 148         void set_ratings (std::list<Rating> r) {
 149                 _ratings = r;
 150         }
 151
 152         static std::string static_pkl_type (Standard standard);
 153
 154 protected:
 155         /** @return type string for PKLs for this asset */
 156         std::string pkl_type (Standard standard) const;
 157
 158 private:
 159         /** &lt;Issuer&gt;, &lt;Creator&gt;, &lt;IssueDate&gt; and &lt;AnnotationText&gt.
 160          *  These are grouped because they occur together in a few places.
 161          */
 162         XMLMetadata _metadata;
 163         std::string _content_title_text;            ///< &lt;ContentTitleText&gt;
 164         ContentKind _content_kind;                  ///< &lt;ContentKind&gt;
 165         std::string _content_version_id;            ///< &lt;Id&gt; in &lt;ContentVersion&gt;
 166         std::string _content_version_label_text;    ///< &lt;LabelText&gt; in &lt;ContentVersion&gt;
 167         std::list<boost::shared_ptr<Reel> > _reels;
 168         std::list<Rating> _ratings;
 169
 170         /** Standard of CPL that was read in */
 171         boost::optional<Standard> _standard;
 172 };
 173
 174 }
 175
 176 #endif