2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
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.
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.
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/>.
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
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.
35 /** @file src/reel_file_asset.h
36 * @brief ReelFileAsset class
40 #ifndef LIBDCP_REEL_MXF_H
41 #define LIBDCP_REEL_MXF_H
45 #include <boost/optional.hpp>
58 /** @class ReelFileAsset
59 * @brief Part of a Reel's description which refers to an asset which can be encrypted
64 explicit ReelFileAsset (std::shared_ptr<Asset> asset, boost::optional<std::string> key_id);
65 explicit ReelFileAsset (std::shared_ptr<const cxml::Node>);
66 virtual ~ReelFileAsset () {}
68 /** @return the 4-character key type for this MXF (MDIK, MDAK, etc.) */
69 virtual std::string key_type () const = 0;
71 /** @return a Ref to our actual asset */
72 Ref const & asset_ref () const {
76 /** @return a Ref to our actual asset */
81 /** @return the asset's hash, if this ReelFileAsset has been created from one,
82 * otherwise the hash written to the CPL for this asset (if present).
84 boost::optional<std::string> hash () const {
88 void set_hash (std::string h) {
92 /** @return true if a KeyId is specified for this asset, implying
93 * that its content is encrypted.
95 bool encrypted () const {
96 return static_cast<bool>(_key_id);
99 /** @return Key ID to describe the key that encrypts this asset's
100 * content, if there is one.
102 boost::optional<std::string> key_id () const {
106 bool mxf_equals (std::shared_ptr<const ReelFileAsset> other, EqualityOptions opt, NoteHandler note) const;
111 std::shared_ptr<T> asset_of_type () const {
112 return std::dynamic_pointer_cast<T> (_asset_ref.asset ());
116 std::shared_ptr<T> asset_of_type () {
117 return std::dynamic_pointer_cast<T> (_asset_ref.asset ());
120 void write_to_cpl_mxf (xmlpp::Node* node) const;
122 /** Reference to the asset (MXF or XML file) that this reel entry
128 boost::optional<std::string> _key_id; ///< The <KeyId> from the reel's entry for this asset, if there is one
129 /** Either our asset's computed hash or the hash read in from the CPL, if it's present */
130 boost::optional<std::string> _hash;