X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fasset.h;h=b88b1167d3c110f1087424805d972d2225667164;hb=a1e7f77e8fcfd71cc8bf94d13ceb2decbacc3b50;hp=e6a302c15010be3fccfd977cfb13fa6caba5927f;hpb=78c94420750c505e59d584c34b33acc953946c2a;p=libdcp.git diff --git a/src/asset.h b/src/asset.h index e6a302c1..b88b1167 100644 --- a/src/asset.h +++ b/src/asset.h @@ -1,42 +1,70 @@ /* - Copyright (C) 2014 Carl Hetherington + Copyright (C) 2014-2021 Carl Hetherington - 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 . + + 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.h - * @brief Asset class. - */ + * @brief Asset class + */ + #ifndef LIBDCP_ASSET_H #define LIBDCP_ASSET_H + #include "object.h" #include "types.h" +#include "pkl.h" #include #include +#include + namespace xmlpp { class Node; } + +struct asset_test; + + namespace dcp { + +class AssetMap; + + /** @class Asset - * @brief Parent class for DCP assets, i.e. picture/sound/subtitles and CPLs. + * @brief Parent class for DCP assets, i.e. picture, sound, subtitles, closed captions, CPLs, fonts * * Note that this class is not used for ReelAssets; those are just for the metadata * that gets put into <Reel>s. @@ -44,46 +72,90 @@ namespace dcp { class Asset : public Object { public: + /** Create an Asset with a randomly-generated ID */ Asset (); - Asset (boost::filesystem::path file); - Asset (std::string id); + + /** Create an Asset from a given file with a randomly-generated ID + * @param file File name + */ + explicit Asset (boost::filesystem::path file); + + /** Create an Asset from a given file with a given ID + * @param id ID + * @param file File name + */ + Asset (std::string id, boost::filesystem::path file); virtual bool equals ( - boost::shared_ptr other, - EqualityOptions opt, - boost::function note + std::shared_ptr other, + EqualityOptions const& opt, + NoteHandler note ) const; - /** Write details of the asset to a ASSETMAP. - * @param node Parent node. - */ - void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const; + virtual void add_to_assetmap (AssetMap& asset_map, boost::filesystem::path root) const; - /** Write details of the asset to a PKL AssetList node. - * @param node Parent node. - */ - void write_to_pkl (xmlpp::Node* node) const; + virtual void add_to_pkl (std::shared_ptr pkl, boost::filesystem::path root) const; - boost::filesystem::path file () const { + /** @return the most recent disk file used to read or write this asset, if there is one */ + boost::optional file () const { return _file; } + /** 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 set_file (boost::filesystem::path file) const; - /** @return the hash of this asset's file. It will be - * computed by this call if necessary. + /** Set the file that holds this asset on disk. Calling this function + * preserves the object's store of its hash, so if the object already + * has a hash it is up to the caller to ensure that the new file has + * the same hash. + * + * @param file New file's path. + */ + void set_file_preserving_hash(boost::filesystem::path file) const; + + /** Set the file that holds this asset on disk. The new file must + * be exactly the same as the old one, as this function assumes + * that the object's hash does not change. + * + * @param file New file's path. + */ + void rename_file(boost::filesystem::path file); + + /** Calculate the hash of this asset's file, if it has not already been calculated, + * then return it + * @param progress Function that will be called with a parameter between 0 and 1 to indicate + * progress in the calculation + * @return the hash */ - std::string hash () const; + std::string hash (boost::function progress = {}) const; + + void set_hash (std::string hash); + void unset_hash(); protected: - virtual std::string pkl_type () const = 0; - - /** The disk file that represents this asset, if one exists */ - mutable boost::filesystem::path _file; - /** Hash of _file, or empty if the hash has not yet been computed */ - mutable std::string _hash; + + /** The most recent disk file used to read or write this asset */ + mutable boost::optional _file; + + static void add_file_to_assetmap (AssetMap& asset_map, boost::filesystem::path root, boost::filesystem::path file, std::string id); + +private: + friend struct ::asset_test; + + /** @return type string for PKLs for this asset */ + virtual std::string pkl_type (Standard standard) const = 0; + + /** Hash of _file if it has been computed */ + mutable boost::optional _hash; }; + } + #endif