src/reel_asset.h

   1 /*
   2     Copyright (C) 2014-2021 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/reel_asset.h
  36  *  @brief ReelAsset class
  37  */
  38
  39
  40 #ifndef LIBDCP_REEL_ASSET_H
  41 #define LIBDCP_REEL_ASSET_H
  42
  43
  44 #include "object.h"
  45 #include "util.h"
  46 #include "ref.h"
  47 #include <memory>
  48
  49
  50 namespace cxml {
  51         class Node;
  52 }
  53
  54
  55 namespace xmlpp {
  56         class Node;
  57 }
  58
  59
  60 namespace dcp {
  61
  62
  63 class Asset;
  64
  65
  66 /** @class ReelAsset
  67  *  @brief An entry in a &lt;Reel&gt; which refers to a use of a piece of content.
  68  *
  69  *  This class encapsulates the XML that exists in a &lt;Reel&gt; to say
  70  *  that a piece of content is used in this reel.  It does not
  71  *  describe the content itself (but links to an Asset object which does).
  72  */
  73 class ReelAsset : public Object
  74 {
  75 public:
  76         /** Construct a ReelAsset
  77          *  @param id ID of this ReelAsset (which is that of the MXF, if there is one)
  78          *  @param edit_rate Edit rate for the asset
  79          *  @param intrinsic_duration Intrinsic duration of this asset
  80          *  @param entry_point Entry point to use in that asset
  81          */
  82         ReelAsset (std::string id, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point);
  83
  84         explicit ReelAsset (std::shared_ptr<const cxml::Node>);
  85
  86         virtual xmlpp::Node* write_to_cpl (xmlpp::Node* node, Standard standard) const = 0;
  87
  88         Fraction edit_rate () const {
  89                 return _edit_rate;
  90         }
  91
  92         int64_t intrinsic_duration () const {
  93                 return _intrinsic_duration;
  94         }
  95
  96         void set_entry_point (int64_t e) {
  97                 _entry_point = e;
  98         }
  99
 100         void unset_entry_point () {
 101                 _entry_point = boost::none;
 102         }
 103
 104         boost::optional<int64_t> entry_point () const {
 105                 return _entry_point;
 106         }
 107
 108         void set_duration (int64_t d) {
 109                 _duration = d;
 110         }
 111
 112         boost::optional<int64_t> duration () const {
 113                 return _duration;
 114         }
 115
 116         /** @return <Duration>, or <IntrinsicDuration> - <EntryPoint> if <Duration> is not present */
 117         int64_t actual_duration () const;
 118
 119         std::string annotation_text () const {
 120                 return _annotation_text;
 121         }
 122
 123         void set_annotation_text (std::string at) {
 124                 _annotation_text = at;
 125         }
 126
 127         bool asset_equals (std::shared_ptr<const ReelAsset>, EqualityOptions, NoteHandler) const;
 128
 129 protected:
 130
 131         /** @return the node name that this asset uses in the CPL's &lt;Reel&gt; node
 132          *  e.g. MainPicture, MainSound etc.
 133          */
 134         virtual std::string cpl_node_name (Standard) const = 0;
 135
 136         /** @return Any attribute that should be used on the asset's node in the CPL */
 137         virtual std::pair<std::string, std::string> cpl_node_attribute (Standard) const;
 138
 139         /** @return Any namespace that should be used on the asset's node in the CPL */
 140         virtual std::pair<std::string, std::string> cpl_node_namespace () const;
 141
 142         xmlpp::Node* write_to_cpl_asset (xmlpp::Node* node, Standard standard, boost::optional<std::string> hash) const;
 143
 144         int64_t _intrinsic_duration = 0;       ///< The &lt;IntrinsicDuration&gt; from the reel's entry for this asset
 145         boost::optional<int64_t> _duration;    ///< The &lt;Duration&gt; from the reel's entry for this asset, if present
 146
 147 private:
 148         std::string _annotation_text;          ///< The &lt;AnnotationText&gt; from the reel's entry for this asset
 149         Fraction _edit_rate;                   ///< The &lt;EditRate&gt; from the reel's entry for this asset
 150         boost::optional<int64_t> _entry_point; ///< The &lt;EntryPoint&gt; from the reel's entry for this asset
 151 };
 152
 153
 154 }
 155
 156
 157 #endif