src/asset.cc

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