src/asset.h

   1 /*
   2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34 /** @file  src/asset.h
  35  *  @brief Asset class.
  36  */
  37
  38 #ifndef LIBDCP_ASSET_H
  39 #define LIBDCP_ASSET_H
  40
  41 #include "object.h"
  42 #include "types.h"
  43 #include "pkl.h"
  44 #include <boost/filesystem.hpp>
  45 #include <boost/function.hpp>
  46 #include <boost/optional.hpp>
  47
  48 namespace xmlpp {
  49         class Node;
  50 }
  51
  52 struct asset_test;
  53
  54 namespace dcp {
  55
  56 /** @class Asset
  57  *  @brief Parent class for DCP assets, i.e. picture, sound, subtitles, CPLs, fonts.
  58  *
  59  *  Note that this class is not used for ReelAssets; those are just for the metadata
  60  *  that gets put into &lt;Reel&gt;s.
  61  */
  62 class Asset : public Object
  63 {
  64 public:
  65         Asset ();
  66         explicit Asset (boost::filesystem::path file);
  67         Asset (std::string id, boost::filesystem::path file);
  68
  69         virtual bool equals (
  70                 std::shared_ptr<const Asset> other,
  71                 EqualityOptions opt,
  72                 NoteHandler note
  73                 ) const;
  74
  75         /** Write details of the asset to a ASSETMAP.
  76          *  @param node Parent node.
  77          */
  78         virtual void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
  79
  80         virtual void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const;
  81
  82         /** @return the most recent disk file used to read or write this asset, if there is one */
  83         boost::optional<boost::filesystem::path> file () const {
  84                 return _file;
  85         }
  86
  87         void set_file (boost::filesystem::path file) const;
  88
  89         /** @return the hash of this asset's file */
  90         std::string hash (boost::function<void (float)> progress = 0) const;
  91
  92         void set_hash (std::string hash);
  93
  94 protected:
  95
  96         /** The most recent disk file used to read or write this asset */
  97         mutable boost::optional<boost::filesystem::path> _file;
  98
  99         static void write_file_to_assetmap (xmlpp::Node* node, boost::filesystem::path root, boost::filesystem::path file, std::string id);
 100
 101 private:
 102         friend struct ::asset_test;
 103
 104         /** @return type string for PKLs for this asset */
 105         virtual std::string pkl_type (Standard standard) const = 0;
 106
 107         /** Hash of _file if it has been computed */
 108         mutable boost::optional<std::string> _hash;
 109 };
 110
 111 }
 112
 113 #endif