2 Copyright (C) 2014-2018 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.
34 /** @file src/asset.cc
38 #include "raw_convert.h"
41 #include "exceptions.h"
42 #include "dcp_assert.h"
43 #include "compose.hpp"
45 #include <libxml++/libxml++.h>
46 #include <boost/algorithm/string.hpp>
49 using boost::function;
50 using boost::shared_ptr;
51 using boost::optional;
54 /** Create an Asset with a randomly-generated ID */
60 /** Create an Asset from a given file.
61 * @param file File name.
63 Asset::Asset (boost::filesystem::path file)
69 /** Create an Asset from a given file with a known ID.
70 * @param file File name.
73 Asset::Asset (string id, boost::filesystem::path file)
81 Asset::add_to_pkl (shared_ptr<PKL> pkl, boost::filesystem::path root) const
85 optional<boost::filesystem::path> path = relative_to_root (
86 boost::filesystem::canonical (root),
87 boost::filesystem::canonical (_file.get())
91 /* The path of this asset is not within our DCP, so we assume it's an external
97 pkl->add_asset (_id, _id, hash(), boost::filesystem::file_size (_file.get()), pkl_type (pkl->standard()));
101 Asset::write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const
104 write_file_to_assetmap (node, root, _file.get(), _id);
108 Asset::write_file_to_assetmap (xmlpp::Node* node, boost::filesystem::path root, boost::filesystem::path file, string id)
110 optional<boost::filesystem::path> path = relative_to_root (
111 boost::filesystem::canonical (root),
112 boost::filesystem::canonical (file)
116 /* The path of this asset is not within our DCP, so we assume it's an external
122 xmlpp::Node* asset = node->add_child ("Asset");
123 asset->add_child("Id")->add_child_text ("urn:uuid:" + id);
124 xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
125 xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
127 chunk->add_child("Path")->add_child_text (path.get().generic_string());
128 chunk->add_child("VolumeIndex")->add_child_text ("1");
129 chunk->add_child("Offset")->add_child_text ("0");
130 chunk->add_child("Length")->add_child_text (raw_convert<string> (boost::filesystem::file_size (file)));
134 Asset::hash (function<void (float)> progress) const
139 _hash = make_digest (_file.get(), progress);
146 Asset::equals (boost::shared_ptr<const Asset> other, EqualityOptions, NoteHandler note) const
148 if (_hash != other->_hash) {
149 note (DCP_ERROR, "Asset: hashes differ");
156 /** Set the file that holds this asset on disk. Calling this function
157 * clears this object's store of its hash, so you should call ::hash
160 * @param file New file's path.
163 Asset::set_file (boost::filesystem::path file) const
165 _file = boost::filesystem::absolute (file);
166 _hash = optional<string> ();
170 Asset::set_hash (string hash)