Add asset_hashes_can_differ option to the equality checks.
[libdcp.git] / src / asset.cc
index 78686a17bf16ffe6ec59ef62c464f64a26042f0b..330bd653082fcb1ff6441322b06c640ee76f7ca7 100644 (file)
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2021 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 "asset.h"
+#include "asset_map.h"
+#include "compose.hpp"
+#include "dcp_assert.h"
+#include "exceptions.h"
+#include "pkl.h"
+#include "raw_convert.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 "warnings.h"
+LIBDCP_DISABLE_WARNINGS
+#include <libxml++/libxml++.h>
+LIBDCP_ENABLE_WARNINGS
+#include <boost/algorithm/string.hpp>
+
+
+using std::string;
+using boost::function;
+using std::shared_ptr;
+using boost::optional;
+using namespace boost::filesystem;
+using namespace dcp;
+
+
+Asset::Asset ()
+{
+
+}
+
+
+Asset::Asset (path file)
+       : _file (file)
+{
+
+}
+
+
+Asset::Asset (string id, path file)
+       : Object (id)
+       , _file (file)
 {
-       
+
 }
 
+
 void
-Asset::write_to_pkl (ostream& s) const
+Asset::add_to_pkl (shared_ptr<PKL> pkl, path root) const
 {
-       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";
+       DCP_ASSERT (_file);
+
+       auto path = relative_to_root (
+               canonical(root),
+               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(), file_size(_file.get()), pkl_type(pkl->standard()), _file->filename().string());
 }
 
+
 void
-Asset::write_to_assetmap (ostream& s) const
+Asset::add_to_assetmap (AssetMap& asset_map, 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);
+       add_file_to_assetmap (asset_map, root, _file.get(), _id);
 }
 
+
 void
-Asset::fill_writer_info (ASDCP::WriterInfo* writer_info) const
+Asset::add_file_to_assetmap (AssetMap& asset_map, path root, path file, string id)
 {
-       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);
+       auto path = relative_to_root (
+               canonical(root),
+               canonical(file)
+               );
+
+       if (!path) {
+               /* The path of this asset is not within our DCP, so we assume it's an external
+                  (referenced) one.
+               */
+               return;
+       }
+
+       asset_map.add_asset(id, file, false);
 }
 
-filesystem::path
-Asset::mxf_path () const
+
+string
+Asset::hash (function<void (float)> progress) const
 {
-       filesystem::path p;
-       p /= _directory;
-       p /= _mxf_name;
-       return p;
+       DCP_ASSERT (_file);
+
+       if (!_hash) {
+               _hash = make_digest (_file.get(), progress);
+       }
+
+       return _hash.get();
 }
 
-list<string>
-Asset::equals (shared_ptr<const Asset> other, EqualityOptions opt) const
+
+bool
+Asset::equals(std::shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
 {
-       list<string> notes;
-       
-       if (opt.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");
+       if (_hash != other->_hash) {
+               if (!opt.asset_hashes_can_differ) {
+                       note(NoteType::ERROR, "Asset: hashes differ");
+                       return false;
+               } else {
+                       note(NoteType::NOTE, "Asset: hashes differ");
                }
        }
-       
-       if (opt.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().string().c_str(), ios::binary);
-               ifstream b (other->mxf_path().string().c_str(), ios::binary);
+       return true;
+}
 
-               int buffer_size = 65536;
-               char abuffer[buffer_size];
-               char bbuffer[buffer_size];
 
-               int n = filesystem::file_size (mxf_path ());
+void
+Asset::set_file (path file) const
+{
+       _file = absolute (file);
+       _hash = optional<string>();
+}
 
-               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;
-                       }
+void
+Asset::set_file_preserving_hash(path file) const
+{
+       _file = absolute(file);
+}
 
-                       n -= t;
-               }
-       }
 
-       return notes;
+void
+Asset::rename_file(path file)
+{
+       _file = absolute(file);
 }
 
-string
-Asset::digest () const
+
+void
+Asset::set_hash (string hash)
 {
-       if (_digest.empty ()) {
-               _digest = make_digest (mxf_path().string(), 0);
-       }
+       _hash = hash;
+}
 
-       return _digest;
+
+void
+Asset::unset_hash()
+{
+       _hash = optional<string>();
 }
 
-               
-               
-