src/reel_asset.h

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