/*
- 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.h
- * @brief Parent class for assets of DCPs.
+ * @brief Asset class
*/
+
#ifndef LIBDCP_ASSET_H
#define LIBDCP_ASSET_H
-#include <string>
-#include <sigc++/sigc++.h>
+
+#include "object.h"
#include "types.h"
+#include "pkl.h"
+#include <boost/filesystem.hpp>
+#include <boost/function.hpp>
+#include <boost/optional.hpp>
+
-namespace ASDCP {
- class WriterInfo;
+namespace xmlpp {
+ class Node;
}
-namespace libdcp
-{
-/** @brief Parent class for assets of DCPs
+struct asset_test;
+
+
+namespace dcp {
+
+
+/** @class Asset
+ * @brief Parent class for DCP assets, i.e. picture, sound, subtitles, closed captions, CPLs, fonts
*
- * These are collections of pictures or sound.
+ * Note that this class is not used for ReelAssets; those are just for the metadata
+ * that gets put into <Reel>s.
*/
-class Asset
+class Asset : public Object
{
public:
- /** Construct an Asset.
- * @param directory Directory where MXF file is.
- * @param mxf_name Name of MXF file.
- * @param progress Signal to inform of progress.
- * @param fps Frames per second.
- * @param length Length in frames.
- */
- Asset (std::string directory, std::string mxf_path, sigc::signal1<void, float>* progress, int fps, int length);
+ /** Create an Asset with a randomly-generated ID */
+ Asset ();
- /** Write details of the asset to a CPL stream.
- * @param s Stream.
+ /** Create an Asset from a given file with a randomly-generated ID
+ * @param file File name
*/
- virtual void write_to_cpl (std::ostream& s) const = 0;
+ explicit Asset (boost::filesystem::path file);
- /** Write details of the asset to a PKL stream.
- * @param s Stream.
+ /** Create an Asset from a given file with a given ID
+ * @param id ID
+ * @param file File name
*/
- void write_to_pkl (std::ostream& s) const;
-
- /** Write details of the asset to a ASSETMAP stream.
- * @param s Stream.
+ Asset (std::string id, boost::filesystem::path file);
+
+ virtual bool equals (
+ std::shared_ptr<const Asset> other,
+ EqualityOptions opt,
+ NoteHandler note
+ ) const;
+
+ virtual void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
+
+ virtual void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const;
+
+ /** @return the most recent disk file used to read or write this asset, if there is one */
+ boost::optional<boost::filesystem::path> 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;
+
+ /** 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
*/
- void write_to_assetmap (std::ostream& s) const;
+ std::string hash (boost::function<void (float)> progress = {}) const;
- virtual std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityFlags flags) const;
+ void set_hash (std::string hash);
protected:
- friend class PictureAsset;
-
- /** Fill in a ADSCP::WriteInfo struct.
- * @param w struct to fill in.
- */
- void fill_writer_info (ASDCP::WriterInfo* w) const;
-
- boost::filesystem::path mxf_path () const;
-
- /** Directory that our MXF file is in */
- std::string _directory;
- /** Name of our MXF file */
- std::string _mxf_name;
- /** Signal to emit to report progress */
- sigc::signal1<void, float>* _progress;
- /** Frames per second */
- int _fps;
- /** Length in frames */
- int _length;
- /** Our UUID */
- std::string _uuid;
- /** Digest of our MXF */
- std::string _digest;
+
+ /** The most recent disk file used to read or write this asset */
+ mutable boost::optional<boost::filesystem::path> _file;
+
+ static void write_file_to_assetmap (xmlpp::Node* node, 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<std::string> _hash;
};
+
}
+
#endif
projects / libdcp.git / blobdiff