/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of libdcp.
+
+ libdcp is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
- This program is distributed in the hope that it will be useful,
+ libdcp is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+ along with libdcp. If not, see <http://www.gnu.org/licenses/>.
+
+ In addition, as a special exception, the copyright holders give
+ permission to link the code of portions of this program with the
+ OpenSSL library under certain conditions as described in each
+ individual source file, and distribute linked combinations
+ including the two.
+
+ You must obey the GNU General Public License in all respects
+ for all of the code used other than OpenSSL. If you modify
+ file(s) with this exception, you may extend this exception to your
+ version of the file(s), but you are not obligated to do so. If you
+ do not wish to do so, delete this exception statement from your
+ version. If you delete this exception statement from all source
+ files in the program, then also delete it here.
*/
/** @file src/asset.cc
- * @brief Parent class for assets of DCPs.
+ * @brief Asset class.
*/
-#include <iostream>
-#include <fstream>
-#include <boost/filesystem.hpp>
-#include "AS_DCP.h"
-#include "KM_util.h"
+#include "raw_convert.h"
#include "asset.h"
#include "util.h"
-#include "metadata.h"
-
-using namespace std;
-using namespace boost;
-using namespace libdcp;
-
-Asset::Asset (string directory, string mxf_name, sigc::signal1<void, float>* progress, int fps, int length)
- : _directory (directory)
- , _mxf_name (mxf_name)
- , _progress (progress)
- , _fps (fps)
- , _length (length)
- , _uuid (make_uuid ())
+#include "exceptions.h"
+#include "dcp_assert.h"
+#include "compose.hpp"
+#include "pkl.h"
+#include <libxml++/libxml++.h>
+#include <boost/algorithm/string.hpp>
+
+using std::string;
+using boost::function;
+using std::shared_ptr;
+using boost::optional;
+using namespace dcp;
+
+/** Create an Asset with a randomly-generated ID */
+Asset::Asset ()
{
-
+
}
-void
-Asset::write_to_pkl (ostream& s) const
+/** Create an Asset from a given file.
+ * @param file File name.
+ */
+Asset::Asset (boost::filesystem::path file)
+ : _file (file)
+{
+
+}
+
+/** Create an Asset from a given file with a known ID.
+ * @param file File name.
+ * @param id ID.
+ */
+Asset::Asset (string id, boost::filesystem::path file)
+ : Object (id)
+ , _file (file)
{
- s << " <Asset>\n"
- << " <Id>urn:uuid:" << _uuid << "</Id>\n"
- << " <AnnotationText>" << _mxf_name << "</AnnotationText>\n"
- << " <Hash>" << _digest << "</Hash>\n"
- << " <Size>" << filesystem::file_size(mxf_path()) << "</Size>\n"
- << " <Type>application/mxf</Type>\n"
- << " </Asset>\n";
+
}
void
-Asset::write_to_assetmap (ostream& s) const
+Asset::add_to_pkl (shared_ptr<PKL> pkl, boost::filesystem::path root) const
{
- s << " <Asset>\n"
- << " <Id>urn:uuid:" << _uuid << "</Id>\n"
- << " <ChunkList>\n"
- << " <Chunk>\n"
- << " <Path>" << _mxf_name << "</Path>\n"
- << " <VolumeIndex>1</VolumeIndex>\n"
- << " <Offset>0</Offset>\n"
- << " <Length>" << filesystem::file_size(mxf_path()) << "</Length>\n"
- << " </Chunk>\n"
- << " </ChunkList>\n"
- << " </Asset>\n";
+ DCP_ASSERT (_file);
+
+ optional<boost::filesystem::path> path = relative_to_root (
+ boost::filesystem::canonical (root),
+ boost::filesystem::canonical (_file.get())
+ );
+
+ if (!path) {
+ /* The path of this asset is not within our DCP, so we assume it's an external
+ (referenced) one.
+ */
+ return;
+ }
+
+ pkl->add_asset (_id, _id, hash(), boost::filesystem::file_size (_file.get()), pkl_type (pkl->standard()));
}
void
-Asset::fill_writer_info (ASDCP::WriterInfo* writer_info) const
+Asset::write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const
{
- writer_info->ProductVersion = Metadata::instance()->product_version;
- writer_info->CompanyName = Metadata::instance()->company_name;
- writer_info->ProductName = Metadata::instance()->product_name.c_str();
-
- writer_info->LabelSetType = ASDCP::LS_MXF_SMPTE;
- unsigned int c;
- Kumu::hex2bin (_uuid.c_str(), writer_info->AssetUUID, Kumu::UUID_Length, &c);
- assert (c == Kumu::UUID_Length);
+ DCP_ASSERT (_file);
+ write_file_to_assetmap (node, root, _file.get(), _id);
}
-filesystem::path
-Asset::mxf_path () const
+void
+Asset::write_file_to_assetmap (xmlpp::Node* node, boost::filesystem::path root, boost::filesystem::path file, string id)
{
- filesystem::path p;
- p /= _directory;
- p /= _mxf_name;
- return p;
+ optional<boost::filesystem::path> path = relative_to_root (
+ boost::filesystem::canonical (root),
+ boost::filesystem::canonical (file)
+ );
+
+ if (!path) {
+ /* The path of this asset is not within our DCP, so we assume it's an external
+ (referenced) one.
+ */
+ return;
+ }
+
+ xmlpp::Node* asset = node->add_child ("Asset");
+ asset->add_child("Id")->add_child_text ("urn:uuid:" + id);
+ xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
+ xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
+
+ chunk->add_child("Path")->add_child_text (path.get().generic_string());
+ chunk->add_child("VolumeIndex")->add_child_text ("1");
+ chunk->add_child("Offset")->add_child_text ("0");
+ chunk->add_child("Length")->add_child_text (raw_convert<string> (boost::filesystem::file_size (file)));
}
-list<string>
-Asset::equals (shared_ptr<const Asset> other, EqualityFlags flags) const
+string
+Asset::hash (function<void (float)> progress) const
{
- list<string> notes;
-
- if (flags & LIBDCP_METADATA) {
- if (_mxf_name != other->_mxf_name) {
- notes.push_back ("MXF names differ");
- }
- if (_fps != other->_fps) {
- notes.push_back ("MXF frames per second differ");
- }
- if (_length != other->_length) {
- notes.push_back ("MXF lengths differ");
- }
+ DCP_ASSERT (_file);
+
+ if (!_hash) {
+ _hash = make_digest (_file.get(), progress);
}
-
- if (flags & MXF_BITWISE) {
-
- if (_digest != other->_digest) {
- notes.push_back ("MXF digests differ");
- }
-
- if (filesystem::file_size (mxf_path()) != filesystem::file_size (other->mxf_path())) {
- notes.push_back (mxf_path().string() + " and " + other->mxf_path().string() + " sizes differ");
- return notes;
- }
-
- ifstream a (mxf_path().c_str(), ios::binary);
- ifstream b (other->mxf_path().c_str(), ios::binary);
-
- int buffer_size = 65536;
- char abuffer[buffer_size];
- char bbuffer[buffer_size];
-
- int n = filesystem::file_size (mxf_path ());
-
- while (n) {
- int const t = min (n, buffer_size);
- a.read (abuffer, t);
- b.read (bbuffer, t);
-
- if (memcmp (abuffer, bbuffer, t) != 0) {
- notes.push_back (mxf_path().string() + " and " + other->mxf_path().string() + " content differs");
- return notes;
- }
-
- n -= t;
- }
+
+ return _hash.get();
+}
+
+bool
+Asset::equals (std::shared_ptr<const Asset> other, EqualityOptions, NoteHandler note) const
+{
+ if (_hash != other->_hash) {
+ note (DCP_ERROR, "Asset: hashes differ");
+ return false;
}
- return notes;
+ return true;
+}
+
+/** Set the file that holds this asset on disk. Calling this function
+ * clears this object's store of its hash, so you should call ::hash
+ * after this.
+ *
+ * @param file New file's path.
+ */
+void
+Asset::set_file (boost::filesystem::path file) const
+{
+ _file = boost::filesystem::absolute (file);
+ _hash = optional<string> ();
+}
+
+void
+Asset::set_hash (string hash)
+{
+ _hash = hash;
}