src/asset.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/asset.h
  21  *  @brief Parent class for assets of DCPs.
  22  */
  23
  24 #ifndef LIBDCP_ASSET_H
  25 #define LIBDCP_ASSET_H
  26
  27 #include <string>
  28 #include <list>
  29 #include <boost/filesystem.hpp>
  30 #include "types.h"
  31
  32 namespace ASDCP {
  33         class WriterInfo;
  34 }
  35
  36 namespace libdcp
  37 {
  38
  39 /** @brief Parent class for assets of DCPs
  40  *
  41  *  These are collections of pictures or sound.
  42  */
  43 class Asset
  44 {
  45 public:
  46         /** Construct an Asset.
  47          *  @param directory Directory where our XML or MXF file is.
  48          *  @param file_name Name of our file within directory, or empty to make one up based on UUID.
  49          */
  50         Asset (std::string directory, std::string file_name = "");
  51
  52         virtual ~Asset() {}
  53
  54         /** Write details of the asset to a CPL stream.
  55          *  @param s Stream.
  56          */
  57         virtual void write_to_cpl (std::ostream& s) const = 0;
  58
  59         /** Write details of the asset to a PKL stream.
  60          *  @param s Stream.
  61          */
  62         void write_to_pkl (std::ostream& s) const;
  63
  64         /** Write details of the asset to a ASSETMAP stream.
  65          *  @param s Stream.
  66          */
  67         void write_to_assetmap (std::ostream& s) const;
  68
  69         std::string uuid () const {
  70                 return _uuid;
  71         }
  72
  73         virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, std::list<std::string>& notes) const = 0;
  74
  75 protected:
  76         friend class PictureAsset;
  77         friend class SoundAsset;
  78
  79         std::string digest () const;
  80         boost::filesystem::path path () const;
  81
  82         /** Directory that our MXF or XML file is in */
  83         std::string _directory;
  84         /** Name of our MXF or XML file */
  85         std::string _file_name;
  86         /** Our UUID */
  87         std::string _uuid;
  88
  89 private:
  90         /** Digest of our MXF or XML file */
  91         mutable std::string _digest;
  92 };
  93
  94 }
  95
  96 #endif