src/asset.cc

   1 /*
   2     Copyright (C) 2014-2018 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/asset.cc
  35  *  @brief Asset class.
  36  */
  37
  38 #include "raw_convert.h"
  39 #include "asset.h"
  40 #include "util.h"
  41 #include "exceptions.h"
  42 #include "dcp_assert.h"
  43 #include "compose.hpp"
  44 #include "pkl.h"
  45 #include <libxml++/libxml++.h>
  46 #include <boost/algorithm/string.hpp>
  47
  48 using std::string;
  49 using boost::function;
  50 using boost::shared_ptr;
  51 using boost::optional;
  52 using namespace dcp;
  53
  54 /** Create an Asset with a randomly-generated ID */
  55 Asset::Asset ()
  56 {
  57
  58 }
  59
  60 /** Create an Asset from a given file.
  61  *  @param file File name.
  62  */
  63 Asset::Asset (boost::filesystem::path file)
  64         : _file (file)
  65 {
  66
  67 }
  68
  69 /** Create an Asset from a given file with a known ID.
  70  *  @param file File name.
  71  *  @param id ID.
  72  */
  73 Asset::Asset (string id, boost::filesystem::path file)
  74         : Object (id)
  75         , _file (file)
  76 {
  77
  78 }
  79
  80 void
  81 Asset::add_to_pkl (shared_ptr<PKL> pkl, boost::filesystem::path root) const
  82 {
  83         DCP_ASSERT (_file);
  84
  85         optional<boost::filesystem::path> path = relative_to_root (
  86                 boost::filesystem::canonical (root),
  87                 boost::filesystem::canonical (_file.get())
  88                 );
  89
  90         if (!path) {
  91                 /* The path of this asset is not within our DCP, so we assume it's an external
  92                    (referenced) one.
  93                 */
  94                 return;
  95         }
  96
  97         pkl->add_asset (_id, _id, hash(), boost::filesystem::file_size (_file.get()), pkl_type (pkl->standard()));
  98 }
  99
 100 void
 101 Asset::write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const
 102 {
 103         DCP_ASSERT (_file);
 104
 105         optional<boost::filesystem::path> path = relative_to_root (
 106                 boost::filesystem::canonical (root),
 107                 boost::filesystem::canonical (_file.get())
 108                 );
 109
 110         if (!path) {
 111                 /* The path of this asset is not within our DCP, so we assume it's an external
 112                    (referenced) one.
 113                 */
 114                 return;
 115         }
 116
 117         xmlpp::Node* asset = node->add_child ("Asset");
 118         asset->add_child("Id")->add_child_text ("urn:uuid:" + _id);
 119         xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
 120         xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
 121
 122         chunk->add_child("Path")->add_child_text (path.get().generic_string());
 123         chunk->add_child("VolumeIndex")->add_child_text ("1");
 124         chunk->add_child("Offset")->add_child_text ("0");
 125         chunk->add_child("Length")->add_child_text (raw_convert<string> (boost::filesystem::file_size (_file.get())));
 126 }
 127
 128 string
 129 Asset::hash (function<void (float)> progress) const
 130 {
 131         DCP_ASSERT (_file);
 132
 133         if (!_hash) {
 134                 _hash = make_digest (_file.get(), progress);
 135         }
 136
 137         return _hash.get();
 138 }
 139
 140 bool
 141 Asset::equals (boost::shared_ptr<const Asset> other, EqualityOptions, NoteHandler note) const
 142 {
 143         if (_hash != other->_hash) {
 144                 note (DCP_ERROR, "Asset: hashes differ");
 145                 return false;
 146         }
 147
 148         return true;
 149 }
 150
 151 /** Set the file that holds this asset on disk.  Calling this function
 152  *  clears this object's store of its hash, so you should call ::hash
 153  *  after this.
 154  *
 155  *  @param file New file's path.
 156  */
 157 void
 158 Asset::set_file (boost::filesystem::path file) const
 159 {
 160         _file = boost::filesystem::absolute (file);
 161         _hash = optional<string> ();
 162 }
 163
 164 void
 165 Asset::set_hash (string hash)
 166 {
 167         _hash = hash;
 168 }