X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fasset.h;h=f69be5a168f38c32c68ace428f389669408cc4ca;hb=f2f2a2afc393dcaee747b97173d71a622d05d910;hp=b0cc450c999865e2f77dddd99c98a08fee961e92;hpb=82d22d7ff5328fae4f2e3048e63a2b11f3ce36b4;p=libdcp.git diff --git a/src/asset.h b/src/asset.h index b0cc450c..f69be5a1 100644 --- a/src/asset.h +++ b/src/asset.h @@ -1,87 +1,110 @@ /* - 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 . + + 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 -#include +#include "object.h" +#include "types.h" +#include "pkl.h" +#include +#include +#include +#include -namespace ASDCP { - class WriterInfo; +namespace xmlpp { + class Node; } -namespace libdcp -{ +struct asset_test; + +namespace dcp { -/** @brief Parent class for assets of DCPs +/** @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 mxf_path Pathname 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 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. - */ - virtual void write_to_cpl (std::ostream& s) const = 0; + void add_to_pkl (boost::shared_ptr pkl, boost::filesystem::path root) 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, if there is one */ + boost::optional 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; + + /** @return the hash of this asset's file */ + std::string hash (boost::function progress = 0) const; + + void set_hash (std::string hash); protected: - /** Fill in a ADSCP::WriteInfo struct. - * @param w struct to fill in. - */ - void fill_writer_info (ASDCP::WriterInfo* w) const; - - /** Path to our MXF file */ - std::string _mxf_path; - /** Signal to emit to report progress */ - sigc::signal1* _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 _file; + +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; }; }