src/asset.h

   1 /*
   2     Copyright (C) 2014-2021 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
  35 /** @file  src/asset.h
  36  *  @brief Asset class
  37  */
  38
  39
  40 #ifndef LIBDCP_ASSET_H
  41 #define LIBDCP_ASSET_H
  42
  43
  44 #include "object.h"
  45 #include "types.h"
  46 #include "pkl.h"
  47 #include <boost/filesystem.hpp>
  48 #include <boost/function.hpp>
  49 #include <boost/optional.hpp>
  50
  51
  52 namespace xmlpp {
  53         class Node;
  54 }
  55
  56
  57 struct asset_test;
  58
  59
  60 namespace dcp {
  61
  62
  63 /** @class Asset
  64  *  @brief Parent class for DCP assets, i.e. picture, sound, subtitles, closed captions, CPLs, fonts
  65  *
  66  *  Note that this class is not used for ReelAssets; those are just for the metadata
  67  *  that gets put into &lt;Reel&gt;s.
  68  */
  69 class Asset : public Object
  70 {
  71 public:
  72         /** Create an Asset with a randomly-generated ID */
  73         Asset ();
  74
  75         /** Create an Asset from a given file with a randomly-generated ID
  76          *  @param file File name
  77          */
  78         explicit Asset (boost::filesystem::path file);
  79
  80         /** Create an Asset from a given file with a given ID
  81          *  @param id ID
  82          *  @param file File name
  83          */
  84         Asset (std::string id, boost::filesystem::path file);
  85
  86         virtual bool equals (
  87                 std::shared_ptr<const Asset> other,
  88                 EqualityOptions opt,
  89                 NoteHandler note
  90                 ) const;
  91
  92         virtual void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
  93
  94         virtual void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const;
  95
  96         /** @return the most recent disk file used to read or write this asset, if there is one */
  97         boost::optional<boost::filesystem::path> file () const {
  98                 return _file;
  99         }
 100
 101         /** Set the file that holds this asset on disk.  Calling this function
 102         *  clears this object's store of its hash, so you should call ::hash
 103         *  after this.
 104         *
 105         *  @param file New file's path.
 106         */
 107         void set_file (boost::filesystem::path file) const;
 108
 109         /** Calculate the hash of this asset's file, if it has not already been calculated,
 110          *  then return it
 111          *  @param progress Function that will be called with a parameter between 0 and 1 to indicate
 112          *  progress in the calculation
 113          *  @return the hash
 114          */
 115         std::string hash (boost::function<void (float)> progress = {}) const;
 116
 117         void set_hash (std::string hash);
 118
 119 protected:
 120
 121         /** The most recent disk file used to read or write this asset */
 122         mutable boost::optional<boost::filesystem::path> _file;
 123
 124         static void write_file_to_assetmap (xmlpp::Node* node, boost::filesystem::path root, boost::filesystem::path file, std::string id);
 125
 126 private:
 127         friend struct ::asset_test;
 128
 129         /** @return type string for PKLs for this asset */
 130         virtual std::string pkl_type (Standard standard) const = 0;
 131
 132         /** Hash of _file if it has been computed */
 133         mutable boost::optional<std::string> _hash;
 134 };
 135
 136
 137 }
 138
 139
 140 #endif