X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fasset.h;h=c0f4700f9c950676b5c6abe228ad9ffd9a0ed527;hb=5591a50b918d2dc784a9e15688dfe24eb2b6dfcc;hp=6c0a9803adb9e47ead40255e0aefc380a0f20c3f;hpb=8d94e57248b7957d62350083a93aa479457f9385;p=libdcp.git diff --git a/src/asset.h b/src/asset.h index 6c0a9803..c0f4700f 100644 --- a/src/asset.h +++ b/src/asset.h @@ -1,101 +1,98 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2014 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 . */ /** @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 -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 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 (); + explicit 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. */ - Asset (std::string directory, std::string mxf_path, sigc::signal1* progress, int fps, int length); + void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const; - /** Write details of the asset to a CPL stream. - * @param s Stream. + /** Write details of the asset to a PKL AssetList node. + * @param node Parent node. + * @param standard Standard to use. */ - virtual void write_to_cpl (std::ostream& s) const = 0; + void write_to_pkl (xmlpp::Node* node, boost::filesystem::path root, Standard standard) const; - /** Write details of the asset to a PKL stream. - * @param s Stream. - */ - void write_to_pkl (std::ostream& s) const; + /** @return the most recent disk file used to read or write this asset; may be empty */ + boost::filesystem::path file () const { + return _file; + } - /** Write details of the asset to a ASSETMAP stream. - * @param s Stream. - */ - void write_to_assetmap (std::ostream& s) const; + void set_file (boost::filesystem::path file) const; - virtual std::list equals (boost::shared_ptr other, EqualityOptions opt) const; + /** @return the hash of this asset's file */ + std::string hash (boost::function progress = 0) const; + + void set_hash (std::string hash); protected: - friend class PictureAsset; - friend class SoundAsset; - - /** 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; - std::string digest () 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* _progress; - /** Frames per second */ - int _fps; - /** Length in frames */ - int _length; - /** Our UUID */ - std::string _uuid; - -private: - /** Digest of our MXF */ - mutable std::string _digest; + + /** The most recent disk file used to read or write this asset; may be empty */ + mutable boost::filesystem::path _file; + +private: + friend struct ::asset_test; + + virtual std::string pkl_type (Standard standard) const = 0; + + /** Hash of _file if it has been computed */ + mutable boost::optional _hash; }; }