libdcp
reel_file_asset.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2012-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 
40 #ifndef LIBDCP_REEL_FILE_ASSET_H
41 #define LIBDCP_REEL_FILE_ASSET_H
42 
43 
44 #include "reel_asset.h"
45 #include "ref.h"
46 #include <boost/optional.hpp>
47 #include <string>
48 
49 
50 namespace dcp {
51 
52 
53 class ReelFileAsset : public ReelAsset
54 {
55 public:
56  ReelFileAsset (std::shared_ptr<Asset> asset, boost::optional<std::string> key_id, std::string id, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point);
57  explicit ReelFileAsset (std::shared_ptr<const cxml::Node> node);
58 
59  virtual xmlpp::Node* write_to_cpl (xmlpp::Node* node, Standard standard) const override;
60 
62  Ref const & asset_ref () const {
63  return _asset_ref;
64  }
65 
67  Ref & asset_ref () {
68  return _asset_ref;
69  }
70 
74  boost::optional<std::string> hash () const {
75  return _hash;
76  }
77 
78  void set_hash (std::string h) {
79  _hash = h;
80  }
81 
82  bool file_asset_equals (std::shared_ptr<const ReelFileAsset> other, EqualityOptions opt, NoteHandler note) const;
83 
84  virtual boost::optional<std::string> key_type () const {
85  return boost::none;
86  }
87 
88  bool encryptable () const override {
89  return static_cast<bool>(key_type());
90  }
91 
92  boost::optional<std::string> key_id () const {
93  return _key_id;
94  }
95 
96  bool encrypted () const {
97  return static_cast<bool>(key_id());
98  }
99 
100 protected:
101 
102  template <class T>
103  std::shared_ptr<T> asset_of_type () const {
104  return std::dynamic_pointer_cast<T>(_asset_ref.asset());
105  }
106 
107  template <class T>
108  std::shared_ptr<T> asset_of_type () {
109  return std::dynamic_pointer_cast<T>(_asset_ref.asset());
110  }
111 
116 
118  boost::optional<std::string> _hash;
119  boost::optional<std::string> _key_id;
120 };
121 
122 
123 }
124 
125 
126 #endif
A fraction (i.e. a thing with an integer numerator and an integer denominator).
Definition: types.h:214
An entry in a <Reel> which refers to a use of a piece of content.
Definition: reel_asset.h:74
Ref const & asset_ref() const
boost::optional< std::string > _key_id
The <KeyId> from the reel's entry for this asset, if there is one.
boost::optional< std::string > _hash
boost::optional< std::string > hash() const
A reference to an asset which is identified by a universally-unique identifier (UUID)
Definition: ref.h:66
std::shared_ptr< Asset > asset() const
Definition: ref.h:98
Namespace for everything in libdcp.
Definition: array_data.h:50
ReelAsset class.
Ref class.