X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fasset.h;h=c7911497b48c70bb40f9f938b982d57af9154091;hb=689d56339857b0a82156641f28392b8d2f11beea;hp=3bc713a38b4b29450bfae79e3111151b890cca0f;hpb=59617eb2230e47b59882c4f9ca6092ce05f53cf1;p=libdcp.git diff --git a/src/asset.h b/src/asset.h index 3bc713a3..c7911497 100644 --- a/src/asset.h +++ b/src/asset.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2014 Carl Hetherington This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -18,122 +18,75 @@ */ /** @file src/asset.h - * @brief Parent class for assets of DCPs. + * @brief Asset class. */ #ifndef LIBDCP_ASSET_H #define LIBDCP_ASSET_H -#include -#include +#include "object.h" +#include "types.h" #include #include -#include -#include "types.h" +#include -namespace ASDCP { - class WriterInfo; +namespace xmlpp { + class Node; } -namespace libdcp -{ +struct asset_test; -/** @brief Parent class for assets of DCPs +namespace dcp { + +/** @class Asset + * @brief Parent class for DCP assets, i.e. picture, sound, subtitles, 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 our XML or MXF file is. - * @param file_name Name of our file within directory, or empty to make one up based on UUID. - */ - Asset (std::string directory, std::string file_name = "", int edit_rate = 0, int intrinsic_duration = 0); - - virtual ~Asset() {} - - /** Write details of the asset to a CPL stream. - * @param s Stream. - */ - virtual void write_to_cpl (xmlpp::Node *) const = 0; - - /** Write details of the asset to a PKL stream. - * @param s Stream. + Asset (); + Asset (boost::filesystem::path file); + Asset (std::string id, boost::filesystem::path file); + + virtual bool equals ( + boost::shared_ptr other, + EqualityOptions opt, + NoteHandler note + ) const; + + /** Write details of the asset to a ASSETMAP. + * @param node Parent node. */ - void write_to_pkl (xmlpp::Node *) const; + void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const; - /** Write details of the asset to a ASSETMAP stream. - * @param s Stream. + /** Write details of the asset to a PKL AssetList node. + * @param node Parent node. + * @param standard Standard to use. */ - void write_to_assetmap (xmlpp::Node *) const; - - std::string uuid () const { - return _uuid; - } - - boost::filesystem::path path () const; + void write_to_pkl (xmlpp::Node* node, boost::filesystem::path root, Standard standard) const; - void set_directory (std::string d) { - _directory = d; + /** @return the most recent disk file used to read or write this asset; may be empty */ + boost::filesystem::path file () const { + return _file; } - void set_file_name (std::string f) { - _file_name = f; - } - - int entry_point () const { - return _entry_point; - } - - int duration () const { - return _duration; - } - - int intrinsic_duration () const { - return _intrinsic_duration; - } - - int edit_rate () const { - return _edit_rate; - } + void set_file (boost::filesystem::path file) const; - void set_entry_point (int e) { - _entry_point = e; - } - - void set_duration (int d) { - _duration = d; - } + /** @return the hash of this asset's file */ + std::string hash (boost::function progress = 0) const; - void set_intrinsic_duration (int d) { - _intrinsic_duration = d; - } +protected: + friend struct ::asset_test; - virtual bool equals (boost::shared_ptr other, EqualityOptions opt, boost::function) const; + virtual std::string pkl_type (Standard standard) const = 0; -protected: - - std::string digest () const; - - /** Directory that our MXF or XML file is in */ - std::string _directory; - /** Name of our MXF or XML file */ - std::string _file_name; - /** Our UUID */ - std::string _uuid; - /** The edit rate; this is normally equal to the number of video frames per second */ - int _edit_rate; - /** Start point to present in frames */ - int _entry_point; - /** Total length in frames */ - int _intrinsic_duration; - /** Length to present in frames */ - int _duration; - -private: - /** Digest of our MXF or XML file */ - mutable std::string _digest; + /** The most recent disk file used to read or write this asset; may be empty */ + mutable boost::filesystem::path _file; + /** Hash of _file, or empty if the hash has not yet been computed */ + mutable std::string _hash; }; }